History

Zuul a227e3a12e Merge "Make _get_router() non-private"		2021-03-09 00:46:29 +00:00
..
api	Merge "[part1] Remove six"	2021-02-25 17:09:59 +00:00
cmd	Merge "Update subunit_describe_calls about new ports"	2021-03-04 21:27:11 +00:00
common	Merge "Remove usage of six"	2021-02-19 20:02:01 +00:00
hacking	Update hacking for Python3	2020-04-04 10:33:23 +02:00
lib	Support scope in dynamic cred for specific roles	2021-03-06 17:14:22 +00:00
scenario	Merge "Make _get_router() non-private"	2021-03-09 00:46:29 +00:00
services	Remove usage of six	2021-02-18 10:43:57 +08:00
test_discover	Remove usage of six	2021-02-23 00:38:55 +00:00
tests	Support scope in dynamic cred for specific roles	2021-03-06 17:14:22 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Remove deprecated config options for volume API selection	2020-12-31 17:53:53 +00:00
config.py	Merge "Remove deprecated config options for volume API selection"	2021-02-23 22:42:23 +00:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
test.py	Support scope in dynamic cred for specific roles	2021-03-06 17:14:22 +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.