Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

OpenStack Integration Test Suite Guide

Red Hat OpenStack Platform 11

Introduction to the OpenStack Integration Test Suite

OpenStack Documentation Team


This guide provides instructions to install, configure and manage the OpenStack Integration Test Suite in a Red Hat OpenStack Platform environment.


This guide provides instructions to install, configure and manage the OpenStack Integration Test Suite in a Red Hat OpenStack Platform environment.

Chapter 1. Introduction

As OpenStack consists of many different projects, it is important to test their interoperability within your OpenStack cluster. The OpenStack Integration Test Suite (tempest) automates the integration testing of your Red Hat OpenStack Platform deployment. Running tests ensures your cluster is working as expected, and can also provide early warning of potential problems, especially after an upgrade.

The Integration Test Suite contains tests for OpenStack API validation and scenario testing, as well as unit testing for self-validation. It performs black box testing using the OpenStack public APIs, with ostestr as the test runner.

Chapter 2. OpenStack Integration Test Suite Tests

The OpenStack Integration Test Suite has many applications. It acts as a gate for commits to the OpenStack core projects, it can stress test to generate load on a cloud deployment, and it can perform CLI tests to check the response formatting of the command line. However, the functionality that we are concerned with are the scenario tests and API tests. These tests are run against your OpenStack cloud deployment. The following sections briefly describe each of these tests and how you can implement them.

2.1. Scenario Tests

Scenario tests simulate a typical end user action workflow to test the integration points between services. The testing framework conducts the set up, tests the integration between services, and then it is torn down. You should tag the tests with which services they relate to, to make it clear which client libraries the test uses.

A scenario is based on a use case, for example:

  • Upload an image to the Image Service
  • Deploy an instance from the image
  • Attach a volume to the instance
  • Create a snapshot of the instance
  • Detach the volume from the instance

2.2. API Tests

API tests validate the OpenStack API. Tests use the OpenStack Integration Test Suite implementation of the Openstack API. Both valid and invalid JSON can be used to make sure error responses are valid. Tests can be run independently, and do not rely on the state left by the previous test.

Chapter 3. Installing the OpenStack Integration Test Suite

This section describes how to install the OpenStack Integration Test Suite either with the director or with a manual installation.

3.1. Using the Director

Edit the undercloud.conf file, located in the stack user’s home directory. By default, enable_tempest is set to false. Change this to true.

enable_tempest = true

You are now ready to install the tempest packages and plug-ins, described in Section 3.3, “Installing the OpenStack Integration Test Suite Packages”.

3.2. Preparing a Manual Installation

To run the OpenStack Integration Test Suite, you need to first install the necessary packages and create a configuration file that will tell the Integration Test Suite where to find the various OpenStack services and other testing behaviour switches.

On the controller node, as a root user, create a virtual machine called tempest. This machine must run Red Hat Enterprise Linux 7.3 or greater. It also needs to be able to reach the cloud, but it does not have to be part of the cloud. For more information, see Creating Guests with Virt-Manager.

Also, before installing the OpenStack Integration Test Suite, the following networks are required within your Red Hat OpenStack Platform environment:

  • An external network which can provide floating IP
  • A private network

These networks must be connected through a router.

Create the private network:

$ openstack network create <network_name> --share
$ openstack subnet create <subnet_name> --subnet-range <address/prefix>
$ openstack router create <router_name>
$ openstack router add subnet <router_name> <subnet_name>

Create the public network:

$ openstack network create <network_name> --external \
  --provider-network-type flat
$ openstack subnet create <subnet_name> --subnet-range <address/prefix> \
  --gateway <default_gateway> --no-dhcp --network <network_name>
$ openstack router set <router_name> --external_gateway <public_network_name>

You are now ready to install and configure the OpenStack Integration Test Suite within the tempest virtual machine. For more information, see Section 3.3, “Installing the OpenStack Integration Test Suite Packages”.

3.3. Installing the OpenStack Integration Test Suite Packages

  1. Install the packages related to the OpenStack Integration Test Suite:

    # yum -y install openstack-tempest

    However, this command will not install any tempest plug-ins. These have to be installed manually, depending on your OpenStack installation.

  2. View all the OpenStack components installed on your machine:

    # openstack-status
  3. Install the appropriate tempest plug-in for each component you have, for example:

    # yum install python-glance-tests python-keystone-tests python-horizon-tests-tempest python-neutron-tests python-cinder-tests python-nova-tests python-swift-tests python-ceilometer-tests python-gnocchi-tests python-aodh-tests

    See Section 3.3.1, “List of Tempest Plug-in Packages” for a list of the tempest plug-ins for each OpenStack component.

3.3.1. List of Tempest Plug-in Packages

ComponentPackage Name



















































Chapter 4. Configuring the OpenStack Integration Test Suite

4.1. Creating a Workspace

  1. Source the admin credentials:

    In the undercloud:

    # source stackrc

    Or in the overcloud:

    # source overcloudrc
  2. Initialize tempest:

    # tempest init mytempest
    # cd mytempest

    This creates a tempest workspace named mytempest.

    You can view a list of existing workspaces:

    # tempest workspace list
  3. Generate the etc/tempest.conf file:

    # discover-tempest-config --deployer-input ~/tempest-deployer-input.conf \
    --debug --create identity.uri $OS_AUTH_URL identity.admin_password \
    $OS_PASSWORD --network-id <UUID>

    uuid is the UUID of the external network.

    discover-tempest-config was formerly called and takes the same parameters. It is provided by python-tempestconf which is installed as a dependency of openstack-tempest.

4.2. Verifying Your Tempest Configuration

Verify your current tempest configuration:

# tempest verify-config -o <output>

output is the output file where your updated configuration is written. This is different from your original configuration file.

4.3. Changing the Logging Configuration

The default location for log files is the logs directory within your tempest workspace.

To change this directory, in tempest.conf, under the [DEFAULT] section, set log_dir to the desired directory:

log_dir = <directory>

If you have your own logging configuration file, in tempest.conf, under the [DEFAULT] section, set log_config_append to your file:

log_config_append = <file>

If this is set, all other logging configuration in tempest.conf will be ignored, including log_dir.

4.4. Configuring Microversion Tests

The OpenStack Integration Test Suite provides stable interfaces to test the API microversions. This section describes how to implement microversion tests using these interfaces.

You first need to configure options in the tempest.conf configuration file to specify the target microversions. This is to make sure that the supported microversions match the microversions used in the OpenStack cloud. You can run multiple microversion tests in a single Integration Test Suite operation by specifying a range of target microversions.

For example, to limit the range of microversions for the compute service, in the [compute] section of your configuration file, assign values to the min_microversion and max_microversion parameters:

min_microversion = 2.14
max_microversion = latest

Chapter 5. Using ostestr to Run Tempest

Ostestr is an OpenStack wrapper for the testr test runner.

5.1. Running Smoke Tests

Smoke testing is a type of preliminary testing which only covers the most important functionality. While they are not comprehensive, running smoke tests can save time if they do identify a problem.

To run the smoke tests:

# ostestr '.*smoke'

5.2. Passing Tests Using Whitelist Files

A whitelist file is a file which contains regular expressions to select tests to include. Regular expressions are separated by a newline.

To use a whitelist file:

# ostestr --whitelist-file <whitelist_file>


# ostestr -w <whitelist_file>

5.3. Skipping Tests Using Blacklist Files

A blacklist file is a file which contains regular expressions to select tests to exclude. Regular expressions are separated by a newline.

To use a blacklist file:

# ostestr --blacklist-file <blacklist_file>


# ostestr -b <blacklist_file>

5.4. Running Tests in Parallel Concurrently, or Serially

Run the tests serially:

# ostestr --serial

Run the tests in parallel (this is the default):

# ostestr --parallel

Specify the number of workers to use when running tests in parallel:

# ostestr --concurrency <workers>


# ostestr -c <workers>

By default, this is set to the number of CPUs.

Chapter 6. Cleaning Tempest Resources

After running tempest, there will be files, users and tenants created in the testing process that need to be deleted. Being able to self clean is one of the design principles of tempest.

6.1. Performing a Clean Up

First you must initialize the saved state. This creates the file saved_state.json, which prevents the cleanup from deleting objects that need to be kept. Typically you would run cleanup with --init-saved-state prior to a tempest run. If this is not the case, saved_state.json must be edited to remove objects you want cleanup to delete.

# tempest cleanup --init-saved-state

Run the cleanup:

# tempest cleanup

6.2. Performing a Dry Run

A dry run lists the files that would be deleted by a cleanup, but does not delete any files. The files are listed in the dry_run.json file.

# tempest cleanup --dry-run

6.3. Deleting Tempest Objects

Delete users and tenants created by tempest:

# tempest cleanup --delete-tempest-conf-objects

Legal Notice

Copyright © 2017 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.