History

guo yunxian 7bbbec1ed9 Replace six.iteritems with dict.items As [1] mentioned, we should use dict.items instead of six.iteritems. Let's use dict.items as it should return iterators in PY3 as well. (As for PY2, the performance about list should be negligible) [1] https://wiki.openstack.org/wiki/Python3 Change-Id: I77b3a71faa71b5f671daff3415e2ae58289fd3ca		2017-01-03 23:17:34 +00:00
..
api	Replace six.iteritems with dict.items	2017-01-03 23:17:34 +00:00
cmd	Separate capabilities service method from account_client	2016-12-13 16:55:28 +09:00
common	Replace six.iteritems with dict.items	2017-01-03 23:17:34 +00:00
hacking	Delete Savanna element in client list	2016-09-21 03:00:15 +00:00
lib	Making all identity service clients as tempest available	2016-12-22 16:17:42 +09:00
scenario	Replace six.iteritems with dict.items	2017-01-03 23:17:34 +00:00
services	Replace six.iteritems with dict.items	2017-01-03 23:17:34 +00:00
test_discover	Only call register_service_clients if there are clients	2016-10-05 11:27:13 -04:00
tests	Replace six.iteritems with dict.items	2017-01-03 23:17:34 +00:00
README.rst	Remove the Stress framework	2016-10-19 14:31:13 +02:00
__init__.py	…
clients.py	Making all identity service clients as tempest available	2016-12-22 16:17:42 +09:00
config.py	Merge "PCI-DSS tests"	2016-12-20 02:10:38 +00:00
exceptions.py	Delete TimeoutException in tempest/exceptions.py	2016-11-03 09:52:18 +08:00
manager.py	Merge "Revert "Move dscv and ca_certs to config section service_clients""	2016-08-20 22:48:10 +00:00
test.py	Merge "Removing baremetal tests from tempest tree"	2016-12-19 10:36:47 +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

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.