Fix e2e CI failure debug script (#2104)

* induce failure for testing, tweak script

* finish fixing the script, remove test failure

* add commit arg

Author: david-crespo

.gitignore

@@ -25,5 +25,6 @@
 .DS_Store
 Thumbs.db
 test-results/
+ci-e2e-traces/
 playwright-report/
 .vercel

tools/debug-ci-e2e-fail.sh

@@ -1,34 +1,55 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at https://mozilla.org/MPL/2.0/.
 #  
 # Copyright Oxide Computer Company
 
+# Run this script on a branch to download the E2E failure traces from the
+# latest run on that branch. Pass a commit (full hash, not abbreviated)
+# to pull the traces for that commit.
+
 set -e
 set -o pipefail
 
-# Get the ID of the last github actions run if there was one
-BRANCH=$(git rev-parse --abbrev-ref HEAD)
-RUN_ID=$(gh run list -b "$BRANCH" -w CI -L 1 --json databaseId --jq '.[0].databaseId')
+DIR="ci-e2e-traces"
+
+COMMIT=$1
 
-if [ -z "$RUN_ID" ]; then
-  echo "No action runs found for this branch"
-  exit 0
+# Get the ID of the last github actions run if there was one. If a commit
+# is specified, use that, otherwise
+if [ -n "$COMMIT" ]; then
+    echo -e "Looking at latest run on commit $COMMIT"
+    RUN_ID=$(gh run list --commit "$COMMIT" -w CI -L 1 --json databaseId --jq '.[0].databaseId')
+    if [ -z "$RUN_ID" ]; then
+      echo "No action runs found. Make sure to use full commit SHA."
+      exit 0
+    fi
+else 
+    BRANCH=$(git rev-parse --abbrev-ref HEAD)
+    echo -e "Looking at latest run on branch $BRANCH"
+    RUN_ID=$(gh run list -b "$BRANCH" -w CI -L 1 --json databaseId --jq '.[0].databaseId')
+    if [ -z "$RUN_ID" ]; then
+      echo "No action runs found"
+      exit 0
+    fi
 fi
 
-if [ -d "test-results" ] && [ -f "test-results/.run" ] && [ "$RUN_ID" == "$(cat test-results/.run)" ]; then
+
+if [ -e "$DIR/.run" ] && [ "$RUN_ID" == "$(cat $DIR/.run)" ]; then
     : # Do nothing, the test results are already up to date
 else
-    rm -rf test-results
-    echo "Attempting to download test failure traces for current branch..."
-    gh run download $RUN_ID
-    echo $RUN_ID > test-results/.run
+    rm -rf $DIR
+    echo "Downloading traces..."
+    gh run download $RUN_ID --dir $DIR
+    echo $RUN_ID > $DIR/.run
 fi
 
-
-echo "Choose a test trace to view"
-select test in $(ls test-results); do
-    npx playwright show-trace test-results/$test/trace.zip
+# gnarly select and re-find is to take filepath noise out of the select list
+echo "Choose a trace to view"
+select trace in $(find $DIR -name "trace.zip" | sed 's/.*\/\(.*\)\/trace.zip/\1/'); do
+    selected_trace=$(find $DIR -path "*/$trace"/trace.zip)
+    npx playwright show-trace "$selected_trace"
     exit 0
-done
+done