History

Jenkins 26149b612d Merge "Remove unused methods"		2015-04-29 09:35:47 +00:00
..
api	Merge "Remove unused methods"	2015-04-29 09:35:47 +00:00
api_schema	Merge "Merge server response schema into one file"	2015-04-27 10:04:10 +00:00
cli	remove swift cli tests	2015-04-22 13:14:26 +00:00
cmd	Switch all uses of urlparse to import from six	2015-04-23 12:00:18 -04:00
common	Merge "Switch all uses of httplib to import from six"	2015-04-29 02:38:56 +00:00
hacking	Fix doc for usage of python clients in scenario tests	2014-11-26 17:04:37 +09:00
openstack	Update all Oslo module use	2015-03-11 21:07:56 +00:00
scenario	Initial class creds creation in test base class	2015-04-27 15:23:13 +01:00
services	Merge "Switch all uses of httplib to import from six"	2015-04-29 02:38:56 +00:00
stress	Apply a naming rule of GET to volume client	2015-04-07 05:24:00 +00:00
test_discover	Use unittest2.TestSuite with py26	2014-01-27 10:54:44 +01:00
tests	Merge "Switch all uses of httplib to import from six"	2015-04-29 02:38:56 +00:00
thirdparty	Merge "Initial class creds creation in test base class"	2015-04-29 02:06:41 +00:00
README.rst	Fix doc for usage of python clients in scenario tests	2014-11-26 17:04:37 +09: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
auth.py	Merge "Allow full v3 authentication"	2015-03-12 11:05:44 +00:00
clients.py	Remove remaining CONF references in service_client	2015-03-23 10:19:39 -04:00
config.py	Merge "Adding port_admin_state_change option to config"	2015-04-20 22:24:10 +00:00
exceptions.py	Merge "Remove auth_version config from get_credentials"	2015-02-13 00:11:24 +00:00
manager.py	Embed network resoruces and credentials in TestResources	2015-04-07 22:53:27 +01:00
test.py	Merge "Remove unused methods"	2015-04-29 09:35:47 +00: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
   cli/ - CLI tests
   scenario/ - complex scenario tests
   stress/ - stress tests
   thirdparty/ - 3rd party api 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.

`cli_field_guide`

CLI tests use the openstack CLI to interact with the OpenStack cloud. CLI testing in unit tests is somewhat difficult because unlike server testing, there is no access to server code to instantiate. Tempest seems like a logical place for this, as it prereqs having a running OpenStack cloud.

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

third_party_field_guide -----------------------------

Many openstack components include 3rdparty API support. It is completely legitimate for Tempest to include tests of 3rdparty APIs, but those should be kept separate from the normal OpenStack validation.

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