tox.ini

# SPDX-FileCopyrightText: 2022 Aleksandr Mezin <mezin.alexander@gmail.com>
#
# SPDX-License-Identifier: CC0-1.0

[tox]
minversion = 4.0
skipsdist = true
envlist =
    eslint
    markdownlint
    flake8
    reuse
    version
    meson-test
    meson-test-legacy

[testenv]
passenv =
    FORCE_COLOR
    GITHUB_ACTIONS
    PIP_DISABLE_PIP_VERSION_CHECK
    DDTERM_BUILT_PACK

suicide_timeout = 15
interrupt_timeout = 15
terminate_timeout = 15

[testenv:pip-compile]
description = Lock Python dependencies
deps = -r requirements/pip-compile.txt
changedir = {toxinidir}/requirements
commands =
    {envpython} -m piptools compile --strip-extras {posargs} test.in
    {envpython} -m piptools compile --strip-extras {posargs} test-images.in
    {envpython} -m piptools compile --strip-extras {posargs} flake8.in
    {envpython} -m piptools compile --strip-extras {posargs} reuse.in
    {envpython} -m piptools compile --strip-extras {posargs} meson.in
    {envpython} -m piptools compile --strip-extras {posargs} version.in
    {envpython} -m piptools compile --strip-extras {posargs} pip-compile.in

[testenv:pytest]
description = Run tests using pytest (advanced)
deps = -r tests/requirements.txt

# https://github.com/pytest-dev/pytest/issues/10451
commands_pre = rm -f '{envsitepackagesdir}/py.py'
allowlist_externals = rm

commands = {envpython} -m pytest --html=tests/report.html --dist=worksteal {posargs}

[testenv:meson{,-test}{,-legacy}]
description =
    Build
    test: and test
    !legacy: esm
    legacy: legacy
    package using Meson

base =
    test: testenv:pytest

deps =
    -r requirements/meson.txt
    test: {[testenv:pytest]deps}

commands_pre =
    test: {[testenv:pytest]commands_pre}
    {envpython} -m mesonbuild.mesonmain setup --reconfigure {env:CONFIGURE_FLAGS} {toxinidir}

commands =
    test: {envpython} -m mesonbuild.mesonmain {posargs:test --no-suite lint-source}
    !test: {envpython} -m mesonbuild.mesonmain {posargs:compile}

changedir = {envdir}

setenv =
    CONFIGURE_FLAGS={env:CONFIGURE_FLAGS}
    legacy: CONFIGURE_FLAGS={env:CONFIGURE_FLAGS} -Desm=false

passenv =
    DISPLAY
    XAUTHORITY

[testenv:test{,-legacy}]
description =
    Test
    !legacy: esm
    legacy: legacy
    package using pytest. It needs to be built by running
    !legacy: meson
    legacy: meson-legacy
    before

base = testenv:pytest

depends =
    !legacy: meson
    legacy: meson-legacy

setenv =
    DDTERM_BUILT_PACK={env:DDTERM_BUILT_PACK:{[testenv:meson]changedir}/ddterm@amezin.github.com.shell-extension.zip}
    legacy: DDTERM_BUILT_PACK={[testenv:meson-legacy]changedir}/ddterm@amezin.github.com.legacy.shell-extension.zip

[testenv:images]
description = Manage container images for pytest
deps = -r requirements/test-images.txt
commands = {envpython} tests/images.py {posargs: pull}

[testenv:flake8]
description = Check Python source code using flake8
deps = -r requirements/flake8.txt
commands = {envpython} -m flake8 {posargs}

[testenv:reuse]
description = Check source code for REUSE compliance
deps = -r requirements/reuse.txt
commands = {envpython} -m reuse {posargs: lint}

[testenv:eslint]
description = Check JavaScript source code using ESLint
deps =
allowlist_externals = npm
commands_pre = npm install
commands = npm run-script lint:eslint -- {posargs}

[testenv:markdownlint]
description = Check Markdown files
deps =
allowlist_externals = npm
commands_pre = npm install
commands = npm run-script lint:markdownlint -- {posargs}

[testenv:version]
description = Manage version number
deps = -r requirements/version.txt
commands = {envpython} -m bumpversion {posargs: bump --dry-run --allow-dirty major}