tox.ini

[tox]
envlist =
    check-{style,security,dependencies}
    test{,-oldestdeps,-devdeps,-sdpdeps}{,-pyargs,-warnings,-regtests,-cov}-xdist
    build-{docs,dist}

# tox environments are constructed with so-called 'factors' (or terms)
# separated by hyphens, e.g. test-devdeps-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, e.g. with flake8
skip_install = true
deps =
    ruff
commands =
    ruff . {posargs}

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

[testenv:check-dependencies]
description = verify that install_requires in setup.cfg has correct dependencies
# `extras` needs to be empty to check modules without additional dependencies
extras =
deps =
    pytest
commands =
    verify_install_requires

[testenv]
description =
    run tests
    opencv: requiring opencv-python
    devdeps: with the latest developer version of key dependencies
    oldestdeps: with the oldest supported version of key dependencies
    sdpdeps: with the recent STScI DMS release pinned dependencies
    pyargs: with --pyargs on installed package
    warnings: treating warnings as errors
    regtests: with --bigdata and --slow flags
    cov: with coverage
    xdist: using parallel processing
pass_env =
    TOXENV
    CI
    CODECOV_*
    HOME
    CRDS_*
    STRICT_VALIDATION
    PASS_INVALID_VALUES
    VALIDATE_ON_ASSIGNMENT
    TEST_BIGDATA
setenv =
    sdpdeps,regtests: CRDS_CONTEXT = jwst-edit
extras =
    test
deps =
    xdist: pytest-xdist
    devdeps: -rrequirements-dev.txt
    sdpdeps: -rrequirements-sdp.txt
    opencv: opencv-python
package =
    !pyargs: editable
    pyargs: wheel
commands_pre =
# Generate a requirements-min.txt file
    oldestdeps: minimum_deps
# Force install everything in that file
    oldestdeps: pip install --ignore-installed -r requirements-min.txt
    pip freeze
commands =
    pip freeze
    pytest \
    cov: --cov=. --cov-config=setup.cfg --cov-report=xml \
    warnings: -W error \
    regtests: --bigdata --slow --basetemp={homedir}/test_outputs \
    xdist: -n auto \
    pyargs: {toxinidir}/docs --pyargs jwst \
    opencv: -- jwst/jump/tests/test_jump_step.py \
    {posargs}

[testenv:build-docs]
description = invoke sphinx-build to build the HTML docs
extras = docs
commands =
    sphinx-build -W docs docs/_build

[testenv:build-dist]
description = check build sdist/wheel and a strict twine check for metadata
skip_install = true
deps =
    build
commands =
    python -m build