History

John Warren b10c6caa1a Fix V3 credential behavior, documentation Fixing V3 credential behavior so that contradicting parameter combinations do not result in unpredictable behavior. Updating accounts.yaml.sample file to reference the correct location of the credentials classes and to describe the updated behavior of Identity V3 attributes. Change-Id: I29efe778afcb1e4a55dffd6a8ed8212d62a4dd15		2016-03-10 18:10:27 -05:00
..
api	Merge "Allow heat volume tests to use configured volume size"	2016-03-10 03:36:24 +00:00
api_schema	Remove zaqar tests from tempest	2016-02-18 20:39:44 -05:00
cmd	Split out Neutron routers client	2016-03-08 17:25:50 -08:00
common	Merge "Get NIC name by "ip -o link""	2016-03-10 12:02:35 +00:00
hacking	Split out Neutron routers client	2016-03-08 17:25:50 -08:00
lib	Fix V3 credential behavior, documentation	2016-03-10 18:10:27 -05:00
scenario	Merge "Get NIC name by "ip -o link""	2016-03-10 12:02:35 +00:00
services	Use tempest.lib's base module for network clients	2016-03-09 09:15:42 -08:00
stress	Merge "Split roles_client for keystone v3 client"	2016-03-01 16:22:59 +00:00
test_discover	Use tempest.lib code in tempest	2016-02-24 10:43:59 -05:00
tests	Fix V3 credential behavior, documentation	2016-03-10 18:10:27 -05:00
README.rst	Remove the ec2 api tests from tempest	2015-12-17 17:59:20 -05: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	Split out Neutron routers client	2016-03-08 17:25:50 -08:00
config.py	Switch hdp to cdh in the default list of Sahara plugins	2016-03-08 16:44:30 +01:00
exceptions.py	Add new exception InvalidAPIVersionRange for microversion	2016-02-02 10:53:33 +09:00
manager.py	Use tempest.lib code in tempest	2016-02-24 10:43:59 -05:00
test.py	Merge "Fix ambiguous method name"	2016-03-03 11:29:54 +00:00
version.py	Add reno to tempest	2016-02-24 11:31:32 -05: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

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.

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