openstack/tempest

History

Zuul fd708dc272 Merge "Add compute response schema for microversion 2.75"		2022-03-09 13:44:19 +00:00
..
api	Merge "Add compute response schema for microversion 2.75"	2022-03-09 13:44:19 +00:00
cmd	Merge "Use LOG.warning instead of deprecated LOG.warn"	2022-03-02 13:15:05 +00:00
common	Introduce PINGABLE and SSHABLE waiters and wait_until state support	2022-03-02 09:21:16 +00:00
hacking	Use LOG.warning instead of deprecated LOG.warn	2022-01-19 13:38:21 +09:00
lib	Merge "Add compute response schema for microversion 2.75"	2022-03-09 13:44:19 +00:00
scenario	Merge "Tests for nova unified quotas"	2022-03-05 03:46:56 +00:00
services	Remove usage of six	2021-02-18 10:43:57 +08:00
test_discover	Remove usage of unittest2	2022-01-24 17:49:25 -05:00
tests	Merge "Introduce PINGABLE and SSHABLE waiters and wait_until state support"	2022-03-03 21:32:55 +00:00
__init__.py
clients.py	Add support for ecdsa keys	2022-01-18 15:25:38 +00:00
config.py	Merge "Add configuration for compute unified limits feature"	2022-03-04 12:30:56 +00:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
test.py	Remove usage of unittest2	2022-01-24 17:49:25 -05: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.