summary refs log tree commit diff
path: root/develop/development/contributing_guide.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2022-03-31 10:30:43 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2022-03-31 10:30:43 +0000
commit2103171774b72389c7cbf2ffaab71fd87005959e (patch)
tree42eddcfcae01e7d4990b031d9e99ecb0a7a2da31 /develop/development/contributing_guide.html
parentdeploy: 2fc15ac718b4f48e42762deb8398af6978dc506f (diff)
downloadsynapse-2103171774b72389c7cbf2ffaab71fd87005959e.tar.xz
deploy: 15cdcf8f302fd9c7aeda15ba0d2c6dbe46291216
Diffstat (limited to 'develop/development/contributing_guide.html')
-rw-r--r--develop/development/contributing_guide.html13
1 files changed, 0 insertions, 13 deletions
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html

index e580dfe324..ef7ef965e1 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html
@@ -330,19 +330,6 @@ export SYNAPSE_POSTGRES_USER=postgres export SYNAPSE_POSTGRES_PASSWORD=mydevenvpassword trial </code></pre> -<h4 id="prebuilt-container"><a class="header" href="#prebuilt-container">Prebuilt container</a></h4> -<p>Since configuring PostgreSQL can be fiddly, we can make use of a pre-made -Docker container to set up PostgreSQL and run our tests for us. To do so, run</p> -<pre><code class="language-shell">scripts-dev/test_postgresql.sh -</code></pre> -<p>Any extra arguments to the script will be passed to <code>tox</code> and then to <code>trial</code>, -so we can run a specific test in this container with e.g.</p> -<pre><code class="language-shell">scripts-dev/test_postgresql.sh tests.replication.test_sharded_event_persister.EventPersisterShardTestCase -</code></pre> -<p>The container creates a folder in your Synapse checkout called -<code>.tox-pg-container</code> and uses this as a tox environment. The output of any -<code>trial</code> runs goes into <code>_trial_temp</code> in your synapse source directory — the same -as running <code>trial</code> directly on your host machine.</p> <h2 id="run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgsytestsytesta"><a class="header" href="#run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgsytestsytesta">Run the integration tests (<a href="https://github.com/matrix-org/sytest">Sytest</a>).</a></h2> <p>The integration tests are a more comprehensive suite of tests. They run a full version of Synapse, including your changes, to check if