History

Ghanshyam Mann ad8737c7f2 Add APIMicroversionFixture to library interface APIMicroversionFixture is used to set the microversion on service clients which will take care of reseting the microversion. This interface has been added to set the microversion on all supported service clients which use microverison. User can set multiple service microversion all together. Using the new interface in compute tests to make sure it is all working in serial and parallel testing. Change-Id: I6ed41b02041d38c2c92c58b0d3dd6613d03da3f7		2019-04-16 02:01:12 +00:00
..
api	Add APIMicroversionFixture to library interface	2019-04-16 02:01:12 +00:00
cmd	Improve router deletion logging in tempest cleanup	2019-04-02 12:51:44 +00:00
common	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	Add APIMicroversionFixture to library interface	2019-04-16 02:01:12 +00:00
scenario	Merge "allow create_server with vnic_type and port_profile from kwargs"	2019-03-16 06:30:03 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
tests	Add APIMicroversionFixture to library interface	2019-04-16 02:01:12 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Init placement client in tempest Manager object	2019-04-01 09:35:42 -04:00
config.py	Merge "Add profiler support into Tempest"	2019-03-17 21:46:15 +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	Add profiler support into Tempest	2019-02-16 08:10:28 +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.