X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=blobdiff_plain;f=tox.ini;h=5a1a8087359c79a0440ec65b5e27bee053341b81;hp=3d21d4b3aeb8247eace65d7cd4eb61dc43022eac;hb=ebdb4771ec06e3c43cacc8d6dea6f23c30ebf5b8;hpb=9b539bfe237cf95ca6ba4055ae283fa55e7af7ff diff --git a/tox.ini b/tox.ini index 3d21d4b..5a1a808 100644 --- a/tox.ini +++ b/tox.ini @@ -1,42 +1,116 @@ -# Copyright (c) 2016-2018 Jeremy Stanley . Permission -# to use, copy, modify, and distribute this software is granted under -# terms provided in the LICENSE file distributed with this software. +# 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 = 2.0 -envlist = flake8, yamllint +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... 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 +# 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 +# filelock raises DeprecationWarning "use poll_interval instead of +# poll_intervall" setenv = - VIRTUAL_ENV={envdir} - PYTHONWARNINGS=default::DeprecationWarning -deps = -r{toxinidir}/test-requirements.txt -commands = python setup.py test --slowest --testr-args='{posargs}' + 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:use poll_interval instead of poll_intervall:DeprecationWarning + VIRTUALENV_CREATOR = venv +commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml + +[testenv:bandit] +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] -deps = pbr -commands = python setup.py bdist_wheel sdist +description = build release artifacts and check for conformance +allowlist_externals = rm +deps = + build + twine +commands = + rm -fr {toxinidir}/dist + python -m build + twine check --strict {toxinidir}/dist/* +usedevelop = False [testenv:docs] -whitelist_externals = rm -deps = -r{toxinidir}/doc/requirements.txt +# Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog +# files to include. Keep usedevelop on so that the project dependencies will be +# installed in the venv. +description = generate hypertext documentation +allowlist_externals = rm +deps = + build + sphinx commands = - rm -fr doc/build + 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 [testenv:flake8] +description = style checks and static analysis of source code +deps = + flake8 + flake8-bugbear commands = flake8 {posargs} +usedevelop = False -[testenv:yamllint] -commands = yamllint {posargs} . +[testenv:selftest_config] +description = run the selftest with the included sample config +commands = mudpy_selftest etc/mudpy.yaml -[testenv:venv] -commands = {posargs} +[testenv:yamllint] +# 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 = yamllint +commands = + mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml + yamllint --strict {posargs} . [flake8] show-source = True -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build +exclude = .git, .tox, *lib/python*, *egg, build