blob: 001404bf4b21b29ac63a8c8678c075580221d897 [file] [log] [blame]
Justin Shepherd0d9bbd12011-08-11 12:57:44 -05001::
2
Jay Pipes7f757632011-12-02 15:53:32 -05003Tempest - The OpenStack Integration Test Suite
4==============================================
Justin Shepherd0d9bbd12011-08-11 12:57:44 -05005
Soren Hansen5d40bdb2011-08-26 16:06:37 +02006This is a set of integration tests to be run against a live cluster.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -05007
8Quickstart
9----------
10
Jay Pipes7f757632011-12-02 15:53:32 -050011To run Tempest, you first need to create a configuration file that
12will tell Tempest where to find the various OpenStack services and
13other testing behaviour switches.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050014
Jay Pipes7f757632011-12-02 15:53:32 -050015The easiest way to create a configuration file is to copy the sample
16one in the ``etc/`` directory ::
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050017
Jay Pipes7f757632011-12-02 15:53:32 -050018 $> cd $TEMPEST_ROOT_DIR
Brian Lamar930fc5b2011-12-08 11:51:26 -050019 $> cp etc/tempest.conf.sample etc/tempest.conf
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050020
Brian Lamar930fc5b2011-12-08 11:51:26 -050021After that, open up the ``etc/tempest.conf`` file and edit the
Jay Pipes7f757632011-12-02 15:53:32 -050022variables to fit your test environment.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050023
Jay Pipes7f757632011-12-02 15:53:32 -050024.. note::
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050025
Jay Pipes7f757632011-12-02 15:53:32 -050026 If you have a running devstack environment, look at the
27 environment variables in your ``devstack/localrc`` file.
28 The ADMIN_PASSWORD variable should match the api_key value
Brian Lamar930fc5b2011-12-08 11:51:26 -050029 in the tempest.conf [nova] configuration section. In addition,
Jay Pipes7f757632011-12-02 15:53:32 -050030 you will need to get the UUID identifier of the image that
31 devstack uploaded and set the image_ref value in the [environment]
Brian Lamar930fc5b2011-12-08 11:51:26 -050032 section in the tempest.conf to that image UUID.
Jay Pipes7f757632011-12-02 15:53:32 -050033
34After setting up your configuration file, you can execute the set of
35Tempest tests by using ``nosetests`` ::
36
Brian Lamar930fc5b2011-12-08 11:51:26 -050037 $> nosetests tempest