History

Matthew Treinish b19c55df4b Migrate the preprov creds module to tempest lib This commit migrates the preprovisioned credentials provider from tempest/common into tempest/lib. As part of this 2 dependencies are also migrated to lib: the InvalidTestResource exception class and the tempest.common.fixed_network module. Change-Id: Ib9e909aaaf81f7cb57e2382cec44598e918747b8		2017-07-21 16:14:41 -04:00
..
api	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
cmd	Migrate the dynamic creds module to tempest lib	2017-07-21 16:14:40 -04:00
common	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
hacking	Add T115 for admin test path	2017-05-23 14:00:27 -07:00
lib	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
scenario	Merge "Generic method for creating a volume snapshot"	2017-07-19 09:37:11 +00:00
services	Update the documention for doc migration	2017-07-19 03:42:23 +00:00
test_discover	Add docstring example for get_opt_lists	2017-04-24 10:07:39 +00:00
tests	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04:00
README.rst	Remove the Stress framework	2016-10-19 14:31:13 +02:00
__init__.py	…
clients.py	Merge "Cleanup the orchestration client init and attr"	2017-07-18 15:53:28 +00:00
config.py	Merge "Pause resource cleanup"	2017-07-05 07:40:05 +00:00
exceptions.py	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04: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	Migrate the preprov creds module to tempest lib	2017-07-21 16:14:41 -04: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.