Skip to main content

Test Management Tool

Project description

Test Management Tool


The tmt python module and command line tool implement the L1 and L2 Metadata Specification which allows to store all needed test execution data directly within a git repository. In this way it makes tests independent on any external test management system.

The Flexible Metadata Format fmf is used to store data in both human and machine readable way close to the source code. Thanks to inheritance and elasticity metadata are organized in the structure efficiently, preventing unnecessary duplication.

Command line tool allows to easily create new tests, convert old metadata, list and filter available tests and verify them against the L1 specification. Plans are used to group tests and precisely define individual test steps defined by the L2 specification, like environment preparation. Stories are used to track implementation, test and documentation coverage for individual features.

Last but not least, the tool provides a user-friendly way how to run, debug and develop tests directly from your laptop across many different test environments. This is currently a proof-of-concept so many features are still on the way. Check stories to see which functionality has already been implemented.


Command line usage is straightforward:

tmt command [options]


Run all or selected steps for each plan:

tmt run
tmt run discover
tmt run prepare execute

List tests, show details, check against the specification:

tmt test ls
tmt test show
tmt test lint

Create a new test, convert old metadata:

tmt test create
tmt test convert

List plans, show details, check against the specification:

tmt plan ls
tmt plan show
tmt plan lint

List stories, check details, show coverage status:

tmt story ls
tmt story show
tmt story coverage

Many commands support regular expression filtering and other specific options:

tmt story ls cli
tmt story show create
tmt story coverage --implemented

Check help message of individual commands for the full list of available options.


Here is the list of the most frequently used commands and options.


The run command is used to execute test steps. By default all test steps are run. See the L2 Metadata specification for detailed description of individual steps. For now here is at least a brief overview:

gather and show information about test cases to be executed
provision an environment for testing (or use localhost)
configure environment for testing (e.g. ansible playbook)
run the tests (using the specified framework and its settings)
provide an overview of test results and send notifications
additional actions to be performed after the test execution

Note: This is only preview / draft of future functionality. Features described above are not implemented yet.


Manage tests (L1 metadata). Check available tests, inspect their metadata, gather old metadata from various sources and stored them in the new fmf format.

List available tests.
Show test details.
Check tests against the L1 metadata specification.
Create a new test based on given template.
Convert old test metadata into the new fmf format.


Manage test plans (L2 metadata). Search for available plans. Explore detailed test step configuration.

List available plans.
Show plan details.
Check plans against the L2 metadata specification.


Manage user stories. Check available user stories. Explore coverage (test, implementation, documentation).

List available stories.
Show story details.
Show code, test and docs coverage for given stories.
Export selected stories into desired format.


Various utility options.

--path PATH Path to the metadata tree (default: current directory)
--verbose Print additional information standard error output
--debug Turn on debugging output, do not catch exceptions

Check help message of individual commands for the full list of available options.


Currently tmt is supported for Fedora 31 and later, available directly in the distro repositories:

sudo dnf install tmt

For RHEL 8 and CentOS 8, first make sure that you have enabled the EPEL repository:

sudo dnf install epel-release
sudo dnf install tmt

Install the latest version from the copr repository:

sudo dnf copr enable psss/tmt
sudo dnf install tmt

When installing using pip you might need to install additional packages on your system:

sudo dnf install gcc python3-devel libvirt-devel
pip install --user tmt

You can omit the --user flag if in a virtual environment.


In order to experiment, play with the latest bits and develop improvements it is best to use a virtual environment:

mkvirtualenv tmt
git clone
cd tmt
pip install -e .

Install python3-virtualenvwrapper to easily create and enable virtual environments using mkvirtualenv and workon. Note that if you have freshly installed the package you need to open a new shell session to enable the wrapper functions.

The main tmt package contains only the core dependencies. For building documentation, testing changes, importing/exporting test cases or advanced provisioning options install the extra deps:

pip install '.[docs]'
pip install '.[tests]'
pip install '.[convert]'
pip install '.[provision]'

Or simply install all extra dependencies to make sure you have everything needed for the tmt development ready on your system:

pip install '.[all]'

Exit Codes

The following exit codes are returned from tmt run. Note that you can use the --quiet option to completely disable output and only check for the exit code.

At least one test passed, there was no fail, warn or error.
There was a fail or warn identified, but no error.
Errors occured during test execution.
No test results found.


Petr Šplíchal, Miro Hrončok, Alexander Sosedkin, Lukáš Zachar, Petr Menšík, Leoš Pol, Miroslav Vadkerti, Pavel Valena, Jakub Heger, Honza Horák, Rachel Sibley, František Nečas, Michal Ruprich, Martin Kyral, Miloš Prchlík and Tomáš Navrátil.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tmt, version 0.21.1
Filename, size File type Python version Upload date Hashes
Filename, size tmt-0.21.1-py3-none-any.whl (100.6 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page