mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-16 03:13:11 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for finding which tests to add for PR in docs/sytest.md

Browse source 
Signed-off-by: Alex Chen <minecnly@gmail.com>
This commit is contained in:
Cnly 2019-05-30 17:08:57 +08:00
parent 7a2d5b17b9
commit 753a41305b
1 changed files with 37 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
docs/sytest.md
View file

@ -1,8 +1,41 @@
# SyTest # SyTest
Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its
integration testing. When creating a new PR, add the test IDs that your PR integration testing. When creating a new PR, add the test IDs (see below) that
should allow to pass to `testfile` in dendrite's root directory. Not all PRs your PR should allow to pass to `testfile` in dendrite's root directory. Not all
need to make new tests pass. If we find your PR should be making a test pass we PRs need to make new tests pass. If we find your PR should be making a test pass
may ask you to add to that file, as generally Dendrite's progress can be 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. tracked through the amount of SyTest tests it passes.
## Finding out which tests to add
An easy way to do this will be let CircleCI run sytest, and then search for the
tests that should be added in the test results file.
You may enable [CircleCI](https://circleci.com/) for your own fork, or simply
refer to the CircleCI build for your PR. Once the build is complete, you can
find the test results in `Container N/logs/results.tap` under the **Artifacts**
tab on the CircleCI build page. To get the tests that should be added, search
for the string:
```
# TODO passed but expected fail
```
Generally, tests with this label should be the tests that your PR is allowing to
pass.
To add a test into `testfile`, extract its test ID and append it to `testfile`.
For example, to add this test:
```
ok 4 (expected fail) POST /register rejects registration of usernames with '!' # TODO passed but expected fail
```
Append:
```
POST /register rejects registration of usernames with '!'
```
to `testfile`.