Avocado’s Configuration Reference

This is current Avocado Configuration reference. You can adjust the values by two ways:

  • Configuration file options;
  • Command-line options (when available)
Some options that are used often are available for your convenience also at the command-line.
This list has all options registered with Avocado so far.

Note

Please, keep in mind that we are in constant evolution and doing a huge improvements on how to configure Avocado, some options here can be changed in the near future.

assets.fetch.ignore_errors

always return success for the fetch command.

  • Default: False
  • Type: <class ‘bool’>

assets.fetch.references

Path to avocado instrumented test

  • Default: []
  • Type: <class ‘list’>

assets.list.days

How old (in days) should Avocado look for assets?

  • Default: None
  • Type: <class ‘int’>

assets.list.overall_limit

Filter will be based on a overall system limit threshold in bytes (with assets orded by last access) or with a suffix unit. Valid suffixes are: b,k,m,g,t

  • Default: None
  • Type: <class ‘str’>

assets.list.size_filter

Apply action based on a size filter (comparison operator + value) in bytes. Ex ‘>20’, ‘<=200’. Supported operators: ==, <, >, <=, >=

  • Default: None
  • Type: <class ‘str’>

assets.purge.days

How old (in days) should Avocado look for assets?

  • Default: None
  • Type: <class ‘int’>

assets.purge.overall_limit

Filter will be based on a overall system limit threshold in bytes (with assets orded by last access) or with a suffix unit. Valid suffixes are: b,k,m,g,t

  • Default: None
  • Type: <class ‘str’>

assets.purge.size_filter

Apply action based on a size filter (comparison operator + value) in bytes. Ex ‘>20’, ‘<=200’. Supported operators: ==, <, >, <=, >=

  • Default: None
  • Type: <class ‘str’>

assets.register.name

Unique name to associate with this asset.

  • Default: None
  • Type: <class ‘str’>

assets.register.sha1_hash

SHA1 hash of this asset.

  • Default: None
  • Type: <class ‘str’>

assets.register.url

Path to asset that you would like to register manually.

  • Default: None
  • Type: <class ‘str’>

config.datadir

Shows the data directories currently being used by Avocado

  • Default: False
  • Type: <class ‘bool’>

core.input_encoding

The encoding used by default on all data input

  • Default: utf-8
  • Type: <class ‘str’>

core.paginator

Turn the paginator on. Useful when output is too long.

  • Default: False
  • Type: <class ‘bool’>

core.show

List of comma separated builtin logs, or logging streams optionally followed by LEVEL (DEBUG,INFO,…). Builtin streams are: “app”: application output; “test”: test output; “debug”: tracebacks and other debugging info; “early”: early logging of other streams, including test (very verbose); “all”: all builtin streams; “none”: disables regular output (leaving only errors enabled). By default: ‘app’

  • Default: {‘app’}
  • Type: <function register_core_options.<locals>.<lambda> at 0x7f08aaf8c5f0>

core.verbose

Some commands can produce more information. This option will enable the verbosity when applicable.

  • Default: False
  • Type: <class ‘bool’>

datadir.paths.base_dir

Base directory for Avocado tests and auxiliary data

  • Default: /var/lib/avocado
  • Type: <function prepend_base_path at 0x7f08a73815f0>

datadir.paths.cache_dirs

Cache directories to be used by the avocado test

  • Default: [‘/home/docs/avocado/data/cache’]
  • Type: <class ‘list’>

datadir.paths.data_dir

Data directory for Avocado

  • Default: /var/lib/avocado/data
  • Type: <function prepend_base_path at 0x7f08a73815f0>

datadir.paths.logs_dir

Logs directory for Avocado

  • Default: /home/docs/avocado/job-results
  • Type: <function prepend_base_path at 0x7f08a73815f0>

datadir.paths.test_dir

Test directory for Avocado tests

  • Default: /usr/share/doc/avocado/tests
  • Type: <function prepend_base_path at 0x7f08a73815f0>

diff.create_reports

Create temporary files with job reports to be used by other diff tools

  • Default: False
  • Type: <class ‘bool’>

diff.filter

Comma separated filter of diff sections: (no)cmdline,(no)time,(no)variants,(no)results, (no)config,(no)sysinfo (defaults to all enabled).

  • Default: [‘cmdline’, ‘time’, ‘variants’, ‘results’, ‘config’, ‘sysinfo’]
  • Type: <function Diff._validate_filters at 0x7f08a3ce0b90>

diff.html

Enable HTML output to the FILE where the result should be written.

  • Default: None
  • Type: <class ‘str’>

diff.jobids

A job reference, identified by a (partial) unique ID (SHA1) or test results directory.

  • Default: []
  • Type: <class ‘list’>

diff.open_browser

Generate and open a HTML report in your preferred browser. If no –html file is provided, create a temporary file.

  • Default: False
  • Type: <class ‘bool’>

diff.strip_id

Strip the “id” from “id-name;variant” when comparing test results.

  • Default: False
  • Type: <class ‘bool’>

distro.distro_def_arch

Primary architecture that the distro targets

  • Default:
  • Type: <class ‘str’>

distro.distro_def_create

Cretes a distro definition file based on the path given.

  • Default: False
  • Type: <class ‘bool’>

distro.distro_def_name

Distribution short name

  • Default:
  • Type: <class ‘str’>

distro.distro_def_path

Top level directory of the distro installation files

  • Default:
  • Type: <class ‘str’>

distro.distro_def_release

Distribution release version number

  • Default:
  • Type: <class ‘str’>

distro.distro_def_type

Distro type (one of: rpm, deb)

  • Default:
  • Type: <class ‘str’>

distro.distro_def_version

Distribution major version name

  • Default:
  • Type: <class ‘str’>

filter.by_tags.include_empty

Include all tests without tags during filtering. This effectively means they will be kept in the test suite found previously to filtering.

  • Default: False
  • Type: <class ‘bool’>

filter.by_tags.include_empty_key

Include all tests that do not have a matching key in its key:val tags. This effectively means those tests will be kept in the test suite found previously to filtering.

  • Default: False
  • Type: <class ‘bool’>

filter.by_tags.tags

Filter tests based on tags

  • Default: []
  • Type: <class ‘list’>

job.output.loglevel

Sets the base log level of the output generated by the job, which is also the base loging level for the –show command line option. Any of the Python logging levels names are allowed here. Examples: DEBUG, INFO, WARNING, ERROR, CRITICAL. For more information refer to: https://docs.python.org/3/library/logging.html#levels

  • Default: DEBUG
  • Type: <class ‘str’>

job.output.testlogs.logfiles

The specific log files that will be shown for tests whose exit status match the ones defined in the “job.output.testlogs.statuses” configuration.

  • Default: [‘debug.log’]
  • Type: <class ‘list’>

job.output.testlogs.statuses

Status that will trigger the output of a test’s logs after the job ends. Valid statuses: SKIP, ERROR, FAIL, WARN, PASS, INTERRUPTED, CANCEL

  • Default: []
  • Type: <class ‘list’>

job.replay.source_job_id

Replays a job, identified by: complete or partial Job ID, “latest” for the latest job, the job results path.

  • Default: latest
  • Type: <class ‘str’>

job.run.result.html.enabled

Enables default HTML result in the job results directory. File will be named “results.html”.

  • Default: True
  • Type: <class ‘bool’>

job.run.result.html.open_browser

Open the generated report on your preferred browser. This works even if –html was not explicitly passed, since an HTML report is always generated on the job results dir.

  • Default: False
  • Type: <class ‘bool’>

job.run.result.html.output

Enable HTML output to the FILE where the result should be written. The value - (output to stdout) is not supported since not all HTML resources can be embedded into a single file (page resources will be copied to the output file dir)

  • Default: None
  • Type: <class ‘str’>

job.run.result.json.enabled

Enables default JSON result in the job results directory. File will be named “results.json”.

  • Default: True
  • Type: <class ‘bool’>

job.run.result.json.output

Enable JSON result format and write it to FILE. Use “-” to redirect to the standard output.

  • Default: None
  • Type: <class ‘str’>

job.run.result.tap.enabled

Enables default TAP result in the job results directory. File will be named “results.tap”

  • Default: True
  • Type: <class ‘bool’>

job.run.result.tap.include_logs

Include test logs as comments in TAP output.

  • Default: False
  • Type: <class ‘bool’>

job.run.result.tap.output

Enable TAP result output and write it to FILE. Use “-” to redirect to standard output.

  • Default: None
  • Type: <class ‘str’>

job.run.result.xunit.enabled

Enables default xUnit result in the job results directory. File will be named “results.xml”.

  • Default: True
  • Type: <class ‘bool’>

job.run.result.xunit.job_name

Override the reported job name. By default uses the Avocado job name which is always unique. This is useful for reporting in Jenkins as it only evaluates first-failure from jobs of the same name.

  • Default: None
  • Type: <class ‘str’>

job.run.result.xunit.max_test_log_chars

Limit the attached job log to given number of characters (k/m/g suffix allowed)

  • Default: 100000
  • Type: <function XUnitInit.initialize.<locals>.<lambda> at 0x7f08a5bd0320>

job.run.result.xunit.output

Enable xUnit result format and write it to FILE. Use “-” to redirect to the standard output.

  • Default: None
  • Type: <class ‘str’>

job.run.store_logging_stream

Store given logging STREAMs in “$JOB_RESULTS_DIR/$STREAM.$LEVEL.”

  • Default: []
  • Type: <class ‘list’>

job.run.timeout

Set the maximum amount of time (in SECONDS) that tests are allowed to execute. Values <= zero means “no timeout”. You can also use suffixes, like: s (seconds), m (minutes), h (hours).

  • Default: 0
  • Type: <function time_to_seconds at 0x7f08a5f52950>

jobs.get.output_files.destination

Destination path

  • Default: None
  • Type: <class ‘str’>

jobs.get.output_files.job_id

JOB id

  • Default: None
  • Type: <class ‘str’>

jobs.show.job_id

JOB id

  • Default: latest
  • Type: <class ‘str’>

json.variants.load

Load the Variants from a JSON serialized file

  • Default: None
  • Type: <class ‘str’>

list.external_runner

Path to an specific test runner that allows the use of its own tests. This should be used for running tests that do not conform to Avocado’s SIMPLE test interface and can not run standalone. Note: the use of –external-runner overwrites the –loaders to ‘external_runner’

  • Default: None
  • Type: <class ‘str’>

list.external_runner_chdir

Change directory before executing tests. This option may be necessary because of requirements and/or limitations of the external test runner. If the external runner requires to be run from its own base directory, use ‘runner’ here. If the external runner runs tests based on files and requires to be run from the directory where those files are located, use ‘test’ here and specify the test directory with the option ‘–external-runner-testdir’.

  • Default: None
  • Type: <class ‘str’>

list.external_runner_testdir

Where test files understood by the external test runner are located in the filesystem. Obviously this assumes and only applies to external test runners that run tests from files

  • Default: None
  • Type: <class ‘str’>

list.loaders

Overrides the priority of the test loaders. You can specify either @loader_name or TEST_TYPE. By default it tries all available loaders according to priority set in settings->plugins.loaders.

  • Default: [‘file’, @DEFAULT’]
  • Type: <class ‘list’>

list.recipes.write_to_directory

Writes runnable recipe files to a directory. Valid only when using –resolver.

  • Default: None
  • Type: <class ‘str’>

list.references

List of test references (aliases or paths). If empty, Avocado will list tests on the configured test source, (see “avocado config –datadir”) Also, if there are other test loader plugins active, tests from those plugins might also show up (behavior may vary among plugins)

  • Default: []
  • Type: <class ‘list’>

list.resolver

What is the method used to detect tests? If –resolver used, Avocado will use the Next Runner Resolver method. If not the legacy one will be used.

  • Default: False
  • Type: <class ‘bool’>

list.write_to_json_file

Writes output to a json file.

  • Default: None
  • Type: <class ‘str’>

nrunner.max_parallel_tasks

Number of maximum number tasks running in parallel. You can disable parallel execution by setting this to 1. Defaults to the amount of CPUs on this machine.

  • Default: 2
  • Type: <class ‘int’>

nrunner.shuffle

Shuffle the tasks to be executed

  • Default: False
  • Type: <class ‘bool’>

nrunner.spawner

Spawn tasks in a specific spawner. Available spawners: ‘process’ and ‘podman’

  • Default: process
  • Type: <class ‘str’>

nrunner.status_server_buffer_size

Buffer size that status server uses. This should generally not be a concern to most users, but it can be tunned in case a runner generates very large status messages, which is common if a test generates a lot of output. Default is 33554432 (32MiB)

  • Default: 33554432
  • Type: <class ‘int’>

nrunner.status_server_listen

URI for listing the status server. Usually a “HOST:PORT” string

  • Default: 127.0.0.1:8888
  • Type: <class ‘str’>

nrunner.status_server_uri

URI for connecting to the status server, usually a “HOST:PORT” string. Use this if your status server is in another host, or different port

  • Default: 127.0.0.1:8888
  • Type: <class ‘str’>

plugins.cli.cmd.order

Execution order for “plugins.cli.cmd” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.cli.order

Execution order for “plugins.cli” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.disable

Plugins that will not be loaded and executed

  • Default: []
  • Type: <class ‘list’>

plugins.init.order

Execution order for “plugins.init” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.job.prepost.order

Execution order for “plugins.job.prepost” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.jobscripts.post

Directory with scripts to be executed after a job is run

  • Default: /etc/avocado/scripts/job/post.d/
  • Type: <function prepend_base_path at 0x7f08a73815f0>

plugins.jobscripts.pre

Directory with scripts to be executed before a job is run

  • Default: /etc/avocado/scripts/job/pre.d/
  • Type: <function prepend_base_path at 0x7f08a73815f0>

plugins.jobscripts.warn_non_existing_dir

Warn if configured (or default) directory does not exist

  • Default: False
  • Type: <class ‘bool’>

plugins.jobscripts.warn_non_zero_status

Warn if any script run return non-zero status

  • Default: True
  • Type: <class ‘bool’>

plugins.resolver.order

Execution order for “plugins.resolver” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.result.order

Execution order for “plugins.result” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.result_events.order

Execution order for “plugins.result_events” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.result_upload.cmd

Specify the command to upload results

  • Default: None
  • Type: <class ‘str’>

plugins.result_upload.url

Specify the result upload url

  • Default: None
  • Type: <class ‘str’>

plugins.resultsdb.api_url

Specify the resultsdb API url

  • Default: None
  • Type: <class ‘str’>

plugins.resultsdb.logs_url

Specify the URL where the logs are published

  • Default: None
  • Type: <class ‘str’>

plugins.resultsdb.note_size_limit

Maximum note size limit

  • Default: 0
  • Type: <class ‘int’>

plugins.runnable.runner.order

Execution order for “plugins.runnable.runner” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.runner.order

Execution order for “plugins.runner” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.skip_broken_plugin_notification

Suppress notification about broken plugins in the app standard error. Add the name of each broken plugin you want to suppress the notification in the list. (e.g. “avocado_result_html”)

  • Default: []
  • Type: <class ‘list’>

plugins.spawner.order

Execution order for “plugins.spawner” plugins

  • Default: []
  • Type: <class ‘list’>

plugins.varianter.order

Execution order for “plugins.varianter” plugins

  • Default: []
  • Type: <class ‘list’>

run.cit.combination_order

Order of combinations. Maximum number is 6

  • Default: 2
  • Type: <class ‘int’>

run.cit.parameter_file

Paths to a parameter file

  • Default: None
  • Type: <class ‘str’>

run.dict_variants

Load the Variants from Python dictionaries

  • Default: []
  • Type: <class ‘list’>

run.dry_run.enabled

Instead of running the test only list them and log their params.

  • Default: False
  • Type: <class ‘bool’>

run.dry_run.no_cleanup

Do not automatically clean up temporary directories used by dry-run

  • Default: False
  • Type: <class ‘bool’>

run.execution_order

Defines the order of iterating through test suite and test variants

  • Default: variants-per-test
  • Type: <class ‘str’>

run.external_runner

Path to an specific test runner that allows the use of its own tests. This should be used for running tests that do not conform to Avocado’s SIMPLE test interface and can not run standalone. Note: the use of –external-runner overwrites the –loaders to ‘external_runner’

  • Default: None
  • Type: <class ‘str’>

run.external_runner_chdir

Change directory before executing tests. This option may be necessary because of requirements and/or limitations of the external test runner. If the external runner requires to be run from its own base directory, use ‘runner’ here. If the external runner runs tests based on files and requires to be run from the directory where those files are located, use ‘test’ here and specify the test directory with the option ‘–external-runner-testdir’.

  • Default: None
  • Type: <class ‘str’>

run.external_runner_testdir

Where test files understood by the external test runner are located in the filesystem. Obviously this assumes and only applies to external test runners that run tests from files

  • Default: None
  • Type: <class ‘str’>

run.failfast

Enable the job interruption on first failed test.

  • Default: False
  • Type: <class ‘bool’>

run.ignore_missing_references

Force the job execution, even if some of the test references are not resolved to tests. “on” and “off” will be deprecated soon.

  • Default: False
  • Type: <class ‘bool’>

run.job_category

Categorizes this within a directory with the same name, by creating a link to the job result directory

  • Default: None
  • Type: <class ‘str’>

run.journal.enabled

Records test status changes (for use with avocado-journal-replay and avocado-server)

  • Default: False
  • Type: <class ‘bool’>

run.keep_tmp

Keep job temporary files (useful for avocado debugging).

  • Default: False
  • Type: <class ‘bool’>

run.loaders

Overrides the priority of the test loaders. You can specify either @loader_name or TEST_TYPE. By default it tries all available loaders according to priority set in settings->plugins.loaders.

  • Default: [‘file’, @DEFAULT’]
  • Type: <class ‘list’>

run.log_test_data_directories

Logs the possible data directories for each test. This is helpful when writing new tests and not being sure where to put data files. Look for “Test data directories” in your test log

  • Default: False
  • Type: <class ‘bool’>

run.output_check

Disables test output (stdout/stderr) check. If this option is given, no output will be checked, even if there are reference files present for the test.

  • Default: True
  • Type: <class ‘bool’>

run.output_check_record

Record the output produced by each test (from stdout and stderr) into both the current executing result and into reference files. Reference files are used on subsequent runs to determine if the test produced the expected output or not, and the current executing result is used to check against a previously recorded reference file. Valid values: “none” (to explicitly disable all recording) “stdout” (to record standard output only), “stderr” (to record standard error only), “both” (to record standard output and error in separate files), “combined” (for standard output and error in a single file). “all” is also a valid but deprecated option that is a synonym of “both”.

  • Default: None
  • Type: <class ‘str’>

run.pict_binary

Where to find the binary version of the pict tool. Tip: download it from “https://github.com/Microsoft/pict” and run make to build it

  • Default: None
  • Type: <class ‘str’>

run.pict_combinations_order

Order of combinations. Maximum number is specific to parameter file content

  • Default: 2
  • Type: <class ‘int’>

run.pict_parameter_file

Paths to a pict parameter file

  • Default: None
  • Type: <class ‘str’>

run.pict_parameter_path

Default path for parameters generated on the Pict based variants

  • Default: /run
  • Type: <class ‘str’>

run.references

List of test references (aliases or paths)

  • Default: []
  • Type: <class ‘list’>

run.replay.ignore

Ignore variants and/or configuration from the source job.

  • Default: []
  • Type: <function Replay._valid_ignore at 0x7f08a4276d40>

run.replay.job_id

Replay a job identified by its (partial) hash id. Use “–replay” latest to replay the latest job.

  • Default: None
  • Type: <class ‘str’>

run.replay.resume

Resume an interrupted job

  • Default: False
  • Type: <class ‘bool’>

run.replay.test_status

Filter tests to replay by test status.

  • Default: []
  • Type: <function Replay._valid_status at 0x7f08a4276cb0>

run.results.archive

Archive (ZIP) files generated by tests

  • Default: False
  • Type: <class ‘bool’>

run.results_dir

Forces to use of an alternate job results directory.

  • Default: None
  • Type: <class ‘str’>

run.test_parameters

Parameter name and value to pass to all tests. This is only applicable when not using a varianter plugin. This option format must be given in the NAME=VALUE format, and may be given any number of times, or per parameter.

  • Default: []
  • Type: <function Run._test_parameter at 0x7f08a5c0cf80>

run.test_runner

Selects the runner implementation from one of the installed and active implementations. You can run “avocado plugins” and find the list of valid runners under the “Plugins that run test suites on a job (runners) section. Defaults to “runner”, which is the conventional and traditional runner.

  • Default: runner
  • Type: <class ‘str’>

run.unique_job_id

Forces the use of a particular job ID. Used internally when interacting with an avocado server. You should not use this option unless you know exactly what you’re doing

  • Default: None
  • Type: <class ‘str’>

run.wrapper.wrappers

Use a script to wrap executables run by a test. The wrapper is either a path to a script (AKA a global wrapper) or a path to a script followed by colon symbol (:), plus a shell like glob to the target EXECUTABLE. Multiple wrapper options are allowed, but only one global wrapper can be defined.

  • Default: []
  • Type: <class ‘list’>

runner.exectest.exitcodes.skip

Use a custom exit code list to consider a test as skipped. This is only used by exec-test runners. Default is [].

  • Default: []
  • Type: <class ‘list’>

runner.output.color

Whether to force colored output to non-tty outputs (e.g. log files). Allowed values: auto, always, never

  • Default: auto
  • Type: <class ‘str’>

runner.output.colored

Whether to display colored output in terminals that support it

  • Default: True
  • Type: <class ‘bool’>

runner.output.utf8

Use UTF8 encoding (True or False)

  • Default: True
  • Type: <class ‘bool’>

runner.timeout.after_interrupted

The amount of time to give to the test process after it it has been interrupted (such as with CTRL+C)

  • Default: 60
  • Type: <class ‘int’>

runner.timeout.process_alive

The amount of time to wait after a test has reported status but the test process has not finished

  • Default: 60
  • Type: <class ‘int’>

runner.timeout.process_died

The amount of to wait for a test status after the process has been noticed to be dead

  • Default: 10
  • Type: <class ‘int’>

simpletests.status.failure_fields

Fields to include in the presentation of SIMPLE test failures. Accepted values: status, stdout, stderr.

  • Default: [‘status’, ‘stdout’, ‘stderr’]
  • Type: <class ‘list’>

simpletests.status.skip_location

Location to search the regular expression on. Accepted values: all, stdout, stderr.

  • Default: all
  • Type: <class ‘str’>

simpletests.status.skip_regex

Python regular expression that will make the test status SKIP when matched.

  • Default: ^SKIP$
  • Type: <class ‘str’>

simpletests.status.warn_location

Location to search the regular expression on. Accepted values: all, stdout, stderr.

  • Default: all
  • Type: <class ‘str’>

simpletests.status.warn_regex

Python regular expression that will make the test status WARN when matched.

  • Default: ^WARN$
  • Type: <class ‘str’>

spawner.podman.bin

Path to the podman binary

  • Default: /usr/bin/podman
  • Type: <class ‘str’>

spawner.podman.image

Image name to use when creating the container

  • Default: fedora:31
  • Type: <class ‘str’>

sysinfo.collect.commands_timeout

Overall timeout to collect commands, when <=0no timeout is enforced

  • Default: -1
  • Type: <class ‘int’>

sysinfo.collect.enabled

Enable or disable sysinfo information. Like hardware details, profiles, etc.

  • Default: True
  • Type: <class ‘bool’>

sysinfo.collect.installed_packages

Whether to take a list of installed packages previous to avocado jobs

  • Default: False
  • Type: <class ‘bool’>

sysinfo.collect.locale

Force LANG for sysinfo collection

  • Default: C
  • Type: <class ‘str’>

sysinfo.collect.optimize

Optimize sysinfo collected so that duplicates between pre and post re not stored in post

  • Default: False
  • Type: <class ‘bool’>

sysinfo.collect.per_test

Enable sysinfo collection per-test

  • Default: False
  • Type: <class ‘bool’>

sysinfo.collect.profiler

Whether to run certain commands in bg to give extra job debug information

  • Default: False
  • Type: <class ‘bool’>

sysinfo.collect.sysinfodir

Directory where Avocado will dump sysinfo data. If one is not given explicitly, it will default to a directory named “sysinfo-” followed by a timestamp in the current working directory.

  • Default: None
  • Type: <class ‘str’>

sysinfo.collectibles.commands

File with list of commands that will be executed and have their output collected

  • Default: /home/docs/checkouts/readthedocs.org/user_builds/avocado-framework/envs/88.1/lib/python3.7/site-packages/avocado_framework-88.1-py3.7.egg/avocado/etc/avocado/sysinfo/commands
  • Type: <function prepend_base_path at 0x7f08a73815f0>

sysinfo.collectibles.fail_commands

File with list of commands that will be executed and have their output collected, in case of failed test

  • Default: /home/docs/checkouts/readthedocs.org/user_builds/avocado-framework/envs/88.1/lib/python3.7/site-packages/avocado_framework-88.1-py3.7.egg/avocado/etc/avocado/sysinfo/fail_commands
  • Type: <function prepend_base_path at 0x7f08a73815f0>

sysinfo.collectibles.fail_files

File with list of files that will be collected verbatim, in case of failed test

  • Default: /home/docs/checkouts/readthedocs.org/user_builds/avocado-framework/envs/88.1/lib/python3.7/site-packages/avocado_framework-88.1-py3.7.egg/avocado/etc/avocado/sysinfo/fail_files
  • Type: <function prepend_base_path at 0x7f08a73815f0>

sysinfo.collectibles.files

File with list of files that will be collected verbatim

  • Default: /home/docs/checkouts/readthedocs.org/user_builds/avocado-framework/envs/88.1/lib/python3.7/site-packages/avocado_framework-88.1-py3.7.egg/avocado/etc/avocado/sysinfo/files
  • Type: <function prepend_base_path at 0x7f08a73815f0>

sysinfo.collectibles.profilers

File with list of commands that will run alongside the job/test

  • Default: /home/docs/checkouts/readthedocs.org/user_builds/avocado-framework/envs/88.1/lib/python3.7/site-packages/avocado_framework-88.1-py3.7.egg/avocado/etc/avocado/sysinfo/profilers
  • Type: <function prepend_base_path at 0x7f08a73815f0>

task.timeout.running

The amount of time a test has to complete in seconds.

  • Default: None
  • Type: <class ‘int’>

variants.cit.combination_order

Order of combinations. Maximum number is 6

  • Default: 2
  • Type: <class ‘int’>

variants.cit.parameter_file

Paths to a parameter file

  • Default: None
  • Type: <class ‘str’>

variants.contents

[obsoleted by –variants] Shows the node content (variables)

  • Default: False
  • Type: <class ‘bool’>

variants.debug

Use debug implementation to gather more information.

  • Default: False
  • Type: <class ‘bool’>

variants.inherit

[obsoleted by –summary] Show the inherited values

  • Default: False
  • Type: <class ‘bool’>

variants.json_variants_dump

Dump the Variants to a JSON serialized file

  • Default: None
  • Type: <class ‘str’>

variants.pict_binary

Where to find the binary version of the pict tool. Tip: download it from “https://github.com/Microsoft/pict” and run make to build it

  • Default: None
  • Type: <class ‘str’>

variants.pict_combinations_order

Order of combinations. Maximum number is specific to parameter file content

  • Default: 2
  • Type: <class ‘int’>

variants.pict_parameter_file

Paths to a pict parameter file

  • Default: None
  • Type: <class ‘str’>

variants.pict_parameter_path

Default path for parameters generated on the Pict based variants

  • Default: /run
  • Type: <class ‘str’>

variants.summary

Verbosity of the variants summary. (positive integer - 0, 1, … - or none, brief, normal, verbose, full, max)

  • Default: 0
  • Type: <function map_verbosity_level at 0x7f08a3cf4950>

variants.tree

[obsoleted by –summary] Shows the multiplex tree structure

  • Default: False
  • Type: <class ‘bool’>

variants.variants

Verbosity of the list of variants. (positive integer - 0, 1, … - or none, brief, normal, verbose, full, max)

  • Default: 1
  • Type: <function map_verbosity_level at 0x7f08a3cf4950>

vmimage.get.arch

Image architecture

  • Default: None
  • Type: <class ‘str’>

vmimage.get.distro

Name of image distribution

  • Default: None
  • Type: <class ‘str’>

vmimage.get.version

Image version

  • Default: None
  • Type: <class ‘str’>

yaml_to_mux.files

Location of one or more Avocado multiplex (.yaml) FILE(s) (order dependent)

  • Default: []
  • Type: <class ‘list’>

yaml_to_mux.filter_only

Filter only path(s) from multiplexing

  • Default: []
  • Type: <class ‘list’>

yaml_to_mux.filter_out

Filter out path(s) from multiplexing

  • Default: []
  • Type: <class ‘str’>

yaml_to_mux.inject

Inject [path:]key:node values into the final multiplex tree.

  • Default: []
  • Type: <class ‘list’>

yaml_to_mux.parameter_paths

List of default paths used to determine path priority when querying for parameters

  • Default: [‘/run/*’]
  • Type: <class ‘list’>