openstack/tempest
Code Issues Proposed changes
4d8ba2377b
tempest/tempest
History
Ken'ichi Ohmichi 4d8ba2377b Fix typo of setUpClass 
There are a few same pattern of typo related to setUpClass.
Let's fix them.

Change-Id: Ic835bb37353f1ef6623d55f294c09f4f06a4be44
2017-03-03 18:28:05 -08:00
..
api Fix typo of setUpClass 2017-03-03 18:28:05 -08:00
cmd Fix subunit describe calls for py3 2017-02-27 16:06:23 +00:00
common Add a generic "wait_for_volume_resource_status" function 2017-02-19 09:12:42 +02:00
hacking Delete Savanna element in client list 2016-09-21 03:00:15 +00:00
lib Merge "Close connection after each failed connect attempt" 2017-03-02 00:29:14 +00:00
scenario Merge "Remove unused variable" 2017-03-02 10:50:03 +00:00
services Swift list containers should test for reverse listing param 2017-02-08 10:42:19 -08:00
test_discover Use oslo.log library instead of system logging module 2017-01-16 05:56:54 +00:00
tests Merge "Adds missing server tags APIs to servers client." 2017-03-01 21:44:06 +00:00
__init__.py Changes the namespace from storm to tempest, as well as adding addition tests and improvements 2011-12-06 16:48:03 -06:00
clients.py Remove default_params_with_timeout_values variable 2017-01-27 02:42:47 +00:00
config.py Merge "Improve test_implied_domain_roles" 2017-03-03 23:08:26 +00:00
exceptions.py Add a generic "wait_for_volume_resource_status" function 2017-02-19 09:12:42 +02: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 Remove the Stress framework 2016-10-19 14:31:13 +02:00
test.py Merge "Remove call_until_true from test module" 2017-02-28 23:13:34 +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 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.