tox.ini

[tox]
envlist = ci

[testenv]
allowlist_externals =
    bash
    coverage
    sphinx-build
    twine
# shared directory for re-used packages
envdir = {toxinidir}/.env_tox
passenv =
    CI
    CLOUDSDK_*
    CONDA_PREFIX
    GITHUB_*
    GOOGLE_*
    GCLOUD_*
    GCP_*
    HOME

covargs = --cov={envsitepackagesdir}/pudl_catalog --cov-append --cov-report=xml
covreport = coverage report --sort=cover

###########################################################################
# Code and Documentation Linters
###########################################################################
[testenv:flake8]
description = Run the full suite of flake8 linters on the PUDL codebase.
skip_install = false
extras =
    tests
commands =
    flake8

[testenv:rstcheck]
description = Check formatting and syntax of RST files.
skip_install = false
extras =
    tests
commands =
    rstcheck --config tox.ini --recursive ./

[testenv:pre_commit]
description = Run git pre-commit hooks not covered by the other linters.
skip_install = false
extras =
    tests
commands =
    pre-commit run --all-files --show-diff-on-failure python-check-blanket-noqa
    pre-commit run --all-files --show-diff-on-failure python-no-eval
    pre-commit run --all-files --show-diff-on-failure python-no-log-warn
    pre-commit run --all-files --show-diff-on-failure check-merge-conflict
    pre-commit run --all-files --show-diff-on-failure check-yaml
    pre-commit run --all-files --show-diff-on-failure check-case-conflict
    pre-commit run --all-files --show-diff-on-failure debug-statements
    pre-commit run --all-files --show-diff-on-failure name-tests-test

[testenv:bandit]
description = Check the codebase for common insecure code patterns.
skip_install = false
extras =
    tests
commands =
    bandit -r src/package_name/

[testenv:linters]
description = Run the pre-commit & flake8 linters.
skip_install = false
extras =
    {[testenv:pre_commit]extras}
    {[testenv:bandit]extras}
    {[testenv:rstcheck]extras}
    {[testenv:flake8]extras}
commands =
    {[testenv:pre_commit]commands}
    {[testenv:bandit]commands}
    {[testenv:rstcheck]commands}
    {[testenv:flake8]commands}

#######################################################################################
# Lint and Build the Docs
#######################################################################################
[testenv:doc8]
description = Check the documentation input files for syntactical correctness.
skip_install = false
extras =
    docs
commands =
    doc8 docs/ README.rst

[testenv:docs]
description = Build the HTML docs from scratch using Sphinx.
skip_install = false
extras =
    {[testenv:doc8]extras}
commands =
    bash -c 'rm -rf docs/_build'
    {[testenv:doc8]commands}
    sphinx-build -W -b html docs docs/_build/html

#######################################################################################
# Test the code
#######################################################################################
[testenv:unit]
description = Run all the software unit tests.
extras =
    tests
commands =
    pytest {posargs} {[testenv]covargs} \
      --doctest-modules {envsitepackagesdir}/pudl_catalog \
      tests/unit

[testenv:integration]
description = Run all software integration tests
extras =
    tests
commands =
    pytest {posargs} {[testenv]covargs} tests/integration

[testenv:ci]
description = Run all continuous integration (CI) checks & generate test coverage.
skip_install = false
recreate = true
extras =
    {[testenv:linters]extras}
    {[testenv:docs]extras}
    {[testenv:unit]extras}
    {[testenv:integration]extras}
commands =
    coverage erase
    {[testenv:linters]commands}
    {[testenv:docs]commands}
    {[testenv:unit]commands}
    {[testenv:integration]commands}
    {[testenv]covreport}

#######################################################################################
# Software Package Build & Release
#######################################################################################
[testenv:build]
description = Prepare Python source and binary packages for release.
basepython = python3
skip_install = false
commands =
    bash -c 'rm -rf build/* dist/*'
    python setup.py sdist bdist_wheel

[testenv:testrelease]
description = Do a dry run of Python package release using the PyPI test server.
basepython = python3
skip_install = false
extras =
    dev
commands =
    {[testenv:build]commands}
    twine check dist/*
    twine upload --sign --verbose --repository testpypi --skip-existing dist/*

[testenv:release]
description = Release the PUDL package to the production PyPI server.
basepython = python3
skip_install = true
extras =
    dev
commands =
    {[testenv:build]commands}
    twine check dist/*
    twine upload --sign --verbose --skip-existing dist/*

#######################################################################################
# Configuration for various tools.
#######################################################################################
[pytest]
testpaths = tests
addopts = --verbose
log_format = %(asctime)s [%(levelname)8s] %(name)s:%(lineno)s %(message)s
log_date_format= %Y-%m-%d %H:%M:%S
log_cli = True
log_cli_level = INFO
doctest_optionflags = NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS

[flake8]
# A few linter errors and warnings that we are currently ignoring:
# * W503, W504: Line break before / after binary operator.
# * D401: Imperative mood.
# * E501: Overlong line
# * E203: Space before ':' (black recommends to ignore)
ignore = W503,W504,D401,E501,E203
inline-quotes = double
max-line-length = 88
extend-exclude =
    .env_tox,
    .eggs,
    build,
# We have a backlog of complex functions being skipped with noqa: C901
max-complexity = 10
format = ${cyan}%(path)s${reset}:${green}%(row)-4d${reset} ${red_bold}%(code)s${reset} %(text)s
extend-ignore =
# Google Python style is not RST until after processed by Napoleon
# See https://github.com/peterjc/flake8-rst-docstrings/issues/17
    RST201,RST203,RST301,
rst-roles =
    attr,
    class,
    doc,
    func,
    meth,
    mod,
    obj,
    py:const,
    ref,
    user,
rst-directives =
    envvar,
    exception,
percent-greedy = 2
format-greedy = 2

[doc8]
max-line-length = 88
ignore-path =
    docs/_build

[rstcheck]
report_level = warning
ignore_roles = pr,issue,user
ignore_messages = (Hyperlink target ".*" is not referenced\.$)
ignore directives = bibliography,todo