History

Zuul 0e52b485e9 Merge "add unit test for delete_group_user method"		2020-02-26 05:02:22 +00:00
..
api	Merge "Add validation_resources in test_resize_volume_backed_server_confirm"	2020-02-19 04:15:09 +00:00
cmd	Merge "Remove the deprecated verify-tempest-config CLI"	2020-02-17 14:16:41 +00:00
common	waiters: Add wait_for_volume_attachment_remove	2020-01-28 20:37:10 +00:00
hacking	Merge "Bump hacking to 1.1.0"	2018-08-21 12:46:22 +00:00
lib	compute: Add volume and placement microversion support to BaseV2ComputeTest	2020-02-07 11:11:30 +00:00
scenario	Merge "Relax volume compare in test_minimum_basic_scenario"	2020-02-19 06:46:24 +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 "add unit test for delete_group_user method"	2020-02-26 05:02:22 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	Add segments client	2019-07-25 10:56:06 +02:00
config.py	Merge "Deprecate spice_console and rdp_console config items"	2020-02-25 06:25:04 +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
test.py	Add workaround to handle the testtool skip exception in CLI test	2019-10-12 01:40:29 +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 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.