# 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.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
# 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._internal.index.collector and Cython.Tempita raise
#   DeprecationWarning "'cgi' is deprecated and slated for removal in Python
#   3.13"
# 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"
# 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."
# yamllint... setuptools.command.build_py raises
#   setuptools._deprecation_warning.SetuptoolsDeprecationWarning "Installing
#   'yamllint.conf' as data is deprecated, please list it in `packages`. [...]"
#   but the message can't be matched because it contains a comma and spans
#   multiple lines while the custom Warning subclass can't be matched
#   specifically leading to a blanket ignore for all Warning types in package
#   builds
# 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
# setuptools.config.pyprojecttoml raises
#   setuptools.config.pyprojecttoml._ExperimentalProjectMetadata "Support for
#   project metadata in `pyproject.toml` is still experimental and may be
#   removed (or change) in future releases." but the parent Warning class has
#   to be used instead
# 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 =
    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:'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
    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}

[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]
description = build release artifacts and check for conformance
skip_install = True
deps =
    build
    twine
commands =
    {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/dist', ignore_errors=True)"
    {envpython} -m build
    twine check --strict {toxinidir}/dist/*

[testenv:docs]
# Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
# files to include.
description = generate hypertext documentation
deps =
    {[testenv]deps}
    build
    sphinx
commands =
    {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

[testenv:flake8]
description = style checks and static analysis of source code
skip_install = True
deps = flake8-bugbear
commands = flake8 {posargs}

[testenv:selftest_config]
description = run the selftest with the included sample config
commands = mudpy_selftest etc/mudpy.yaml

[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 =
    {[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