History

Jenkins 1238eabef7 Merge "Revert "Move dscv and ca_certs to config section service_clients""		2016-08-20 22:48:10 +00:00
..
api	remove unnecessary call in test_delete_container	2016-08-19 21:50:45 +00:00
api_schema	Move keypair client to lib interfaces	2016-04-07 00:42:26 +00:00
cmd	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
common	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
hacking	Remove trove tests from tempest	2016-06-27 10:22:11 -04:00
lib	Merge "Define volume quotas_client as library"	2016-08-18 04:56:22 +00:00
scenario	Merge "Fix test_shelve_volume_backed_instance"	2016-08-19 03:47:28 +00:00
services	Make args of types_client same	2016-08-19 19:51:29 +00:00
stress	Merge "Correct reraising of exception"	2016-07-15 10:37:50 +00:00
test_discover	Migrate service_clients to tempest.lib	2016-08-05 16:23:26 +01:00
tests	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
README.rst	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05:00
__init__.py	Changes the namespace from storm to tempest, as well as adding addition tests and improvements	2011-12-06 16:48:03 -06:00
clients.py	Configure stable service clients via the registry	2016-08-07 10:17:58 +01:00
config.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
exceptions.py	Merge "Add server_id in exception ServerUnreachable"	2016-07-28 01:31:36 +00: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	Remove unused service tags and client	2016-06-28 15:09:31 +09: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 proposed Havana restructuring for Tempest to make this clear.

tempest/
   api/ - API tests
   scenario/ - complex scenario tests
   stress/ - stress tests

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. This allows us to test both XML and JSON. Having raw clients also lets us pass invalid JSON and XML 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.

`stress_field_guide`

Stress tests are designed to stress an OpenStack environment by running a high workload against it and seeing what breaks. The stress test framework runs several test jobs in parallel and can run any existing test in Tempest as a stress job.

`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.