[stable/1.6 only] Changes needed for full functionality of tox 4.0.0 runtime

Caps setuptools to version 64.* in order to avoid[1].

[1] https://github.com/pypa/setuptools/issues/3525

Closes-Bug: #2000867

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: Ib9e3d5c1a8bde890f915cf28baf58695a008abc9
(cherry picked from commit 970a940914)

.zuul.yaml

@@ -94,16 +94,22 @@
 
 - job:
     name: validations-libs-openstack-tox-linters-ubuntu-focal
+    vars:
+      ensure_tox_version: '<4'
     nodeset: ubuntu-focal
     parent: openstack-tox-linters
 
 - job:
     name: validations-libs-openstack-tox-cover-ubuntu-focal
+    vars:
+      ensure_tox_version: '<4'
     nodeset: ubuntu-focal
     parent: openstack-tox-cover
 
 - job:
     name: validations-libs-openstack-tox-docs-ubuntu-focal
+    vars:
+      ensure_tox_version: '<4'
     nodeset: ubuntu-focal
     parent: openstack-tox-docs
 

doc/source/conf.py

@@ -67,6 +67,7 @@ openstackdocs_bug_tag = 'documentation'
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
+autodoc_mock_imports = ['oslotest', 'ansible', 'ansible_runner']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

requirements.txt

@@ -2,6 +2,9 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
+# setuptools were capped in order to prevent https://github.com/pypa/setuptools/issues/3525
+# during the documentation build. (@jpodivin)
+setuptools<65.0.0 # MIT
 pbr>=3.1.1 # Apache-2.0
 six>=1.11.0 # MIT
 PyYAML>=3.13 # MIT

tox.ini

@@ -29,7 +29,7 @@ deps =
     -r {toxinidir}/requirements.txt
     -r {toxinidir}/test-requirements.txt
     -r {toxinidir}/doc/requirements.txt
-whitelist_externals = bash
+allowlist_externals = bash
 basepython = python3.8
 
 [testenv:bindep]
@@ -96,11 +96,12 @@ deps =
   -r {toxinidir}/test-requirements.txt
   -r {toxinidir}/doc/requirements.txt
 commands=
+  pip install {toxinidir}
   sphinx-build -a -E -W -d doc/build/doctrees --keep-going -b html doc/source doc/build/html -T
   doc8 doc
 
 [testenv:pdf-docs]
-whitelist_externals = make
+allowlist_externals = make
 description =
   Build PDF documentation.
 envdir = {toxworkdir}/docs