Rich MegginsonandRichard Megginson
b7d6ec5ba3
* Pass in a YAML true value as `__bootc_validation: true` using
the --extra-vars option to ensure that `__bootc_validation` is
treated as a boolean and not a string value.
`-e "__bootc_validation: true"`
You can also use JSON format:
`-e '{"__bootc_validation": true}'`
but YAML is simpler in this case.
* Use tox-lsr version 3.11.1
* Ensure the citest bad comment works when the test was cancelled in
addition to the failure case.
* Update contributing.md documentation
* Update number of nodes to use in testing farm, if needed
* remove unnecessary ansible-lint skips
Signed-off-by: Rich Megginson <rmeggins@redhat.com>
2.7 KiB
Contributing to the aide Linux System Role
Where to start
The first place to go is Contribute. This has all of the common information that all role developers need:
- Role structure and layout
- Development tools - How to run tests and checks
- Ansible recommended practices
- Basic git and github information
- How to create git commits and submit pull requests
Bugs and needed implementations are listed on Github Issues. Issues labeled with help wanted are likely to be suitable for new contributors!
Code is managed on Github, using Pull Requests.
Running CI Tests Locally
Use tox-lsr with qemu
The latest version of tox-lsr supports qemu testing. https://github.com/linux-system-roles/tox-lsr#qemu-testing
Steps:
-
If you are using RHEL or CentOS, enable the EPEL repository for your platform - https://docs.fedoraproject.org/en-US/epel/
-
Use yum or dnf to install
standard-test-roles-inventory-qemu- If for some reason dnf/yum do not work, just download the script from
https://pagure.io/standard-test-roles/raw/master/f/inventory/standard-inventory-qcow2
- copy to your
$PATH, and make sure it is executable
- copy to your
- If for some reason dnf/yum do not work, just download the script from
https://pagure.io/standard-test-roles/raw/master/f/inventory/standard-inventory-qcow2
-
Install tox
- Use yum/dnf to install
python3-tox- if that does not work, then usepip install --user tox, then make sure~/.local/binis in your$PATH
- Use yum/dnf to install
-
Install tox-lsr https://github.com/linux-system-roles/tox-lsr#how-to-get-it
pip install --user git+https://github.com/linux-system-roles/tox-lsr@main -
Download the config file to
~/.config/linux-system-roles.jsonfrom https://github.com/linux-system-roles/linux-system-roles.github.io/blob/main/download/linux-system-roles.json -
Assuming you are in a git clone of a role repo which has a tox.ini file - you can use e.g.
tox -e qemu-ansible-core-2.14 -- --image-name centos-9 tests/tests_default.yml
There are many command line options and environment variables which can be used to control the behavior, and you can customize the testenv in tox.ini. See https://github.com/linux-system-roles/tox-lsr#qemu-testing
This method supports RHEL also - will download the latest image for a compose, and will set up the yum repos to point to internal composes.
See https://linux-system-roles.github.io/contribute.html for general development guidelines.