openstack/tempest

History

Jenkins e9bf2d8cbc Merge "Fix a spelling typo in tempest/thirdparty/boto/test.py"		2015-08-08 05:30:46 +00:00
..
api	Merge "increase failure information for ip_regex test"	2015-08-06 14:56:45 +00:00
api_schema	Fix list_migration response schema for None values	2015-07-17 09:48:05 +09:00
cmd	Merge "Stop gating on sample generation check"	2015-08-05 04:57:48 +00:00
common	Fixing tests when run_validation is set to true	2015-08-07 17:34:06 +03:00
hacking	Add a rule for blocking "-" from rand_name call	2015-06-18 00:41:22 +00:00
scenario	Merge "Revert "Fix scenario test fails when port_vnic_type is set""	2015-08-07 14:55:48 +00:00
services	Merge "Add identity v2 endpoint operations"	2015-08-05 11:33:16 +00:00
stress	Make security_group_rules_client use **kwargs	2015-08-04 05:59:04 +00:00
test_discover	Add plugin interface for extending sample config generation	2015-08-03 12:03:15 -04:00
tests	Merge "Add unit test for method show_limits"	2015-08-06 21:27:32 +00:00
thirdparty	Fix a spelling typo in tempest/thirdparty/boto/test.py	2015-08-07 21:42:51 +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	Added endpoint types for intialization of different IdentityClients	2015-08-05 14:09:38 +03:00
config.py	Added endpoint types for intialization of different IdentityClients	2015-08-05 14:09:38 +03:00
exceptions.py	Remove common/ssh.py due to migration to tempest_lib	2015-05-08 17:43:26 +00:00
manager.py	Drop auth and corresponding unit tests	2015-04-29 14:40:41 +01:00
README.rst	Remove CLI testing once and for all	2015-05-07 14:17:44 -04:00
test.py	Remove extra space in docstring	2015-07-19 22:40:28 +08: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
   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.

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