History

zhufl 9b442510e7 Adding description for testcases - swift part1 When Tempest is used in customer site, often we are required to provide a testcase list including testcase names and descriptions. Now no this kind of doc is available, so we can add descriptions with the format of doc string for every testcase, so later we can generata such a testcase description list. There are hundreds of testcases missing descriptions, so we can add them gradually, and limit the modified files in one patch for the convenience of reviewing. Change-Id: Ib0df766d305ab2583d284d4c0aed32e7685eb595 partially-implements: blueprint testcase-description		2020-08-18 11:11:16 +08:00
..
api	Adding description for testcases - swift part1	2020-08-18 11:11:16 +08:00
cmd	Merge "Fix the argument check for account-generator"	2020-06-23 21:13:18 +00:00
common	Remove checking of Accept-Range header	2020-07-08 08:55:18 +00:00
hacking	Update hacking for Python3	2020-04-04 10:33:23 +02:00
lib	Merge "Add response schema validation for volumes"	2020-08-14 05:32:22 +00:00
scenario	Merge "Unstable test_server_connectivity_cold_migration_revert"	2020-07-15 11:28:56 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Add logs for plugins data	2020-04-16 17:22:39 +00:00
tests	Merge "Add response schema validation for volumes"	2020-08-14 05:32:22 +00:00
README.rst	Transfer respository to repository	2018-12-09 19:59:12 +08:00
__init__.py	…
clients.py	services: Introduce a cinder v3 attachments client	2020-03-02 09:02:50 +00:00
config.py	Merge "Stop to use the __future__ module."	2020-07-28 13:01:46 +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.