blob: 27b5ebe15222ef2906f53fadca044263f8ee4038 [file] [log] [blame]
Dmitry Tantsura068e662017-12-21 11:14:43 +01001=====
Jim Rollenhagen4f8f2292016-11-18 06:22:18 -05002Usage
Dmitry Tantsura068e662017-12-21 11:14:43 +01003=====
Jim Rollenhagen4f8f2292016-11-18 06:22:18 -05004
Dmitry Tantsura068e662017-12-21 11:14:43 +01005Configuring
6-----------
Jim Rollenhagen4f8f2292016-11-18 06:22:18 -05007
Dmitry Tantsura068e662017-12-21 11:14:43 +01008Update your `Tempest configuration`_ to enable support for ironic:
9
10.. code-block:: ini
11
12 [service_enabled]
13 ironic = True
14
15If introspection tests are needed, also enable support for ironic-inspector:
16
17.. code-block:: ini
18
19 [service_enabled]
20 ironic_inspector = True
21
Dmitry Tantsurea9af862018-03-14 16:48:48 +010022See the following example configurations for more details:
23
24.. toctree::
25 :maxdepth: 1
26
27 config/with-nova
28
29.. TODO(dtantsur): cover standalone tests
Dmitry Tantsura068e662017-12-21 11:14:43 +010030
31.. _Tempest configuration: https://docs.openstack.org/tempest/latest/configuration.html
32
33Running
34-------
35
36Run tests as described in the `Tempest documentation`_. The following patterns
37can be used with ``--regex`` option to only run bare metal tests:
38
39``ironic``
40 all bare metal tests
Dmitry Tantsur0c4a6932018-09-07 14:41:57 +020041``ironic_tempest_plugin.tests.api``
42 only API tests using fake hardware, without other OpenStack services (these
43 tests are run by jobs starting with ``tempest-dsvm-ironic-functional``)
44``ironic_tempest_plugin.tests.scenario``
45 all integration tests, excluding the API tests with fake hardware (these
46 tests are run by most of the jobs)
Dmitry Tantsura068e662017-12-21 11:14:43 +010047``ironic_standalone``
48 standalone bare metal tests that do not use the Compute service
Dmitry Tantsur0c4a6932018-09-07 14:41:57 +020049 (these tests are run by the job ``ironic-dsvm-standalone``)
Dmitry Tantsura068e662017-12-21 11:14:43 +010050``InspectorBasicTest``
Dmitry Tantsur0c4a6932018-09-07 14:41:57 +020051 basic introspection tests (these tests are run by most of the jobs with
52 ``ironic-inspector`` in their name)
Dmitry Tantsura068e662017-12-21 11:14:43 +010053``InspectorDiscoveryTest``
Dmitry Tantsur0c4a6932018-09-07 14:41:57 +020054 introspection auto-discovery tests (these tests are run by the job
55 ``ironic-inspector-tempest-dsvm-discovery`` and require additional set up)
Dmitry Tantsura068e662017-12-21 11:14:43 +010056
57.. _Tempest documentation: https://docs.openstack.org/tempest/latest/run.html