chore: use gotestsum for running tests

chmouel · chmouel · commit dc8d0a87eb79 · 2026-03-28T07:48:07.000+01:00
Introduced a helper script to manage gotestsum binary installation
across CI environments. Replaced make targets with gotestsum to improve
test reporting and consistency in Tekton pipelines and GitHub Actions.

This allows output to json and stdout at the same time
diff --git a/.tekton/generate-coverage-release.yaml b/.tekton/generate-coverage-release.yaml
@@ -82,12 +82,18 @@ spec:
                   value: "$(context.pipelineRun.name)"
                 - name: TESTRR_RUN_LABEL
                   value: "tekton-coverage-release"
+                - name: GH_TOKEN
+                  valueFrom:
+                    secretKeyRef:
+                      name: "nightly-ci-github-hub-token"
+                      key: "hub-token"
               script: |
                 #!/usr/bin/env bash
                 set -euo pipefail
+                ./hack/install-gotestsum.sh 1.13.0 "$(go env GOPATH)/bin"
                 test_status=0
-                make test GO_TEST_FLAGS="-json -coverprofile=coverage.txt -covermode=atomic" \
-                  2>&1 | tee /tmp/testrr-coverage-go.json || test_status=$?
+                gotestsum --format standard-verbose --jsonfile /tmp/testrr-coverage-go.json -- \
+                  -coverprofile=coverage.txt -covermode=atomic ./pkg/... || test_status=$?
                 if ! ./hack/upload-testrr.sh /tmp/testrr-coverage-go.json; then
                   echo "WARNING: testrr upload failed; continuing without failing Tekton"
                 fi
diff --git a/.tekton/go.yaml b/.tekton/go.yaml
@@ -80,14 +80,20 @@ spec:
                   value: "$(context.pipelineRun.name)"
                 - name: TESTRR_RUN_LABEL
                   value: "pac-unit-tests"
+                - name: GH_TOKEN
+                  valueFrom:
+                    secretKeyRef:
+                      name: "nightly-ci-github-hub-token"
+                      key: "hub-token"
               workingDir: $(workspaces.source.path)
               script: |
                 #!/usr/bin/env bash
                 set -euo pipefail
                 git config --global --add safe.directory $(workspaces.source.path)
+                ./hack/install-gotestsum.sh 1.13.0 "$(go env GOPATH)/bin"
                 test_status=0
-                make test GO_TEST_FLAGS="-json -coverprofile=coverage.txt -covermode=atomic" \
-                  2>&1 | tee /tmp/testrr-unit-go.json || test_status=$?
+                gotestsum --format standard-verbose --jsonfile /tmp/testrr-unit-go.json -- \
+                  -coverprofile=coverage.txt -covermode=atomic ./pkg/... || test_status=$?
                 if ! ./hack/upload-testrr.sh /tmp/testrr-unit-go.json; then
                   echo "WARNING: testrr upload failed; continuing without failing Tekton"
                 fi
diff --git a/hack/gh-workflow-ci.sh b/hack/gh-workflow-ci.sh
@@ -219,7 +219,10 @@ run_e2e_tests() {
 
   # shellcheck disable=SC2001
   test_pattern="$(echo "${tests[*]}" | sed 's/ /|/g')"
-  make test-e2e GO_TEST_FLAGS="-json -run \"${test_pattern}\"" 2>&1 | tee "${raw_output}" || test_status=$?
+  ./hack/install-gotestsum.sh 1.13.0 "${HOME}/go/bin"
+  env GODEBUG=asynctimerchan=1 \
+    gotestsum --format standard-verbose --jsonfile "${raw_output}" -- \
+    -race -failfast -timeout 45m -count=1 -tags=e2e -run "${test_pattern}" ./test || test_status=$?
   if ! TESTRR_RUN_LABEL="${TESTRR_RUN_LABEL:-gha-e2e-${target}}" ./hack/upload-testrr.sh "${raw_output}"; then
     echo "::warning::testrr upload failed; continuing without failing GitHub Actions"
   fi
diff --git a/hack/install-gotestsum.sh b/hack/install-gotestsum.sh
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# description: Download gotestsum binary from GitHub releases.
+# this lets us pin the version and avoid slow `go install` in CI.
+# Author: Chmouel Boudjnah <chmouel@chmouel.com>
+set -eufo pipefail
+
+VERSION=${1:-}
+TARGETDIR=${2:-}
+
+[[ -z ${VERSION} || -z ${TARGETDIR} ]] && { echo "Usage: $0 <version> <targetdir>" && exit 1; }
+[[ -d ${TARGETDIR} ]] || mkdir -p "${TARGETDIR}"
+[[ -x ${TARGETDIR}/gotestsum ]] && {
+  "${TARGETDIR}/gotestsum" --version 2>/dev/null | grep -q "${VERSION}" && exit 0
+  rm -f "${TARGETDIR}/gotestsum"
+}
+
+detect_os_arch() {
+  local os arch
+
+  case "$(uname -s)" in
+  Linux*)  os=linux ;;
+  Darwin*) os=darwin ;;
+  *) echo "Unknown OS" && exit 1 ;;
+  esac
+
+  case "$(uname -m)" in
+  x86_64)           arch=amd64 ;;
+  arm64 | aarch64)  arch=arm64 ;;
+  *) echo "Unknown arch" && exit 1 ;;
+  esac
+
+  echo "${os}_${arch}"
+}
+
+os_arch=$(detect_os_arch)
+download_url="https://github.com/gotestyourself/gotestsum/releases/download/v${VERSION}/gotestsum_${VERSION}_${os_arch}.tar.gz"
+
+token="${GH_TOKEN:-${GITHUB_TOKEN:-}}"
+curl_args=(-sL --fail-early -f)
+[[ -n "${token}" ]] && curl_args+=(-H "Authorization: Bearer ${token}")
+
+echo -n "Downloading gotestsum ${VERSION} (${os_arch}) to ${TARGETDIR}: "
+curl "${curl_args[@]}" -o- "${download_url}" | tar -xz -C "${TARGETDIR}" gotestsum
+echo "Done"
