tox.ini

   1 # Copyright (c) 2016-2022 mudpy authors. Permission to use, copy,
   2 # modify, and distribute this software is granted under terms
   3 # provided in the LICENSE file distributed with this software.
   4
   5 [tox]
   6 minversion = 3.18
   7 envlist = bandit, codespell, dist, docs, flake8, yamllint, selftest_config, py3
   8 skipsdist = True
   9 ignore_basepython_conflict = True
  10
  11 [testenv]
  12 description = run the functional selftest with optimized configuration
  13 basepython = python3
  14 # TODO(fungi) Switch this to "error" once the following are solved
  15 #
  16 # py311... Cython.Compiler.Main raises FutureWarning "Cython directive
  17 #   'language_level' not set, using 2 for now (Py2). This will change in a
  18 #   later release!" but this can't be matched by message because it has a comma
  19 # py311... pip._internal.index.collector and Cython.Tempita raise
  20 #   DeprecationWarning "'cgi' is deprecated and slated for removal in Python
  21 #   3.13"
  22 # py311... passlib.utils raises DeprecationWarning "'crypt' is deprecated and
  23 #   slated for removal in Python 3.13"
  24 # py311... mudpy.tests.selftest raises DeprecationWarning "'telnetlib' is
  25 #   deprecated and slated for removal in Python 3.13"
  26 # py310... distutils.command.install raises DeprecationWarning "The
  27 #   distutils.sysconfig module is deprecated, use sysconfig instead" but this
  28 #   can't be matched by message because it contains a comma
  29 # flake8... flake8.plugins.manager raises DeprecationWarning "SelectableGroups
  30 #   dict interface is deprecated. Use select."
  31 # yamllint... setuptools.command.build_py raises
  32 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "Installing
  33 #   'yamllint.conf' as data is deprecated, please list it in `packages`. [...]"
  34 #   but the message can't be matched because it contains a comma and spans
  35 #   multiple lines while the custom Warning subclass can't be matched
  36 #   specifically leading to a blanket ignore for all Warning types in package
  37 #   builds
  38 # multiple callers raise DeprecationWarning "The distutils package is
  39 #   deprecated and slated for removal in Python 3.12. Use setuptools or check
  40 #   PEP 632 for potential alternatives"
  41 # multiple callers raise DeprecationWarning "Creating a LegacyVersion has been
  42 #   deprecated and will be removed in the next major release"
  43 # SetupTools raises
  44 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "setup.py
  45 #   install is deprecated. Use build and pip and other standards-based tools."
  46 #   but only the message can be matched because the exception is private
  47 # SetupTools raises
  48 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning
  49 #   "setup_requires is deprecated. Supply build dependencies using PEP 517
  50 #   pyproject.toml build-requires." but only the message can be matched because
  51 #   the exception is private
  52 # SetupTools raises
  53 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "easy_install
  54 #   command is deprecated. Use build and pip and other standards-based tools."
  55 #   but only the message can be matched because the exception is private
  56 # setuptools.config.pyprojecttoml raises
  57 #   setuptools.config.pyprojecttoml._ExperimentalProjectMetadata "Support for
  58 #   project metadata in `pyproject.toml` is still experimental and may be
  59 #   removed (or change) in future releases." but the parent Warning class has
  60 #   to be used instead
  61 # pip._vendor.certifi.core and pip._vendor.pep517.in_process raise
  62 #   DeprecationWarning "path is deprecated. Use files() instead. Refer to
  63 #   https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy
  64 #   for migration advice." but this can't be matched by message because it
  65 #   contains a colon
  66 setenv =
  67     PYTHONWARNDFAULTENCODING = 1
  68     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:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning:pip._internal.index.collector, ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning:Cython.Tempita, 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::Warning:setuptools.command.build_py, ignore:Support for project metadata in `pyproject.toml` is still experimental and may be removed (or change) in future releases.:Warning:setuptools.config.pyprojecttoml
  69     PYTHONUTF8 = 1
  70     VIRTUALENV_CREATOR = venv
  71 commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
  72 download = true
  73 deps = {toxinidir}
  74
  75 [testenv:bandit]
  76 description = check for potential security risks in source code
  77 skip_install = True
  78 deps = bandit
  79 commands = bandit -r mudpy -x mudpy/tests {posargs}
  80
  81 [testenv:codespell]
  82 description = find common spelling mistakes in code and documentation
  83 skip_install = True
  84 deps = codespell
  85 commands = codespell {posargs}
  86
  87 [testenv:demo]
  88 description = start an interactive demo with the sample config
  89 commands = mudpy {posargs}
  90
  91 [testenv:dist]
  92 description = build release artifacts and check for conformance
  93 skip_install = True
  94 deps =
  95     build
  96     twine
  97 commands =
  98     {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/dist', ignore_errors=True)"
  99     {envpython} -m build
 100     twine check --strict {toxinidir}/dist/*
 101
 102 [testenv:docs]
 103 # Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
 104 # files to include.
 105 description = generate hypertext documentation
 106 deps =
 107     {[testenv]deps}
 108     build
 109     sphinx
 110 commands =
 111     {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/doc/build', ignore_errors=True)"
 112     {envpython} -m build --outdir={toxinidir}/doc/build/dist --sdist
 113     sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
 114
 115 [testenv:flake8]
 116 description = style checks and static analysis of source code
 117 skip_install = True
 118 deps = flake8-bugbear
 119 commands = flake8 {posargs}
 120
 121 [testenv:selftest_config]
 122 description = run the selftest with the included sample config
 123 commands = mudpy_selftest etc/mudpy.yaml
 124
 125 [testenv:yamllint]
 126 # Run the selftest before checking YAML files so we'll be sure to also catch at
 127 # least some which are generated by the application, making sure it creates
 128 # them with the same style we enforce for those carried in the repository.
 129 description = test data files for correct syntax and formatting
 130 deps =
 131     {[testenv]deps}
 132     yamllint
 133 commands =
 134     mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
 135     yamllint --strict {posargs} .
 136
 137 [flake8]
 138 show-source = True
 139 exclude = .git, .tox, *lib/python*, *egg, build