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

Add instructions for running Complement with gotestfmt-formatted output locally. #13073

Merged
merged 2 commits into from
Jun 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13073.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add instructions for running Complement with `gotestfmt`-formatted output locally.
14 changes: 14 additions & 0 deletions docs/development/contributing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,20 @@ The above will run a monolithic (single-process) Synapse with SQLite as the data
- Passing `WORKERS=1` as an environment variable to use a workerised setup instead. This option implies the use of Postgres.


### Prettier formatting with `gotestfmt`

If you want to format the output of the tests the same way as it looks in CI,
install [gotestfmt](https://github.com/haveyoudebuggedit/gotestfmt).

You can then use this incantation to format the tests appropriately:

```sh
COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests
```

(Remove `-hide successful-tests` if you don't want to hide successful tests.)


### Access database for homeserver after Complement test runs.

If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:
Expand Down