blob: af245694008de8419112b35e54291062c036cc2c [file] [log] [blame]
Jay Pipes7f757632011-12-02 15:53:32 -05001Tempest - The OpenStack Integration Test Suite
2==============================================
Justin Shepherd0d9bbd12011-08-11 12:57:44 -05003
Sean Dagueb56052b2013-05-21 17:57:41 -04004This is a set of integration tests to be run against a live OpenStack
5cluster. Tempest has batteries of tests for OpenStack API validation,
6Scenarios, and other specific tests useful in validating an OpenStack
7deployment.
8
Sean Daguea26454d2013-11-01 18:09:55 -04009Design Principles
Matthew Treinish077a5632014-06-04 11:43:10 -040010-----------------
Sean Daguea26454d2013-11-01 18:09:55 -040011Tempest Design Principles that we strive to live by.
12
13- Tempest should be able to run against any OpenStack cloud, be it a
14 one node devstack install, a 20 node lxc cloud, or a 1000 node kvm
15 cloud.
16- Tempest should be explicit in testing features. It is easy to auto
17 discover features of a cloud incorrectly, and give people an
18 incorrect assessment of their cloud. Explicit is always better.
19- Tempest uses OpenStack public interfaces. Tests in Tempest should
20 only touch public interfaces, API calls (native or 3rd party),
Matthew Treinish464d2872015-04-29 12:23:01 -040021 or libraries.
Sean Daguea26454d2013-11-01 18:09:55 -040022- Tempest should not touch private or implementation specific
23 interfaces. This means not directly going to the database, not
24 directly hitting the hypervisors, not testing extensions not
25 included in the OpenStack base. If there is some feature of
26 OpenStack that is not verifiable through standard interfaces, this
27 should be considered a possible enhancement.
28- Tempest strives for complete coverage of the OpenStack API and
29 common scenarios that demonstrate a working cloud.
30- Tempest drives load in an OpenStack cloud. By including a broad
31 array of API and scenario tests Tempest can be reused in whole or in
32 parts as load generation for an OpenStack cloud.
33- Tempest should attempt to clean up after itself, whenever possible
34 we should tear down resources when done.
35- Tempest should be self testing.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050036
37Quickstart
38----------
39
Jay Pipes7f757632011-12-02 15:53:32 -050040To run Tempest, you first need to create a configuration file that
41will tell Tempest where to find the various OpenStack services and
Daryl Wallecke36f6232012-03-06 00:21:45 -060042other testing behavior switches.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050043
Jay Pipes7f757632011-12-02 15:53:32 -050044The easiest way to create a configuration file is to copy the sample
45one in the ``etc/`` directory ::
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050046
Jay Pipes7f757632011-12-02 15:53:32 -050047 $> cd $TEMPEST_ROOT_DIR
Brian Lamar930fc5b2011-12-08 11:51:26 -050048 $> cp etc/tempest.conf.sample etc/tempest.conf
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050049
Brian Lamar930fc5b2011-12-08 11:51:26 -050050After that, open up the ``etc/tempest.conf`` file and edit the
Daryl Wallecke36f6232012-03-06 00:21:45 -060051configuration variables to match valid data in your environment.
52This includes your Keystone endpoint, a valid user and credentials,
53and reference data to be used in testing.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050054
Jay Pipes7f757632011-12-02 15:53:32 -050055.. note::
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050056
Joe H. Rahme00a75422015-03-16 17:46:24 +010057 If you have a running devstack environment, Tempest will be
Sean Dagueb56052b2013-05-21 17:57:41 -040058 automatically configured and placed in ``/opt/stack/tempest``. It
59 will have a configuration file already set up to work with your
60 devstack installation.
Jay Pipes7f757632011-12-02 15:53:32 -050061
Matthew Treinisha970d652015-03-11 15:39:24 -040062Tempest is not tied to any single test runner, but `testr`_ is the most commonly
Joe H. Rahme00a75422015-03-16 17:46:24 +010063used tool. Also, the nosetests test runner is **not** recommended to run Tempest.
Matthew Treinisha970d652015-03-11 15:39:24 -040064
65After setting up your configuration file, you can execute the set of Tempest
66tests by using ``testr`` ::
Attila Fazekas58d23302013-07-24 10:25:02 +020067
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +000068 $> testr run --parallel
Daryl Wallecke36f6232012-03-06 00:21:45 -060069
Matthew Treinisha970d652015-03-11 15:39:24 -040070.. _testr: http://testrepository.readthedocs.org/en/latest/MANUAL.html
Attila Fazekas58d23302013-07-24 10:25:02 +020071
Matthew Treinisha970d652015-03-11 15:39:24 -040072To run one single test serially ::
73
74 $> testr run tempest.api.compute.servers.test_servers_negative.ServersNegativeTestJSON.test_reboot_non_existent_server
Matthew Treinishb17460e2013-09-17 17:04:03 +000075
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +000076Alternatively, you can use the run_tempest.sh script which will create a venv
Matthew Treinisha970d652015-03-11 15:39:24 -040077and run the tests or use tox to do the same. Tox also contains several existing
78job configurations. For example::
79
80 $> tox -efull
81
82which will run the same set of tests as the OpenStack gate. (it's exactly how
Joe H. Rahme00a75422015-03-16 17:46:24 +010083the gate invokes Tempest) Or::
Matthew Treinisha970d652015-03-11 15:39:24 -040084
85 $> tox -esmoke
86
87to run the tests tagged as smoke.
88
nayna-patelddb489c2012-11-13 22:06:45 +000089
Daryl Wallecke36f6232012-03-06 00:21:45 -060090Configuration
91-------------
92
Joe H. Rahme00a75422015-03-16 17:46:24 +010093Detailed configuration of Tempest is beyond the scope of this
Matthew Treinisha970d652015-03-11 15:39:24 -040094document see :ref:`tempest-configuration` for more details on configuring
Joe H. Rahme00a75422015-03-16 17:46:24 +010095Tempest. The etc/tempest.conf.sample attempts to be a self documenting version
Matthew Treinisha970d652015-03-11 15:39:24 -040096of the configuration.
Sean Dagueb56052b2013-05-21 17:57:41 -040097
Matthew Treinisha970d652015-03-11 15:39:24 -040098You can generate a new sample tempest.conf file, run the following
Joe H. Rahme00a75422015-03-16 17:46:24 +010099command from the top level of the Tempest directory:
Masayuki Igawaac401c72014-11-18 15:28:46 +0900100
101 tox -egenconfig
Matthew Treinish6eb05852013-11-26 15:28:12 +0000102
Sean Dagueb56052b2013-05-21 17:57:41 -0400103The most important pieces that are needed are the user ids, openstack
Matthew Treinisha970d652015-03-11 15:39:24 -0400104endpoint, and basic flavors and images needed to run tests.
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000105
106Unit Tests
107----------
108
Joe H. Rahme00a75422015-03-16 17:46:24 +0100109Tempest also has a set of unit tests which test the Tempest code itself. These
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000110tests can be run by specifing the test discovery path::
111
112 $> OS_TEST_PATH=./tempest/tests testr run --parallel
113
114By setting OS_TEST_PATH to ./tempest/tests it specifies that test discover
115should only be run on the unit test directory. The default value of OS_TEST_PATH
116is OS_TEST_PATH=./tempest/test_discover which will only run test discover on the
Joe H. Rahme00a75422015-03-16 17:46:24 +0100117Tempest suite.
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000118
119Alternatively, you can use the run_tests.sh script which will create a venv and
Matthew Treinish3460aaa2015-05-11 22:18:00 -0400120run the unit tests. There are also the py27 and py34 tox jobs which will run
121the unit tests with the corresponding version of python.
Matthew Treinishaf37dc92014-02-13 14:35:38 -0500122
123Python 2.6
124----------
125
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500126Starting in the kilo release the OpenStack services dropped all support for
Joe H. Rahme00a75422015-03-16 17:46:24 +0100127python 2.6. This change has been mirrored in Tempest, starting after the
128tempest-2 tag. This means that proposed changes to Tempest which only fix
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500129python 2.6 compatibility will be rejected, and moving forward more features not
Joe H. Rahme00a75422015-03-16 17:46:24 +0100130present in python 2.6 will be used. If you're running your OpenStack services
131on an earlier release with python 2.6 you can easily run Tempest against it
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500132from a remote system running python 2.7. (or deploy a cloud guest in your cloud
133that has python 2.7)
Matthew Treinish3460aaa2015-05-11 22:18:00 -0400134
135Python 3.4
136----------
137
138Starting during the Liberty release development cycle work began on enabling
139Tempest to run under both Python 2.7 and Python 3.4. Tempest strives to fully
140support running with Python 3.4. A gating unit test job was added to also run
141Tempest's unit tests under Python 3.4. This means that the Tempest code at
142least imports under Python 3.4 and things that have unit test coverage will
143work on Python 3.4. However, because large parts of Tempest are self verifying
144there might be uncaught issues running on Python 3.4. So until there is a gating
145job which does a full Tempest run using Python 3.4 there isn't any guarantee
146that running Tempest under Python 3.4 is bug free.