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 # py310... distutils.command.install raises DeprecationWarning "The
  20 #   distutils.sysconfig module is deprecated, use sysconfig instead" but this
  21 #   can't be matched by message because it contains a comma
  22 # flake8... flake8.plugins.manager raises DeprecationWarning "SelectableGroups
  23 #   dict interface is deprecated. Use select."
  24 # multiple callers raise DeprecationWarning "The distutils package is
  25 #   deprecated and slated for removal in Python 3.12. Use setuptools or check
  26 #   PEP 632 for potential alternatives"
  27 # multiple callers raise DeprecationWarning "Creating a LegacyVersion has been
  28 #   deprecated and will be removed in the next major release"
  29 # SetupTools raises
  30 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "setup.py
  31 #   install is deprecated. Use build and pip and other standards-based tools."
  32 #   but only the message can be matched because the exception is private
  33 # SetupTools raises
  34 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning
  35 #   "setup_requires is deprecated. Supply build dependencies using PEP 517
  36 #   pyproject.toml build-requires." but only the message can be matched because
  37 #   the exception is private
  38 # SetupTools raises
  39 #   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "easy_install
  40 #   command is deprecated. Use build and pip and other standards-based tools."
  41 #   but only the message can be matched because the exception is private
  42 # pip._vendor.certifi.core and pip._vendor.pep517.in_process raise
  43 #   DeprecationWarning "path is deprecated. Use files() instead. Refer to
  44 #   https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy
  45 #   for migration advice." but this can't be matched by message because it
  46 #   contains a colon
  47 setenv =
  48     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
  49     VIRTUALENV_CREATOR = venv
  50 commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
  51 deps = {toxinidir}
  52
  53 [testenv:bandit]
  54 description = check for potential security risks in source code
  55 deps = bandit
  56 commands = bandit -r mudpy -x mudpy/tests {posargs}
  57
  58 [testenv:codespell]
  59 description = find common spelling mistakes in code and documentation
  60 deps = codespell
  61 commands = codespell {posargs}
  62
  63 [testenv:demo]
  64 description = start an interactive demo with the sample config
  65 commands = mudpy {posargs}
  66
  67 [testenv:dist]
  68 description = build release artifacts and check for conformance
  69 allowlist_externals = rm
  70 deps =
  71     build
  72     twine
  73 commands =
  74     rm -fr {toxinidir}/dist
  75     python -m build
  76     twine check --strict {toxinidir}/dist/*
  77
  78 [testenv:docs]
  79 # Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
  80 # files to include.
  81 description = generate hypertext documentation
  82 allowlist_externals = rm
  83 deps =
  84     {toxinidir}
  85     build
  86     sphinx
  87 commands =
  88     rm -fr {toxinidir}/doc/build
  89     python -m build --outdir={toxinidir}/doc/build/dist --sdist
  90     sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
  91
  92 [testenv:flake8]
  93 description = style checks and static analysis of source code
  94 deps =
  95     flake8
  96     flake8-bugbear
  97 commands = flake8 {posargs}
  98
  99 [testenv:selftest_config]
 100 description = run the selftest with the included sample config
 101 commands = mudpy_selftest etc/mudpy.yaml
 102
 103 [testenv:yamllint]
 104 # Run the selftest before checking YAML files so we'll be sure to also catch at
 105 # least some which are generated by the application, making sure it creates
 106 # them with the same style we enforce for those carried in the repository.
 107 description = test data files for correct syntax and formatting
 108 deps =
 109     {toxinidir}
 110     yamllint
 111 commands =
 112     mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
 113     yamllint --strict {posargs} .
 114
 115 [flake8]
 116 show-source = True
 117 exclude = .git, .tox, *lib/python*, *egg, build