openstack
/
tempest
Code Issues Proposed changes
tempest/tempest
History
Matthew Treinish a6b0a2f129 Revert "Add tests for wait_for_server_status" 
This unit test class added several race conditions to the unit tests as well as
added a dependency on having a valid tempest config file. At this point instead
of trying to fix all of these issues I'm pushing a revert in the short term and 
long-term we can just fix things and re-push these tests.

This reverts commit ae7c9ac4aa.

Change-Id: If6026611f3938be0716ce95491a8ee60a53e8c12
Closes-Bug: #1347096
 		2014-07-22 18:39:13 +00:00
..
api Merge "Use known flavor ID as marker" 2014-06-18 15:48:31 +00:00
api_schema Verify list_instance_action attributes of Nova API 2014-06-17 17:35:54 +09:00
cli Enable E113,E111,H302,F812,E713 rules 2014-06-17 23:33:30 +00:00
cmd Enable E113,E111,H302,F812,E713 rules 2014-06-17 23:33:30 +00:00
common Merge "Deduplicate status call checks" 2014-06-17 22:13:13 +00:00
hacking Add noqa support to no_setupclass_for_unit_tests 2014-05-02 19:14:28 -04:00
openstack Sync versionutils from oslo-incubator 2014-06-13 05:00:25 -07:00
scenario Merge "Reworked scenario tests to use their own non-default security groups" 2014-06-17 21:29:53 +00:00
services Merge "Sharing codes for cinder v1 and v2 tests" 2014-06-18 14:34:51 +00:00
stress Enable E251,E265 rules ignore H402 2014-06-17 22:54:49 -04:00
test_discover Use unittest2.TestSuite with py26 2014-01-27 10:54:44 +01:00
tests Revert "Add tests for wait_for_server_status" 2014-07-22 18:39:13 +00:00
thirdparty Merge "Don't include boto tests as part of smoke tests" 2014-06-18 14:34:43 +00: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 Use auth data to fill credentials 2014-04-30 13:36:14 +01:00
clients.py Merge "Test script for CRUD operations on regions" 2014-06-10 23:06:17 +00:00
config.py Merge "Adds test for Floating Ips bulk Nova V2 API" 2014-06-18 02:18:29 +00:00
exceptions.py Merge "Add a lacking message format letter 's'" 2014-05-06 09:56:02 +00:00
manager.py Enforces the use of Credentials (part2) 2014-05-06 14:38:55 +01:00
test.py Enable E251,E265 rules ignore H402 2014-06-17 22:54:49 -04: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.