openstack/tempest

History

ghanshyam de676babd3 Move volume v2 service clients to v3 dir Moving all existing volume v2 service clients to v3 dir. These service clients will be available as v3 service clients. For backward compatibility, keeping all service clients importable from volume.v2 dir with deprecation warning. This patch is starting patch to make volume service clients cleanup for v3 API testing as default. Change-Id: I5888740f94d9f1ef8ce3fac78e4ce76ae650a6fd		2018-05-16 08:00:40 +00:00
..
api	Merge "Add 2.55 schema & update flavor API in flavors_client"	2018-05-16 05:35:28 +00:00
cmd	Modify the empty list ensure method	2018-04-24 14:28:43 +00:00
common	Connect to default ports if none are specified	2018-02-19 10:16:22 -05:00
hacking	Cleanup ignored_list_T110.txt	2018-05-15 16:37:23 +09:00
lib	Move volume v2 service clients to v3 dir	2018-05-16 08:00:40 +00:00
scenario	Merge "Backup and restore scenario"	2018-05-15 18:35:27 +00:00
services	Move the object client to tempest.lib	2017-10-17 00:14:20 +00:00
test_discover	Fix doc issue in plugin.py	2017-11-05 21:41:33 +11:00
tests	Move volume v2 service clients to v3 dir	2018-05-16 08:00:40 +00:00
__init__.py
clients.py	Backup and restore scenario	2018-05-10 14:26:59 +03:00
config.py	Volume Service Testing: default to v3 endpoints	2018-05-16 07:59:19 +00:00
exceptions.py	Remove unused RFCViolation	2017-09-11 14:20:20 +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	Fix directory tree appearance in document	2017-11-14 16:29:35 +09:00
test.py	Fix code to pass pep8 Tox environment.	2018-04-12 11:09:37 +02: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 respository 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.