tox.ini

[coverage:report]
skip_covered = False
show_missing = True
[coverage:run]
branch = true
parallel = true
omit = */snowflake/connector/tool/*
       */snowflake/connector/vendored/*
       src/snowflake/connector/incident.py
[coverage:paths]
source = src/snowflake/connector
         */.tox/*/lib/python*/site-packages/snowflake/connector
         */.tox\*\Lib\site-packages\snowflake\connector
         */src/snowflake/connector
         *\src\snowflake\connector
         */fips_env/lib/python*/site-packages/snowflake/connector

[tox]
minversion = 4
envlist = fix_lint,
          py{39,310,311,312,313}-{extras,unit-parallel,integ,pandas,sso},
          coverage
skip_missing_interpreters = true

[testenv]
description = run the tests with pytest under {basepython}
extras =
    development
    pandas: pandas
    sso: secure-local-storage
package = wheel
setenv =
    COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
    ci: SNOWFLAKE_PYTEST_OPTS = -vvv
    # Set test type, either notset, unit, integ, or both
    unit-integ: SNOWFLAKE_TEST_TYPE = (unit or integ)
    !unit-!integ: SNOWFLAKE_TEST_TYPE = (unit or integ)
    auth: SNOWFLAKE_TEST_TYPE = auth
    unit: SNOWFLAKE_TEST_TYPE = unit
    integ: SNOWFLAKE_TEST_TYPE = integ
    parallel: SNOWFLAKE_PYTEST_OPTS = {env:SNOWFLAKE_PYTEST_OPTS:} -n auto
    # Add common parts into pytest command
    SNOWFLAKE_PYTEST_COV_LOCATION = {env:JUNIT_REPORT_DIR:{toxworkdir}}/junit.{envname}-{env:cloud_provider:dev}.xml
    SNOWFLAKE_PYTEST_COV_CMD = --cov snowflake.connector --junitxml {env:SNOWFLAKE_PYTEST_COV_LOCATION} --cov-report=
    SNOWFLAKE_PYTEST_CMD = pytest {env:SNOWFLAKE_PYTEST_OPTS:} {env:SNOWFLAKE_PYTEST_COV_CMD}
    SNOWFLAKE_TEST_MODE = true
passenv =
    AWS_ACCESS_KEY_ID
    AWS_SECRET_ACCESS_KEY
    SF_PROJECT_ROOT
    cloud_provider
    SF_REGRESS_LOGS
    # Github Actions provided environmental variables
    GITHUB_ACTIONS
    JENKINS_HOME
    # This is required on windows. Otherwise pwd module won't be imported successfully,
    # see https://github.com/tox-dev/tox/issues/1455
    USERNAME
    CLIENT_LOG_DIR_PATH_DOCKER
    PYTEST_ADDOPTS
commands =
    # Test environments
    # Note: make sure to have a default env and all the other special ones
    !pandas-!sso-!lambda-!extras: {env:SNOWFLAKE_PYTEST_CMD} -m "{env:SNOWFLAKE_TEST_TYPE} and not sso and not pandas and not lambda" {posargs:} test
    pandas: {env:SNOWFLAKE_PYTEST_CMD} -m "{env:SNOWFLAKE_TEST_TYPE} and pandas" {posargs:} test
    sso: {env:SNOWFLAKE_PYTEST_CMD} -m "{env:SNOWFLAKE_TEST_TYPE} and sso" {posargs:} test
    lambda: {env:SNOWFLAKE_PYTEST_CMD} -m "{env:SNOWFLAKE_TEST_TYPE} and lambda" {posargs:} test
    extras: python -m test.extras.run {posargs:}

[testenv:olddriver]
basepython = python3.9
description = run the old driver tests with pytest under {basepython}
deps =
    pip >= 19.3.1
    pyOpenSSL<=25.0.0
    snowflake-connector-python==3.0.2
    azure-storage-blob==2.1.0
    pandas==2.0.3
    numpy==1.26.4
    pendulum!=2.1.1
    pytest<6.1.0
    pytest-cov
    pytest-rerunfailures
    pytest-timeout
    pytest-xdist
    mock
skip_install = True
setenv = {[testenv]setenv}
passenv = {[testenv]passenv}
commands =
    # Unit and pandas tests are already skipped for the old driver (see test/conftest.py). Avoid walking those
    # directories entirely to avoid loading any potentially incompatible subdirectories' own conftest.py files.
    {env:SNOWFLAKE_PYTEST_CMD} --ignore=test/unit --ignore=test/pandas -m "not skipolddriver" -vvv {posargs:} test

[testenv:noarrowextension]
basepython = python3.9
skip_install = True
description = run import with no arrow extension under {basepython}
setenv = SNOWFLAKE_DISABLE_COMPILE_ARROW_EXTENSIONS=1
commands =
    pip install .
    python -c 'import snowflake.connector.result_batch'

[testenv:coverage]
description = [run locally after tests]: combine coverage data and create report
;              generates a diff coverage against origin/master (can be changed by setting DIFF_AGAINST env var)
deps =
       coverage
;       diff_cover
skip_install = True
passenv = DIFF_AGAINST
setenv = COVERAGE_FILE={toxworkdir}/.coverage
commands = coverage combine
           coverage report -m
           coverage xml -o {env:COV_REPORT_DIR:{toxworkdir}}/coverage.xml
           coverage html -d {env:COV_REPORT_DIR:{toxworkdir}}/htmlcov
;           diff-cover --compare-branch {env:DIFF_AGAINST:origin/master} {toxworkdir}/coverage.xml
depends = py39, py310, py311, py312, py313

[testenv:py{39,310,311,312,313}-coverage]
# I hate doing this, but this env is for Jenkins, please keep it up-to-date with the one env above it if necessary
description = [run locally after tests]: combine coverage data and create report specifically with {basepython}
deps = {[testenv:coverage]deps}
skip_install = {[testenv:coverage]skip_install}
passenv = {[testenv:coverage]passenv}
setenv = {[testenv:coverage]setenv}
commands = {[testenv:coverage]commands}
depends = {[testenv:coverage]depends}

[testenv:flake8]
; DEPRECATED
description = check code style with flake8
skip_install = true
deps = flake8
commands = flake8 {posargs}

[testenv:fix_lint]
basepython = python3.9
description = format the code base to adhere to our styles, and complain about what we cannot do automatically
passenv =
    PROGRAMDATA
deps =
    pre-commit >= 2.9.0
skip_install = True
commands = pre-commit run --all-files
           python -c 'import pathlib; print("hint: run \{\} install to add checks as pre-commit hook".format(pathlib.Path(r"{envdir}") / "bin" / "pre-commit"))'

[testenv:dependency]
description = Check if there is conflicting dependency
deps =
    pip-tools
skip_install = True
commands = pip-compile setup.py
depends = py39, py310, py311, py312, py313

[pytest]
log_level = info
addopts = -ra --strict-markers
junit_family = legacy
filterwarnings =
    error::UserWarning:cryptography.*
    error::cryptography.utils.CryptographyDeprecationWarning
markers =
    # Optional dependency groups markers
    lambda: AWS lambda tests
    pandas: tests for pandas integration
    sso: tests for sso optional dependency integration
    # Cloud provider markers
    aws: tests for Amazon Cloud storage
    azure: tests for Azure Cloud storage
    gcp: tests for Google Cloud storage
    # Test type markers
    integ: integration tests
    unit: unit tests
    auth: tests for authentication
    skipolddriver: skip for old driver tests
    # Other markers
    timeout: tests that need a timeout time
    internal: tests that could but should only run on our internal CI
    external: tests that could but should only run on our external CI

[isort]
multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
known_first_party =snowflake,parameters,generate_test_files

[flake8]
# Notes on ignores:
# - all ignored Ds mean doc issues, these should be cleaned up
ignore = B011,C901,D100,D101,D102,D103,D104,D105,D107,D401,E203,E402,E501,E704,F821,W503
exclude=
    build,tool,.tox,parameters.py,parameters_jenkins.py,
# Disable checking virtualenv contents
    *venv*
max-line-length = 88
show-source = true