refactor: replace custom test formatter with gotestsum (#380)

Author: gabor-boros

.github/workflows/build.yml

@@ -46,6 +46,8 @@ jobs:
       - uses: actions/setup-go@v5
         with:
           go-version: "^1.25"
+      - name: Install gotestsum
+        run: go install gotest.tools/gotestsum@latest
       - name: Execute unit tests
         run: make test.backend.unit
       - name: Stash test results
@@ -81,6 +83,8 @@ jobs:
       - uses: actions/setup-go@v5
         with:
           go-version: "^1.25"
+      - name: Install gotestsum
+        run: go install gotest.tools/gotestsum@latest
       - name: Execute integration tests
         run: make test.backend.integration
       - name: Stash test results

CONTRIBUTING.md

@@ -190,7 +190,7 @@ test                           # Run all k6, backend and front-end tests
 ## Code Quality and Tests
 
 The project ensures code quality and code coverage in multiple ways. Besides third-party online tools, with the lack of
-completeness, `gofmt` `go-imports`, `golangci-lint`, `go test`, `k6`, `playwright` and `eslint` are used to keep up with
+completeness, `gofmt` `go-imports`, `golangci-lint`, `gotestsum`, `k6`, `playwright` and `eslint` are used to keep up with
 industry standards.
 
 Although front-end unit tests are not created yet, linters and some end-to-end tests are available. In order to run

Makefile

@@ -22,7 +22,6 @@ PNPM_RUN=$(PNPM_EXEC) run --prefix "$(ROOT_DIR)/web"
 PNPM_EMAILS_RUN=$(PNPM_EXEC) run --prefix "$(ROOT_DIR)/build/email"
 
 GO_EXEC:=$(shell which go)
-GO_TEST_COVER=$(GO_EXEC) test -shuffle=on -cover -covermode=atomic -ldflags="-extldflags=-Wl,-ld_classic"
 GO_TEST_IGNORE:=(mode: atomic|testutil|tools|cmd|http\/api)
 
 TMPDIR:=$(shell echo "${TMPDIR:-/tmp}")
@@ -165,13 +164,13 @@ test.backend.bench: ## Run backend benchmarks
 test.backend.unit: ## Run backend unit tests
 	$(call log, execute backend unit tests)
 	@rm -f "$(BACKEND_COVER_OUT_UNIT)"
-	@bash -c '$(GO_TEST_COVER) -json -race -short -coverprofile="$(BACKEND_COVER_OUT_UNIT)" ./... 2>&1 | $(SCRIPTS_DIR)/pretty-test.sh; exit $${PIPESTATUS[0]}'
+	@gotestsum --format testname -- -shuffle=on -cover -covermode=atomic -ldflags="-extldflags=-Wl,-ld_classic" -race -short -coverprofile="$(BACKEND_COVER_OUT_UNIT)" ./...
 
 .PHONY: test.backend.integration
 test.backend.integration: ## Run backend integration tests
 	$(call log, execute backend integration tests)
 	@rm -f "$(BACKEND_COVER_OUT_INTEGRATION)"
-	@bash -c '$(GO_TEST_COVER) -json -timeout 900s -run=Integration -coverprofile="$(BACKEND_COVER_OUT_INTEGRATION)" ./... 2>&1 | $(SCRIPTS_DIR)/pretty-test.sh; exit $${PIPESTATUS[0]}'
+	@gotestsum --format testname -- -shuffle=on -cover -covermode=atomic -ldflags="-extldflags=-Wl,-ld_classic" -timeout 900s -run=Integration -coverprofile="$(BACKEND_COVER_OUT_INTEGRATION)" ./...
 
 .PHONY: test.backend.coverage
 test.backend.coverage: ## Combine unit and integration test coverage

README.md

@@ -70,7 +70,7 @@ on Linux, MacOS, or Windows WSL2. Follow the steps below and get ready to contri
 
    ```shell
    # Make sure you have all the development requirements installed, then run the setup script.
-   # Requirements: yq, jq, go, openssl, docker (with compose plugin), make, nvm
+   # Requirements: yq, jq, go, openssl, docker (with compose plugin), make, nvm, gotestsum
    ./scripts/setup.sh
    ```
 

scripts/README.md

@@ -19,11 +19,6 @@ This script generates development configuration files and key.
 Takes the Open API specification in the `api/openapi` directory, and generates
 a TypeScript client from it.
 
-## pretty-test.sh
-
-Takes the JSON output of `go test` command and pretty-formats it using `jq` to
-make it more readable.
-
 ## setup.sh
 
 This script prepares the whole development environment. Generates a new