History

Jenkins ef3768bc71 Merge "Remove CONF usage from dynamic_creds module"		2016-10-18 06:04:23 +00:00
..
api	Merge "Remove one-line function in test_volumes_actions"	2016-10-18 02:35:18 +00:00
cmd	Merge "Remove CONF usage from dynamic_creds module"	2016-10-18 06:04:23 +00:00
common	Remove CONF usage from dynamic_creds module	2016-10-13 11:15:46 -04:00
hacking	Delete Savanna element in client list	2016-09-21 03:00:15 +00:00
lib	Move volume service clients under tempest.lib	2016-10-15 21:50:47 +03:00
scenario	Merge "Fallback to creds provider for fixed IP network if no network_for_ssh"	2016-10-13 00:21:44 +00:00
services	Move volume service clients under tempest.lib	2016-10-15 21:50:47 +03:00
stress	Add 'code-block' and revise tab	2016-09-30 23:35:31 +09:00
test_discover	Only call register_service_clients if there are clients	2016-10-05 11:27:13 -04:00
tests	Merge "Remove CONF usage from dynamic_creds module"	2016-10-18 06:04:23 +00:00
README.rst	Deprecate meaningless TYPE	2016-08-26 09:59:02 +08: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	Remove Sahara tests from Tempest	2016-10-05 13:06:14 +02:00
config.py	Revert an accidental error modification of config item help message	2016-10-14 11:11:01 +00:00
exceptions.py	Migrate backups clients to tempest.lib	2016-10-02 09:37:46 +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 the NegativeAutoTest Framework	2016-10-13 10:32:53 +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 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. 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.

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