From ffe2464836dec7bbce2659b2b4e62eb956bf2a90 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Thu, 16 Jun 2022 10:31:10 +0100 Subject: [PATCH] Add instructions for running Complement with `gotestfmt`-formatted output locally. (#13073) --- changelog.d/13073.doc | 1 + docs/development/contributing_guide.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 changelog.d/13073.doc diff --git a/changelog.d/13073.doc b/changelog.d/13073.doc new file mode 100644 index 000000000..e162a8404 --- /dev/null +++ b/changelog.d/13073.doc @@ -0,0 +1 @@ +Add instructions for running Complement with `gotestfmt`-formatted output locally. \ No newline at end of file diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index c2f04a390..4738f8a6b 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -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: