aboutsummaryrefslogtreecommitdiff
path: root/docs/sytest.md
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2020-01-22 13:31:22 +0000
committerGitHub <noreply@github.com>2020-01-22 13:31:22 +0000
commit0f8d6cc1c1c6c3f85b1c4a382f9859ae3e99f62d (patch)
tree63b1137205256b2a4e5b20a8d14d75bff7468ee5 /docs/sytest.md
parentac96fd565b676f428f0402aa5cf0d430811d7c14 (diff)
Add a Sytest blacklist file (#849)
Diffstat (limited to 'docs/sytest.md')
-rw-r--r--docs/sytest.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/sytest.md b/docs/sytest.md
index e936dc49..6d03270b 100644
--- a/docs/sytest.md
+++ b/docs/sytest.md
@@ -2,16 +2,17 @@
Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its
integration testing. When creating a new PR, add the test IDs (see below) that
-your PR should allow to pass to `testfile` in dendrite's root directory. Not all
-PRs need to make new tests pass. If we find your PR should be making a test pass
-we may ask you to add to that file, as generally Dendrite's progress can be
-tracked through the amount of SyTest tests it passes.
+your PR should allow to pass to `sytest-whitelist` in dendrite's root
+directory. Not all PRs need to make new tests pass. If we find your PR should
+be making a test pass we may ask you to add to that file, as generally
+Dendrite's progress can be tracked through the amount of SyTest tests it
+passes.
## Finding out which tests to add
We recommend you run the tests locally by manually setting up SyTest or using a
SyTest docker image. After running the tests, a script will print the tests you
-need to add to `testfile` for you.
+need to add to `sytest-whitelist`.
You should proceed after you see no build problems for dendrite after running:
@@ -50,16 +51,16 @@ EOF
Run the tests:
```sh
-./run-tests.pl -I Dendrite::Monolith -d ../dendrite/bin -W ../dendrite/testfile -O tap --all | tee results.tap
+./run-tests.pl -I Dendrite::Monolith -d ../dendrite/bin -W ../dendrite/sytest-whitelist -O tap --all | tee results.tap
```
where `tee` lets you see the results while they're being piped to the file.
Once the tests are complete, run the helper script to see if you need to add
-any newly passing test names to `testfile` in the project's root directory:
+any newly passing test names to `sytest-whitelist` in the project's root directory:
```sh
-../dendrite/show-expected-fail-tests.sh results.tap ../dendrite/testfile
+../dendrite/show-expected-fail-tests.sh results.tap ../dendrite/sytest-whitelist ../dendrite/sytest-blacklist
```
If the script prints nothing/exits with 0, then you're good to go.
@@ -75,4 +76,4 @@ docker run --rm -v /path/to/dendrite/:/src/ matrixdotorg/sytest-dendrite
where `/path/to/dendrite/` should be replaced with the actual path to your
dendrite source code. The output should tell you if you need to add any tests to
-`testfile`.
+`sytest-whitelist`.