From 8c932e4c215b85b95ee27214ec47ee5ccfe5a952 Mon Sep 17 00:00:00 2001
From: Ron Stone <ronald.stone@windriver.com>
Date: Fri, 13 Jan 2023 10:29:50 -0500
Subject: [PATCH] Pin tox to be less than 4

The dev environment used by some docs developers uses
an old version of tox, and does not support the
whitelist_externals entry required by tox 4.

The version of tox used by some other developers cannot
support tox.ini that contains both allowlist_externals and
whitelist_externals in the same file.

The fix for now is to stay with whitelist_externals and tox<4

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ib398b6b552d8dfd4d53a6581a3d91f3a3800a30c
---
 .zuul.yaml |  2 ++
 tox.ini    | 16 +++++-----------
 2 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 14395d18d..0cbce6540 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,5 +1,7 @@
 ---
 - project:
+    vars:
+      ensure_tox_version: '<4'
     templates:
       - stx-api-ref-jobs
     check:
diff --git a/tox.ini b/tox.ini
index 2a1227b72..2a9ceabdb 100644
--- a/tox.ini
+++ b/tox.ini
@@ -18,21 +18,18 @@ deps =
 commands =
   sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b html doc/source doc/build/html {posargs}
   bash htmlChecks.sh
-allowlist_externals = bash
+whitelist_externals = bash
                       htmlChecks.sh
-whitelist_externals = {[testenv:docs]allowlist_externals}
 
 [testenv:api-ref]
 deps = {[testenv:docs]deps}
 commands =
   rm -rf api-ref/build
   sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
-allowlist_externals = rm
-whitelist_externals = {[testenv:api-ref]allowlist_externals}
+whitelist_externals = rm
 
 [testenv:linters]
-allowlist_externals = bash
-whitelist_externals = {[testenv:linters]allowlist_externals}
+whitelist_externals = bash
 commands =
   bash -c "find {toxinidir}                   \
             \( -name .tox -prune \)           \
@@ -50,16 +47,14 @@ passenv=PWD
 commands =
        bash -c "echo Running in {env:PWD}"
        bash new-topic.sh {env:PWD} {toxinidir}
-allowlist_externals = new-topic.sh
+whitelist_externals = new-topic.sh
                       bash
-whitelist_externals = {[testenv:newfile]allowlist_externals}
 
 [testenv:picks]
 commands =
        ./pickCompare.sh
-allowlist_externals = pickCompare.sh
+whitelist_externals = pickCompare.sh
                       bash
-whitelist_externals = {[testenv:picks]allowlist_externals}
 
 
 [testenv:linkcheck]
@@ -75,4 +70,3 @@ deps =
   sphinxcontrib-spelling==7.3.2
 commands =
        sphinx-build -a -E --keep-going -d doc/build/doctrees -t starlingx -t openstack -t use_spellext -b spelling doc/source doc/build/spelling {posargs}
-