tox.ini

[tox]
envlist =
    check-{style,security,build}
    test{,-jwst}{,-devdeps}-xdist{,-cov}
    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 =
    flake8
commands =
    flake8 --count src tests {posargs}

[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
    xdist: using parallel processing
    cov: with coverage
pass_env =
    CRDS_*
set_env =
    cov: COVERAGE_RC_FILE=pyproject.toml
extras =
    test
deps =
    xdist: pytest-xdist
    cov: pytest-cov
    jwst: jwst[test] @ git+https://github.com/spacetelescope/jwst.git
    jwst: stpipe @ git+https://github.com/spacetelescope/stpipe.git
package=
    cov: editable
    !cov: wheel
commands_pre =
    devdeps: pip install -r requirements-dev.txt -U --upgrade-strategy eager
    pip freeze
commands =
    pytest \
    xdist: -n auto \
    cov: --cov=src --cov-report=term-missing --cov-report=xml \
    jwst: --pyargs jwst --ignore-glob=*/scripts/* \
    jwst: -o filterwarnings="[]" \
    # TODO: fix bug with `.finalize()` in `jwst.associations`
    jwst: --ignore-glob=*/associations/tests/test_dms.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 = build wheel and sdist
skip_install = true
deps =
    build
commands =
    python -m build .