History

zhufl f824fcf0d7 addCleanup should be immediately after the creating statement. It's not safe to add addCleanup for a bundle of resources after creating them all, instead, addCleanup should be immediately after every resource creation. Change-Id: Icca816298d1d7e8e4d064a1adc7006c5f160f95d		2018-11-14 15:44:18 +08:00
..
api	addCleanup should be immediately after the creating statement.	2018-11-14 15:44:18 +08:00
cmd	Merge "Handling invalid name of workspace register and rename."	2018-10-11 14:38:28 +00:00
common	Deprecate available filters in favor of enabled	2018-11-02 08:09:33 -04:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	Add api ref link for import_backup	2018-11-08 16:12:53 +08:00
scenario	Mark network slow test as slow	2018-11-02 08:00:21 +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	[Trivial Fix] modify spelling error of "resource"	2018-11-01 09:44:14 +08:00
README.rst	Fix indentation in README.rst	2018-05-24 08:46:09 +02:00
__init__.py	…
clients.py	Remove deprecated option volume_feature_enabled.api_v1	2018-08-13 12:46:09 +00:00
config.py	Deprecate available filters in favor of enabled	2018-11-02 08:09:33 -04: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	Fix code to pass pep8 Tox environment.	2018-04-12 11:09:37 +02: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.