openstack
/
tempest
Code Issues Proposed changes
tempest/tempest
History
Matthew Treinish 0948724aea Fix last unit tests on py34 
This commit fixes the last remaining issues in the tempest unit tests.
There were several failures for a couple of different issues previously
but after this running the tempest unit tests will pass on python 3.4.

Change-Id: Icf9090df83f8266a4683c88995c547e3c1bff523
 		2015-05-12 18:58:00 +00:00
..
api Merge "Define validation_resources function for ssh validation" 2015-05-11 09:49:12 +00:00
api_schema Merge "Merge server response schema into one file" 2015-04-27 10:04:10 +00:00
cmd Fix last unit tests on py34 2015-05-12 18:58:00 +00:00
common Merge "Fix tenant isolation and unit tests with py3" 2015-05-12 17:59:10 +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 Switch all uses of iteritems to use six instead 2015-05-10 12:46:22 -04:00
services Switch all uses of iteritems to use six instead 2015-05-10 12:46:22 -04:00
stress Switch all uses of iteritems to use six instead 2015-05-10 12:46:22 -04:00
test_discover Remove CLI testing once and for all 2015-05-07 14:17:44 -04:00
tests Fix last unit tests on py34 2015-05-12 18:58:00 +00:00
thirdparty Fix raise syntax in test.py for python3 compat 2015-05-12 18:57:35 +00:00
README.rst Remove CLI testing once and for all 2015-05-07 14:17:44 -04: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 Drop auth and corresponding unit tests 2015-04-29 14:40:41 +01:00
config.py Merge "Test live migrate on a paused instance" 2015-05-08 20:00:27 +00: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
test.py Fix raise syntax in test.py for python3 compat 2015-05-12 18:57:35 +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.