History

Zuul 982f31b9f2 Merge "Add image task client and image tests task APIs."		2023-08-06 14:50:18 +00:00
..
api	Merge "Add image task client and image tests task APIs."	2023-08-06 14:50:18 +00:00
cmd	Add project reader to account-generator	2023-03-30 09:55:49 +02:00
common	Merge "Add image task client and image tests task APIs."	2023-08-06 14:50:18 +00:00
hacking	Use LOG.warning instead of deprecated LOG.warn	2022-01-19 13:38:21 +09:00
lib	Merge "Add image task client and image tests task APIs."	2023-08-06 14:50:18 +00:00
scenario	Skip test early to improve memory footprint and time	2023-08-04 11:20:00 -07:00
serial_tests	Introduce @serial test execution decorator	2023-01-18 02:45:43 +00:00
test_discover	Introduce @serial test execution decorator	2023-01-18 02:45:43 +00:00
tests	Add image task client and image tests task APIs.	2023-08-03 21:34:59 +03:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Add image task client and image tests task APIs.	2023-08-03 21:34:59 +03:00
config.py	Add skip for cinder extend volume with snapshot	2023-05-10 12:06:43 +10:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
test.py	Fail create if validation flags do not agree	2023-05-02 13:09:23 -07: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.