openstack
/
tempest
Code Issues Proposed changes
tempest/tempest
History
Ken'ichi Ohmichi 0e83665d98 Remove all CONF values from RestClient 
To moving RestClient to tempest-lib, this patch moves all CONF values
from RestClient to service clients. This patch adds TempestRestClient
which passes common CONF values for Tempest own values.

Change-Id: I3434061fd19de741e36b13bd3c458cf49fdfe783
 		2015-01-13 00:38:01 +00:00
..
api Merge "Change v2 identity client methods to return one value" 2015-01-12 17:10:54 +00:00
api_schema Delete unused schema definition console_output 2015-01-02 09:27:56 +01:00
cli Added neutron cli test case for fwaas 2014-11-20 07:41:27 -08:00
cmd Merge "Change v2 identity client methods to return one value" 2015-01-12 17:10:54 +00:00
common Remove all CONF values from RestClient 2015-01-13 00:38:01 +00:00
hacking Fix doc for usage of python clients in scenario tests 2014-11-26 17:04:37 +09:00
openstack Sync latest log module from oslo-incubator 2014-11-20 03:44:00 +00:00
scenario Change image client methods to return one value 2015-01-06 17:22:24 -05:00
services Remove all CONF values from RestClient 2015-01-13 00:38:01 +00:00
stress Change v2 identity client methods to return one value 2015-01-06 09:10:47 -05:00
test_discover Use unittest2.TestSuite with py26 2014-01-27 10:54:44 +01:00
tests Merge "Change v2 identity client methods to return one value" 2015-01-12 17:10:54 +00:00
thirdparty EC2: do not assume order in dictionary 2014-12-22 19:02:29 +05:30
README.rst Fix doc for usage of python clients in scenario tests 2014-11-26 17:04:37 +09: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 Drop ComputeAdmin configs, credentials and manager 2014-12-30 09:49:18 +00:00
clients.py Separate NegativeRestClient from rest_client 2015-01-05 23:28:32 +00:00
config.py Add image client build timeout config option 2015-01-07 14:34:38 +02:00
exceptions.py Raise a new exception NotImplemented for HTTP501 2014-12-11 11:42:58 +00:00
manager.py Drop client_type for auth module 2014-10-01 11:38:45 +01:00
test.py Merge "Remove Nova v3 API config" 2014-12-30 21:28:23 +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_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.

cli_field_guide

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