Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Minor updates to docs on how to run tests
Browse files Browse the repository at this point in the history
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: Dan Callahan <danc@element.io>
  • Loading branch information
callahad committed Oct 26, 2020
1 parent 2e380f0 commit 19a6f79
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,9 @@ directory of your choice::
Synapse has a number of external dependencies, that are easiest
to install using pip and a virtualenv::

virtualenv -p python3 env
source env/bin/activate
python -m pip install --no-use-pep517 -e ".[all]"
python3 -m venv ./env
source ./env/bin/activate
pip install -e ".[all,test]"

This will run a process of downloading and installing all the needed
dependencies into a virtual env.
Expand All @@ -270,9 +270,9 @@ check that everything is installed as it should be::

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
=============================
Expand Down
1 change: 1 addition & 0 deletions changelog.d/8666.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Minor updates to docs on running tests.
5 changes: 0 additions & 5 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@ deps =
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

Expand Down

0 comments on commit 19a6f79

Please sign in to comment.