openstack
/
tempest
Code Issues Proposed changes
tempest/tempest
History
Matthew Treinish f8b816af07 Add cmd entry point for verify_tempest_config 
This commit moves the verify_tempest_config script from the tools dir
to tempest.cmd and adds a pbr entry point for the script. This means
that the script will in effect be a packaged binary for tempest.

Partially implements bp config-verification

Change-Id: I75b9743a8117d55c6c445db05eb39404b5708624
 		2014-04-30 17:36:12 +00:00
..
api Merge "Remove {begin,roll}_detaching volume API tests" 2014-04-29 13:07:24 +00:00
api_schema Merge "Verify os-migration API response attributes" 2014-04-30 16:19:49 +00:00
cli Merge "Add sahara edp cli commands tests" 2014-04-10 15:46:06 +00:00
cmd Add cmd entry point for verify_tempest_config 2014-04-30 17:36:12 +00:00
common Merge "Add unit tests for all generators" 2014-04-22 18:16:41 +00:00
hacking Merge "Add check that service tag isn't in path name" 2014-04-25 00:28:41 +00:00
openstack Update Oslo config sample generator 2014-03-17 15:04:12 +00:00
scenario Skip lbaas test test_load_balancer_basic 2014-04-29 16:42:52 -07:00
services Merge "Verify os-migration API response attributes" 2014-04-30 16:19:49 +00:00
stress Merge "Fix stress runner signal related issues" 2014-04-25 10:22:12 +00:00
test_discover Use unittest2.TestSuite with py26 2014-01-27 10:54:44 +01:00
tests Defines a Credentials class 2014-04-23 07:42:41 +01:00
thirdparty fix test_compute_with_volumes 2014-04-23 11:45:56 -04:00
README.rst Remove Whitebox tests 2013-09-12 15:40:15 +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
auth.py Defines a Credentials class 2014-04-23 07:42:41 +01:00
clients.py Delete OrchestrationManager, and its unusual credentials 2014-04-21 10:34:01 -07:00
config.py ssh instance validation add options for Neutron 2014-04-19 14:53:26 +02:00
exceptions.py Move exceptions back into one place 2014-04-14 23:03:57 -04:00
manager.py Object storage tests to use default auth_provider 2014-03-13 10:35:18 +00:00
test.py safe_setup preserve original trace 2014-04-09 11:31:19 +02: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
   cli/ - CLI tests
   scenario/ - complex scenario tests
   stress/ - stress tests
   thirdparty/ - 3rd party api 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

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. This allows us to test both XML and JSON. Having raw clients also lets us pass invalid JSON and XML 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.

cli

CLI tests use the openstack CLI to interact with the OpenStack cloud. CLI testing in unit tests is somewhat difficult because unlike server testing, there is no access to server code to instantiate. Tempest seems like a logical place for this, as it prereqs having a running OpenStack cloud.

scenario

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 can and should use the OpenStack python clients.

stress

Stress tests are designed to stress an OpenStack environment by running a high workload against it and seeing what breaks. Tools may be provided to help detect breaks (stack traces in the logs).

TODO: old stress tests deleted, new_stress that david is working on moves into here.

thirdparty

Many openstack components include 3rdparty API support. It is completely legitimate for Tempest to include tests of 3rdparty APIs, but those should be kept separate from the normal OpenStack validation.