tox.ini

[tox]
envlist =
    check-{style,security}
    test{,-oldestdeps,-alldeps}{,-pyargs,-warnings,-cov,-small}{,-xdist}
    build-docs
    build-docs-pdfusermanual-{exes,fifils,flitecam,forcast,hawc}
    build-dist

# tox environments are constructed with so-called 'factors' (or terms)
# separated by hyphens, e.g. test-oldestdeps-cov. Lines below starting with factor:
# will only take effect if that factor is included in the environment name. To
# see a list of example environments that can be run, along with a description,
# run:
#
#     tox -l -v
#

[testenv:check-style]
description = check code style with ruff
skip_install = true
deps =
    ruff
commands =
    ruff check {posargs:sofia_redux}

[testenv:check-security]
description = run bandit to check security compliance
skip_install = true
deps =
    bandit>=1.7
commands =
    bandit -r -ll -x sofia_redux/*test* -x sofia_redux/*/*test* sofia_redux

[testenv]
description =
    run tests
    oldestdeps: with the oldest supported version of key dependencies
    alldeps: with all optional dependencies
    pyargs: with --pyargs on installed package
    warnings: treating warnings as errors
    cov: with coverage
    small: skipping the most resource-intensive tests
basepython =
    oldestdeps: python3.11
pass_env =
    TOXENV
    CI
    CODECOV_*
    HOME
    STRICT_VALIDATION
    PASS_INVALID_VALUES
    VALIDATE_ON_ASSIGNMENT
    USERNAME
setenv =
    !alldeps: QT_QPA_PLATFORM = offscreen
    xdist: NUMBA_DISABLE_CACHE = 1
extras =
    test
    alldeps: all
    alldeps: test-display
deps =
    xdist: pytest-xdist
    oldestdeps: -r requirements-min.txt
package =
    !pyargs: editable
    pyargs: wheel
commands =
    pytest --durations=5 \
    xdist: -n auto \
    cov: --cov=sofia_redux --cov-report=xml --cov-report=html \
    !small: --run-slow --run-hugemem \
    warnings: -W error \
    pyargs: {toxinidir}/docs --pyargs sofia_redux \
    {posargs}

[testenv:build-docs]
description = invoke sphinx-build to build the HTML docs
extras =
    docs
allowlist_externals =
    rm
commands =
    rm -rf docs/api docs/_build/html
    sphinx-build docs docs/_build/html
    rm -rf docs/_build/html/.doctrees

[testenv:build-docs-pdfusermanual-{exes,fifils,flitecam,forcast,hawc}]
description = build the PDF user manual for the selected instrument
extras =
    docs
setenv =
    exes: INSTRUMENT=exes
    fifils: INSTRUMENT=fifils
    flitecam: INSTRUMENT=flitecam
    forcast: INSTRUMENT=forcast
    hawc: INSTRUMENT=hawc
allowlist_externals =
    rm
commands =
    rm -rf docs/_build/{env:INSTRUMENT}/users
    sphinx-build -M latexpdf \
        docs/manuals/{env:INSTRUMENT}/users \
        docs/_build/{env:INSTRUMENT}/users

[testenv:build-dist]
description = check build sdist/wheel
skip_install = true
allowlist_externals = rm
deps =
    build
commands =
    rm -rf dist
    python -m build