ci: tidy check-profiling-results.sh

Author: marc-casavant

scripts/ci/check-profiling-results.sh

@@ -14,13 +14,11 @@
 #
 #  The check's details_url deep-links the store's cest-latest.html for this
 #  publish. Ingest writes that file synchronously inside the publish POST, so
-#  it exists now or never (a failed summary step logs a warning server-side
-#  and never fails the publish): probe it once, and on a miss post the check
-#  without the link rather than linking a 404.
-#
-#  The store path is <branch>/<short-sha> with "/" mapped to "_", built by
-#  src/tests/multi-server/all.mk; read the leaf off prof-results/ rather than
-#  recomputing it, so the URL cannot drift from the publish.
+#  it exists now or never: probe it once, and on a miss post the check without
+#  the link rather than linking a 404. The store path is <branch>/<short-sha>
+#  with "/" mapped to "_", built by src/tests/multi-server/all.mk; read the
+#  leaf off prof-results/ rather than recomputing it, so the URL cannot drift
+#  from the publish.
 #
 
 set -eu
@@ -62,17 +60,20 @@ esac
 [ $# -eq 1 ] || { usage >&2; exit 2; }
 store=${1%/}
 
-for var in GH_TOKEN GITHUB_SHA GITHUB_REPOSITORY GITHUB_API_URL; do
-	eval "val=\${$var:-}"
-	[ -n "$val" ] || { echo "ERROR: $var is not set" >&2; exit 2; }
-done
+: "${GH_TOKEN:?}" "${GITHUB_SHA:?}" "${GITHUB_REPOSITORY:?}" "${GITHUB_API_URL:?}"
 
-#  The name stays short and stable; the verdict lives in the title. Check
-#  runs created with the Actions GITHUB_TOKEN get attached to an arbitrary
-#  workflow's check suite (GitHub limitation, community discussion #24616),
-#  so the workflow-name prefix GitHub renders cannot be relied on.
-check_name='profiling'
+check_name='profiling: CEst regression'
+api="$GITHUB_API_URL/repos/$GITHUB_REPOSITORY"
 
+gh_api()
+{
+	curl -sS --connect-timeout 5 --max-time 20 \
+		-H "Authorization: Bearer $GH_TOKEN" \
+		-H "Accept: application/vnd.github+json" "$@"
+}
+
+#  Run the gate. An empty report file stands in when the analyzer dies before
+#  writing one, so the check always has a summary body.
 curl -fsSL -o cest-analyzer "$store/dashboard/bin/cest-analyzer"
 chmod +x ./cest-analyzer
 : > cest-latest.md
@@ -82,44 +83,47 @@ rc=0
 echo "cest-analyzer exit code: $rc"
 [ -s cest-latest.md ] || echo "No comparison report was produced." > cest-latest.md
 
-leaf=$(cd prof-results 2>/dev/null && ls -d */*/ 2>/dev/null | head -1) || leaf=""
-details="$store/data/${leaf%/}/cest-latest.html"
-if [ -z "$leaf" ] || ! curl -sfI --connect-timeout 5 --max-time 20 -o /dev/null "$details"; then
-	echo "warning: $details is not fetchable; posting the check without a details link"
-	details=""
-fi
-
 case "$rc" in
-0) conclusion=success; title="no performance degradation detected" ;;
-1) conclusion=neutral; title="latest results need review, performance degradation detected" ;;
-*) conclusion=neutral; title="gate did not run (analyzer exit $rc)" ;;
+0) conclusion=success; title="No CEst regression" ;;
+1) conclusion=neutral; title="CEst regression vs the previous profiling run" ;;
+*) conclusion=neutral; title="Profiling gate did not run (analyzer exit $rc)" ;;
 esac
 
+#  The summary link, if this publish's cest-latest.html is really there.
+details=""
+leaf=$(ls -d prof-results/*/*/ 2>/dev/null | head -n 1)
+if [ -n "$leaf" ]; then
+	details="$store/data/${leaf#prof-results/}"
+	details="${details%/}/cest-latest.html"
+	curl -sfI --connect-timeout 5 --max-time 20 -o /dev/null "$details" || {
+		echo "warning: $details is not fetchable; posting the check without a details link"
+		details=""
+	}
+fi
+
 #  GitHub caps output.summary at 65535 characters; trim below the cap.
-payload=$(jq -n --arg name "$check_name" --arg sha "$GITHUB_SHA" \
-	--arg conclusion "$conclusion" --arg title "$title" --arg details "$details" \
+payload=$(jq -n --arg name "$check_name" --arg conclusion "$conclusion" \
+	--arg title "$title" --arg details "$details" \
 	--rawfile summary cest-latest.md \
-	'{name: $name, head_sha: $sha, status: "completed", conclusion: $conclusion,
+	'{name: $name, status: "completed", conclusion: $conclusion,
 	  output: {title: $title, summary: $summary[0:60000]}}
 	 + (if $details != "" then {details_url: $details} else {} end)')
 
-#  One check per commit: a re-run updates the existing run in place.
-id=$(curl -sS -H "Authorization: Bearer $GH_TOKEN" -H "Accept: application/vnd.github+json" \
-	--get --data-urlencode "check_name=$check_name" \
-	"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/commits/$GITHUB_SHA/check-runs" \
+#  One check per commit: update the existing run if there is one, else create
+#  (head_sha is only valid on create).
+id=$(gh_api --get --data-urlencode "check_name=$check_name" \
+	"$api/commits/$GITHUB_SHA/check-runs" \
 	| jq -r '.check_runs[0].id // empty') || id=""
+
 if [ -n "$id" ]; then
-	code=$(curl -sS -o /dev/null -w '%{http_code}' -X PATCH \
-		-H "Authorization: Bearer $GH_TOKEN" -H "Accept: application/vnd.github+json" \
-		-d "$(printf '%s' "$payload" | jq 'del(.head_sha)')" \
-		"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/check-runs/$id") || code=000
-	action="update"
+	action=update
+	code=$(gh_api -o /dev/null -w '%{http_code}' -X PATCH \
+		-d "$payload" "$api/check-runs/$id") || code=000
 else
-	code=$(curl -sS -o /dev/null -w '%{http_code}' -X POST \
-		-H "Authorization: Bearer $GH_TOKEN" -H "Accept: application/vnd.github+json" \
-		-d "$payload" \
-		"$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/check-runs") || code=000
-	action="create"
+	action=create
+	payload=$(printf '%s' "$payload" | jq --arg sha "$GITHUB_SHA" '. + {head_sha: $sha}')
+	code=$(gh_api -o /dev/null -w '%{http_code}' -X POST \
+		-d "$payload" "$api/check-runs") || code=000
 fi
 
 case "$code" in