Glossary

Here you can find some common terms used throughout the tmt project.

General

test framework

A tool for writing and running the logic of individual test cases, providing primitives such as assertions and fixtures, for example pytest or beakerlib. The way the test framework results should be interpreted is defined by the framework key. See also the Is tmt a test framework? question for detailed explanation.

Machines

guest

The machine where the tests are being run.

runner

The machine that is running the tmt command.

Identifiers

fmf id

An identifier used to uniquely define test, plan or story. Consists of name, url, ref and path. See the fmf identifier documentation for detailed description of individual keys.

Directories

import tree

The fmf tree cloned into the run workdir under the import folder from where the remote plan is imported, e.g. /var/tmp/tmt/run-123/import/plan. See Import Tree for details.

plan workdir

Directory used for storing temporary files related to particular plan, e.g. /var/tmp/tmt/run-123/plans/core.

run workdir

Working directory created for each run used for storing various temporary files needed during the test discovery and execution, e.g. /var/tmp/tmt/run-123/.

test tree

Directory tests containing test code prepared by the discover step, e.g. /var/tmp/tmt/run-123/plans/core/discover/default-0/tests. See Test Tree for details.

user tree

The fmf tree from which the tmt command was executed, e.g. /home/user/git/project. See User Tree for details.

work tree

Copy of the user tree stored under plan-workdir/tree. Path to this directory is available in the TMT_TREE environment variable, e.g. /var/tmp/tmt/run-123/plans/core/tree. See Work Tree for details.

Paths

anchor path

The directory against which relative paths are resolved, the fmf metadata root by default or the current working directory when no fmf tree is detected. See anchor path for details.

fmf path

The path key of the fmf id, pointing to the location of the fmf tree inside its git repository, for example /tests/feature/data. See fmf path for details.

test path

The path key of a test, defining the directory to enter before the test is executed, for example /common/scripts. See test path for details.