OpenStack Testing (Tempest) of an existing cloud
Go to file
Masayuki Igawa c268dd6beb Add 'Field' to the title of the Field Guides
In several field guides, the title doesn't have 'Field'.
This causes inconsistency in the tempest documentation.
 http://docs.openstack.org/developer/tempest/#field-guides
This commit adds 'Field' word to the field guides.

Change-Id: I0379442da59f66b1f5a0e755e5383c56b2a46688
2013-09-18 13:29:53 +09:00
doc/source Remove Whitebox tests 2013-09-12 15:40:15 +00:00
etc Merge "task_state must be consider before many action" 2013-09-13 19:59:07 +00:00
include Updating images tests 2011-10-31 15:23:19 -04:00
tempest Add 'Field' to the title of the Field Guides 2013-09-18 13:29:53 +09:00
tools Sync latest versions of oslo incubator 2013-09-16 17:18:53 +00:00
.gitignore Ignore .testrepository/ 2013-05-07 09:13:02 +12:00
.gitreview Update .gitreview with new project name. 2011-11-30 10:59:36 -08:00
.mailmap Update gitignore because of oslo setup.py 2013-01-09 10:54:17 -05:00
.testr.conf Increase default test timeout for timeout fixture 2013-08-30 14:00:13 -04:00
HACKING.rst Add parallel test execution section to HACKING.rst 2013-09-16 17:26:26 +00:00
LICENSE Add License to Tempest. 2012-04-12 16:04:36 +02:00
README.rst Update README.rst to use testr instead of nose 2013-09-17 17:04:03 +00:00
openstack-common.conf Switching to oslo importutils in the stress tests 2013-07-31 13:18:47 +02:00
requirements.txt add required python modules(six,iso8601,fixtures) to requirements.txt 2013-09-15 13:52:48 -05:00
run_tests.sh Remove Whitebox tests 2013-09-12 15:40:15 +00:00
setup.cfg Remove bin/tempest script 2013-09-12 14:15:30 +00:00
setup.py Migrate to pbr from openstack.common.setup. 2013-05-01 14:04:27 -04:00
test-requirements.txt Update requirements from global requirements 2013-08-26 10:42:28 -04:00
tox.ini Merge "Add large-ops option to tox" 2013-08-29 12:29:11 +00:00

README.rst

Tempest - The OpenStack Integration Test Suite

This is a set of integration tests to be run against a live OpenStack cluster. Tempest has batteries of tests for OpenStack API validation, Scenarios, and other specific tests useful in validating an OpenStack deployment.

Quickstart

To run Tempest, you first need to create a configuration file that will tell Tempest where to find the various OpenStack services and other testing behavior switches.

The easiest way to create a configuration file is to copy the sample one in the etc/ directory :

$> cd $TEMPEST_ROOT_DIR
$> cp etc/tempest.conf.sample etc/tempest.conf

After that, open up the etc/tempest.conf file and edit the configuration variables to match valid data in your environment. This includes your Keystone endpoint, a valid user and credentials, and reference data to be used in testing.

Note

If you have a running devstack environment, tempest will be automatically configured and placed in /opt/stack/tempest. It will have a configuration file already set up to work with your devstack installation.

Tempest is not tied to any single test runner, but testr is the most commonly used tool. After setting up your configuration file, you can execute the set of Tempest tests by using testr :

$> testr run --parallel tempest

To run one single test :

$> testr run --parallel tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_rebuild_nonexistent_server

Alternatively, you can use the run_tests.sh script which will create a venv and run the tests or use tox to do the same.

Configuration

Detailed configuration of tempest is beyond the scope of this document. The etc/tempest.conf.sample attempts to be a self documenting version of the configuration.

The most important pieces that are needed are the user ids, openstack endpoints, and basic flavors and images needed to run tests.

Common Issues

Tempest was originally designed to primarily run against a full OpenStack deployment. Due to that focus, some issues may occur when running Tempest against devstack.

Running Tempest, especially in parallel, against a devstack instance may cause requests to be rate limited, which will cause unexpected failures. Given the number of requests Tempest can make against a cluster, rate limiting should be disabled for all test accounts.

Additionally, devstack only provides a single image which Nova can use. For the moment, the best solution is to provide the same image uuid for both image_ref and image_ref_alt. Tempest will skip tests as needed if it detects that both images are the same.