os-autoinst-distri-rocky/VARIABLES.md
Adam Williamson df195a7853 rename BOOT_UPDATES_IMG_URL to TEST_UPDATES, add GRUBADD
Summary:
BOOT_UPDATES_IMG_URL is a pretty misleading name - it used to
be the actual URL, but now it's simply a boolean that decides
whether we look for the effect of the openQA updates image or
not. TEST_UPDATES seems clearer.

GRUBADD does the same thing as GRUB, on top of it. The point of
this is so we can add an option to the scheduler CLI that lets
you say 'run the normal tests, but with this updates image' -
so we can easily (albeit manually triggered) check the impact
of some anaconda change that needs testing. It should never be
set in the templates or the tests, it's there strictly for the
scheduler (whether that's fedora_openqa_schedule or literally a
person calling `client isos post`) to use as a kind of override.
The tests that test updates image loading will probably fail
when doing this, but all other tests should work as intended,
including ones that specify GRUB, becase the extra params will
just get added on top. That's why I invented a new var instead
of just letting the scheduler override GRUB's value when POST
ing.

Test Plan:
Check the rename didn't break anything (updates tests
still work). Run tests with GRUBADD param, make sure value is
correctly appended to cmdline both when GRUB is also specified
and when it is not.

Reviewers: jskladan, garretraziel

Reviewed By: garretraziel

Subscribers: tflink

Differential Revision: https://phab.qadevel.cloud.fedoraproject.org/D801
2016-04-08 13:21:29 -07:00

9.0 KiB

List of variables usable in tests

This list contains variables that are possible to set/redefine in WebUI and get their values in tests. This document merges relevant variables from official documentation (backend variables), variables that control flow through main.pm (test variables) and variables that are specified when ISO is posted into OpenQA (run variables).

Backend variables

These variables control settings of underlying virtual machine where tests runs on. Some of them (ARCH, QEMURAM, ...) should be set per machine, others (HDD_$i, HDDMODEL, ...) should be set per test and some of them (KEEPHDDS, MAKETESTSNAPSHOTS, SKIPTO) should be set only during development and debugging.

Variable Values allowed Default value Explanation
ARCH x86_64, i686, aarch64, ... depends on tested medium architecture of VM
BIOS filename ovmf-x86_64-ms.bin for x86_64 UEFI, not set otherwise set different BIOS
BOOTFROM characters (see man qemu, -boot order= option) not set boot from different medium than CD
CDMODEL see qemu-kvm -device help not set/Qemu default type of device for CD
HDDMODEL see qemu-kvm -device help (e. g. PATA = id-hd, SATA = ide-hd,bus-ahci0.0, SCSI = virtio-scsi-pci) virtio-blk type of device for HDD
HDDSIZEGB integer 10 size (in GBs) for disks that are created automatically
HDD_$i (HDD_1, HDD_2, ...) filename not set attach additional HDD to VM
ISO filename not set attach CD drive with ISO inserted
ISO_$i (ISO_1, ISO_2, ...) filename not set additional CD drives to by attached
KEEPHDDS boolean false/not set don't delete HDD after test finishes
LAPTOP boolean or filename false/not set if true, Dell E6330 DMI is used; if set to filename, that file is used for DMI
MAKETESTSNAPSHOTS boolean false/not set save snapshot for each test
NOVIDEO boolean false/not set don't create video output if set
NUMDISKS integer 1 number of disks to be created and attached to VM
PART_TABLE_TYPE mbr, gpt not set what type of partition table should attached HDD have
PXEBOOT boolean false/not set boot VM from PXE (network)
QEMU filename, path to Qemu binary not set filename of Qemu binary
QEMUCPU see qemu-kvm -cpu help not set CPU to emulate
QEMUCPUS integer 1 number of processor cores to use for Qemu
QEMURAM integer 1024 size of RAM to use (in MiB)
QEMUTHREADS integer 0 number of CPU threads to use for Qemu
QEMUVGA see qemu-kvm -device help cirrus (should be set to std on Fedora, cirrus driver was retired) display device to use for VM
QEMU_COMPRESS_QCOW2 boolean false/not set compress qcow2 images
SKIPTO name of snapshot not set restore VM from given snapshot - better used with MAKETESTSNAPSHOTS
UEFI boolean false/not set whether to use UEFI (UEFI BIOS files should be installed)
UEFI_BIOS filename false/not set, ovmf-x86_64-ms.bin when UEFI is set filename of UEFI BIOS
USBBOOT boolean false/not set if set, mount ISO as USB and boot from it

For additional (kvm2usb, IPMI...) as well as for other Qemu variables, see official documentation.

Test variables

These variables control flow through main.pm - by setting them, you can alter what parts will be loaded.

There are certain tests that conflict each other. Note that conflict is always mutual, but for simplification purposes, only one side of this conflict is shown (that means, if it's shown that A conflicts B, it also means that B conflicts A even if not shown in the table).

Variable Values allowed Default value/behavior Conflicts Explanation
LIVE boolean not set technically PACKAGE_SET, KICKSTART, MIRRORLIST_GRAPHICAL, REPOSITORY_GRAPHICAL, REPOSITORY_VARIATION specify that the test is running on Live system - additional steps are required (starting Anaconda...)
PACKAGE_SET string (minimal, default, ...) minimal; default when LIVE is set nothing sets packageset to install - you have to add appropriate needles, see tests/_software_selection.pm
ENTRYPOINT filename not set N/A set ENTRYPOINT to load specific test directly (bypass modular structure, mainly usable for testing)
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
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)
ROOT_PASSWORD string weakpassword nothing root password is set to this value
GRUB string not set nothing when set, append this string to kernel line in GRUB
GRUBADD string not set nothing when set, append this string to kernel line in GRUB, after the GRUB string if that one is set too. This is never set by tests; instead it's provided as a way to e.g. run the normal tests with an updates.img to test some anaconda change (the scheduler CLI can help you use this feature)
USER_LOGIN string not set should be used with USER_PASSWORD (unless false) when set, user login is set to this value. If not set, default value test is used for console installs, no login is done for graphical installs. If set to false, no user login will be done
USER_PASSWORD string not set should be used with USER_LOGIN when set, user password is set to this value. If not set, default value weakpassword is used for console installs, no login is done for graphical installs
TEST_UPDATES boolean false/not set set to indicate that this test checks updates.img loading, so we should check for the expected effect of the updates image used for this testing
POSTINSTALL string not set nothing If set, tests/(value)_postinstall.pm will be loaded after install, boot, login, and other postinstall tests
UEFI boolean false/not set nothing whether to use UEFI, this variable isn't usually set in test suites but in machine definition

Run variables

These variables should be set when tests are scheduled (when running isos post).

Variable Explanation
ISO contains filename of ISO that is used for booting. If ISOURL is not set, file must exist in /var/lib/openqa/share/factory/iso. If ISOURL is set, it will be downloaded to this name instead of its original name
ISO_URL contains URL for ISO to boot, openQA will download it
DISTRI contains distribution name (should be same as in WebUI, probably fedora)
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)