openstack/ironic
Code Issues Proposed changes

Document how to run the tempest tests

Browse Source 
This patch is extending the developer quick-start guide to include
information about how one can run the integration tests (tempest) against
a running devstack cloud (the setup for such a cloud is already part of
the documentation).

The patch also removes the information about how to run tests from the
ironic_tempest_plugin/README.rst file and add a link pointing to our
documentation.

Change-Id: I6aeb3a4fa735ff08cbb62b0b15cf95be57d1a308
This commit is contained in:
Lucas Alvares Gomes 2016-04-19 11:26:01 +01:00
parent 47f40c7c60
commit 9f4f0a4447
2 changed files with 58 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/source/dev/dev-quickstart.rst
View File

@ -547,6 +547,61 @@ The server should now be accessible via SSH::
ssh cirros@10.1.0.4
$
=====================
Running Tempest tests
=====================
After `Deploying Ironic with DevStack`_ one might want to run integration
tests against the running cloud. The Tempest project is the project that
offers an integration test suite for OpenStack.
First, navigate to Tempest directory::
cd /opt/stack/tempest
To run all tests from the `Ironic plugin
<https://github.com/openstack/ironic/tree/master/ironic_tempest_plugin>`_,
execute the following command::
tox -e all-plugin -- ironic
To limit the amount of tests that you would like to run, you can use
a regex. For instance, to limit the run to a single test file, the
following command can be used::
tox -e all-plugin -- ironic_tempest_plugin.tests.scenario.test_baremetal_basic_ops
Debugging Tempest tests
-----------------------
It is sometimes useful to step through the test code, line by line,
especially when the error output is vague. This can be done by
running the tests in debug mode and using a debugger such as `pdb
<https://docs.python.org/2/library/pdb.html>`_.
For example, after editing the *test_baremetal_basic_ops* file and
setting up the pdb traces you can invoke the ``run_tempest.sh`` script
in the Tempest directory with the following parameters::
./run_tempest.sh -N -d ironic_tempest_plugin.tests.scenario.test_baremetal_basic_ops
* The *-N* parameter tells the script to run the tests in the local
environment (without a virtualenv) so it can find the Ironic tempest
plugin.
* The *-d* parameter enables the debug mode, allowing it to be used
with pdb.
For more information about the supported parameters see::
./run_tempest.sh --help
.. note::
Always be careful when running debuggers in time sensitive code,
they may cause timeout errors that weren't there before.
================================
Building developer documentation
================================

15
ironic_tempest_plugin/README.rst
View File

@ -8,15 +8,6 @@ as well as a plugin to automatically load these tests into tempest.
See the tempest plugin docs for information on using it:
http://docs.openstack.org/developer/tempest/plugin.html#using-plugins
To run all tests from this plugin, install ironic into your environment
and run::
$ tox -e all-plugin -- ironic
To run a single test case, run with the test case name, for example::
$ tox -e all-plugin -- ironic_tempest_plugin.tests.scenario.test_baremetal_basic_ops.BaremetalBasicOps.test_baremetal_server_ops
To run all tempest tests including this plugin, run::
$ tox -e all-plugin
See the Ironic documentation for information about how to run the
tempest tests:
http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#running-tempest-tests