From 90fee4f50eb5a0f81390e088f60265ab4974370e Mon Sep 17 00:00:00 2001
From: strawberry <june@girlboss.ceo>
Date: Sat, 8 Mar 2025 00:15:13 -0500
Subject: [PATCH] add gotestfmt log output to complement script and CI output

Signed-off-by: strawberry <june@girlboss.ceo>
---
 .github/workflows/ci.yml | 30 +++++++++++++++++++-----------
 bin/complement           | 22 +++++++++++++++++-----
 flake.nix                |  1 +
 3 files changed, 37 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index c0425873..c8fef47f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -176,6 +176,13 @@ jobs:
                 path: complement_test_results.jsonl
                 if-no-files-found: error
 
+            - name: Upload Complement logs (gotestfmt)
+              uses: actions/upload-artifact@v4
+              with:
+                name: complement_test_logs_gotestfmt.log
+                path: complement_test_logs_gotestfmt.log
+                if-no-files-found: error
+
             - name: Diff Complement results with checked-in repo results
               run: |
                   diff -u --color=always tests/test_results/complement/test_results.jsonl complement_test_results.jsonl > >(tee -a complement_diff_output.log)
@@ -186,22 +193,23 @@ jobs:
               if: success() || failure()
               run: |
                   if [ ${GH_JOB_STATUS} == 'success' ]; then
-                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
+                      echo '# ✅ CI completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
                   else
-                      echo '# CI failure' >> $GITHUB_STEP_SUMMARY
+                      echo '# ❌ CI failed (last 100 lines of output)' >> $GITHUB_STEP_SUMMARY
                       echo '```' >> $GITHUB_STEP_SUMMARY
-                      tail -n 40 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
-                      echo '```' >> $GITHUB_STEP_SUMMARY
-
-                      echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
-                      echo '```diff' >> $GITHUB_STEP_SUMMARY
-                      tail -n 100 complement_diff_output.log | sed 's/\x1b\[[0-9;]*m//g' >>     $GITHUB_STEP_SUMMARY
+                      tail -n 100 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
                       echo '```' >> $GITHUB_STEP_SUMMARY
                   fi
 
-            - name: Run cargo clean test artifacts to free up space
-              run: |
-                  cargo clean --profile test
+                  echo '# Complement diff results (last 100 lines)' >> $GITHUB_STEP_SUMMARY
+                  echo '```diff' >> $GITHUB_STEP_SUMMARY
+                  tail -n 100 complement_diff_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                  echo '```' >> $GITHUB_STEP_SUMMARY
+
+                  echo '# Complement gotestfmt logs (last 100 lines)' >> $GITHUB_STEP_SUMMARY
+                  echo '```diff' >> $GITHUB_STEP_SUMMARY
+                  tail -n 100 complement_test_logs_gotestfmt.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                  echo '```' >> $GITHUB_STEP_SUMMARY
 
     build:
         name: Build
diff --git a/bin/complement b/bin/complement
index 9960299c..aec27c5b 100755
--- a/bin/complement
+++ b/bin/complement
@@ -10,15 +10,15 @@ set -euo pipefail
 COMPLEMENT_SRC="${COMPLEMENT_SRC:-$1}"
 
 # A `.jsonl` file to write test logs to
-LOG_FILE="$2"
+LOG_FILE="${2:-complement_test_logs.jsonl}"
 
 # A `.jsonl` file to write test results to
-RESULTS_FILE="$3"
+RESULTS_FILE="${3:-complement_test_results.jsonl}"
 
 OCI_IMAGE="complement-conduwuit:main"
 
-# Complement tests that are skipped due to flakiness/reliability issues
-SKIPPED_COMPLEMENT_TESTS='-skip=TestPartialStateJoin.*'
+# Complement tests that are skipped due to flakiness/reliability issues or we don't implement such features and won't for a long time
+#SKIPPED_COMPLEMENT_TESTS='-skip=TestPartialStateJoin.*'
 
 # $COMPLEMENT_SRC needs to be a directory to Complement source code
 if [ -f "$COMPLEMENT_SRC" ]; then
@@ -34,6 +34,7 @@ toplevel="$(git rev-parse --show-toplevel)"
 
 pushd "$toplevel" > /dev/null
 
+# if using macOS, use linux-complement
 #bin/nix-build-and-cache just .#linux-complement
 bin/nix-build-and-cache just .#complement
 
@@ -45,7 +46,8 @@ set +o pipefail
 env \
     -C "$COMPLEMENT_SRC" \
     COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -tags="conduwuit_blacklist" "$SKIPPED_COMPLEMENT_TESTS" -v -timeout 1h -json ./tests/... | tee "$LOG_FILE"
+    COMPLEMENT_ENABLE_DIRTY_RUNS=1 \ # reuses the same complement container for faster complement, at the possible expense of test environment pollution
+    go test -tags="conduwuit_blacklist" -v -timeout 1h -json ./tests/... | tee "$LOG_FILE"
 set -o pipefail
 
 # Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
@@ -55,3 +57,13 @@ cat "$LOG_FILE" | jq -s -c 'sort_by(.Test)[]' | jq -c '
         and .Test != null
     ) | {Action: .Action, Test: .Test}
     ' > "$RESULTS_FILE"
+
+grep '^{"Time":' "$LOG_FILE" | gotestfmt > "${LOG_FILE}_gotestfmt.log"
+
+echo ""
+echo ""
+echo "complement logs saved at $LOG_FILE"
+echo "complement results saved at $RESULTS_FILE"
+echo "complement logs in gotestfmt pretty format outputted at ${LOG_FILE}_gotestfmt.log (use an editor/terminal that interprets ANSI colours)"
+echo ""
+echo ""
diff --git a/flake.nix b/flake.nix
index 8f08a7d9..544cdd4a 100644
--- a/flake.nix
+++ b/flake.nix
@@ -161,6 +161,7 @@
 
           # Needed for our script for Complement
           jq
+          gotestfmt
 
           # Needed for finding broken markdown links
           lychee