History

Martin Kopec a47c8afc0e Get rid of jsonschema.compat usage jsonschema.compat module is not a public interface anymore and it got removed in version > 3.2.0 The compat module was a helper for py2/3 compatibility [1]. As Tempest is full py3 now, we can rework the whole if-condition and let the timeutils to handle any wrong format. [1] https://github.com/Julian/jsonschema/blob/v3.2.0/jsonschema/compat.py Closes-Bug: #1946321 Change-Id: Ia78c19c06cfb712b1b8d0aff457fd2f91144dc07		2021-10-07 19:01:21 +00:00
..
api	Mark unstable test_create_object_with_transfer_encoding	2021-10-04 12:27:51 +00:00
cmd	Merge "Update subunit_describe_calls about new ports"	2021-03-04 21:27:11 +00:00
common	compute: Rework attach_volume waiters and cleanup	2021-08-06 08:16:02 +00:00
hacking	Fix hacking check for service client	2021-04-30 10:32:13 -05:00
lib	Get rid of jsonschema.compat usage	2021-10-07 19:01:21 +00:00
scenario	Merge "Revert "Skip test_qos_min_bw_allocation_basic when not supported""	2021-09-18 09:14:56 +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	Fix test_fix_argument_yes	2021-09-14 05:13:02 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Merge "Add loggable resource client"	2021-08-24 10:29:23 +00:00
config.py	Always enable project tags Identity tests	2021-08-11 13:13:28 +02:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08:00
test.py	Remove usage of six	2021-04-15 09:25:19 +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.