openstack/tempest

History

Jenkins 43f7d563d3 Merge "Py3: `reduce` is not a built-in anymore, use six.moves instead"		2016-05-10 14:31:00 +00:00
..
api	Merge "Correct mispell words in comments"	2016-05-09 10:35:17 +00:00
api_schema	Move keypair client to lib interfaces	2016-04-07 00:42:26 +00:00
cmd	Merge "Add option to tempest init to show global conf dir"	2016-05-06 21:00:45 +00:00
common	Merge "Py3: `reduce` is not a built-in anymore, use six.moves instead"	2016-05-10 14:31:00 +00:00
hacking	Remove few refercences left to tempest-lib	2016-04-29 20:30:34 +00:00
lib	Merge "Py3: fix an error when adding two `dict_items`"	2016-05-10 14:28:56 +00:00
scenario	Correct mispell words in comments	2016-05-09 10:52:01 +08:00
services	Merge "Migrate network resources into scenario path"	2016-05-03 12:44:35 +00:00
stress	Merge "Removed deprecation warning from 'tempest --help'"	2016-03-30 00:37:30 +00:00
test_discover	Use tempest.lib code in tempest	2016-02-24 10:43:59 -05:00
tests	Merge "Add generic CONF skip decorators"	2016-05-07 02:48:10 +00:00
__init__.py
clients.py	Merge "Move keypair client to lib interfaces"	2016-04-11 05:53:18 +00:00
config.py	Merge "Fix the docstring of skip_unless_config()"	2016-05-09 17:10:37 +00:00
exceptions.py	Remove few refercences left to tempest-lib	2016-04-29 20:30:34 +00:00
manager.py	Use tempest.lib code in tempest	2016-02-24 10:43:59 -05:00
README.rst	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05:00
test.py	Add pep8 check to use data_utils.rand_uuid()	2016-04-19 14:23:00 -07: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.