openstack/tempest

History

Zuul 9d1c625746 Merge "Fix use of get_server_ip with fixed networks"		2019-09-03 20:47:41 +00:00
..
api	Merge "Fix use of get_server_ip with fixed networks"	2019-09-03 20:47:41 +00:00
cmd	Merge "Remove python shebangs from python modules"	2019-08-13 22:08:35 +00:00
common	mke2fs: do not use full path	2019-08-26 12:31:19 +03:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	Add the api reference for roles_client in v3	2019-08-28 11:15:26 +08:00
scenario	Merge "Fix invalid original_name key in flavor check"	2019-08-15 08:40:52 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Add autopep8 to tox.ini	2019-03-08 16:04:05 +01:00
tests	Merge "mke2fs: do not use full path"	2019-08-29 20:37:07 +00:00
__init__.py
clients.py	Add segments client	2019-07-25 10:56:06 +02:00
config.py	Merge "mke2fs: do not use full path"	2019-08-29 20:37:07 +00:00
exceptions.py	Break wait_for_volume_resource_status when error_extending	2019-06-03 15:37:13 +08: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	Transfer respository to repository	2018-12-09 19:59:12 +08:00
test.py	Add profiler support into Tempest	2019-02-16 08:10:28 +00:00
version.py

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 overview of the Tempest repository structure to make this clear.

tempest/
   api/ - API tests
   scenario/ - complex scenario tests
   tests/ - unit tests for Tempest internals

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.