From 73c703e2ca29f20f44eb82c49992e4b0d2bdec10 Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Tue, 28 Feb 2023 00:32:21 +0000 Subject: [PATCH] Update the README file to use tox -e all This patch updates the README file to have instructions for running the tempest tests using the "all" environment instead of "all-plugins". The "all-plugins" environment has been deprecated for years and uses site-packages, which may cause unintended test scenarios. Change-Id: I297babd2e97ad146f60f32ae9073e47a62973860 --- README.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 8b5bd3cc..beb0f5a2 100644 --- a/README.rst +++ b/README.rst @@ -30,20 +30,26 @@ https://docs.openstack.org/tempest/latest/plugin.html Installing ---------- -Clone this repository to the destination machine, and call from the repo:: +From the tempest directory, setup the tempest virtual environment for the +Octavia tempest plugin:: - $ pip install -e . + $ tox -e venv-tempest -- pip3 install -e + +For example, when using a typical devstack setup:: + + $ cd /opt/stack/tempest + $ tox -e venv-tempest -- pip3 install -e /opt/stack/octavia-tempest-plugin Running the tests ----------------- To run all the tests from this plugin, call from the tempest repo:: - $ tox -e all-plugin -- octavia_tempest_plugin + $ tox -e all -- octavia_tempest_plugin To run a single test case, call with full path, for example:: - $ tox -e all-plugin -- octavia_tempest_plugin.tests.scenario.v2.test_traffic_ops.TrafficOperationsScenarioTest.test_basic_traffic + $ tox -e all -- octavia_tempest_plugin.tests.scenario.v2.test_traffic_ops.TrafficOperationsScenarioTest.test_basic_traffic To retrieve a list of all tempest tests, run::