tox.ini

[tox]
envlist =
    autoformat,
    py{37,38}-{local,integ,examples},
    noenvvars, sourcebuildcheck,
    {flake8,pylint}{,-tests,-examples},
    mypy,
    bandit,
    doc8, readme, docs,
    # prone to false positives
    vulture

##############################################################################################
# Additional environments:                                                                   #
#                                                                                            #
# autoformat : Apply all autoformatters.                                                     #
# lint :: Run all linters.                                                                   #
# vulture :: Run vulture. Prone to false-positives.                                          #
#                                                                                            #
# Operational helper environments:                                                           #
#                                                                                            #
# docs :: Build Sphinx documentation.                                                        #
# autodocs :: Build Sphinx documentation and start server, autobuilding on any file changes. #
# park :: Build name-parking packages using pypi-parker.                                     #
# build :: Build source and wheel dist files.                                                #
# test-release :: Build dist files and upload to testpypi pypirc profile.                    #
# release :: Build dist files and upload to pypi pypirc profile.                             #
# changelog :: Generate the changelog                                                        #
##############################################################################################

#########
# Tests #
#########

[testenv:base-command]
commands = pytest --basetemp={envtmpdir} -l --cov xy_tag {posargs}

[testenv]
passenv =
    # Pass through AWS credentials
    AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SESSION_TOKEN \
    # Pass through AWS profile name (useful for local testing)
    AWS_PROFILE \
    # Pass through the default AWS region (used for integration tests)
    AWS_DEFAULT_REGION \
    # Pass through PyPI variable
    PYPI_SECRET_ARN TWINE_PASSWORD
sitepackages = False
deps = -rtest/requirements.txt
commands =
    # Local tests: no network access required
    local: {[testenv:base-command]commands} test/ -m local
    # Integration tests: requires network access and might require service credentials
    integ: {[testenv:base-command]commands} test/ -m integ
    # Acceptance tests: testing against static test vectors : same requirements as integ
    accept: {[testenv:base-command]commands} test/ -m accept
    # Test the examples : same requirements as integ
    examples: {[testenv:base-command]commands} examples/test/ -m examples
    # Run all known tests : same requirements as integ
    all: {[testenv:base-command]commands} test/ examples/test/
    # You decide what tests to run
    manual: {[testenv:base-command]commands}

# Verify that local tests work without environment variables present
[testenv:noenvvars]
basepython = python3
sitepackages = False
deps = {[testenv]deps}
commands = {[testenv:base-command]commands} test/ -m local

# Verify that tests can be successfully run from the source build.
[testenv:sourcebuildcheck]
basepython = python3
sitepackages = False
recreate = True
deps =
    {[testenv:build]deps}
commands =
    {[testenv:build]commands}
    {toxinidir}/test/source-build-check.sh {envtmpdir} {toxinidir}/dist

###############
# Type checks #
###############

[testenv:mypy-coverage]
commands =
    # Make mypy linecoverage report readable by coverage
    python -c \
        "t = open('.coverage', 'w');\
        c = open('build/coverage.json').read();\
        t.write('!coverage.py: This is a private format, don\'t read it directly!\n');\
        t.write(c);\
        t.close()"
    coverage report -m

[testenv:mypy]
basepython = python3
deps =
    coverage
    mypy>=0.650
    mypy_extensions
    typing>=3.6.2
commands =
    python -m mypy \
        --linecoverage-report build \
        src/xy_tag/ \
        {posargs}
    {[testenv:mypy-coverage]commands}

###############################
# Formatting and style checks #
###############################

[testenv:flake8]
basepython = python3
deps =
    flake8
    flake8-docstrings
    flake8-isort
    flake8-print>=3.1.0
    flake8-bugbear
commands =
    flake8 \
        src/xy_tag/ \
        setup.py \
        doc/conf.py

[testenv:flake8-tests]
basepython = {[testenv:flake8]basepython}
deps = {[testenv:flake8]deps}
commands =
    flake8 \
        # Ignore F811 redefinition errors in tests (breaks with pytest-mock use)
        # Ignore F841 local variable assigned but never used (useful for collecting locals for test reports)
        # Ignore D101,D102,D103 docstring requirements for tests
        # Ignore B011 assert False warning (never run tests with python -O)
        --ignore F811,F841,D101,D102,D103,B011 \
        test/

[testenv:flake8-examples]
basepython = {[testenv:flake8]basepython}
deps = {[testenv:flake8]deps}
commands =
    flake8 \
        examples/src/
    flake8 \
        # Ignore F811 redefinition errors in tests (breaks with pytest-mock use)
        # Ignore F841 local variable assigned but never used (useful for collecting locals for test reports)
        # Ignore D101,D102,D103 docstring requirements for tests
        # Ignore B011 assert False warning (never run tests with python -O)
        --ignore F811,F841,D101,D102,D103,B011 \
        examples/test/

[testenv:pylint]
basepython = python3
deps =
    {[testenv]deps}
    pyflakes
    pylint>=2.0.0
commands =
    pylint \
        --rcfile=src/pylintrc \
        src/xy_tag/  \
        setup.py \
        doc/conf.py

[testenv:pylint-tests]
basepython = {[testenv:pylint]basepython}
deps = {[testenv:pylint]deps}
commands =
    pylint \
        --rcfile=test/pylintrc \
        test/unit/ \
        test/functional/ \
        test/integration/

[testenv:pylint-examples]
basepython = {[testenv:pylint]basepython}
deps = {[testenv:pylint]deps}
commands =
    pylint --rcfile=examples/src/pylintrc examples/src/
    pylint --rcfile=examples/test/pylintrc examples/test/

[testenv:bandit]
basepython = python3
deps = bandit
commands = bandit \
    # B322: Ignore Python 2 input check: we only support Python 3
    -s B322 \
    -r src/xy_tag/

# Prone to false positives: only run manually
[testenv:vulture]
basepython = python3
deps = vulture
commands = vulture src/xy_tag/

[testenv:blacken-src]
basepython = python3
deps =
    black
commands =
    black --line-length 120 \
        src/xy_tag/ \
        setup.py \
        doc/conf.py \
        test/ \
        examples/ \
        {posargs}

[testenv:blacken]
basepython = python3
deps =
    {[testenv:blacken-src]deps}
commands =
    {[testenv:blacken-src]commands}

[testenv:isort-seed]
basepython = python3
deps = seed-isort-config
commands = seed-isort-config

[testenv:isort]
basepython = python3
deps = isort
commands = isort \
    -rc \
        src \
        test \
        examples \
        doc \
        setup.py \
    {posargs}

[testenv:autoformat]
basepython = python3
deps =
    {[testenv:isort-seed]deps}
    {[testenv:isort]deps}
    {[testenv:blacken]deps}
commands =
    {[testenv:isort-seed]commands}
    {[testenv:isort]commands}
    {[testenv:blacken]commands}

[testenv:doc8]
basepython = python3
whitelist_externals = {[testenv:resetdocs]whitelist_externals}
deps =
    sphinx
    doc8
commands =
    {[testenv:resetdocs]commands}
    doc8 doc/index.rst doc/lib/ README.rst CHANGELOG.rst

[testenv:readme]
basepython = python3
deps = readme_renderer
commands = python setup.py check -r -s

[testenv:lint]
basepython = python3
whitelist_externals = {[testenv:resetdocs]whitelist_externals}
deps =
    {[testenv:autoformat]deps}
    {[testenv:flake8]deps}
    {[testenv:flake8-tests]deps}
    {[testenv:flake8-examples]deps}
    {[testenv:pylint]deps}
    {[testenv:pylint-tests]deps}
    {[testenv:pylint-examples]deps}
    {[testenv:doc8]deps}
    {[testenv:readme]deps}
    {[testenv:bandit]deps}
commands =
    {[testenv:autoformat]commands}
    {[testenv:flake8]commands}
    {[testenv:flake8-tests]commands}
    {[testenv:flake8-examples]commands}
    {[testenv:pylint]commands}
    {[testenv:pylint-tests]commands}
    {[testenv:pylint-examples]commands}
    {[testenv:doc8]commands}
    {[testenv:readme]commands}
    {[testenv:bandit]commands}

#################
# Documentation #
#################

# Clear out any generated files from doc/
[testenv:resetdocs]
skip_install = true
deps =
whitelist_externals =
    mkdir
    rm
commands =
    # Make sure that the directory exists to avoid
    # potential side effects of using rm -f
    mkdir -p {toxinidir}/doc/lib/generated
    rm -r {toxinidir}/doc/lib/generated

[testenv:assert-file-is-empty]
basepython = python3
commands =
    python -c \
        "import sys;\
        f = open(sys.argv[-1], 'r');\
        contents = f.read();\
        sys.exit(contents if contents.strip() else 0);\
        f.close()" \
        {posargs}

[testenv:docs-build]
basepython = python3
deps = {[testenv:docs]deps}
commands =
    sphinx-build -E -c {toxinidir}/doc/ -b html {toxinidir}/doc/ {toxinidir}/doc/build/html
    {[testenv:assert-file-is-empty]commands} "{toxinidir}/doc/build/html/output.txt"

[testenv:docs-spelling]
basepython = python3
deps = {[testenv:docs]deps}
commands =
    sphinx-build -E -c {toxinidir}/doc/  -b spelling {toxinidir}/doc/ {toxinidir}/doc/build/spelling
    {[testenv:assert-file-is-empty]commands} "{toxinidir}/doc/build/spelling/output.txt"

[testenv:docs-linkcheck]
basepython = python3
deps = {[testenv:docs]deps}
commands =
    sphinx-build -E -c {toxinidir}/doc/ -b linkcheck {toxinidir}/doc/ {toxinidir}/doc/build/linkcheck
    {[testenv:assert-file-is-empty]commands} "{toxinidir}/doc/build/linkcheck/output.txt"

[testenv:docs]
basepython = python3
deps =
    {[testenv]deps}
    -r{toxinidir}/doc/requirements.txt
commands =
    {[testenv:docs-build]commands}
    {[testenv:docs-spelling]commands}
    {[testenv:docs-linkcheck]commands}

[testenv:autodocs]
basepython = python3
deps =
    {[testenv:docs]deps}
    sphinx-autobuild
commands =
    sphinx-autobuild -E -c {toxinidir}/doc/ -b html {toxinidir}/doc/ {toxinidir}/doc/build/html \
        --watch . \
        --ignore .git/*

###################
# Release tooling #
###################

[testenv:park]
basepython = python3
skip_install = true
deps =
    pypi-parker
    setuptools
commands = python setup.py park

[testenv:build]
basepython = python3
skip_install = true
deps =
    wheel
    setuptools
commands =
    python setup.py bdist_wheel

[testenv:test-release]
basepython = python3
skip_install = true
ignore_errors = false
setenv =
    TWINE_REPOSITORY_URL = https://test.pypi.org/legacy/
    TWINE_USERNAME = __token__
deps =
    {[testenv:park]deps}
    {[testenv:build]deps}
    twine
whitelist_externals =
    rm
commands =
    rm -rf {toxinidir}/dist/
    {[testenv:park]commands}
    {[testenv:build]commands}
    twine upload --skip-existing {toxinidir}/dist/*

[testenv:release]
basepython = python3
skip_install = true
ignore_errors = false
setenv =
    TWINE_USERNAME = __token__
deps =
    {[testenv:park]deps}
    {[testenv:build]deps}
    twine
whitelist_externals =
    rm
commands =
    rm -rf {toxinidir}/dist/
    {[testenv:park]commands}
    {[testenv:build]commands}
    twine upload --skip-existing {toxinidir}/dist/*

[testenv:changelog]
skip_install = true
deps = towncrier
commands = towncrier {posargs}