Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 5. Using ostestr to Run Tempest

Ostestr is an OpenStack wrapper for the testr test runner.

  1. You can view a list of the available tests: 

    $ ostestr -l
    Copy to Clipboard Toggle word wrap
    Note

    Before running tests, you can use tempest cleanup --init-saved-state to capture the current state. This will make cleanup easier. For more information see Chapter 6, Cleaning Tempest Resources.

  2. You can run specific tests using ostestr.

    • To run just one test, use: 

      ostestr --regex '(test_regex)'
      Copy to Clipboard Toggle word wrap

    • To run multiple tests: 

      ostestr --regex '(test1|test2|test3)'
      Copy to Clipboard Toggle word wrap

5.1. Running Smoke Tests
Copy link

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 --regex '(.*smoke)'
Copy to Clipboard Toggle word wrap

5.2. Running Specific Tests Using Whitelist Files
Copy link

A whitelist file contains specific tests to include.

  1. Create a whitelist.txt file in your tempest workspace: 

    $ touch whitelist.txt
    Copy to Clipboard Toggle word wrap

  2. Append all the tests you want to run to the whitelist.txt file: 

    $ cat whitelist.txt
keystone_tempest_plugin.*
networking_bgpvpn_tempest.tests*
    Copy to Clipboard Toggle word wrap

  3. Run those tests using ostestr: 

    $ ostestr -w <path to whitelist tests file>
    Copy to Clipboard Toggle word wrap

5.3. Skipping Tests Using Blacklist Files
Copy link

A blacklist file contains a list of tests to exclude.

  1. Create a skip_test.txt file in your tempest workspace: 

    $ touch skip_test.txt
    Copy to Clipboard Toggle word wrap

  2. Append all the tests to skip to the skip_test.txt file. 

    $ cat skip_test.txt
keystone_tempest_plugin.*
networking_bgpvpn_tempest.tests*
    Copy to Clipboard Toggle word wrap

  3. Run tests using ostestr: 

    $ ostestr -b <path to skip test file>
    Copy to Clipboard Toggle word wrap

  4. You can run specific tests by skipping the listed tests: 

    ostestr --regex '(tempest.api.object_storage) -b <path to skip test file>
    Copy to Clipboard Toggle word wrap

  • Run the tests in series: 

    $ ostestr --serial
    Copy to Clipboard Toggle word wrap

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

    $ ostestr --parallel
    Copy to Clipboard Toggle word wrap

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

    $ ostestr --concurrency _<workers>_
    Copy to Clipboard Toggle word wrap

    Alternatively: 

    $ ostestr -c _<workers>_
    Copy to Clipboard Toggle word wrap

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

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat