tempest/tempest
Jenkins 600d40a305 Merge "Skip test that rely on creds by role" 2015-11-20 10:36:43 +00:00
..
api Merge "Fix H404/405 violations for api tests(3/3)" 2015-11-20 00:19:44 +00:00
api_schema Rename get_server_group to show_server_group 2015-11-16 06:01:49 +00:00
cmd Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
common Skip test that rely on creds by role 2015-11-20 06:40:54 +00:00
hacking Remove server_groups_client from ignore_list 2015-11-17 07:55:50 +00:00
scenario Merge "Modify baremetal_basic_ops test" 2015-11-20 08:05:50 +00:00
services Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
stress Fix H404/405 violations for thirdparty and stress 2015-11-19 09:42:05 +00:00
test_discover Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
tests Fix H404/405 violations for unit tests 2015-11-19 08:45:06 +00:00
thirdparty Fix H404/405 violations for thirdparty and stress 2015-11-19 09:42:05 +00:00
README.rst Cleanup tempest docs a bit 2015-09-02 11:06:44 -04:00
__init__.py
clients.py Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
config.py Merge "Use choices kwarg when defining string options with defined choices" 2015-11-13 15:31:41 +00:00
exceptions.py Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
manager.py Fix H404/405 violations for remaining 2015-11-19 11:22:29 +00:00
test.py Fix H404/405 violations for remaining 2015-11-19 11:22:29 +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
   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.