Skip to content
Snippets Groups Projects
Unverified Commit e90fad5c authored by Dan Callahan's avatar Dan Callahan Committed by GitHub
Browse files

Minor updates to docs on how to run tests (#8666)


The test runner isn't present in the `[all]` set of extras, so the
previous instructions did not work without also installing `[test]`.

Note that this does not include the `[lint]` extras, since those do not
install on all supported Python versions (specifically, isort 5.x
requires Python 3.6, while we still support 3.5). Instructions for that
are included in our pull request template, so we should be fine there.

I've also dropped the `--no-use-pep517` arg to `pip install` since it
seems to have been added to address a temporary regression in pip 19.1
which was fixed in pip 19.1.1 the following month.

Lastly, updated the example output of the test suite to set more
realistic expectations around run time.

Signed-off-by: default avatarDan Callahan <danc@element.io>
parent 88e1d0c5
No related branches found
No related tags found
No related merge requests found
...@@ -256,9 +256,9 @@ directory of your choice:: ...@@ -256,9 +256,9 @@ directory of your choice::
Synapse has a number of external dependencies, that are easiest Synapse has a number of external dependencies, that are easiest
to install using pip and a virtualenv:: to install using pip and a virtualenv::
virtualenv -p python3 env python3 -m venv ./env
source env/bin/activate source ./env/bin/activate
python -m pip install --no-use-pep517 -e ".[all]" pip install -e ".[all,test]"
This will run a process of downloading and installing all the needed This will run a process of downloading and installing all the needed
dependencies into a virtual env. dependencies into a virtual env.
...@@ -270,9 +270,9 @@ check that everything is installed as it should be:: ...@@ -270,9 +270,9 @@ check that everything is installed as it should be::
This should end with a 'PASSED' result:: This should end with a 'PASSED' result::
Ran 143 tests in 0.601s Ran 1266 tests in 643.930s
PASSED (successes=143) PASSED (skips=15, successes=1251)
Running the Integration Tests Running the Integration Tests
============================= =============================
......
Minor updates to docs on running tests.
...@@ -24,11 +24,6 @@ deps = ...@@ -24,11 +24,6 @@ deps =
pip>=10 pip>=10
setenv = 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 PYTHONDONTWRITEBYTECODE = no_byte_code
COVERAGE_PROCESS_START = {toxinidir}/.coveragerc COVERAGE_PROCESS_START = {toxinidir}/.coveragerc
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment