-# Copyright (c) 2016-2020 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
+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 the following are solved
+#
+# py311... Cython.Compiler.Main raises FutureWarning "Cython directive
+# 'language_level' not set, using 2 for now (Py2). This will change in a
+# later release!" but this can't be matched by message because it has a comma
+# py311... pip._vendor.pyparsing.core and pkg_resources._vendor.pyparsing raise
+# DeprecationWarning "module 'sre_constants' is deprecated" until a new
+# release containing https://github.com/pyparsing/pyparsing/commit/3c03942 is
+# vendored into pip and pkg_resources
+# py310... distutils.command.install raises DeprecationWarning "The
+# distutils.sysconfig module is deprecated, use sysconfig instead" but this
+# can't be matched by message because it contains a comma
+# flake8... flake8.plugins.manager raises DeprecationWarning "SelectableGroups
+# dict interface is deprecated. Use select."
+# multiple callers raise DeprecationWarning "The distutils package is
+# deprecated and slated for removal in Python 3.12. Use setuptools or check
+# PEP 632 for potential alternatives"
+# 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
+# pip._vendor.certifi.core and pip._vendor.pep517.in_process raise
+# DeprecationWarning "path is deprecated. Use files() instead. Refer to
+# https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy
+# for migration advice." but this can't be matched by message because it
+# contains a colon
setenv =
- PYTHONWARNINGS=default::DeprecationWarning
+ PYTHONWARNDFAULTENCODING = 1
+ PYTHONWARNINGS = error, ignore::FutureWarning:Cython.Compiler.Main, ignore::DeprecationWarning:distutils.command.install, ignore:The distutils package is deprecated and slated for removal in Python 3.12. Use setuptools or check PEP 632 for potential alternatives:DeprecationWarning, ignore:Creating a LegacyVersion has been deprecated and will be removed in the next major release:DeprecationWarning, ignore:SelectableGroups dict interface is deprecated. Use select.:DeprecationWarning:flake8.plugins.manager, 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::DeprecationWarning:pip._vendor.certifi.core, ignore::DeprecationWarning:pip._vendor.pep517.in_process, ignore:module 'sre_constants' is deprecated:DeprecationWarning:pip._vendor.pyparsing.core, ignore:module 'sre_constants' is deprecated:DeprecationWarning:pkg_resources._vendor.pyparsing
+ PYTHONUTF8 = 1
+ VIRTUALENV_CREATOR = venv
commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
+deps = {toxinidir}
[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]
-# TODO(fungi) switch to a proper PyPI dep once .codespellrc is supported in a
-# release version, and ratchet down deprecation warnings for it at that point
-#setenv =
-# PYTHONWARNINGS=error
-#deps = codespell
-deps = git+https://github.com/codespell-project/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
+ build
twine
- wheel
commands =
- rm -fr dist
- python setup.py bdist_wheel sdist
- twine check dist/*
-usedevelop = False
+ rm -fr {toxinidir}/dist
+ python -m build
+ twine check --strict {toxinidir}/dist/*
[testenv:docs]
-setenv =
- PYTHONWARNINGS=error
-whitelist_externals = rm
+# Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
+# files to include.
+description = generate hypertext documentation
+allowlist_externals = rm
deps =
- -r{toxinidir}/requirements.txt
- -r{toxinidir}/doc/requirements.txt
+ {toxinidir}
+ build
+ sphinx
commands =
- rm -fr doc/build
- python setup.py sdist
+ rm -fr {toxinidir}/doc/build
+ python -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]
-setenv =
- PYTHONWARNINGS=error
+description = style checks and static analysis of source code
deps =
flake8
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]
-setenv =
- PYTHONWARNINGS=error
-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 =
+ {toxinidir}
+ 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
projects / mudpy.git / blobdiff