tox.ini

[tox]
package = rstcheck

minversion = 3.15.0
requires =
    tox-envlist
skip_missing_interpreters = true
ignore_basepython_conflict = true
isolated_build = true
skipsdist = false

envlist =
    package
    pre-commit-run
    py{311,310,39,38,37}
    py{311,310,39,38,37}-with-sphinx{2,3,4,5}
    py{311,310,39,38,37}-with-tomli
    coverage-all
    docs-test-{html,linkcheck,coverage,doctest,spelling}


[envlists]
test = py{311,310,39,38,37},py{311,310,39,38,37}-with-sphinx{2,3,4,5},py{311,310,39,38,37}-with-tomli,coverage-all
py3.7 = py37,py37-with-sphinx{2,3,4,5},py37-with-tomli,coverage-all
py3.8 = py38,py38-with-sphinx{2,3,4,5},py38-with-tomli,coverage-all
py3.9 = py39,py39-with-sphinx{2,3,4,5},py39-with-tomli,coverage-all
py3.10 = py310,py310-with-sphinx{2,3,4,5},py310-with-tomli,package,coverage-all
py3.11 = py311,py311-with-sphinx{2,3,4,5},py311-with-tomli,package,coverage-all
docs = docs-test-{html,linkcheck,coverage,doctest,spelling}


[testenv]
description = basic config env
passenv =
    HOME
    CI
    CI_FORCE_COLORS_PRE_COMMIT
    CI_FORCE_COLORS_POETRY
    CI_FORCE_COLORS_PYTEST
    CI_FORCE_COLORS_SPHINX
setenv =
    PIP_DISABLE_VERSION_CHECK = 1
download = true


[testenv:pre-commit]
description = format and check the code
envdir = {toxworkdir}/pre-commit
passenv =
    {[testenv]passenv}
    SSH_AUTH_SOCK
    SKIP
setenv =
    {[testenv]setenv}
    SKIP = {tty:identity:},{env:SKIP:}
skip_install = true
deps = pre-commit >= 2.17
commands =
    pre-commit {posargs:--help}


[testenv:pre-commit-run]
description = install pre-commit as git hook from the tox env
envdir = {[testenv:pre-commit]envdir}
skip_install = {[testenv:pre-commit]skip_install}
deps = {[testenv:pre-commit]deps}
commands =
    pre-commit run {posargs} \
        --all-files \
        {tty::--show-diff-on-failure} \
        {tty:--color always:{env:CI_FORCE_COLORS_PRE_COMMIT:}}


[testenv:pre-commit-install]
description = install pre-commit as git hook from the tox env
envdir = {[testenv:pre-commit]envdir}
skip_install = {[testenv:pre-commit]skip_install}
deps = {[testenv:pre-commit]deps}
commands = pre-commit install


[testenv:mypy]
description = run mypy type checker
deps = mypy >=0.931
extras =
    sphinx
    toml
    testing
    docs
ignore_errors = true
commands =
    mypy src/rstcheck
    mypy tests
    mypy docs/source/conf.py
    mypy prep_release.py


[testenv:pylint]
description = run pylint linter
deps = pylint >= 2.12
extras =
    sphinx
    toml
    testing
    docs
commands = pylint src/rstcheck tests docs/source/conf.py prep_release.py


[testenv:package]
description = check sdist and wheel
skip_install = true
deps =
    poetry >= 1.1.13
    twine >= 3.3
commands =
    poetry build {tty:--ansi:{env:CI_FORCE_COLORS_POETRY:}} --no-interaction -vv
    twine check --strict dist/*


[testenv:py{311,310,39,38,37}]
description = run tests with {basepython}
passenv =
    {[testenv]passenv}
    PYTEST_*
setenv =
    {[testenv]setenv}
    COVERAGE_FILE = {env:COVERAGE_FILE:{toxinidir}/.coverage_cache/.coverage.{envname}}
extras = testing
commands =
    pytest \
        {tty:--color yes:{env:CI_FORCE_COLORS_PYTEST:}} \
        --basetemp {envtmpdir} \
        --cov {envsitepackagesdir}/{[tox]package} \
        --cov-fail-under 0 \
        {tty::-vvv} \
        {posargs:tests}


[testenv:py{311,310,39,38,37}-with-sphinx{2,3,4,5}]
description = run tests with {basepython} and sphinx
passenv =
    {[testenv]passenv}
    PYTEST_*
setenv =
    {[testenv]setenv}
    COVERAGE_FILE = {env:COVERAGE_FILE:{toxinidir}/.coverage_cache/.coverage.{envname}}
extras = testing
deps =
    sphinx2,sphinx3: jinja2<3
    sphinx2,sphinx3: markupsafe<2
    sphinx2: sphinx>=2,<3
    sphinx3: sphinx>=3,<4
    # With python 3.10 there is a failing import added in sphinx 3.5
    py310-sphinx3: sphinx>=3,<3.5
    py311-sphinx3: sphinx>=3,<3.5
    sphinx4: sphinx>=4,<5
    sphinx5: sphinx>=5,<6
commands =
    pytest \
        {tty:--color yes:{env:CI_FORCE_COLORS_PYTEST:}} \
        --basetemp {envtmpdir} \
        --cov {envsitepackagesdir}/{[tox]package} \
        --cov-fail-under 0 \
        {tty::-vvv} \
        {posargs:tests}


[testenv:py{311,310,39,38,37}-with-tomli]
description = run tests with {basepython} and tomli
passenv =
    {[testenv]passenv}
    PYTEST_*
setenv =
    {[testenv]setenv}
    COVERAGE_FILE = {env:COVERAGE_FILE:{toxinidir}/.coverage_cache/.coverage.{envname}}
extras =
    testing
    tomli
commands =
    pytest \
        {tty:--color yes:{env:CI_FORCE_COLORS_PYTEST:}} \
        --basetemp {envtmpdir} \
        --cov {envsitepackagesdir}/{[tox]package} \
        --cov-fail-under 0 \
        {tty::-vvv} \
        {posargs:tests}


[testenv:coverage-{all,merge,report}]
description =
    all,merge: combine coverage data and create xml/html reports;
    all,report: report total and diff coverage against origin/main (or DIFF_AGAINST)
envdir = {toxworkdir}/coverage
depends = py{py3,311,310,39,38}
passenv =
    {[testenv]passenv}
    all,report: MIN_COVERAGE
    all,report: MIN_DIFF_COVERAGE
    all,report: DIFF_AGAINST
    all,report: DIFF_RANGE_NOTATION
setenv =
    {[testenv]setenv}
    COVERAGE_FILE={toxinidir}/.coverage_cache/.coverage
skip_install = true
parallel_show_output = true
ignore_errors = true
deps =
    coverage[toml] >= 6
    coverage-conditional-plugin >= 0.5
    diff-cover
commands =
    all,merge:  coverage combine
    all,merge:  coverage xml -o {toxinidir}/.coverage_cache/coverage.xml
    all,merge:  coverage html -d {toxinidir}/.coverage_cache/htmlcov
    all,report: coverage report -m --fail-under {env:MIN_COVERAGE:0}
    all,report: diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} \
    all,report:     --ignore-staged --ignore-unstaged \
    all,report:     --fail-under {env:MIN_DIFF_COVERAGE:0} \
    all,report:     --diff-range-notation {env:DIFF_RANGE_NOTATION:..} \
    all,report:     {toxinidir}/.coverage_cache/coverage.xml


[testenv:docs{,-auto}]
description = build docs with sphinx
envdir = {toxworkdir}/docs
setenv =
    {[testenv]setenv}
    TOXENV_BUILDCMD = sphinx-build {tty:--color:}
    auto: TOXENV_BUILDCMD = sphinx-autobuild --re-ignore autoapidoc --watch {toxinidir}/src
extras =
    docs
    sphinx
    toml
commands =
    # Build fresh docs
    {env:TOXENV_BUILDCMD} -b html -aE docs/source docs/build/html
    # Output link to index.html
    python -c \
       'from pathlib import Path; \
        index_file = Path(r"{toxinidir}")/"docs/build/html/index.html"; \
        print(f"DOCUMENTATION AVAILABLE UNDER: \{index_file.as_uri()\}")'


[testenv:docs-test-{html,linkcheck,coverage,doctest,spelling}]
description = Build and check docs with (see env name) sphinx builder
envdir = {[testenv:docs]envdir}
setenv =
    {[testenv]setenv}
    html:       TOXENV_BUILDER = html
    linkcheck:  TOXENV_BUILDER = linkcheck
    coverage:   TOXENV_BUILDER = coverage
    doctest:    TOXENV_BUILDER = doctest
    spelling:   TOXENV_BUILDER = spelling
extras = {[testenv:docs]extras}
commands =
    sphinx-build \
        {tty:--color:{env:CI_FORCE_COLORS_SPHINX:}} \
        -b {env:TOXENV_BUILDER} \
        -aE -v -nW --keep-going \
        docs/source docs/build/test/{env:TOXENV_BUILDER}