openstack/tempest

History

Jenkins 09df11b150 Merge "Make wait_until default as 'ACTIVE' in manager.create_server"		2017-02-10 14:38:26 +00:00
..
api	Merge "Use correct routers_client in _delete_router"	2017-02-10 14:24:25 +00:00
cmd	Replaces yaml.load() with yaml.safe_load()	2017-01-16 17:03:17 +07:00
common	Log server state changes when waiting for delete	2017-02-03 11:33:11 -05:00
hacking	Delete Savanna element in client list	2016-09-21 03:00:15 +00:00
lib	Merge "Fix AZ List Detail schema to allow hosts as None"	2017-02-09 12:27:23 +00:00
scenario	Make wait_until default as 'ACTIVE' in manager.create_server	2017-02-10 14:53:20 +08:00
services	Merge "Port object_storage tests to Py3."	2017-01-19 23:39:54 +00:00
test_discover	Use oslo.log library instead of system logging module	2017-01-16 05:56:54 +00:00
tests	Merge "Implied roles methods"	2017-02-08 11:33:18 +00:00
__init__.py
clients.py	Remove default_params_with_timeout_values variable	2017-01-27 02:42:47 +00:00
config.py	Merge "Use oslo.log library instead of system logging module"	2017-01-16 18:22:03 +00:00
exceptions.py	Get server fault if snapshot fails	2017-02-07 17:06:02 -05:00
manager.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
README.rst	Remove the Stress framework	2016-10-19 14:31:13 +02:00
test.py	Remove an unused variable in the BaseTestCase class	2017-01-04 19:17:35 +01: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

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. Having raw clients let us pass invalid JSON 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.

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