| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 1 | ===== |
| Jim Rollenhagen | 4f8f229 | 2016-11-18 06:22:18 -0500 | [diff] [blame] | 2 | Usage |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 3 | ===== |
| Jim Rollenhagen | 4f8f229 | 2016-11-18 06:22:18 -0500 | [diff] [blame] | 4 | |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 5 | Configuring |
| 6 | ----------- |
| Jim Rollenhagen | 4f8f229 | 2016-11-18 06:22:18 -0500 | [diff] [blame] | 7 | |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 8 | Update your `Tempest configuration`_ to enable support for ironic: |
| 9 | |
| 10 | .. code-block:: ini |
| 11 | |
| Iury Gregory Melo Ferreira | a512913 | 2020-03-13 11:41:19 +0100 | [diff] [blame] | 12 | [service_available] |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 13 | ironic = True |
| 14 | |
| 15 | If introspection tests are needed, also enable support for ironic-inspector: |
| 16 | |
| 17 | .. code-block:: ini |
| 18 | |
| Iury Gregory Melo Ferreira | a512913 | 2020-03-13 11:41:19 +0100 | [diff] [blame] | 19 | [service_available] |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 20 | ironic_inspector = True |
| 21 | |
| Dmitry Tantsur | ea9af86 | 2018-03-14 16:48:48 +0100 | [diff] [blame] | 22 | See 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 Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 30 | |
| 31 | .. _Tempest configuration: https://docs.openstack.org/tempest/latest/configuration.html |
| 32 | |
| 33 | Running |
| 34 | ------- |
| 35 | |
| 36 | Run tests as described in the `Tempest documentation`_. The following patterns |
| 37 | can be used with ``--regex`` option to only run bare metal tests: |
| 38 | |
| 39 | ``ironic`` |
| 40 | all bare metal tests |
| Dmitry Tantsur | 0c4a693 | 2018-09-07 14:41:57 +0200 | [diff] [blame] | 41 | ``ironic_tempest_plugin.tests.api`` |
| 42 | only API tests using fake hardware, without other OpenStack services (these |
| Iury Gregory Melo Ferreira | 8bcc4fa | 2020-03-09 16:50:09 +0100 | [diff] [blame] | 43 | tests are run by jobs starting with ``ironic-tempest-functional-python3``) |
| Dmitry Tantsur | 0c4a693 | 2018-09-07 14:41:57 +0200 | [diff] [blame] | 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 Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 47 | ``ironic_standalone`` |
| 48 | standalone bare metal tests that do not use the Compute service |
| Iury Gregory Melo Ferreira | 8bcc4fa | 2020-03-09 16:50:09 +0100 | [diff] [blame] | 49 | (these tests are run by the jobs ``ironic-standalone`` and |
| 50 | ``ironic-standalone-redfish``) |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 51 | ``InspectorBasicTest`` |
| Dmitry Tantsur | 0c4a693 | 2018-09-07 14:41:57 +0200 | [diff] [blame] | 52 | basic introspection tests (these tests are run by most of the jobs with |
| 53 | ``ironic-inspector`` in their name) |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 54 | ``InspectorDiscoveryTest`` |
| Dmitry Tantsur | 0c4a693 | 2018-09-07 14:41:57 +0200 | [diff] [blame] | 55 | introspection auto-discovery tests (these tests are run by the job |
| Iury Gregory Melo Ferreira | 8bcc4fa | 2020-03-09 16:50:09 +0100 | [diff] [blame] | 56 | ``ironic-inspector-tempest-discovery`` and require additional set up) |
| Dmitry Tantsur | a068e66 | 2017-12-21 11:14:43 +0100 | [diff] [blame] | 57 | |
| 58 | .. _Tempest documentation: https://docs.openstack.org/tempest/latest/run.html |