OpenStack Integration Test Suite Guide

Procedure

1. Log in to the undercloud host as the stack user.
2. Edit the undercloud.conf file located in the home directory of the stack user.

3. Set the enable_tempest parameter to true.

   enable_tempest = true

4. Run the openstack undercloud install command to include the extra configuration in the undercloud:

   $ openstack undercloud install

Procedure

1. Ensure that the following networks are available within your Red Hat OpenStack Platform (RHOSP) environment:

   • An external network that can provide a floating IP.

   • A private network.

     Connect these networks through a router.

     1. To create the private network, specify the following options according to your network deployment:

        $ openstack network create <network_name> --share
        $ openstack subnet create <subnet_name> --subnet-range <address/prefix> \
          --network <network_name>
        $ openstack router create <router_name>
        $ openstack router add subnet <router_name> <subnet_name>

     2. To create the public network, specify the following options according to your network deployment:

        $ openstack network create <network_name> --external \
          --provider-network-type flat \
          --provider-physical-network datacentre
        $ openstack subnet create <subnet_name> --subnet-range <address/prefix> \
          --gateway <default_gateway> --no-dhcp --network <network_name>
        $ openstack router set <router_name> --external-gateway <public_network_name>

2. Install the packages related to the Integration Test Suite:

   $ sudo dnf -y install openstack-tempest

   This command does not install any tempest plugins. You must install the plugins manually, depending on your RHOSP installation.

3. Install the appropriate tempest plugin for each component in your environment. For example, enter the following command to install the keystone, neutron, cinder, and telemetry plugins:

   $ sudo dnf install python3-keystone-tests-tempest python3-neutron-tests-tempest python3-cinder-tests-tempest python3-telemetry-tests-tempest

   For a full list of packages, see Integration Test Suite packages.

Procedure

1. Source the credentials for the target deployment:

   • If the target is in the undercloud, source the credentials for the undercloud:

     # source stackrc

   • If the target is in the overcloud, source the credentials for the overcloud:

     # source overcloudrc

2. Initialize tempest:

   # tempest init mytempest
   # cd mytempest

   This command creates a tempest workspace named mytempest.

3. Optional: Enter the following command to view a list of existing workspaces:

   # tempest workspace list

4. Generate the etc/tempest.conf file:

   # discover-tempest-config --deployer-input ~/tempest-deployer-input.conf \
   --debug --create --network-id <UUID>

   Replace UUID with the UUID of the external network.

   discover-tempest-config was formerly called config_tempest.py and uses the same parameters. python-tempestconf is as a dependency of openstack-tempest and provides the discover-tempest-config.

   Note

   To generate the etc/tempest.conf file for the undercloud, ensure that the region name in the tempest-deployer-input.conf file is the same as the name in the undercloud deployment. If these names do not match, update the region name in the tempest-deployer-input.conf file to match the region name of your undercloud.

5. To inspect the region name of your undercloud, enter the following commands:

   $ source stackrc
   $ openstack region list

6. To inspect the region name of your overcloud, enter the following commands:

   $ source overcloudrc
   $ openstack region list

Procedure

1. In tempest.conf, under the [DEFAULT] section, set log_dir to the desired directory:

   [DEFAULT]
   log_dir = <directory>

2. If you have your own logging configuration file, in tempest.conf, under the [DEFAULT] section, set log_config_append to your file:

   [DEFAULT]
   log_config_append = <file>

Procedure

1. Configure options in the tempest.conf configuration file to specify the target microversions. Configure these options to ensure that the supported microversions correspond to the microversions in the OpenStack cloud.

2. You can specify a range of target microversions to run multiple microversion tests in a single Integration Test Suite operation.

   For example, to limit the range of microversions for the compute service, in the [compute] section of your configuration file, assign values to the min_microversion and max_microversion parameters:

   [compute]
   min_microversion = 2.14
   max_microversion = latest

Procedure

1. Complete the dry run:

   # tempest cleanup --dry-run

2. Review the dry_run.json file to ensure that the cleanup does not delete any files that you require for your environment.

Procedure

1. Initialize the saved state to create the saved_state.json file:

   # tempest cleanup --init-saved-state

2. Perform the cleanup:

   # tempest cleanup