tox.ini

[tox]
envlist =
    check-{style,security,build}
    test{,-warnings,-cov,-xdist,-oldestdeps,-devdeps,-downstreamdeps}{-nolegacypath}
    test-{jwst,romancal}-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]
skip_install = true
description = Run all style and file checks with pre-commit
deps =
    pre-commit
commands =
    pre-commit install-hooks
    pre-commit run {posargs:--color always --all-files --show-diff-on-failure}

[testenv:check-security]
description = run bandit to check security compliance
skip_install = true
deps =
    bandit>=1.7
commands =
    bandit -r -ll src

[testenv]
description =
    run tests
    jwst: of JWST pipeline
    romancal: of Romancal pipeline
    oldestdeps: with the oldest supported version of key dependencies
    downstreamdeps: with the downstream packages that depend on stpipe
    warnings: treating warnings as errors
    cov: with coverage
    xdist: using parallel processing
extras =
    test
deps =
    xdist: pytest-xdist
    cov: pytest-cov
    jwst: jwst[test] @ git+https://github.com/spacetelescope/jwst.git
    romancal: romancal[test] @ git+https://github.com/spacetelescope/romancal.git
    oldestdeps: minimum_dependencies
    devdeps: astropy>=0.0.dev0
    downstreamdeps: jwst
    downstreamdeps: stdatamodels
    downstreamdeps: roman_datamodels
pass_env =
    CRDS_*
    CI
set_env =
    devdeps: PIP_EXTRA_INDEX_URL = https://pypi.anaconda.org/astropy/simple https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
    jwst: CRDS_SERVER_URL=https://jwst-crds.stsci.edu
    downstreamdeps: CRDS_SERVER_URL=https://jwst-crds.stsci.edu
    romancal: CRDS_SERVER_URL=https://roman-crds.stsci.edu
package =
    !cov: wheel
    cov: editable
allowlist_externals =
    echo
commands_pre =
    oldestdeps: minimum_dependencies stpipe --filename requirements-min.txt
    oldestdeps: pip install -r requirements-min.txt
    pip freeze
commands =
    pytest \
    warnings: -W error \
    nolegacypath: -p no:legacypath \
    xdist: -n auto \
    jwst: --pyargs jwst --ignore-glob=timeconversion --ignore-glob=associations --ignore-glob=*/scripts/* \
    romancal: --pyargs romancal \
    cov: --cov=src/stpipe --cov-config=pyproject.toml --cov-report=term-missing --cov-report=xml \
    {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 = build wheel and sdist
skip_install = true
deps =
    build
commands =
    python -m build .