xref: /sqlalchemy/tox.ini (revision f6fca84a)
16b051503SMike Bayer
29281e700SMike Bayer[tox]
3c312b3b2SMike Bayerenvlist = py
49281e700SMike Bayer
59281e700SMike Bayer[testenv]
649dfeda6SMike Bayer# note that we have a .coveragerc file that points coverage specifically
749dfeda6SMike Bayer# at ./lib/sqlalchemy, and *not* at the build that tox might create under .tox.
849dfeda6SMike Bayer# See the notes below for setenv for more detail.
949dfeda6SMike Bayer# also using --cov-append so that we can aggregate multiple runs together.
1049dfeda6SMike Bayer# Jenkins etc. need to call "coverage erase" externally.
1149dfeda6SMike Bayercov_args=--cov=sqlalchemy --cov-report term --cov-append --cov-report xml --exclude-tag memory-intensive --exclude-tag timing-intensive -k "not aaa_profiling"
1249dfeda6SMike Bayer
13f704f47aSMike Bayerinstall_command=python -m pip install {env:TOX_PIP_OPTS:} {opts} {packages}
1422800000SMike Bayer
15086ad9ceSMike Bayerusedevelop=
16086ad9ceSMike Bayer     cov: True
17d100bfcfSMike Bayer
18f1e96cb0SMike Bayerdeps=
19f1e96cb0SMike Bayer     pytest>=4.6.11,<5.0; python_version < '3'
20f1e96cb0SMike Bayer     pytest>=6.2; python_version >= '3'
213568e508SMike Bayer     pytest-xdist
229c7fb63dSFantix King     greenlet != 0.4.17
230396fb76SMike Bayer     mock; python_version < '3.3'
24cd03b8f0SMike Bayer     importlib_metadata; python_version < '3.8'
25897cd176SMike Bayer     postgresql: .[postgresql]
2606f1929bSTony Locke     postgresql: .[postgresql_asyncpg]; python_version >= '3'
2706f1929bSTony Locke     postgresql: .[postgresql_pg8000]; python_version >= '3'
28897cd176SMike Bayer     mysql: .[mysql]
29897cd176SMike Bayer     mysql: .[pymysql]
3048930113SMike Bayer     mysql: git+https://github.com/sqlalchemy/aiomysql@sqlalchemy_tox; python_version >= '3'
31603f7d30SGeorg Richter     mysql: .[mariadb_connector]; python_version >= '3'
32603f7d30SGeorg Richter
33603f7d30SGeorg Richter     # we should probably try to get mysql_connector back in the mix
34603f7d30SGeorg Richter     # as well
35603f7d30SGeorg Richter     # mysql: .[mysql_connector]; python_version >= '3'
36603f7d30SGeorg Richter
37897cd176SMike Bayer     oracle: .[oracle]
38897cd176SMike Bayer     mssql: .[mssql]
39d1fe8f43SMike Bayer
40d100bfcfSMike Bayer     cov: pytest-cov
419281e700SMike Bayer
42f6fca84aSjonathan vanascoallowlist_externals=sh
4349dfeda6SMike Bayer
4449dfeda6SMike Bayer# PYTHONPATH - erased so that we use the build that's present
4549dfeda6SMike Bayer# in .tox as the SQLAlchemy library to be imported
4649dfeda6SMike Bayer#
4749dfeda6SMike Bayer# PYTHONUSERSITE - this *MUST* be set so that the ./lib/ import
4849dfeda6SMike Bayer# set up explicitly in test/conftest.py is *disabled*, again so that
4949dfeda6SMike Bayer# when SQLAlchemy is built into the .tox area, we use that and not the
5049dfeda6SMike Bayer# local checkout, at least when usedevelop=False
5149dfeda6SMike Bayer#
5249dfeda6SMike Bayer# BASECOMMAND - using an env variable here so we can use it
5349dfeda6SMike Bayer# as a substitution in a command (see https://bitbucket.org/hpk42/tox/issues/307/)
5449dfeda6SMike Bayer#
55ffb6fbf8SMike Bayer# only use --dropfirst option if we're *not* using -n;
56ffb6fbf8SMike Bayer# if -n is used, we're working in brand new DBs anyway, dropfirst
57ffb6fbf8SMike Bayer# will collide on CI environments
58f30e35baSMike Bayersetenv=
59f30e35baSMike Bayer    PYTHONPATH=
6049dfeda6SMike Bayer    PYTHONNOUSERSITE=1
61e2d4b2e7SMike Bayer    MEMUSAGE=--nomemory
625edb931eSMike Bayer    BASECOMMAND=python -m pytest --rootdir {toxinidir} --log-info=sqlalchemy.testing
63086ad9ceSMike Bayer
643ceb87daSMike Bayer    WORKERS={env:TOX_WORKERS:-n4  --max-worker-restart=5}
653231e281SMike Bayer
66086ad9ceSMike Bayer    nocext: DISABLE_SQLALCHEMY_CEXT=1
67a54a0c6eSMike Bayer    cext: REQUIRE_SQLALCHEMY_CEXT=1
68086ad9ceSMike Bayer    cov: COVERAGE={[testenv]cov_args}
693231e281SMike Bayer    backendonly: BACKENDONLY=--backend-only
703231e281SMike Bayer    memusage: MEMUSAGE='-k test_memusage'
713231e281SMike Bayer
723231e281SMike Bayer    oracle: WORKERS={env:TOX_WORKERS:-n2  --max-worker-restart=5}
733231e281SMike Bayer    oracle: ORACLE={env:TOX_ORACLE:--db oracle}
743231e281SMike Bayer
759e6393c6SMike Bayer    sqlite: SQLITE={env:TOX_SQLITE:--db sqlite}
7679a53645SGord Thompson    sqlite_file: SQLITE={env:TOX_SQLITE_FILE:--db sqlite_file}
773231e281SMike Bayer
783231e281SMike Bayer    postgresql: POSTGRESQL={env:TOX_POSTGRESQL:--db postgresql}
79f1e96cb0SMike Bayer    py2{,7}-postgresql: POSTGRESQL={env:TOX_POSTGRESQL_PY2K:{env:TOX_POSTGRESQL:--db postgresql}}
802581655cSFederico Caselli    py3{,5,6,7,8,9,10,11}-postgresql: EXTRA_PG_DRIVERS={env:EXTRA_PG_DRIVERS:--dbdriver psycopg2 --dbdriver asyncpg --dbdriver pg8000}
813231e281SMike Bayer
823231e281SMike Bayer    mysql: MYSQL={env:TOX_MYSQL:--db mysql}
83f1e96cb0SMike Bayer    py2{,7}-mysql: MYSQL={env:TOX_MYSQL_PY2K:{env:TOX_MYSQL:--db mysql}}
843231e281SMike Bayer    mysql: EXTRA_MYSQL_DRIVERS={env:EXTRA_MYSQL_DRIVERS:--dbdriver mysqldb --dbdriver pymysql}
852581655cSFederico Caselli    py3{,5,6,7,8,9,10,11}-mysql: EXTRA_MYSQL_DRIVERS={env:EXTRA_MYSQL_DRIVERS:--dbdriver mysqldb --dbdriver pymysql --dbdriver mariadbconnector --dbdriver aiomysql}
863231e281SMike Bayer
8706f1929bSTony Locke
88f87570acSMike Bayer    mssql: MSSQL={env:TOX_MSSQL:--db mssql}
893231e281SMike Bayer
9079a53645SGord Thompson    oracle,mssql,sqlite_file: IDENTS=--write-idents db_idents.txt
91e2d4b2e7SMike Bayer    oracle,mssql,sqlite_file: MEMUSAGE=--nomemory
92f30e35baSMike Bayer
937f423e87SMike Bayer# tox as of 2.0 blocks all environment variables from the
947f423e87SMike Bayer# outside, unless they are here (or in TOX_TESTENV_PASSENV,
95077f26afSMike Bayer# wildcards OK).  Need at least these
96f1e96cb0SMike Bayerpassenv=ORACLE_HOME NLS_LANG TOX_POSTGRESQL TOX_POSTGRESQL_PY2K TOX_MYSQL TOX_MYSQL_PY2K TOX_ORACLE TOX_MSSQL TOX_SQLITE TOX_SQLITE_FILE TOX_WORKERS EXTRA_PG_DRIVERS EXTRA_MYSQL_DRIVERS
977f423e87SMike Bayer
9849dfeda6SMike Bayer# for nocext, we rm *.so in lib in case we are doing usedevelop=True
999281e700SMike Bayercommands=
100c312b3b2SMike Bayer  cext: /bin/true
1012efd89d0SMike Bayer  nocext: sh -c "rm -f lib/sqlalchemy/*.so"
1023231e281SMike Bayer  {env:BASECOMMAND} {env:WORKERS} {env:SQLITE:} {env:POSTGRESQL:} {env:EXTRA_PG_DRIVERS:} {env:MYSQL:} {env:EXTRA_MYSQL_DRIVERS:} {env:ORACLE:} {env:MSSQL:} {env:BACKENDONLY:} {env:IDENTS:} {env:MEMUSAGE:} {env:COVERAGE:} {posargs}
10379a53645SGord Thompson  oracle,mssql,sqlite_file: python reap_dbs.py db_idents.txt
1049281e700SMike Bayer
105d229360aSMike Bayer# thanks to https://julien.danjou.info/the-best-flake8-extensions/
1069281e700SMike Bayer[testenv:pep8]
107e8ff0af8SMike Bayerbasepython = python3
108d229360aSMike Bayerdeps=
109d229360aSMike Bayer      flake8
110d229360aSMike Bayer      flake8-import-order
111d229360aSMike Bayer      flake8-builtins
112a55a1a41SMike Bayer      flake8-docstrings>=1.3.1
113d229360aSMike Bayer      flake8-rst-docstrings
114a55a1a41SMike Bayer      # flake8-rst-docstrings depdendency, leaving it here
115a55a1a41SMike Bayer      # in case it requires a version pin
116a55a1a41SMike Bayer      pydocstyle
117d229360aSMike Bayer      pygments
118c3f102c9SMike Bayer      black==20.8b1
119d8378f45SFederico Casellicommands =
1207ff6cf1eSMike Bayer     flake8 ./lib/ ./test/ ./examples/ setup.py doc/build/conf.py {posargs}
121d8378f45SFederico Caselli     black --check .
122c658540bSFederico Caselli
123c658540bSFederico Caselli# command run in the github action when cext are active.
124c658540bSFederico Caselli[testenv:github-cext]
125c658540bSFederico Casellicommands=
126e2d4b2e7SMike Bayer  python -m pytest {env:WORKERS} {env:SQLITE:} {env:POSTGRESQL:} {env:MYSQL:} {env:ORACLE:} {env:MSSQL:} {env:BACKENDONLY:} {env:IDENTS:} {env:MEMUSAGE:} {env:COVERAGE:} {posargs}
127c658540bSFederico Caselli  oracle,mssql,sqlite_file: python reap_dbs.py db_idents.txt
128c658540bSFederico Caselli
129c658540bSFederico Caselli# command run in the github action when cext are not active.
130c658540bSFederico Caselli[testenv:github-nocext]
131c658540bSFederico Casellicommands=
132e2d4b2e7SMike Bayer  python -m pytest {env:WORKERS} {env:SQLITE:} {env:POSTGRESQL:} {env:MYSQL:} {env:ORACLE:} {env:MSSQL:} {env:BACKENDONLY:} {env:IDENTS:} {env:MEMUSAGE:} {env:COVERAGE:} {posargs}
1337ff6cf1eSMike Bayer  oracle,mssql,sqlite_file: python reap_dbs.py db_idents.txt
134