tempest/tempest
Masayuki Igawa 8648bae065 Make imports proper order
We have a rule for imports order. That is:
 stdlib
 third-party lib
 project
 http://docs.openstack.org/developer/hacking/#imports
But some files are not correct. This patch fixes it.

Change-Id: I0031677e30dd70a07125d7a11bc93963db2b8ce3
2014-03-13 07:23:14 +09:00
..
api Make imports proper order 2014-03-13 07:23:14 +09:00
cli Skip nova cli tests with volumes if Cinder unavailable 2014-03-06 11:22:44 -05:00
common Merge "Fix problem of deleting dhcp port" 2014-03-12 19:17:39 +00:00
exceptions Fixed _error_checker in rest client 2014-03-07 09:52:20 +02:00
hacking Introduce T106 rule for vi modelines 2014-02-20 11:42:35 +09:00
openstack Sync Patch and PatchObject fixtures from oslo-incubator 2014-01-21 03:23:21 +00:00
scenario Increase testing of network connectivity 2014-03-09 15:35:49 +02:00
services Make imports proper order 2014-03-13 07:23:14 +09:00
stress replace basetring/xrange 2014-03-03 10:14:10 +08:00
test_discover Use unittest2.TestSuite with py26 2014-01-27 10:54:44 +01:00
tests Merge "Fixed _error_checker in rest client" 2014-03-11 08:46:02 +00:00
thirdparty replace basetring/xrange 2014-03-03 10:14:10 +08:00
README.rst Remove Whitebox tests 2013-09-12 15:40:15 +00: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
auth.py Prepare for enabling H302 rule (api/volume,tempest/*) 2014-03-04 18:37:19 +09:00
clients.py Merge "Adds basic Marconi test" 2014-03-12 05:26:02 +00:00
config.py Merge "Adds basic Marconi test" 2014-03-12 05:26:02 +00:00
manager.py Refactor Managers to a common base class 2014-02-23 09:36:08 +00:00
test.py Merge "Improve readability of test_networks" 2014-03-12 19:15:10 +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
   cli/ - CLI 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

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.

cli

CLI tests use the openstack CLI to interact with the OpenStack cloud. CLI testing in unit tests is somewhat difficult because unlike server testing, there is no access to server code to instantiate. Tempest seems like a logical place for this, as it prereqs having a running OpenStack cloud.

scenario

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 can and should use the OpenStack python clients.

stress

Stress tests are designed to stress an OpenStack environment by running a high workload against it and seeing what breaks. Tools may be provided to help detect breaks (stack traces in the logs).

TODO: old stress tests deleted, new_stress that david is working on moves into here.

thirdparty

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.