tempest/tempest
Zuul cd147631f8 Merge "Add system scope for admin auth" 2021-01-21 05:18:24 +00:00
..
api Fix memory explosion in multi-store image tests 2021-01-14 12:15:45 -08:00
cmd Merge "Remove six.PY3/six.PY2" 2020-11-27 01:52:40 +00:00
common Add system scope for admin auth 2021-01-11 19:11:45 +00:00
hacking Update hacking for Python3 2020-04-04 10:33:23 +02:00
lib Merge "Add system scope for admin auth" 2021-01-21 05:18:24 +00:00
scenario Merge "Pass custom args to create_port through create_server" 2021-01-13 02:59:42 +00:00
services Move the object client to tempest.lib 2017-10-17 00:14:20 +00:00
test_discover Use os.path.join as possible 2020-09-06 09:49:40 +00:00
tests Merge "Add system scope for admin auth" 2021-01-21 05:18:24 +00:00
README.rst Transfer respository to repository 2018-12-09 19:59:12 +08:00
__init__.py
clients.py Add placement API methods for testing routed provider nets 2020-09-28 06:45:37 +00:00
config.py Add system scope for admin auth 2021-01-11 19:11:45 +00:00
exceptions.py Break wait_for_volume_resource_status when error_extending 2019-06-03 15:37:13 +08:00
manager.py Need to have stable tempest scenario manager 2020-09-03 15:49:53 +05:30
test.py Add workaround to handle the testtool skip exception in CLI test 2019-10-12 01:40:29 +00:00
version.py Add reno to tempest 2016-02-24 11:31:32 -05:00

README.rst

Tempest Field Guide Overview

Tempest is designed to be useful for a large number of different environments. This includes being useful for gating commits to OpenStack core projects, being used to validate OpenStack cloud implementations for both correctness, as well as a burn in tool for OpenStack clouds.

As such Tempest tests come in many flavors, each with their own rules and guidelines. Below is the overview of the Tempest repository structure to make this clear.

tempest/
   api/ - API tests
   scenario/ - complex scenario tests
   tests/ - unit tests for Tempest internals

Each of these directories contains different types of tests. What belongs in each directory, the rules and examples for good tests, are documented in a README.rst file in the directory.

api_field_guide

API tests are validation tests for the OpenStack API. They should not use the existing Python clients for OpenStack, but should instead use the Tempest implementations of clients. Having raw clients let us pass invalid JSON to the APIs and see the results, something we could not get with the native clients.

When it makes sense, API testing should be moved closer to the projects themselves, possibly as functional tests in their unit test frameworks.

scenario_field_guide

Scenario tests are complex "through path" tests for OpenStack functionality. They are typically a series of steps where complicated state requiring multiple services is set up exercised, and torn down.

Scenario tests should not use the existing Python clients for OpenStack, but should instead use the Tempest implementations of clients.

unit_tests_field_guide

Unit tests are the self checks for Tempest. They provide functional verification and regression checking for the internal components of Tempest. They should be used to just verify that the individual pieces of Tempest are working as expected.