tox.ini

[tox]
envlist = generate-fixture-yml, linting, doclinting, ruleslinting, docbuild, cov-init, doctests, py{37,38,39,310}, dbt{017,018,019,020,021,100,130}-py{37,38,39,310}, cov-report, bench, mypy, winpy, dbt{017,018,019,020,021,100,130}-winpy, yamllint

[testenv]
passenv = CI CIRCLECI CIRCLE_* HOME SQLFLUFF_BENCHMARK_API_KEY
# Have option to explictly set TMPDIR for python as on GitHub Action Windows
# machines it doesn't read this from env and resets to system default, which
# is often on different drive (C) from working dir (D), which causes problems.
setenv =
    SQLFLUFF_TESTENV = 1
    COVERAGE_FILE = .coverage.{envname}
    winpy: TMPDIR = temp_pytest
allowlist_externals =
    make
pip_pre = true
deps =
    # -U keeps dev requirements up-to-date
    -Urrequirements_dev.txt
    # Add the example plugin
    plugins/sqlfluff-plugin-example
    # Define dbt versions
    dbt020: dbt-core==0.20.2
    dbt021: dbt-core==0.21.0
    dbt100: dbt-core==1.0.0
    dbt130: dbt-core>1.2,<1.4.0
    # Define dbt-postgres versions
    dbt020: dbt-postgres==0.20.2
    dbt021: dbt-postgres==0.21.0
    dbt100: dbt-postgres==1.0.0
    dbt130: dbt-postgres>1.2,<1.4.0
# Include any other steps necessary for testing below.
# {posargs} is there to allow us to specify specific tests, which
# can then be invoked from tox by calling e.g.
# tox -e py35 -- project/tests/test_file.py::TestClassName::test_method
commands =
    # Install the plugins as required
    dbt{020,021,100,130}: python -m pip install {toxinidir}/plugins/sqlfluff-templater-dbt
    # For the dbt test cases install dependencies.
    python {toxinidir}/plugins/sqlfluff-templater-dbt/test/generate_packages_yml.py {toxinidir}/plugins/sqlfluff-templater-dbt/test/fixtures/dbt/dbt_project
    dbt{020,021,100,130}: dbt deps --project-dir {toxinidir}/plugins/sqlfluff-templater-dbt/test/fixtures/dbt/dbt_project --profiles-dir {toxinidir}/plugins/sqlfluff-templater-dbt/test/fixtures/dbt
    # Clean up from previous tests
    python {toxinidir}/util.py clean-tests
    # Run tests
    pytest -vv -rs --cov=sqlfluff --cov-report=xml {posargs: {toxinidir}/test} -m "not integration_test"

[testenv:cov-init]
setenv =
    COVERAGE_FILE = .coverage
commands =
    coverage erase

[testenv:bench]
commands =
    python {toxinidir}/util.py benchmark -f {toxinidir}/benchmarks/benchmarks.yml

[testenv:cov-report]
setenv =
    COVERAGE_FILE = .coverage
commands =
    coverage combine
    # Exclude dbt templater by default as those tests do not run without dbt
    coverage report --fail-under=100 --show-missing --omit "*templaters/dbt.py,*/dbt_templater/*"

# Have copy of above for full coverage - including dbt - for those that want it
[testenv:cov-report-dbt]
setenv =
    COVERAGE_FILE = .coverage
commands =
    coverage combine
    coverage report --fail-under=100 --show-missing

[testenv:generate-fixture-yml]
commands = python {toxinidir}/test/generate_parse_fixture_yml.py {posargs}

[testenv:linting]
skip_install = true
commands = flake8

[testenv:ruleslinting]
commands = pytest -vv -rs --cov=sqlfluff --cov-report=xml {posargs: {toxinidir}/test} -m "integration_test"

[testenv:doctests]
commands = pytest -vv -rs --cov=sqlfluff --cov-report=xml --doctest-modules {posargs: {toxinidir}/src}

[testenv:yamllint]
skip_install = true
deps = yamllint
commands = yamllint -c .yamllint .

[testenv:doclinting]
skip_install = true
commands = doc8 {toxinidir}/docs/source --file-encoding utf8

[testenv:docbuild]
deps =
    # -U keeps all requirements up-to-date
    -Urdocs/requirements.txt
commands = make -C {toxinidir}/docs html

[testenv:mypy]
skip_install = true
commands = mypy {toxinidir}/src/sqlfluff

[testenv:build-dist]
skip_install = true
deps =
    build
commands =
    python -m build --sdist --wheel {posargs: {toxinidir}}

[testenv:check-dist]
skip_install = true
deps =
    twine
commands =
    twine check {toxinidir}/dist/*

[testenv:publish-dist]
skip_install = true
deps =
    {[testenv:build-dist]deps}
    twine
commands =
    {[testenv:build-dist]commands}
    twine upload --skip-existing {toxinidir}/dist/*

[testenv:pre-commit]
skip_install = true
deps = pre-commit
commands =
    pre-commit {posargs:run --all-files}

[flake8]
# Ignore:
# W503: Line breaks before binary operators
# D107: Don't require docstrings on __init__
# D105: Don't require docstrings on magic methods
ignore = W503, D107, D105, D418
exclude = .git,__pycache__,env,.tox,build,.venv,venv,.coverage.py
max-line-length = 88
extend-ignore =
    # See https://github.com/PyCQA/pycodestyle/issues/373
    E203,
# sqlfluff uses flake8-docstrings https://pypi.org/project/flake8-docstrings/
# this is to assist with the sphinx based autodoc
docstring-convention = google

[pytest]
python_files = *_test.py
testpaths = test

[coverage:run]
source = src/sqlfluff
omit = src/sqlfluff/__main__.py

[coverage:report]
exclude_lines =
    sys.version_info
    pragma: no cover