tox.ini

# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
envlist = bandit, docs, flake8, mypy, py310
ignore_base_python_conflict = True

[testenv]
basepython = python3
setenv = FRESHMAKER_TESTING_ENV = 1
usedevelop = true
skip_install = false
deps = -r{toxinidir}/test-requirements.txt
commands =
    python3 -m pytest \
        -W "ignore::UserWarning:flask.sessions" \
        -W "ignore:You do not have a working installation:UserWarning" \
        -W "ignore:inspect.getargspec:DeprecationWarning" \
        -W "ignore:This method will be removed in future versions.  Use 'parser.read_file()':DeprecationWarning" \
        -W "ignore:Use .persist_selectable:DeprecationWarning" \
        {posargs}

[testenv:flake8]
basepython = python3
skip_install = true
deps = flake8
commands = flake8

[testenv:mypy]
description = type check
# Pin to an older version of mypy since 0.902 does not seem to ignore missing imports
deps =
    mypy==0.812
commands =
        mypy --ignore-missing-imports --exclude freshmaker/migrations freshmaker tests

[testenv:bandit]
basepython = python3
skip_install = true
deps = bandit
allowlist_externals = /bin/bash
commands =
    ; 0.0.0.0 is set in BaseConfiguration, which is ok for local dev and it
    ; will be replace with a specific host IP when deploy to a server. So, it
    ; works to ignore B104.
    /bin/bash -c "bandit -r -s B104 -ll $(find . -mindepth 1 -maxdepth 1 ! -name tests ! -name \.\* -type d -o -name \*.py)"
ignore_outcome = True

[flake8]
skip_install = true
ignore = E501,E731,W504
exclude = dev_scripts/*,freshmaker/migrations/*,.tox/*,build/*,__pycache__,scripts/print_handlers_md.py,.copr/*,.env

[testenv:docs]
description = invoke sphinx-build to build the HTML docs
basepython = python3
deps =
    -r{toxinidir}/test-requirements.txt
    Sphinx>=4.2
    sphinx_rtd_theme
    sphinxcontrib-httpdomain
    sphinx_rtd_theme
commands =
    python3 -m 'sphinx' {toxinidir}/docs "{toxinidir}/docs/_build/html" -W {posargs}

[pytest]
addopts = --cov=freshmaker
testpaths = tests

[coverage:report]
skip_covered = 1
show_missing = 1
fail_under = 80
omit =
     .tox
     .env
     tests/*
     /usr/*