History

Zuul 6f0015ba9d Merge "Remove resource_cleanup from test_object_version"		2017-12-18 21:07:16 +00:00
..
api	Merge "Remove resource_cleanup from test_object_version"	2017-12-18 21:07:16 +00:00
cmd	Fix docs markup consistency	2017-11-21 19:02:54 +09:00
common	Remove confusing comment in common/compute.py	2017-12-08 15:39:36 +09:00
hacking	Unsupported 'message' Exception attribute in PY3	2017-07-31 07:30:28 +00:00
lib	Merge "Add update groups types API endpoint to volumes v3 library"	2017-12-14 03:24:07 +00:00
scenario	Merge "Fix docs markup consistency"	2017-11-30 23:30:00 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Fix doc issue in plugin.py	2017-11-05 21:41:33 +11:00
tests	Merge "Add update groups types API endpoint to volumes v3 library"	2017-12-14 03:24:07 +00:00
README.rst	Fix directory tree appearance in document	2017-11-14 16:29:35 +09:00
__init__.py	…
clients.py	Merge "Don't read config in Manager class definition"	2017-10-19 07:17:58 +00:00
config.py	Add CONF.compute_feature_enabled.volume_backed_live_migration	2017-12-15 16:53:56 +00:00
exceptions.py	Remove unused RFCViolation	2017-09-11 14:20:20 +08:00
manager.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
test.py	Move identity_utils to common.identity	2017-09-14 13:00:31 -06: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 respository 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.