tahoe-lafs/tox.ini

267 lines
10 KiB
INI
Raw Normal View History

# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
2021-05-11 15:02:15 +00:00
# Map Python versions in GitHub Actions to tox environments to run, for use by
# the tox-gh-actions package.
[gh-actions]
python =
2.7: py27-coverage,codechecks
3.6: py36-coverage
3.7: py37-coverage,typechecks,codechecks3
3.8: py38-coverage
3.9: py39-coverage
pypy-3.7: pypy3
[pytest]
twisted = 1
[tox]
2021-05-10 17:18:08 +00:00
envlist = typechecks,codechecks,codechecks3,py{27,36,37,38,39}-{coverage},pypy27,pypy3,integration,integration3
minversion = 2.4
[testenv]
passenv = TAHOE_LAFS_* PIP_* SUBUNITREPORTER_* USERPROFILE HOMEDRIVE HOMEPATH
# Get "certifi" to avoid bug #2913. Basically if a `setup_requires=...` causes
# a package to be installed (with setuptools) then it'll fail on certain
# platforms (travis's OX-X 10.12, Slackware 14.2) because PyPI's TLS
# requirements (TLS >= 1.2) are incompatible with the old TLS clients
# available to those systems. Installing it ahead of time (with pip) avoids
# this problem.
deps =
2019-05-14 07:36:34 +00:00
# Pin all of these versions for the same reason you ever want to pin
# anything: to prevent new releases with regressions from introducing
# spurious failures into CI runs for whatever development work is
# happening at the time. The versions selected here are just the current
# versions at the time. Bumping them to keep up with future releases is
# fine as long as those releases are known to actually work.
#
# For now these are versions that support Python 2.
pip==20.3.4
setuptools==44.1.1
wheel==0.36.2
subunitreporter==19.3.2
2019-05-14 07:36:34 +00:00
# As an exception, we don't pin certifi because it contains CA
# certificates which necessarily change over time. Pinning this is
# guaranteed to cause things to break eventually as old certificates
# expire and as new ones are used in the wild that aren't present in
# whatever version we pin. Hopefully there won't be functionality
# regressions in new releases of this package that cause us the kind of
# suffering we're trying to avoid with the above pins.
certifi
# VCS hooks support
py36,!coverage: pre-commit
# We add usedevelop=False because testing against a true installation gives
# more useful results.
usedevelop = False
# We use extras=test to get things like "mock" that are required for our unit
2021-03-05 14:42:06 +00:00
# tests.
2018-08-06 15:40:44 +00:00
extras = test
setenv =
# Define TEST_SUITE in the environment as an aid to constructing the
# correct test command below.
TEST_SUITE = allmydata
commands =
2020-08-27 14:40:27 +00:00
# As an aid to debugging, dump all of the Python packages and their
# versions that are installed in the test environment. This is
# particularly useful to get from CI runs - though hopefully the
# version pinning we do limits the variability of this output
pip freeze
tahoe --version
python -c "import sys; print('sys.stdout.encoding:', sys.stdout.encoding)"
2021-09-08 18:25:10 +00:00
# Run tests with -b to catch bugs like `"%s" % (some_bytes,)`. -b makes
# Python emit BytesWarnings, and warnings configuration in
# src/allmydata/tests/__init__.py turns allmydata's BytesWarnings into
# exceptions.
!coverage: python -b -m twisted.trial {env:TAHOE_LAFS_TRIAL_ARGS:--rterrors} {posargs:{env:TEST_SUITE}}
2020-08-27 14:40:27 +00:00
# measuring coverage is somewhat slower than not measuring coverage
# so only do it on request.
coverage: python -b -m coverage run -m twisted.trial {env:TAHOE_LAFS_TRIAL_ARGS:--rterrors --reporter=timing} {posargs:{env:TEST_SUITE}}
2020-08-27 14:40:27 +00:00
coverage: coverage combine
coverage: coverage xml
coverage: coverage report
[testenv:integration]
2019-07-23 16:39:45 +00:00
setenv =
COVERAGE_PROCESS_START=.coveragerc
commands =
2020-08-27 14:40:27 +00:00
# NOTE: 'run with "py.test --keep-tempdir -s -v integration/" to debug failures'
2021-01-13 15:21:00 +00:00
py.test --timeout=1800 --coverage -v {posargs:integration}
2019-07-23 16:39:45 +00:00
coverage combine
coverage report
[testenv:integration3]
basepython = python3
setenv =
COVERAGE_PROCESS_START=.coveragerc
commands =
2021-05-13 14:26:30 +00:00
python --version
# NOTE: 'run with "py.test --keep-tempdir -s -v integration/" to debug failures'
2021-06-10 15:22:11 +00:00
py.test --timeout=1800 --coverage -v {posargs:integration}
coverage combine
coverage report
# Once 2.7 is dropped, this can be removed. It just does flake8 with Python 2
# since that can give different results than flake8 on Python 3.
[testenv:codechecks]
basepython = python2.7
setenv =
# If no positional arguments are given, try to run the checks on the
# entire codebase, including various pieces of supporting code.
DEFAULT_FILES=src integration static misc setup.py
commands =
flake8 {posargs:{env:DEFAULT_FILES}}
2021-05-07 13:41:30 +00:00
[testenv:codechecks3]
basepython = python3
deps =
# Newer versions of PyLint have buggy configuration
# (https://github.com/PyCQA/pylint/issues/4574), so stick to old version
# for now.
pylint < 2.5
# On macOS, git inside of towncrier needs $HOME.
passenv = HOME
2021-05-07 13:41:30 +00:00
setenv =
# If no positional arguments are given, try to run the checks on the
# entire codebase, including various pieces of supporting code.
DEFAULT_FILES=src integration static misc setup.py
commands =
flake8 {posargs:{env:DEFAULT_FILES}}
python misc/coding_tools/check-umids.py {posargs:{env:DEFAULT_FILES}}
python misc/coding_tools/check-debugging.py {posargs:{env:DEFAULT_FILES}}
python misc/coding_tools/find-trailing-spaces.py -r {posargs:{env:DEFAULT_FILES}}
# PyLint has other useful checks, might want to enable them:
# http://pylint.pycqa.org/en/latest/technical_reference/features.html
pylint --disable=all --enable=cell-var-from-loop {posargs:{env:DEFAULT_FILES}}
# If towncrier.check fails, you forgot to add a towncrier news
# fragment explaining the change in this branch. Create one at
# `newsfragments/<ticket>.<change type>` with some text for the news
# file. See towncrier.toml for legal <change type> values.
python -m towncrier.check --config towncrier.toml
2021-05-07 13:41:30 +00:00
[testenv:typechecks]
basepython = python3
skip_install = True
deps =
mypy
2021-06-10 15:03:01 +00:00
mypy-zope
types-mock
types-six
types-PyYAML
types-pkg_resources
git+https://github.com/warner/foolscap
# Twisted 21.2.0 introduces some type hints which we are not yet
# compatible with.
# https://tahoe-lafs.org/trac/tahoe-lafs/ticket/3622
2021-03-01 17:46:44 +00:00
twisted<21.2.0
commands = mypy src
2018-08-27 23:44:17 +00:00
[testenv:draftnews]
passenv = TAHOE_LAFS_* PIP_* SUBUNITREPORTER_* USERPROFILE HOMEDRIVE HOMEPATH
deps =
# see comment in [testenv] about "certifi"
certifi
towncrier==21.3.0
2018-08-27 23:44:17 +00:00
commands =
python -m towncrier --draft --config towncrier.toml
2018-08-27 23:44:17 +00:00
2020-03-11 16:52:26 +00:00
[testenv:news]
# On macOS, git invoked from Tox needs $HOME.
passenv = TAHOE_LAFS_* PIP_* SUBUNITREPORTER_* USERPROFILE HOMEDRIVE HOMEPATH HOME
whitelist_externals =
git
2020-03-11 16:52:26 +00:00
deps =
# see comment in [testenv] about "certifi"
certifi
towncrier==21.3.0
2020-03-11 16:52:26 +00:00
commands =
python -m towncrier --yes --config towncrier.toml
# commit the changes
git commit -m "update NEWS.txt for release"
2020-03-11 16:52:26 +00:00
[testenv:deprecations]
commands =
python misc/build_helpers/run-deprecations.py --package allmydata --warnings={env:TAHOE_LAFS_WARNINGS_LOG:_trial_temp/deprecation-warnings.log} trial {env:TAHOE_LAFS_TRIAL_ARGS:--rterrors} {posargs:allmydata}
[testenv:upcoming-deprecations]
deps =
2018-07-06 14:12:44 +00:00
# Take the base deps as well!
{[testenv]deps}
git+https://github.com/warner/foolscap
commands =
flogtool --version
python misc/build_helpers/run-deprecations.py --package allmydata --warnings={env:TAHOE_LAFS_WARNINGS_LOG:_trial_temp/deprecation-warnings.log} trial {env:TAHOE_LAFS_TRIAL_ARGS:--rterrors} {posargs:allmydata}
[testenv:checkmemory]
commands =
rm -rf _test_memory
python src/allmydata/test/check_memory.py upload
python src/allmydata/test/check_memory.py upload-self
python src/allmydata/test/check_memory.py upload-POST
python src/allmydata/test/check_memory.py download
python src/allmydata/test/check_memory.py download-GET
python src/allmydata/test/check_memory.py download-GET-slow
python src/allmydata/test/check_memory.py receive
# Use 'tox -e docs' to check formatting and cross-references in docs .rst
# files. The published docs are built by code run over at readthedocs.org,
# which does not use this target (but does something similar).
#
# If you have "sphinx" installed in your virtualenv, you can just do "make -C
# docs html", or "cd docs; make html".
#
# You can also open docs/_build/html/index.html to see the rendered docs in
# your web browser.
[testenv:docs]
# we pin docutils because of https://sourceforge.net/p/docutils/bugs/301/
# which asserts when it reads links to .svg files (e.g. about.rst)
deps =
sphinx
docutils==0.12
recommonmark
sphinx_rtd_theme
# normal install is not needed for docs, and slows things down
skip_install = True
commands =
sphinx-build -W -b html -d {toxinidir}/docs/_build/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
[testenv:pyinstaller]
# We override this to pass --no-use-pep517 because pyinstaller (3.4, at least)
# is broken when this feature is enabled.
install_command = python -m pip install --no-use-pep517 {opts} {packages}
extras =
deps =
{[testenv]deps}
packaging
2020-08-10 13:59:36 +00:00
# PyInstaller 4.0 drops Python 2 support. When we finish porting to
# Python 3 we can reconsider this constraint.
pyinstaller < 4.0
pefile ; platform_system == "Windows"
# Setting PYTHONHASHSEED to a known value assists with reproducible builds.
# See https://pyinstaller.readthedocs.io/en/stable/advanced-topics.html#creating-a-reproducible-build
setenv=PYTHONHASHSEED=1
commands=
pip freeze
pyinstaller -y --clean pyinstaller.spec
[testenv:tarballs]
deps =
commands =
python setup.py update_version
python setup.py sdist --formats=bztar,gztar,zip bdist_wheel