tempest/tempest
Jenkins 420bc79fd3 Merge "Update "create_server" to wait until status is 'ACTIVE'" 2017-06-12 04:52:56 +00:00
..
api Merge "Update "create_server" to wait until status is 'ACTIVE'" 2017-06-12 04:52:56 +00:00
cmd Reuse v2 extension client for cinder v3 2017-05-30 12:57:46 -07:00
common Merge "Use Neutron (if available) to create floating IPs for validation" 2017-06-08 17:38:36 +00:00
hacking Add T115 for admin test path 2017-05-23 14:00:27 -07:00
lib Merge "Fix DeprecationWarning in test_volume_pools.py" 2017-06-06 03:00:17 +00:00
scenario Replace assertions with more specific ones 2017-06-09 06:45:05 +00:00
services Fix create, update or delete account metadata method 2017-04-21 02:47:30 +00:00
test_discover Add docstring example for get_opt_lists 2017-04-24 10:07:39 +00:00
tests Unit test for asserting correct url in list_services 2017-06-05 21:26:55 +01:00
README.rst Remove the Stress framework 2016-10-19 14:31:13 +02:00
__init__.py
clients.py Stop warning on client_parameters 2017-05-24 20:46:48 +00:00
config.py Add option for whether the cloud supports floating ips 2017-05-23 15:37:03 -04:00
exceptions.py Move InvalidServiceTag 2017-04-19 11:21:04 +01: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 cls.os is deprecated use cls.os_primary 2017-05-24 10:44:46 +01: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.