Tempest Snap

This repository contains the source code of the snap for the OpenStack integration test suite, Tempest.

Alongside with the tempest project, this snap also includes the currently maintained tempest plugins, the python-tempestconf package and several curated test lists to provide ease of use.

The python-tempestconf package provides discover-tempest-config command line application that automatically generates a tempest configuration appropriate for your cloud.

Installing this snap

The tempest snap can be installed directly from the snap store:

sudo snap install [install-OPTIONS] tempest

Compatibility matrix

With version numbers not being aligned between Tempest, the various Tempest plugins, and OpenStack releases, it is not immediately obvious which set of components are compatible with each other.

The Tempest snap simplifies testing OpenStack clouds by providing release-specific channels, which package all the correct Tempest and Tempest plugin versions for the relative OpenStack release.

The default channel for this snap is the stable channel for the latest current OpenStack release, e.g. 2023.1/stable if Antelope is the most recent release. To test older clouds, please specify an alternate channel. For example, in a Yoga OpenStack cloud, users can install the Tempest snap from the yoga/stable channel:

sudo snap install --channel yoga/stable tempest

Further details about the compatibility of the various components are available in the upstream documentation:

• OpenStack Antelope release notes - Tempest plugins
• Tempest release notes

Plugins

The snap provides all the most common plugins listed in the [OpenStack release notes] and those cannot be removed or updated. Currently, it is not possible to add new plugins or use your own.

If you need a plugin not listed here please open a feature request.

List of plugins:

• barbican-tempest-plugin
• cinder-tempest-plugin
• designate-tempest-plugin
• glance-tempest-plugin
• heat-tempest-plugin
• ironic-tempest-plugin
• keystone-tempest-plugin
• magnum-tempest-plugin
• manila-tempest-plugin
• neutron-tempest-plugin
• octavia-tempest-plugin
• telemetry-tempest-plugin

Quickstart

Running the tempest smoke suite against a deployed OpenStack cloud would look like this.

# Install the tempest snap from the latest/edge channel
sudo snap install tempest --edge

# Have the cloud credentials in the environment
source novarc

# Initialize a tempest workspace directory called cloud-01
tempest init cloud-01 && cd cloud-01

# Generate the tempest configuration specific to the cloud
discover-tempest-config

# Run the tempest smoke suite
tempest run --smoke

For more information please refer to the Tempest QuickStart and python-tempestconf documentation.

Test Lists

The tempest snap provides a set of pre-defined test lists with different profiles and a mechanism to specify them easily.

The @BUILTIN_TESTLISTS keyword will be automatically replaced by the full path of the directory storing the built-in test lists.

Note: the single-quotation marks around the test list file path is required if the @BUILTIN_TESTLISTS keyword is used (in other words, when running tempest with a built-in test list file). Failure to do so will result in a wrong path error.

readonly-quick

For quickly verifying the behavior of the target cloud and making sure tempest is correctly set up

tempest run --load-list '@BUILTIN_TESTLISTS/readonly-quick'

refstack-2022.11

Version 2022.11 of the RefStack guidelines. The list includes the required and advisory tests of all platforms.

tempest run --load-list '@BUILTIN_TESTLISTS/refstack-2022.11'