2015-08-24 16:17:31 +00:00
|
|
|
[tox]
|
2021-12-21 19:37:04 +00:00
|
|
|
envlist = packaging, py37, py38, py39, py310, check_codestyle, check_isort
|
2021-04-08 11:09:48 +00:00
|
|
|
|
|
|
|
# we require tox>=2.3.2 for the fix to https://github.com/tox-dev/tox/issues/208
|
|
|
|
minversion = 2.3.2
|
2015-08-24 16:17:31 +00:00
|
|
|
|
2022-02-17 15:55:14 +00:00
|
|
|
# the tox-venv plugin makes tox use python's built-in `venv` module rather than
|
|
|
|
# the legacy `virtualenv` tool. `virtualenv` embeds its own `pip`, `setuptools`,
|
|
|
|
# etc, and ends up being rather unreliable.
|
|
|
|
requires = tox-venv
|
|
|
|
|
2018-08-13 06:47:46 +00:00
|
|
|
[base]
|
2015-08-24 16:17:31 +00:00
|
|
|
deps =
|
2015-11-13 16:22:51 +00:00
|
|
|
python-subunit
|
|
|
|
junitxml
|
2018-11-28 09:59:31 +00:00
|
|
|
coverage
|
2020-12-17 22:58:00 +00:00
|
|
|
|
|
|
|
# this is pinned since it's a bit of an obscure package.
|
|
|
|
coverage-enable-subprocess==1.0
|
2016-12-06 11:35:14 +00:00
|
|
|
|
2018-10-30 21:00:31 +00:00
|
|
|
# cyptography 2.2 requires setuptools >= 18.5
|
|
|
|
#
|
|
|
|
# older versions of virtualenv (?) give us a virtualenv with the same
|
|
|
|
# version of setuptools as is installed on the system python (and tox runs
|
|
|
|
# virtualenv under python3, so we get the version of setuptools that is
|
|
|
|
# installed on that).
|
|
|
|
#
|
|
|
|
# anyway, make sure that we have a recent enough setuptools.
|
2021-04-27 12:13:07 +00:00
|
|
|
setuptools>=18.5
|
2018-10-30 21:00:31 +00:00
|
|
|
|
|
|
|
# we also need a semi-recent version of pip, because old ones fail to
|
|
|
|
# install the "enum34" dependency of cryptography.
|
2021-04-27 12:13:07 +00:00
|
|
|
pip>=10
|
2018-10-30 21:00:31 +00:00
|
|
|
|
2021-01-21 18:26:52 +00:00
|
|
|
# directories/files we run the linters on.
|
|
|
|
# if you update this list, make sure to do the same in scripts-dev/lint.sh
|
2021-01-08 14:08:44 +00:00
|
|
|
lint_targets =
|
|
|
|
setup.py
|
|
|
|
synapse
|
|
|
|
tests
|
2021-05-14 10:46:35 +00:00
|
|
|
# annoyingly, black doesn't find these so we have to list them
|
2021-01-08 14:08:44 +00:00
|
|
|
scripts-dev
|
|
|
|
stubs
|
|
|
|
contrib
|
|
|
|
synctl
|
|
|
|
synmark
|
2021-08-11 19:08:14 +00:00
|
|
|
.ci
|
2021-01-08 14:08:44 +00:00
|
|
|
docker
|
|
|
|
|
2021-01-07 11:41:54 +00:00
|
|
|
# default settings for all tox environments
|
2018-08-13 06:47:46 +00:00
|
|
|
[testenv]
|
|
|
|
deps =
|
|
|
|
{[base]deps}
|
2021-01-07 11:41:54 +00:00
|
|
|
extras =
|
|
|
|
# install the optional dependendencies for tox environments without
|
|
|
|
# '-noextras' in their name
|
2021-04-08 11:09:48 +00:00
|
|
|
# (this requires tox 3)
|
2021-01-07 11:41:54 +00:00
|
|
|
!noextras: all
|
|
|
|
test
|
2018-08-13 06:47:46 +00:00
|
|
|
|
|
|
|
setenv =
|
2020-12-17 22:58:00 +00:00
|
|
|
# use a postgres db for tox environments with "-postgres" in the name
|
|
|
|
# (see https://tox.readthedocs.io/en/3.20.1/config.html#factors-and-factor-conditional-settings)
|
2019-02-20 07:42:24 +00:00
|
|
|
postgres: SYNAPSE_POSTGRES = 1
|
2020-12-17 22:58:00 +00:00
|
|
|
|
|
|
|
# this is used by .coveragerc to refer to the top of our tree.
|
2019-08-29 12:19:57 +00:00
|
|
|
TOP={toxinidir}
|
2018-08-13 06:47:46 +00:00
|
|
|
|
|
|
|
passenv = *
|
|
|
|
|
2015-08-24 16:17:31 +00:00
|
|
|
commands =
|
2020-12-17 22:58:00 +00:00
|
|
|
# the "env" invocation enables coverage checking for sub-processes. This is
|
|
|
|
# particularly important when running trial with `-j`, since that will make
|
|
|
|
# it run tests in a subprocess, whose coverage would otherwise not be
|
|
|
|
# tracked. (It also makes an explicit `coverage run` command redundant.)
|
|
|
|
#
|
|
|
|
# (See https://coverage.readthedocs.io/en/coverage-5.3/subprocess.html.
|
|
|
|
# Note that the `coverage.process_startup()` call is done by
|
|
|
|
# `coverage-enable-subprocess`.)
|
|
|
|
#
|
|
|
|
# we use "env" rather than putting a value in `setenv` so that it is not
|
|
|
|
# inherited by other tox environments.
|
|
|
|
#
|
|
|
|
/usr/bin/env COVERAGE_PROCESS_START={toxinidir}/.coveragerc "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:}
|
2015-08-24 16:17:31 +00:00
|
|
|
|
2017-09-05 15:35:23 +00:00
|
|
|
# As of twisted 16.4, trial tries to import the tests as a package (previously
|
|
|
|
# it loaded the files explicitly), which means they need to be on the
|
|
|
|
# pythonpath. Our sdist doesn't include the 'tests' package, so normally it
|
|
|
|
# doesn't work within the tox virtualenv.
|
|
|
|
#
|
|
|
|
# As a workaround, we tell tox to do install with 'pip -e', which just
|
|
|
|
# creates a symlink to the project directory instead of unpacking the sdist.
|
|
|
|
#
|
|
|
|
# (An alternative to this would be to set PYTHONPATH to include the project
|
|
|
|
# directory. Note two problems with this:
|
|
|
|
#
|
|
|
|
# - if you set it via `setenv`, then it is also set during the 'install'
|
|
|
|
# phase, which inhibits unpacking the sdist, so the virtualenv isn't
|
|
|
|
# useful for anything else without setting PYTHONPATH similarly.
|
|
|
|
#
|
|
|
|
# - `synapse` is also loaded from PYTHONPATH so even if you only set
|
|
|
|
# PYTHONPATH for the test phase, we're still running the tests against
|
|
|
|
# the working copy rather than the contents of the sdist. So frankly
|
|
|
|
# you might as well use -e in the first place.
|
|
|
|
#
|
|
|
|
# )
|
|
|
|
usedevelop=true
|
|
|
|
|
2018-09-27 13:21:54 +00:00
|
|
|
# A test suite for the oldest supported versions of Python libraries, to catch
|
|
|
|
# any uses of APIs not available in them.
|
2021-04-08 15:41:35 +00:00
|
|
|
[testenv:py3-old]
|
2021-04-08 15:21:32 +00:00
|
|
|
skip_install = true
|
|
|
|
usedevelop = false
|
2018-09-27 13:21:54 +00:00
|
|
|
deps =
|
2022-01-21 22:23:26 +00:00
|
|
|
Automat == 0.8.0
|
2018-09-27 13:21:54 +00:00
|
|
|
lxml
|
2022-02-18 11:38:48 +00:00
|
|
|
# markupsafe 2.1 introduced a change that breaks Jinja 2.x. Since we depend on
|
|
|
|
# Jinja >= 2.9, it means this test suite will fail if markupsafe >= 2.1 is installed.
|
|
|
|
markupsafe < 2.1
|
2021-01-25 19:22:35 +00:00
|
|
|
{[base]deps}
|
2019-03-18 17:45:45 +00:00
|
|
|
|
2018-09-27 13:21:54 +00:00
|
|
|
commands =
|
|
|
|
# Make all greater-thans equals so we test the oldest version of our direct
|
|
|
|
# dependencies, but make the pyopenssl 17.0, which can work against an
|
|
|
|
# OpenSSL 1.1 compiled cryptography (as older ones don't compile on Travis).
|
2021-01-22 11:14:49 +00:00
|
|
|
/bin/sh -c 'python -m synapse.python_dependencies | sed -e "s/>=/==/g" -e "/psycopg2/d" -e "s/pyopenssl==16.0.0/pyopenssl==17.0.0/" | xargs -d"\n" pip install'
|
2019-03-18 17:31:46 +00:00
|
|
|
|
2019-03-19 12:51:32 +00:00
|
|
|
# Install Synapse itself. This won't update any libraries.
|
2020-09-23 10:45:37 +00:00
|
|
|
pip install -e ".[test]"
|
2018-09-27 13:21:54 +00:00
|
|
|
|
2021-04-08 11:09:48 +00:00
|
|
|
{[testenv]commands}
|
2019-03-18 17:45:45 +00:00
|
|
|
|
2019-12-03 09:21:25 +00:00
|
|
|
[testenv:benchmark]
|
|
|
|
deps =
|
|
|
|
{[base]deps}
|
|
|
|
pyperf
|
|
|
|
setenv =
|
|
|
|
SYNAPSE_POSTGRES = 1
|
|
|
|
commands =
|
|
|
|
python -m synmark {posargs:}
|
|
|
|
|
2015-08-24 16:17:31 +00:00
|
|
|
[testenv:packaging]
|
2021-04-08 15:21:32 +00:00
|
|
|
skip_install = true
|
|
|
|
usedevelop = false
|
2015-08-24 16:17:31 +00:00
|
|
|
deps =
|
|
|
|
check-manifest
|
|
|
|
commands =
|
|
|
|
check-manifest
|
|
|
|
|
|
|
|
[testenv:check_codestyle]
|
2020-09-17 20:45:22 +00:00
|
|
|
extras = lint
|
2018-11-07 17:57:28 +00:00
|
|
|
commands =
|
2021-01-08 14:08:44 +00:00
|
|
|
python -m black --check --diff {[base]lint_targets}
|
|
|
|
flake8 {[base]lint_targets} {env:PEP8SUFFIX:}
|
2019-10-23 12:22:54 +00:00
|
|
|
{toxinidir}/scripts-dev/config-lint.sh
|
2018-06-25 13:42:27 +00:00
|
|
|
|
2018-07-16 14:03:41 +00:00
|
|
|
[testenv:check_isort]
|
2020-09-17 20:45:22 +00:00
|
|
|
extras = lint
|
2022-02-22 11:30:19 +00:00
|
|
|
commands = isort -c --df {[base]lint_targets}
|
2018-06-25 13:42:27 +00:00
|
|
|
|
2019-08-29 12:19:57 +00:00
|
|
|
[testenv:combine]
|
2021-04-08 15:21:32 +00:00
|
|
|
skip_install = true
|
|
|
|
usedevelop = false
|
2018-11-28 09:59:31 +00:00
|
|
|
deps =
|
|
|
|
coverage
|
2021-04-27 12:13:07 +00:00
|
|
|
pip>=10
|
2019-08-29 12:19:57 +00:00
|
|
|
commands=
|
2018-11-28 09:59:31 +00:00
|
|
|
coverage combine
|
2019-08-29 12:19:57 +00:00
|
|
|
coverage report
|
2019-08-28 11:18:53 +00:00
|
|
|
|
2019-09-12 16:29:55 +00:00
|
|
|
[testenv:cov-erase]
|
2021-04-08 15:21:32 +00:00
|
|
|
skip_install = true
|
|
|
|
usedevelop = false
|
2019-09-12 16:29:55 +00:00
|
|
|
deps =
|
|
|
|
coverage
|
|
|
|
commands=
|
|
|
|
coverage erase
|
|
|
|
|
|
|
|
[testenv:cov-html]
|
2021-04-08 15:21:32 +00:00
|
|
|
skip_install = true
|
|
|
|
usedevelop = false
|
2019-09-12 16:29:55 +00:00
|
|
|
deps =
|
|
|
|
coverage
|
|
|
|
commands=
|
|
|
|
coverage html
|
|
|
|
|
2019-08-28 11:18:53 +00:00
|
|
|
[testenv:mypy]
|
|
|
|
deps =
|
|
|
|
{[base]deps}
|
2020-10-20 11:55:21 +00:00
|
|
|
extras = all,mypy
|
2020-08-26 13:59:37 +00:00
|
|
|
commands = mypy
|