blob: b44df651ec40d7748e1d65a44c47694987bd2023 [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
Masayuki Igawab5d32932016-03-25 12:46:43 +09004.. image:: https://img.shields.io/pypi/v/tempest.svg
5 :target: https://pypi.python.org/pypi/tempest/
6 :alt: Latest Version
7
8.. image:: https://img.shields.io/pypi/dm/tempest.svg
9 :target: https://pypi.python.org/pypi/tempest/
10 :alt: Downloads
11
Sean Dagueb56052b2013-05-21 17:57:41 -040012This is a set of integration tests to be run against a live OpenStack
13cluster. Tempest has batteries of tests for OpenStack API validation,
14Scenarios, and other specific tests useful in validating an OpenStack
15deployment.
16
Sean Daguea26454d2013-11-01 18:09:55 -040017Design Principles
Matthew Treinish077a5632014-06-04 11:43:10 -040018-----------------
Sean Daguea26454d2013-11-01 18:09:55 -040019Tempest Design Principles that we strive to live by.
20
21- Tempest should be able to run against any OpenStack cloud, be it a
22 one node devstack install, a 20 node lxc cloud, or a 1000 node kvm
23 cloud.
24- Tempest should be explicit in testing features. It is easy to auto
25 discover features of a cloud incorrectly, and give people an
26 incorrect assessment of their cloud. Explicit is always better.
27- Tempest uses OpenStack public interfaces. Tests in Tempest should
Ken'ichi Ohmichib8249902016-06-01 17:11:04 -070028 only touch public OpenStack APIs.
Sean Daguea26454d2013-11-01 18:09:55 -040029- Tempest should not touch private or implementation specific
30 interfaces. This means not directly going to the database, not
31 directly hitting the hypervisors, not testing extensions not
OctopusZhang03b89002015-11-05 11:24:14 +080032 included in the OpenStack base. If there are some features of
33 OpenStack that are not verifiable through standard interfaces, this
Sean Daguea26454d2013-11-01 18:09:55 -040034 should be considered a possible enhancement.
35- Tempest strives for complete coverage of the OpenStack API and
36 common scenarios that demonstrate a working cloud.
37- Tempest drives load in an OpenStack cloud. By including a broad
38 array of API and scenario tests Tempest can be reused in whole or in
39 parts as load generation for an OpenStack cloud.
40- Tempest should attempt to clean up after itself, whenever possible
41 we should tear down resources when done.
zhangfengc53e4e12015-08-21 04:09:08 +000042- Tempest should be self-testing.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050043
44Quickstart
45----------
46
Matthew Treinish828734a2015-07-06 15:43:46 -040047To run Tempest, you first need to create a configuration file that will tell
48Tempest where to find the various OpenStack services and other testing behavior
49switches. Where the configuration file lives and how you interact with it
50depends on how you'll be running Tempest. There are 2 methods of using Tempest.
51The first, which is a newer and recommended workflow treats Tempest as a system
52installed program. The second older method is to run Tempest assuming your
53working dir is the actually Tempest source repo, and there are a number of
54assumptions related to that. For this section we'll only cover the newer method
55as it is simpler, and quicker to work with.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050056
OctopusZhang03b89002015-11-05 11:24:14 +080057#. You first need to install Tempest. This is done with pip after you check out
58 the Tempest repo::
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050059
Ken'ichi Ohmichi9883ff22016-04-22 18:24:15 -070060 $ git clone http://git.openstack.org/openstack/tempest
OctopusZhang03b89002015-11-05 11:24:14 +080061 $ pip install tempest/
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050062
Matthew Treinish828734a2015-07-06 15:43:46 -040063 This can be done within a venv, but the assumption for this guide is that
64 the Tempest cli entry point will be in your shell's PATH.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050065
Matthew Treinish531b01c2016-07-05 10:22:52 -040066#. Installing Tempest may create a /etc/tempest dir, however if one isn't
67 created you can create one or use ~/.tempest/etc or ~/.config/tempest in
68 place of /etc/tempest. If none of these dirs are created tempest will create
69 ~/.tempest/etc when it's needed. The contents of this dir will always
70 automatically be copied to all etc/ dirs in local workspaces as an initial
71 setup step. So if there is any common configuration you'd like to be shared
72 between local Tempest workspaces it's recommended that you pre-populate it
73 before running ``tempest init``.
Justin Shepherd0d9bbd12011-08-11 12:57:44 -050074
Matthew Treinishab77cbf2016-07-01 13:55:05 -040075#. Setup a local Tempest workspace. This is done by using the tempest init
Matthew Treinish828734a2015-07-06 15:43:46 -040076 command::
Jay Pipes7f757632011-12-02 15:53:32 -050077
Ken'ichi Ohmichi9883ff22016-04-22 18:24:15 -070078 $ tempest init cloud-01
Matthew Treinisha970d652015-03-11 15:39:24 -040079
Matthew Treinishab77cbf2016-07-01 13:55:05 -040080 which also works the same as::
Attila Fazekas58d23302013-07-24 10:25:02 +020081
Ken'ichi Ohmichi9883ff22016-04-22 18:24:15 -070082 $ mkdir cloud-01 && cd cloud-01 && tempest init
Daryl Wallecke36f6232012-03-06 00:21:45 -060083
Matthew Treinish828734a2015-07-06 15:43:46 -040084 This will create a new directory for running a single Tempest configuration.
85 If you'd like to run Tempest against multiple OpenStack deployments the idea
86 is that you'll create a new working directory for each to maintain separate
87 configuration files and local artifact storage for each.
Attila Fazekas58d23302013-07-24 10:25:02 +020088
Matthew Treinish828734a2015-07-06 15:43:46 -040089#. Then cd into the newly created working dir and also modify the local
90 config files located in the etc/ subdir created by the ``tempest init``
91 command. Tempest is expecting a tempest.conf file in etc/ so if only a
92 sample exists you must rename or copy it to tempest.conf before making
93 any changes to it otherwise Tempest will not know how to load it.
Matthew Treinisha970d652015-03-11 15:39:24 -040094
Matthew Treinish828734a2015-07-06 15:43:46 -040095#. Once the configuration is done you're now ready to run Tempest. This can
Matthew Treinish85c8e3e2016-06-30 19:28:04 -040096 be done using the :ref:`tempest_run` command. This can be done by either
Matthew Treinishab77cbf2016-07-01 13:55:05 -040097 running::
Matthew Treinish85c8e3e2016-06-30 19:28:04 -040098
99 $ tempest run
100
Matthew Treinishab77cbf2016-07-01 13:55:05 -0400101 from the Tempest workspace directory. Or you can use the ``--workspace``
102 argument to run in the workspace you created regarless of your current
103 working directory. For example::
Matthew Treinish85c8e3e2016-06-30 19:28:04 -0400104
105 $ tempest run --workspace cloud-01
106
107 There is also the option to use testr directly, or any `testr`_ based test
Matthew Treinishab77cbf2016-07-01 13:55:05 -0400108 runner, like `ostestr`_. For example, from the workspace dir run::
Matthew Treinishb17460e2013-09-17 17:04:03 +0000109
Matthew Treinish42d69512015-09-11 14:46:21 -0400110 $ ostestr --regex '(?!.*\[.*\bslow\b.*\])(^tempest\.(api|scenario))'
Matthew Treinisha970d652015-03-11 15:39:24 -0400111
Matthew Treinish828734a2015-07-06 15:43:46 -0400112 will run the same set of tests as the default gate jobs.
Matthew Treinisha970d652015-03-11 15:39:24 -0400113
Matthew Treinish828734a2015-07-06 15:43:46 -0400114.. _testr: https://testrepository.readthedocs.org/en/latest/MANUAL.html
115.. _ostestr: http://docs.openstack.org/developer/os-testr/
nayna-patelddb489c2012-11-13 22:06:45 +0000116
Matthew Treinish55511d92016-02-23 10:55:53 -0500117Library
118-------
119Tempest exposes a library interface. This interface is a stable interface and
120should be backwards compatible (including backwards compatibility with the
121old tempest-lib package, with the exception of the import). If you plan to
122directly consume tempest in your project you should only import code from the
123tempest library interface, other pieces of tempest do not have the same
124stable interface and there are no guarantees on the Python API unless otherwise
125stated.
126
127For more details refer to the library documentation here: :ref:`library`
128
129Release Versioning
130------------------
131Tempest's released versions are broken into 2 sets of information. Depending on
132how you intend to consume tempest you might need
133
134The version is a set of 3 numbers:
135
136X.Y.Z
137
138While this is almost `semver`_ like, the way versioning is handled is slightly
139different:
140
141X is used to represent the supported OpenStack releases for tempest tests
142in-tree, and to signify major feature changes to tempest. It's a monotonically
143increasing integer where each version either indicates a new supported OpenStack
144release, the drop of support for an OpenStack release (which will coincide with
145the upstream stable branch going EOL), or a major feature lands (or is removed)
146from tempest.
147
148Y.Z is used to represent library interface changes. This is treated the same
149way as minor and patch versions from `semver`_ but only for the library
150interface. When Y is incremented we've added functionality to the library
151interface and when Z is incremented it's a bug fix release for the library.
152Also note that both Y and Z are reset to 0 at each increment of X.
153
154.. _semver: http://semver.org/
155
Daryl Wallecke36f6232012-03-06 00:21:45 -0600156Configuration
157-------------
158
Joe H. Rahme00a75422015-03-16 17:46:24 +0100159Detailed configuration of Tempest is beyond the scope of this
Matthew Treinisha970d652015-03-11 15:39:24 -0400160document see :ref:`tempest-configuration` for more details on configuring
zhangfengc53e4e12015-08-21 04:09:08 +0000161Tempest. The etc/tempest.conf.sample attempts to be a self-documenting version
Matthew Treinisha970d652015-03-11 15:39:24 -0400162of the configuration.
Sean Dagueb56052b2013-05-21 17:57:41 -0400163
Matthew Treinisha970d652015-03-11 15:39:24 -0400164You can generate a new sample tempest.conf file, run the following
Joe H. Rahme00a75422015-03-16 17:46:24 +0100165command from the top level of the Tempest directory:
Masayuki Igawaac401c72014-11-18 15:28:46 +0900166
167 tox -egenconfig
Matthew Treinish6eb05852013-11-26 15:28:12 +0000168
Sean Dagueb56052b2013-05-21 17:57:41 -0400169The most important pieces that are needed are the user ids, openstack
Matthew Treinisha970d652015-03-11 15:39:24 -0400170endpoint, and basic flavors and images needed to run tests.
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000171
172Unit Tests
173----------
174
Joe H. Rahme00a75422015-03-16 17:46:24 +0100175Tempest also has a set of unit tests which test the Tempest code itself. These
Atsushi SAKAI0a183b82015-07-28 21:52:17 +0900176tests can be run by specifying the test discovery path::
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000177
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700178 $ OS_TEST_PATH=./tempest/tests testr run --parallel
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000179
180By setting OS_TEST_PATH to ./tempest/tests it specifies that test discover
181should only be run on the unit test directory. The default value of OS_TEST_PATH
182is OS_TEST_PATH=./tempest/test_discover which will only run test discover on the
Joe H. Rahme00a75422015-03-16 17:46:24 +0100183Tempest suite.
Matthew Treinisha7c7f9f2014-01-13 18:20:50 +0000184
185Alternatively, you can use the run_tests.sh script which will create a venv and
Matthew Treinish3460aaa2015-05-11 22:18:00 -0400186run the unit tests. There are also the py27 and py34 tox jobs which will run
187the unit tests with the corresponding version of python.
Matthew Treinishaf37dc92014-02-13 14:35:38 -0500188
189Python 2.6
190----------
191
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500192Starting in the kilo release the OpenStack services dropped all support for
Joe H. Rahme00a75422015-03-16 17:46:24 +0100193python 2.6. This change has been mirrored in Tempest, starting after the
194tempest-2 tag. This means that proposed changes to Tempest which only fix
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500195python 2.6 compatibility will be rejected, and moving forward more features not
Joe H. Rahme00a75422015-03-16 17:46:24 +0100196present in python 2.6 will be used. If you're running your OpenStack services
197on an earlier release with python 2.6 you can easily run Tempest against it
Matthew Treinishd28dd7b2015-02-23 11:52:33 -0500198from a remote system running python 2.7. (or deploy a cloud guest in your cloud
199that has python 2.7)
Matthew Treinish3460aaa2015-05-11 22:18:00 -0400200
201Python 3.4
202----------
203
204Starting during the Liberty release development cycle work began on enabling
205Tempest to run under both Python 2.7 and Python 3.4. Tempest strives to fully
206support running with Python 3.4. A gating unit test job was added to also run
207Tempest's unit tests under Python 3.4. This means that the Tempest code at
208least imports under Python 3.4 and things that have unit test coverage will
zhangfengc53e4e12015-08-21 04:09:08 +0000209work on Python 3.4. However, because large parts of Tempest are self-verifying
Matthew Treinish3460aaa2015-05-11 22:18:00 -0400210there might be uncaught issues running on Python 3.4. So until there is a gating
211job which does a full Tempest run using Python 3.4 there isn't any guarantee
212that running Tempest under Python 3.4 is bug free.
Matthew Treinish828734a2015-07-06 15:43:46 -0400213
214Legacy run method
215-----------------
216
217The legacy method of running Tempest is to just treat the Tempest source code
218as a python unittest repository and run directly from the source repo. When
219running in this way you still start with a Tempest config file and the steps
220are basically the same except that it expects you know where the Tempest code
221lives on your system and requires a bit more manual interaction to get Tempest
222running. For example, when running Tempest this way things like a lock file
223directory do not get generated automatically and the burden is on the user to
224create and configure that.
225
226To start you need to create a configuration file. The easiest way to create a
227configuration file is to generate a sample in the ``etc/`` directory ::
228
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700229 $ cd $TEMPEST_ROOT_DIR
230 $ oslo-config-generator --config-file \
David Paterson0bf52d42015-04-13 21:55:58 -0400231 etc/config-generator.tempest.conf \
Matthew Treinish828734a2015-07-06 15:43:46 -0400232 --output-file etc/tempest.conf
233
234After that, open up the ``etc/tempest.conf`` file and edit the
235configuration variables to match valid data in your environment.
236This includes your Keystone endpoint, a valid user and credentials,
237and reference data to be used in testing.
238
239.. note::
240
241 If you have a running devstack environment, Tempest will be
242 automatically configured and placed in ``/opt/stack/tempest``. It
243 will have a configuration file already set up to work with your
244 devstack installation.
245
246Tempest is not tied to any single test runner, but `testr`_ is the most commonly
247used tool. Also, the nosetests test runner is **not** recommended to run Tempest.
248
249After setting up your configuration file, you can execute the set of Tempest
250tests by using ``testr`` ::
251
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700252 $ testr run --parallel
Matthew Treinish828734a2015-07-06 15:43:46 -0400253
Matthew Treinish828734a2015-07-06 15:43:46 -0400254To run one single test serially ::
255
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700256 $ testr run tempest.api.compute.servers.test_servers_negative.ServersNegativeTestJSON.test_reboot_non_existent_server
Matthew Treinish828734a2015-07-06 15:43:46 -0400257
258Alternatively, you can use the run_tempest.sh script which will create a venv
259and run the tests or use tox to do the same. Tox also contains several existing
260job configurations. For example::
261
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700262 $ tox -efull
Matthew Treinish828734a2015-07-06 15:43:46 -0400263
264which will run the same set of tests as the OpenStack gate. (it's exactly how
265the gate invokes Tempest) Or::
266
Ken'ichi Ohmichidcf55a02016-06-01 19:57:14 -0700267 $ tox -esmoke
Matthew Treinish828734a2015-07-06 15:43:46 -0400268
269to run the tests tagged as smoke.