tox.ini

[tox]
envlist =
    tests
    linting
    coverage
    type_check
skip_missing_interpreters = True
skipsdist = True

[testenv]
commands = python -m pip install --upgrade pip

[testenv:tests]
# the tests environment is called by the Github action that runs the unit tests
deps =
    -r requirements.txt
    .[tests]
setenv = PYTHONPATH = {toxinidir}/src
commands = python -m pytest --basetemp={envtmpdir} {posargs} --ignore integrationtests

[testenv:integrationtests]
passenv = AUTH0_TEST_CLIENT_ID,AUTH0_TEST_CLIENT_SECRET
# the integrationtests environment is called by the Github action that runs the integration tests
# other than the (unit) tests, this requires a docker container with transformer.bee to be running
deps =
    -r requirements.txt
    .[tests]
setenv = PYTHONPATH = {toxinidir}/src
commands = python -m pytest --basetemp={envtmpdir} {posargs} --ignore unittests

[testenv:linting]
# the linting environment is called by the Github Action that runs the linter
deps =
    {[testenv:tests]deps}
    .[linting]
    # add your fixtures like e.g. pytest_datafiles here
setenv = PYTHONPATH = {toxinidir}/src
commands =
    pylint transformerbeeclient
    pylint unittests --rcfile=unittests/.pylintrc
    pylint integrationtests --rcfile=integrationtests/.pylintrc
    # add single files (ending with .py) or packages here

[testenv:type_check]
# the type_check environment checks the type hints using mypy
setenv = PYTHONPATH = {toxinidir}/src
deps =
    {[testenv:tests]deps}
    .[type_check]
commands =
    mypy --show-error-codes src/transformerbeeclient
    mypy --show-error-codes unittests
    mypy --show-error-codes integrationtests
    # add single files (ending with .py) or packages here

[testenv:spell_check]
# the spellcheck environment checks the code for typos
setenv = PYTHONPATH = {toxinidir}/src
deps =
    -r requirements.txt
    .[spellcheck]
commands =
    codespell --ignore-words=domain-specific-terms.txt src
    codespell --ignore-words=domain-specific-terms.txt README.md
    # add single files (ending with .py) or packages here

[testenv:coverage]
passenv = AUTH0_TEST_CLIENT_ID,AUTH0_TEST_CLIENT_SECRET
# the coverage environment is called by the Github Action that runs the coverage measurement
changedir = integrationtests
deps =
    {[testenv:tests]deps}
    .[coverage]
setenv = PYTHONPATH = {toxinidir}/src
# note, that we collect the coverage from the integration test path here!
commands =
    coverage run -m pytest --basetemp={envtmpdir} {posargs}
    coverage html --omit .tox/*,integrationtests/*
    coverage report --fail-under 84 --omit .tox/*,integrationtests/*


[testenv:dev]
# the dev environment contains everything you need to start developing on your local machine.
deps =
    {[testenv:tests]deps}
    {[testenv:linting]deps}
    {[testenv:type_check]deps}
    {[testenv:coverage]deps}
    {[testenv:spell_check]deps}
    .[formatting]
    pip-tools
    pre-commit
commands =
    python -m pip install --upgrade pip
    pip-compile pyproject.toml
    pip install -r requirements.txt
    pre-commit install

[testenv:test_packaging]
skip_install = true
deps =
    .[packaging]
commands =
    python -m build
    twine check dist/*