tox.ini

[tox]
envlist = {py35,py36,py37,py38}-beam{22,23,24},docs,manifest,check-formatting,lint

[testenv]
install_command = python -m pip install {opts} {packages}
extras = tests
deps =
    {toxinidir}/../core
    ; numpy 1.19+ does not support py3.5 (dependency via apache-beam)
    py35: numpy<1.19
    beam22: apache-beam[gcp]>=2.22.0,<2.23.0
    beam23: apache-beam[gcp]>=2.23.0,<2.24.0
    beam24: apache-beam[gcp]>=2.24.0,<2.25.0
    ; we'll leave old SDKs as a tox env available to invoke manually, but
    ; remove from `envlist` so they're not ran by default
commands =
    coverage run -m pytest {posargs}

[testenv:docs]
basepython = python3.6
extras = docs
; this otherwise inherits from [testenv]
deps =
    {toxinidir}/../core
commands =
    interrogate src --ignore-init-module --ignore-init-method \
        --ignore-semiprivate --ignore-private \
        --verbose --fail-under 0
    interrogate tests --ignore-init-module --ignore-init-method \
        --ignore-semiprivate --ignore-private \
        --fail-under 0 --verbose

[testenv:manifest]
; a safety check for source distributions
basepython = python3.6
deps = check-manifest
skip_install = true
commands = check-manifest

; This env just runs `black` and fails tox if it's not formatted correctly.
; If this env fails, run `tox -e format` locally in order to apply changes.
[testenv:check-formatting]
basepython = python3.6
deps = black==19.10b0
skip_install = true
commands =
    black src/klio tests --line-length 79 --diff --check

[testenv:format]
basepython = python3.6
deps = black==19.10b0
skip_install = true
commands =
    black --line-length 79 src/klio tests

[testenv:lint]
basepython = python3.6
deps =
    flake8
    flake8-import-order
    apache-license-check
skip_install = true
commands =
    flake8
    apache-license-check src tests setup.py --include-empty --copyright 'Spotify AB'

; The sections defined below are for configuring specific tools that are used
; in the above testenvs. Usually, if the tool is ran directly/outside of tox,
; i.e. `(env) $ pytest`, it will still pick up this configuration.

[flake8]
show-source = true
max-line-length = 80
exclude = .venv,.tox,.git,dist,doc,*.egg,build
import-order-style = edited
application-import-names = klio,tests
application-package-names = klio_core

[pytest]
addopts = -v --cov=klio --cov-config .coveragerc --cov-report=xml:cobertura/coverage.xml --cov-report=term-missing
testpaths = tests
filterwarnings =
    ; 3rd party libraries haven't updated their string escaping (py36+)
    ignore:invalid escape sequence:DeprecationWarning
    ; Apache Beam-related warnings
    ignore:Running the Apache Beam SDK on Python 3:UserWarning
    ignore:Some syntactic constructs of Python 3 are not yet fully supported by Apache Beam:UserWarning
    ignore:the imp module is deprecated in favour of importlib:DeprecationWarning
    ignore:You are using Apache Beam with Python 2:UserWarning
    ; protobuf & past packages (via Apache Beam) hasn't updated use of collections
    ignore:Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated:DeprecationWarning

; required for mapping envs -> github runtimes/envs
; will inherently run all beam versions in `envlist` per py version
[gh-actions]
python =
    3.5: py35
    3.6: py36, docs, manifest, check-formatting,lint
    3.7: py37
    3.8: py38