From 887f1e9385a03c98db17ac2941c67a6fa0fd3612 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Fri, 26 Apr 2024 13:14:32 +0100
Subject: [PATCH] tox: Add testenv descriptions

Change-Id: I0a7880d72248e94690a973d3a1fd33c176ed658e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
 tox.ini | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/tox.ini b/tox.ini
index b97f72acea..e7c84c5110 100644
--- a/tox.ini
+++ b/tox.ini
@@ -3,6 +3,8 @@ minversion = 4.3.0
 envlist = py3,pep8
 
 [testenv]
+description =
+    Run unit tests.
 usedevelop = true
 setenv =
     OS_STDOUT_CAPTURE=1
@@ -16,6 +18,8 @@ commands =
     stestr run {posargs}
 
 [testenv:pep8]
+description =
+    Run style checks.
 skip_install = true
 deps =
     pre-commit
@@ -23,6 +27,8 @@ commands =
     pre-commit run --all-files --show-diff-on-failure
 
 [testenv:bandit]
+description =
+    Run bandit security checks.
 skip_install = true
 deps =
     pre-commit
@@ -39,6 +45,8 @@ commands =
     stestr run {posargs}
 
 [testenv:functional{,-tips,-py38,-py39,-py310,-py311,-py312}]
+description =
+    Run functional tests.
 setenv =
     OS_TEST_PATH=./openstackclient/tests/functional
 passenv =
@@ -52,6 +60,8 @@ commands =
     {[testenv]commands}
 
 [testenv:venv]
+description =
+    Run specified command in a virtual environment with all dependencies installed.
 deps =
     -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
     -r{toxinidir}/requirements.txt
@@ -60,22 +70,28 @@ commands =
     {posargs}
 
 [testenv:cover]
+description =
+    Run unit tests and generate coverage report.
 setenv =
-    VIRTUAL_ENV={envdir}
+    {[testenv]setenv}
     PYTHON=coverage run --source openstackclient --parallel-mode
 commands =
-    stestr -q run {posargs}
+    stestr run {posargs}
     coverage combine
     coverage html -d cover
     coverage xml -o cover/coverage.xml
 
 [testenv:debug]
+description =
+    Run specified tests through oslo_debug_helper, which allows use of pdb.
 passenv =
     OS_*
 commands =
     oslo_debug_helper -t openstackclient/tests {posargs}
 
 [testenv:docs]
+description =
+    Build documentation in HTML format.
 deps =
     -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
     -r{toxinidir}/doc/requirements.txt
@@ -86,6 +102,8 @@ commands =
     whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
 
 [testenv:releasenotes]
+description =
+    Build release note documentation in HTML format.
 deps =
     -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
     -r{toxinidir}/doc/requirements.txt