X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=blobdiff_plain;f=tox.ini;h=f9fd3933820bd2829927fff4d1514bba0f85de25;hp=23ac936f3ee1676e9e59ddd3301e8e4257dab57d;hb=HEAD;hpb=03ebfe3129537277ad82553b30f2093bbf5d8e84

diff --git a/tox.ini b/tox.ini
index 23ac936..33c4fb9 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,67 +1,112 @@
-# Copyright (c) 2016-2019 mudpy authors. Permission to use, copy,
+# Copyright (c) 2016-2022 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" once the following are solved
+#
+# py311... passlib.utils raises DeprecationWarning "'crypt' is deprecated and
+#   slated for removal in Python 3.13"
+# py311... mudpy.tests.selftest raises DeprecationWarning "'telnetlib' is
+#   deprecated and slated for removal in Python 3.13"
+# multiple callers raise DeprecationWarning "Creating a LegacyVersion has been
+#   deprecated and will be removed in the next major release"
+# SetupTools raises
+#   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "setup.py
+#   install is deprecated. Use build and pip and other standards-based tools."
+#   but only the message can be matched because the exception is private
+# SetupTools raises
+#   setuptools._deprecation_warning.SetuptoolsDeprecationWarning
+#   "setup_requires is deprecated. Supply build dependencies using PEP 517
+#   pyproject.toml build-requires." but only the message can be matched because
+#   the exception is private
+# SetupTools raises
+#   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "easy_install
+#   command is deprecated. Use build and pip and other standards-based tools."
+#   but only the message can be matched because the exception is private
+# setuptools.config.pyprojecttoml raises
+#   setuptools.config.pyprojecttoml._ExperimentalProjectMetadata "Support for
+#   `[tool.setuptools]` in `pyproject.toml` is still *beta*." but the parent
+#   Warning class has to be used instead
 setenv =
-    PYTHONWARNINGS=default::DeprecationWarning
+    PYTHONWARNDFAULTENCODING = 1
+    PYTHONWARNINGS = error, ignore:Creating a LegacyVersion has been deprecated and will be removed in the next major release:DeprecationWarning, ignore:setup.py install is deprecated. Use build and pip and other standards-based tools., ignore:easy_install command is deprecated. Use build and pip and other standards-based tools., ignore:'crypt' is deprecated and slated for removal in Python 3.13:DeprecationWarning:passlib.utils, ignore:'telnetlib' is deprecated and slated for removal in Python 3.13:DeprecationWarning:mudpy.tests.selftest, ignore:Support for `[tool.setuptools]` in `pyproject.toml` is still *beta*.:Warning:setuptools.config.pyprojecttoml
+    PYTHONUTF8 = 1
+    VIRTUALENV_CREATOR = venv
 commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
+download = true
+deps = {toxinidir}
 
 [testenv:bandit]
+description = check for potential security risks in source code
+skip_install = True
 deps = bandit
 commands = bandit -r mudpy -x mudpy/tests {posargs}
-usedevelop = False
+
+[testenv:codespell]
+description = find common spelling mistakes in code and documentation
+skip_install = True
+deps = codespell
+commands = codespell {posargs}
 
 [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
+skip_install = True
 deps =
-    pbr
+    build
     twine
-    wheel
 commands =
-    rm -fr dist
-    python setup.py bdist_wheel sdist
-    twine check dist/*
-usedevelop = False
+    {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/dist', ignore_errors=True)"
+    {envpython} -m build
+    twine check --strict {toxinidir}/dist/*
 
 [testenv:docs]
-whitelist_externals = rm
+# Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
+# files to include.
+description = generate hypertext documentation
 deps =
-    -r{toxinidir}/requirements.txt
-    -r{toxinidir}/doc/requirements.txt
+    {[testenv]deps}
+    build
+    sphinx
 commands =
-    rm -fr doc/build
-    python setup.py sdist
+    {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/doc/build', ignore_errors=True)"
+    {envpython} -m build --outdir={toxinidir}/doc/build/dist --sdist
     sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
-usedevelop = False
 
 [testenv:flake8]
-deps =
-    flake8
-    flake8-bugbear
+description = style checks and static analysis of source code
+skip_install = True
+deps = flake8-bugbear
 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]
-deps = yamllint
-commands = yamllint --strict {posargs} .
-usedevelop = False
+# Run the selftest before checking YAML files so we'll be sure to also catch at
+# least some which are generated by the application, making sure it creates
+# them with the same style we enforce for those carried in the repository.
+description = test data files for correct syntax and formatting
+deps =
+    {[testenv]deps}
+    yamllint
+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