forked from MirrorHub/synapse
b7ddece2a6
Run `isort`, `flake8` and `black` over the `contrib/` directory and `synctl` script. The latter was already being done in CI, but now the linting script does it too. Fixes https://github.com/matrix-org/synapse/issues/7910
218 lines
6.4 KiB
INI
218 lines
6.4 KiB
INI
[tox]
|
|
envlist = packaging, py35, py36, py37, py38, check_codestyle, check_isort
|
|
|
|
[base]
|
|
deps =
|
|
mock
|
|
python-subunit
|
|
junitxml
|
|
coverage
|
|
coverage-enable-subprocess
|
|
parameterized
|
|
|
|
# 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.
|
|
setuptools>=18.5
|
|
|
|
# we also need a semi-recent version of pip, because old ones fail to
|
|
# install the "enum34" dependency of cryptography.
|
|
pip>=10
|
|
|
|
setenv =
|
|
# we have a pyproject.toml, but don't want pip to use it for building.
|
|
# (otherwise we get an error about 'editable mode is not supported for
|
|
# pyproject.toml-style projects').
|
|
PIP_USE_PEP517 = false
|
|
|
|
PYTHONDONTWRITEBYTECODE = no_byte_code
|
|
COVERAGE_PROCESS_START = {toxinidir}/.coveragerc
|
|
|
|
[testenv]
|
|
deps =
|
|
{[base]deps}
|
|
extras = all
|
|
|
|
whitelist_externals =
|
|
sh
|
|
|
|
setenv =
|
|
{[base]setenv}
|
|
postgres: SYNAPSE_POSTGRES = 1
|
|
TOP={toxinidir}
|
|
|
|
passenv = *
|
|
|
|
commands =
|
|
/usr/bin/find "{toxinidir}" -name '*.pyc' -delete
|
|
# Add this so that coverage will run on subprocesses
|
|
{envbindir}/coverage run "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:}
|
|
|
|
# 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
|
|
|
|
# A test suite for the oldest supported versions of Python libraries, to catch
|
|
# any uses of APIs not available in them.
|
|
[testenv:py35-old]
|
|
skip_install=True
|
|
deps =
|
|
# Old automat version for Twisted
|
|
Automat == 0.3.0
|
|
|
|
mock
|
|
lxml
|
|
coverage
|
|
coverage-enable-subprocess
|
|
|
|
commands =
|
|
/usr/bin/find "{toxinidir}" -name '*.pyc' -delete
|
|
# 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).
|
|
/bin/sh -c 'python -m synapse.python_dependencies | sed -e "s/>=/==/g" -e "s/psycopg2==2.6//" -e "s/pyopenssl==16.0.0/pyopenssl==17.0.0/" | xargs -d"\n" pip install'
|
|
|
|
# Install Synapse itself. This won't update any libraries.
|
|
pip install -e .
|
|
|
|
{envbindir}/coverage run "{envbindir}/trial" {env:TRIAL_FLAGS:} {posargs:tests} {env:TOXSUFFIX:}
|
|
|
|
[testenv:benchmark]
|
|
deps =
|
|
{[base]deps}
|
|
pyperf
|
|
setenv =
|
|
SYNAPSE_POSTGRES = 1
|
|
commands =
|
|
python -m synmark {posargs:}
|
|
|
|
[testenv:packaging]
|
|
skip_install=True
|
|
deps =
|
|
check-manifest
|
|
commands =
|
|
check-manifest
|
|
|
|
[testenv:check_codestyle]
|
|
skip_install = True
|
|
deps =
|
|
flake8
|
|
flake8-comprehensions
|
|
# We pin so that our tests don't start failing on new releases of black.
|
|
black==19.10b0
|
|
commands =
|
|
python -m black --check --diff .
|
|
/bin/sh -c "flake8 synapse tests scripts scripts-dev contrib synctl {env:PEP8SUFFIX:}"
|
|
{toxinidir}/scripts-dev/config-lint.sh
|
|
|
|
[testenv:check_isort]
|
|
skip_install = True
|
|
deps = isort==5.0.3
|
|
commands = /bin/sh -c "isort -c --df --sp setup.cfg synapse tests scripts-dev scripts"
|
|
|
|
[testenv:check-newsfragment]
|
|
skip_install = True
|
|
deps = towncrier>=18.6.0rc1
|
|
commands =
|
|
python -m towncrier.check --compare-with=origin/develop
|
|
|
|
[testenv:check-sampleconfig]
|
|
commands = {toxinidir}/scripts-dev/generate_sample_config --check
|
|
|
|
[testenv:combine]
|
|
skip_install = True
|
|
deps =
|
|
coverage
|
|
commands=
|
|
coverage combine
|
|
coverage report
|
|
|
|
[testenv:cov-erase]
|
|
skip_install = True
|
|
deps =
|
|
coverage
|
|
commands=
|
|
coverage erase
|
|
|
|
[testenv:cov-html]
|
|
skip_install = True
|
|
deps =
|
|
coverage
|
|
commands=
|
|
coverage html
|
|
|
|
[testenv:mypy]
|
|
skip_install = True
|
|
deps =
|
|
{[base]deps}
|
|
mypy==0.750
|
|
mypy-zope
|
|
env =
|
|
MYPYPATH = stubs/
|
|
extras = all
|
|
commands = mypy \
|
|
synapse/api \
|
|
synapse/appservice \
|
|
synapse/config \
|
|
synapse/event_auth.py \
|
|
synapse/events/spamcheck.py \
|
|
synapse/federation \
|
|
synapse/handlers/auth.py \
|
|
synapse/handlers/cas_handler.py \
|
|
synapse/handlers/directory.py \
|
|
synapse/handlers/federation.py \
|
|
synapse/handlers/oidc_handler.py \
|
|
synapse/handlers/presence.py \
|
|
synapse/handlers/room_member.py \
|
|
synapse/handlers/room_member_worker.py \
|
|
synapse/handlers/saml_handler.py \
|
|
synapse/handlers/sync.py \
|
|
synapse/handlers/ui_auth \
|
|
synapse/http/server.py \
|
|
synapse/http/site.py \
|
|
synapse/logging/ \
|
|
synapse/metrics \
|
|
synapse/module_api \
|
|
synapse/push/pusherpool.py \
|
|
synapse/push/push_rule_evaluator.py \
|
|
synapse/replication \
|
|
synapse/rest \
|
|
synapse/spam_checker_api \
|
|
synapse/storage/data_stores/main/ui_auth.py \
|
|
synapse/storage/database.py \
|
|
synapse/storage/engines \
|
|
synapse/storage/util \
|
|
synapse/streams \
|
|
synapse/util/caches/stream_change_cache.py \
|
|
tests/replication \
|
|
tests/test_utils \
|
|
tests/rest/client/v2_alpha/test_auth.py \
|
|
tests/util/test_stream_change_cache.py
|
|
|
|
# To find all folders that pass mypy you run:
|
|
#
|
|
# find synapse/* -type d -not -name __pycache__ -exec bash -c "mypy '{}' > /dev/null" \; -print
|