mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-15 10:53:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Refine sytest.md

Browse source
This commit is contained in:
Alex Chen 2019-06-21 22:10:59 +08:00 committed by GitHub
parent e51d9838a3
commit 39110cd254
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/sytest.md
View file

@ -13,7 +13,7 @@ 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.
You should proceed after you see no build problems for dendrite by running:
You should proceed after you see no build problems for dendrite after running:
```sh
./build.sh
@ -21,8 +21,10 @@ You should proceed after you see no build problems for dendrite by running:
### Manually Setting up sytest
Get a copy of sytest on the `develop` branch next to your dendrite
directory, and run the setup script:
Make sure you have Perl v5+ installed, and get sytest with:
(Note that this guide assumes your `sytest` checkout is next to your
`dendrite` checkout.)
```sh
git clone -b develop https://github.com/matrix-org/sytest
@ -38,9 +40,9 @@ sudo -u postgres psql -c "CREATE DATABASE sytest_template OWNER dendrite"
mkdir -p "server-0"
cat > "server-0/database.yaml" << EOF
args:
user: $PGUSER
database: $PGUSER
host: $PGHOST
user: dendrite
database: dendrite
host: 127.0.0.1
type: pg
EOF
```
@ -54,7 +56,7 @@ Run the tests:
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
anything, and add them as needed:
any newly passing test names to `testfile` in the project's root directory:
```sh
../dendrite/show-expected-fail-tests.sh results.tap
@ -62,7 +64,7 @@ anything, and add them as needed:
If the script prints nothing/exits with 0, then you're good to go.
### Using a sytest Docker Image
### Using a sytest Docker image
Ensure you have the latest image for sytest, then run the tests: