mirror of
https://github.com/rocky-linux/os-autoinst-distri-rocky.git
synced 2024-11-17 10:41:27 +00:00
minor updates to README.md and VARIABLES.md
This commit is contained in:
parent
c48ea7fc7a
commit
45b4b1072b
12
README.md
12
README.md
@ -1,6 +1,6 @@
|
||||
# openQA tests for the Fedora distribution
|
||||
# openQA tests for the Rocky Linux distribution
|
||||
|
||||
This repository contains tests and images for testing [Fedora](https://getfedora.org/) with [openQA](http://os-autoinst.github.io/openQA/). The [fedora_openqa library and CLI](https://pagure.io/fedora-qa/fedora_openqa) are used for scheduling tests, and [createhdds](https://pagure.io/fedora-qa/createhdds) is used for creating base disk images for the test. For openQA installation instructions, see [the Fedora openQA wiki page](https://fedoraproject.org/wiki/OpenQA).
|
||||
This repository contains tests and images for testing [Rocky](https://rockylinux.org/download) with [openQA](http://os-autoinst.github.io/openQA/). The [fedora_openqa library and CLI](https://pagure.io/fedora-qa/fedora_openqa) are used for scheduling tests, and [createhdds](https://pagure.io/fedora-qa/createhdds) is used for creating base disk images for the test. For openQA installation instructions, see [the Fedora openQA wiki page](https://fedoraproject.org/wiki/OpenQA).
|
||||
|
||||
## Issues
|
||||
|
||||
@ -8,7 +8,7 @@ This repository contains tests and images for testing [Fedora](https://getfedora
|
||||
|
||||
## Requirements
|
||||
|
||||
Obviously, this repository is little use without access to an openQA installation. Also, the tests themselves require the perl libraries JSON and REST::Client to be installed on the worker host; in Fedora, the package names are `perl-JSON` and `perl-REST-Client`. To load templates from this repository, you will need the upstream client tools (packaged as `openqa-client` in Fedora) and the dependencies of `fifloader.py` (see below for more on this tool) installed. Those dependencies are Python 3 and the `jsonschema` library. For running the unit tests, you will additionally need `pytest` and `tox`.
|
||||
Obviously, this repository is little use without access to an openQA installation. Also, the tests themselves require the perl libraries JSON and REST::Client to be installed on the worker host; in Fedora, the package names are `perl-JSON` and `perl-REST-Client`. To load templates from this repository, you will need the upstream client tools (packaged as `openqa-client` in Fedora) and the dependencies of `fifloader-rocky.py` (see below for more on this tool) installed. Those dependencies are Python 3 and the `jsonschema` library. For running the unit tests, you will additionally need `pytest` and `tox`.
|
||||
|
||||
## Test development
|
||||
|
||||
@ -23,7 +23,7 @@ See [this example repo](https://github.com/os-autoinst/os-autoinst-distri-exampl
|
||||
|
||||
### FIF template format
|
||||
|
||||
The test templates in this repository (files ending in `fif.json`) are not in the same format as expected by and are not directly compatible with the upstream template loader. They are in a format referred to as 'FIF' ('Fedora Intermediate Format') which is parsed into the upstream format by the `fifloader.py` utility found in this repository. This format is intended to be more convenient for human reading and editing. It is more fully explained in the docstring at the top of `fifloader.py`. Please refer to this when adding new tests to the templates. A command like `./fifloader.py --load templates.fif.json templates-updates.fif.json` can be used to load templates in the FIF format (this converts them to the upstream format, and calls the upstream template loader on the converted data). See `./fifloader.py -h` for further details on `fifloader.py`.
|
||||
The test templates in this repository (files ending in `fif.json`) are not in the same format as expected by and are not directly compatible with the upstream template loader. They are in a format referred to as 'FIF' ('Fedora Intermediate Format') which is parsed into the upstream format by the `fifloader-rocky.py` utility found in this repository. This format is intended to be more convenient for human reading and editing. It is more fully explained in the docstring at the top of `fifloader.py`. Please refer to this when adding new tests to the templates. A command like `./fifloader-rocky.py --load templates.fif.json templates-updates.fif.json` can be used to load templates in the FIF format (this converts them to the upstream format, and calls the upstream template loader on the converted data). See `./fifloader-rocky.py -h` for further details on `fifloader-rocky.py`.
|
||||
|
||||
### main.pm modular architecture
|
||||
|
||||
@ -52,7 +52,7 @@ To customize this step, you can set following variables:
|
||||
- Set `PACKAGE_SET` to install required package set on "Software selection spoke" - you have to provide correct needles with the name of `anaconda_${PACKAGE_SET}_highlighted` and `anaconda_${PACKAGE_SET}_selected`.
|
||||
- Set `ENCRYPT_PASSWORD` to encrypt disk, value of this variable is used as an actual password.
|
||||
|
||||
#### Installing Fedora and waiting for Fedora to reboot
|
||||
#### Installing Rocky Linux and waiting for Rocky Linux to reboot
|
||||
|
||||
After all customizations are finished, `_do_install_and_reboot.pm` test is automatically loaded. It starts installation, creates user and sets root password when required, waits for installation to finish and reboots into installed system. Only variables that control flow in this part are these:
|
||||
|
||||
@ -103,4 +103,4 @@ Note that tags of the form `ENV-INSTLANG-(anything)` are useless artefacts and s
|
||||
|
||||
The contents of this repository are available under the GPL, version 3 or any later version. A copy is included as COPYING. Note that we do not include the full GPL header in every single test file as they are quite short and this would waste a lot of space.
|
||||
|
||||
The tools and tests in this repository are maintained by the [Fedora QA team](https://fedoraproject.org/wiki/QA). We are grateful to the [openSUSE](https://opensuse.org) team for developing openQA, and for the [openSUSE tests](https://github.com/os-autoinst/os-autoinst-distri-opensuse) on which this repository was initially based (and from which occasional pieces are still borrowed).
|
||||
The tools and tests in this repository are maintained by the [Rocky Linux QA team](https://wiki.rockylinux.org/team/testing). We are grateful to the [openSUSE](https://opensuse.org) team for developing openQA, to the [Fedora QA team](https://fedoraproject.org/wiki/QA) for their respin and for the [openSUSE tests](https://github.com/os-autoinst/os-autoinst-distri-opensuse) and [Fedora tests](https://pagure.io/fedora-qa/os-autoinst-distri-fedora) on which this repository was initially based (and from which occasional pieces are still borrowed).
|
||||
|
||||
14
VARIABLES.md
14
VARIABLES.md
@ -61,8 +61,8 @@ it also means that `B` conflicts `A` even if not shown in the table).
|
||||
| `UPGRADE` | string (`minimal`, `desktop`, `encrypted`, ...) | not set | all except of `LIVE` and `USER_PASSWORD` | when set, do an upgrade test of specified type |
|
||||
| `KICKSTART` | boolean | `false`/not set | all | when specified, do an kickstart installation (you should use `GRUB` variable to specify where kickstart file resides) |
|
||||
| `MIRRORLIST_GRAPHICAL` | boolean | `false`/not set | `REPOSITORY_GRAPHICAL` | sets installation source to mirrorlist |
|
||||
| `REPOSITORY_GRAPHICAL` | url to repository (without arch and `/os`, for example `http://dl.fedoraproject.org/pub/fedora/linux/development`) | not set | `MIRRORLIST_GRAPHICAL` | sets installation source to repository url in Anaconda |
|
||||
| `REPOSITORY_VARIATION` | url to repository (without arch and `/os`, for example `http://dl.fedoraproject.org/pub/fedora/linux/development`) | not set | nothing | sets installation source to repository url in GRUB |
|
||||
| `REPOSITORY_GRAPHICAL` | url to repository (without arch and `/os`, for example `http://dl.rockylinux.org/pub/rocky/linux/development`) | not set | `MIRRORLIST_GRAPHICAL` | sets installation source to repository url in Anaconda |
|
||||
| `REPOSITORY_VARIATION` | url to repository (without arch and `/os`, for example `http://dl.rockylinux.org/pub/rocky/linux/development`) | not set | nothing | sets installation source to repository url in GRUB |
|
||||
| `PARTITIONING` | string (`custom_software_raid`, `guided_delete_all`, ...) | `guided_empty` | nothing | load specified test for partitioning part (when `PARTITIONING=guided_delete_all`, `tests/disk_guided_delete_all.pm` is loaded) and optionally post-install partitioning check (if `tests/disk_guided_delete_all_postinstall.pm` exists, it will be loaded after login to the installed system). Also, if value starts with `custom_`, the `select_disks()` method will check the custom partitioning box |
|
||||
| `ENCRYPT_PASSWORD` | string | not set | nothing | if set, encrypt disk with given password |
|
||||
| `DESKTOP` | boolean | `false`/not set | nothing | set to indicate that Fedora is running with GUI (so for example OpenQA should expect graphical login screen) |
|
||||
@ -97,14 +97,14 @@ These variables should be set when tests are scheduled (when running `isos post`
|
||||
| `ISO_URL` | contains URL for ISO to boot, openQA will download it |
|
||||
| `ADVISORY` | A Bodhi update ID. If set, the 'update testing' flow will be used: post-install tests will be run with the packages from the update, starting from the stable release base disk images |
|
||||
| `KOJITASK` | A Koji task ID. If set, the modified 'update testing' flow for testing scratch builds will be used: post-install tests will be run with the packages from the update, starting from the stable release base disk images |
|
||||
| `DISTRI` | contains distribution name (should be same as in WebUI, probably `fedora`) |
|
||||
| `DISTRI` | contains distribution name (should be same as in WebUI, probably `rocky`) |
|
||||
| `VERSION` | contains version of distribution |
|
||||
| `FLAVOR` | indicates what type of distribution is used. Three Pungi properties, joined with `-`: `variant`, `type`, and `format`. e.g.: `Server-dvd-iso`. Special value `universal` is used to schedule the group of tests that should be run once each per arch per compose, against the 'best' available ISO |
|
||||
| `ARCH` | is set to architecture that will be used (`x86_64`, `i686`) |
|
||||
| `BUILD` | contains Pungi compose_id (something like `Fedora-24-20160121.n.3`) |
|
||||
| `BUILD` | contains Pungi compose_id (something like `Rocky-8.4-20210801.n.0`) |
|
||||
| `LABEL` | contains Pungi compose label, if it has one (otherwise should be unset) - e.g `RC-1.5` |
|
||||
| `CURRREL` | the current stable Fedora release at the time of the test run |
|
||||
| `PREVREL` | the previous stable Fedora release at the time of the test run |
|
||||
| `CURRREL` | the current stable Rocky release at the time of the test run |
|
||||
| `PREVREL` | the previous stable Rocky release at the time of the test run |
|
||||
| `UP1REL` | the source release for "1-release" upgrade tests (usually but not always same as `CURRREL`) |
|
||||
| `UP2REL` | the source release for "2-release" upgrade tests (currently always same as `PREVREL`) |
|
||||
| `LOCATION` | contains Pungi base compose location (something like `https://kojipkgs.fedoraproject.org/compose/branched/Fedora-25-20160901.n.0/compose/`) |
|
||||
| `LOCATION` | contains Pungi base compose location (something like `https://kojipkgs.rockylinux.org/compose/branched/Rocky-8.4-20210801.n.0/compose/`) |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user