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

Commit ffe2464

Browse files
authored
Add instructions for running Complement with gotestfmt-formatted output locally. (#13073)
1 parent 8ecf6be commit ffe2464

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

changelog.d/13073.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add instructions for running Complement with `gotestfmt`-formatted output locally.

docs/development/contributing_guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,20 @@ The above will run a monolithic (single-process) Synapse with SQLite as the data
310310
- Passing `WORKERS=1` as an environment variable to use a workerised setup instead. This option implies the use of Postgres.
311311
312312
313+
### Prettier formatting with `gotestfmt`
314+
315+
If you want to format the output of the tests the same way as it looks in CI,
316+
install [gotestfmt](https://github.com/haveyoudebuggedit/gotestfmt).
317+
318+
You can then use this incantation to format the tests appropriately:
319+
320+
```sh
321+
COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests
322+
```
323+
324+
(Remove `-hide successful-tests` if you don't want to hide successful tests.)
325+
326+
313327
### Access database for homeserver after Complement test runs.
314328

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

0 commit comments

Comments
 (0)