Environment_Variables.md 3.53 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Generally you want to prefix all new vars with `OPENQA_` as they will get auto
routed all the way through to vars.json and thus `testapi::get_var`. Older vars
do not have the prefix (yet).

# Tooling Variables

Tooling variables are used to influence our tooling but generally aren't
available in os-autoinst (or have a different name, being env vars you could
still fish them out of `ENV` I suppose).

|Variable|Description|
|--------|-----------|
|QEMUVGA|Overrides the qemu VGA default.|
|OPENQA_BIOS|Modifies the system to boot in BIOS mode instead of UEFI (our tooling only). In os-autoinst this var is `UEFI` and inverted.|
|PLASMA_MOBILE|Enables special config for plasma mobile|
Harald Sitter's avatar
Harald Sitter committed
16
|NO_CLEAN|Sets Jenkinsfile to not clean up workspace when the job ends (useful to inspect the disk image)|
17
|OPENQA_OS_AUTOINST_IN_TREE|Super duper internal var. If you don't wanna read the code for it you really don't need to know what it does|
18 19 20 21 22 23 24 25 26 27 28 29 30

# Test Variables

|Variable|Description|
|--------|-----------|
|TYPE|Identifies the image type. This is the ISO identifier not the build type (i.e. devedition-gitunstable not unstable)|
|BIOS|Modifies the system to boot in BIOS mode instead of UEFI (our tooling only). In os-auto-inst this var is `UEFI` and inverted.
|SECUREBOOT|Modifier for INSTALLATION to run in secureboot (gets bootstrapped before ISO starts)|
|INSTALLATION_OEM|Modifier for INSTALLATION to run in OEM mode|
|OEM_USERNAME|User name to use for the temporary oem user (i.e. the user the vendor uses to configure the system)|
|OEM_PASSWORD|Password of the oem user|
|OPENQA_APT_UPGRADE|Can be a space separated list of packages or `all` to do a dist-upgrade|
|OPENQA_INSTALLATION_OFFLINE|Modifier for INSTALLATION to switch networking offline before starting the install|
31
|OPENQA_INSTALLATION_NONENGLISH|Modifier for INSTALLATION to test install in Spanish|
32
|OPENQA_IN_CLOUD|Set by CI nodes. Used internally to optimize perform for builds on some cloud server (e.g. use apt mirrors for speed)|
33 34 35 36
|OPENQA_IN_CLOUD|Set by CI nodes. Used internally to optimize perform for builds on some cloud server (e.g. use apt mirrors for speed)|
|OPENQA_SNAP_NAME|For snap testing this sets the application snap name. This is also the name that will be passed to `snap run`|
|OPENQA_SNAP_CHANNEL|For snap testing this sets the store channel snaps are pulled from|
|OPENQA_SNAP_RUNTIME_CHANNEL|For snap testing this sets the store channel the snap runtime (kde-frameworks-5) is pulled from. If this is not set OPENQA_SNAP_CHANNEL will be used. If that isn't set either, the stable channel is used instead|
37
|OPENQA_PARTITIONING|Can only be used in combination with INSTALLATION=1. Selects advanced partitioning tests during installation. This does not create a fully functional installation when done but instead serves only to test all partitioning features in the installer.|
38 39 40 41 42 43 44 45 46 47 48

# Test Suites

Suites are more or less hardcoded variants of a suite comprised of multiple
tests. Suites are generally mutually exclusive.

|Variable|Description|
|--------|-----------|
|INSTALLATION|Test group. Conduct an installation test. Requires a TYPE to decide which ISO to install|
|PLASMA_DESKTOP|Test group. Core Plasma behavior|
|TESTS_TO_RUN|Colon separated list of test files to run (e.g. `tests/install_ubiquity.pm:tests/plasma_folder.pm`). Only used unless a test group is set.|
49
|OPENQA_SNAP_NAME|Basename of a snap-only test. This test needs to be in the `tests/snap/` directory. This can be a specific testfile, e.g. `okular.pm`, if none exists `generic.pm` will be used instead. This variable is also a test variable (see above)|