openstack/tempest

History

Ken'ichi Ohmichi c240bccc91 Change rest client exceptions' inheritances RateLimitExceeded, ServerFault and OverLimit raise at rest_client layer and they should inherit from RestClientException for representing what happens clearly. This patch changes them. Change-Id: I0b74bd44a88cc68bdaeab6bd605722d47f5a28a9		2014-12-11 03:09:53 +00:00
..
api	Merge "Check that the number of fixed_ips is at least one"	2014-12-10 19:45:19 +00:00
api_schema	Expand service validation to work for Nova cells	2014-11-25 14:47:52 -05:00
cli	Added neutron cli test case for fwaas	2014-11-20 07:41:27 -08:00
cmd	Ensure extension aliases are used for nova based services	2014-12-08 20:49:07 -05:00
common	Move safe_body() into specific class	2014-12-10 23:39:50 +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	Skip test_update_router_admin_state for baremetal	2014-12-09 14:13:28 -08:00
services	Add more verbose info for wait_for_..._status methods	2014-12-08 09:49:54 +01:00
stress	Remove Resp status code checks in stress tests	2014-10-03 09:38:36 +09:00
test_discover	Use unittest2.TestSuite with py26	2014-01-27 10:54:44 +01:00
tests	Ensure extension aliases are used for nova based services	2014-12-08 20:49:07 -05:00
thirdparty	Use standard assertVolumeStatusWait for volume detachment	2014-11-20 20:46:15 +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
auth.py	remove xml_utils and all things that depend on it	2014-11-25 10:55:40 -05:00
clients.py	add cinder v2 api tests for volume_services	2014-12-02 14:02:19 +08:00
config.py	Add ca_certificates_file option to test against SSL servers	2014-12-03 02:11:48 -05:00
exceptions.py	Change rest client exceptions' inheritances	2014-12-11 03:09:53 +00:00
manager.py	Drop client_type for auth module	2014-10-01 11:38:45 +01:00
README.rst	Fix doc for usage of python clients in scenario tests	2014-11-26 17:04:37 +09:00
test.py	Merge "Framework for staged setup"	2014-12-11 01:52:04 +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.