Use consistent spacing in tox variables and lists

[mudpy.git] / tox.ini

diff --git a/tox.ini b/tox.ini
index d57c0d7..7cbc5e4 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,36 +1,47 @@
-# Copyright (c) 2016-2020 mudpy authors. Permission to use, copy,
+# Copyright (c) 2016-2021 mudpy authors. Permission to use, copy,
 # modify, and distribute this software is granted under terms
 # provided in the LICENSE file distributed with this software.
 
 [tox]
-minversion = 3.1
-envlist = bandit, dist, docs, flake8, yamllint, selftest_config, py3
+minversion = 3.18
+envlist = bandit, codespell, dist, docs, flake8, yamllint, selftest_config, py3
 skipsdist = True
 ignore_basepython_conflict = True
 
 [testenv]
+description = run the functional selftest with optimized configuration
 basepython = python3
 usedevelop = True
-install_command = pip install {opts} {packages}
-# TODO(fungi) Switch this to "error" and remove env-specific copies once
-# https://review.opendev.org/735433 and https://review.opendev.org/735443
-# merge and appear in a new PBR release
+# TODO(fungi) Switch this to "error" once
+# https://github.com/pypa/setuptools/issues/2086 and
+# https://github.com/pypa/setuptools/issues/2466 are fixed in a new release of
+# Setuptools and the vendored copy in Python 3.8 and later updated with it;
+# also that won't work for Python 3.6 due to the older Setuptools there still
+# calling imp instead of importlib so probably not while we still support 3.6
 setenv =
     PYTHONWARNINGS=default::DeprecationWarning
+    VIRTUALENV_CREATOR = venv
 commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
 
 [testenv:bandit]
-setenv =
-    PYTHONWARNINGS=error
+description = check for potential security risks in source code
 deps = bandit
 commands = bandit -r mudpy -x mudpy/tests {posargs}
 usedevelop = False
 
+[testenv:codespell]
+description = find common spelling mistakes in code and documentation
+deps = codespell
+commands = codespell {posargs}
+usedevelop = False
+
 [testenv:demo]
+description = start an interactive demo with the sample config
 commands = mudpy {posargs}
 
 [testenv:dist]
-whitelist_externals = rm
+description = build release artifacts and check for conformance
+allowlist_externals = rm
 deps =
     pbr
     twine
@@ -38,13 +49,12 @@ deps =
 commands =
     rm -fr dist
     python setup.py bdist_wheel sdist
-    twine check dist/*
+    twine check --strict dist/*
 usedevelop = False
 
 [testenv:docs]
-setenv =
-    PYTHONWARNINGS=error
-whitelist_externals = rm
+description = generate hypertext documentation
+allowlist_externals = rm
 deps =
     -r{toxinidir}/requirements.txt
     -r{toxinidir}/doc/requirements.txt
@@ -55,8 +65,7 @@ commands =
 usedevelop = False
 
 [testenv:flake8]
-setenv =
-    PYTHONWARNINGS=error
+description = style checks and static analysis of source code
 deps =
     flake8
     flake8-bugbear
@@ -64,15 +73,16 @@ commands = flake8 {posargs}
 usedevelop = False
 
 [testenv:selftest_config]
+description = run the selftest with the included sample config
 commands = mudpy_selftest etc/mudpy.yaml
 
 [testenv:yamllint]
-setenv =
-    PYTHONWARNINGS=error
+description = test data files for correct syntax and formatting
 deps = yamllint
-commands = yamllint --strict {posargs} .
-usedevelop = False
+commands =
+    mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
+    yamllint --strict {posargs} .
 
 [flake8]
 show-source = True
-exclude=.git,.tox,*lib/python*,*egg,build
+exclude = .git, .tox, *lib/python*, *egg, build