History

Matthew Treinish 9e26ca8760 Migrate tempest-lib code into new lib dir This commit migrates all of the code from tempest-lib as of it's current HEAD, 6ad0ce42c2791a28125d38b40e7dcddf32dbeed7. The only changes made to the tempest-lib code is to update the imports and other references to tempest_lib. Since in it's new home it should be tempest.lib. Partially implements bp tempest-lib-reintegration Change-Id: Iadc1b61953a86fa9de34e285a0bb083b1ba06fa8		2016-02-23 14:15:04 -05:00
..
api	Merge "Remove MapR 4.0.1 tempest test"	2016-02-23 12:38:19 +00:00
api_schema	Remove zaqar tests from tempest	2016-02-18 20:39:44 -05:00
cmd	Merge "Fix cleanup command"	2016-02-23 12:38:09 +00:00
common	Merge "Remove some dead code"	2016-02-23 12:36:30 +00:00
hacking	Migrate tempest-lib code into new lib dir	2016-02-23 14:15:04 -05:00
lib	Migrate tempest-lib code into new lib dir	2016-02-23 14:15:04 -05:00
scenario	Merge "Remove some dead code"	2016-02-23 12:36:30 +00:00
services	Merge "Remove zaqar tests from tempest"	2016-02-20 05:45:01 +00:00
stress	Split users_client from keystone V3 client	2016-02-12 17:31:09 +00:00
test_discover	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05:00
tests	Migrate tempest-lib code into new lib dir	2016-02-23 14:15:04 -05: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	Remove zaqar tests from tempest	2016-02-18 20:39:44 -05:00
config.py	Merge "Remove zaqar tests from tempest"	2016-02-20 05:45:01 +00:00
exceptions.py	Add new exception InvalidAPIVersionRange for microversion	2016-02-02 10:53:33 +09:00
manager.py	Remove some dead code	2016-02-16 14:01:57 +00:00
test.py	Merge "add client_manager_class param to BaseTestCase"	2016-02-19 12:06:49 +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
   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.