feat: add a CircleCI logs script

Author: DevilPepper

scripts/.local/bin/circle

@@ -0,0 +1,139 @@
+#!/usr/bin/env bash
+
+if [[ -f .env ]]; then
+  # Mark variables which are modified or created for export
+  set -a
+  source .env
+  set +a
+fi
+
+if ! git is-repo; then
+  echo "You must run this in a git repo" >&2
+  exit 1
+fi
+
+if [[ -z "$CIRCLECI_PROJECT_SLUG" ]]; then
+  echo "CIRCLECI_PROJECT_SLUG not set" >&2
+  exit 1
+fi
+
+export circle_token=$(keyring get circleci Circle-Token)
+if [[ -z "$circle_token" ]]; then
+  echo "Circle-Token not found in keyring" >&2
+  echo "Store it by running: 'keyring set circleci Circle-Token'" >&2
+  exit 1
+fi
+
+function main() {
+  if [[ "$1" == "logs" ]]; then
+    job_name="$2"
+    step_name="$3"
+  fi
+
+  revision=$(git rev-parse --verify HEAD)
+
+  pipeline=$( \
+    curl --fail --silent --show-error --location \
+      --header "Circle-Token: ${circle_token}" \
+      --url "https://circleci.com/api/v2/project/${CIRCLECI_PROJECT_SLUG}/pipeline?branch=$(git branch --show-current)" \
+    | jq --arg revision "$revision" '.items | map(select(.vcs.revision == $revision)) | .[0]' \
+  )
+
+  pipeline_id=$(echo "$pipeline" | jq -r '.id')
+  pipeline_number=$(echo "$pipeline" | jq -r '.number')
+
+  workflow_name="${CIRCLECI_WORKFLOW_NAME:-main}"
+  workflow=$( \
+    curl --fail --silent --show-error --location \
+      --header "Circle-Token: ${circle_token}" \
+      --url "https://circleci.com/api/v2/pipeline/${pipeline_id}/workflow" \
+    | jq --arg workflow_name "$workflow_name" '.items | map(select(.name == $workflow_name)) | .[0]' \
+  )
+
+  if [[ "$workflow" == "null" ]]; then
+    echo "Workflow '${workflow_name}' not found for this pipeline" >&2
+    exit 1
+  fi
+
+  workflow_id=$(echo "$workflow" | jq -r '.id')
+  circleci_ui="https://app.circleci.com/pipelines/${CIRCLECI_PROJECT_SLUG}/${pipeline_number}/workflows/${workflow_id}"
+
+  selected_job=$(get_a_job "$workflow_id" "$job_name")
+
+  if [[ -z "$selected_job" ]]; then
+    echo "$circleci_ui"
+    exit 0
+  fi
+
+  job_number=$(echo "$selected_job" | cut -d' ' -f1)
+  job_name=$(echo "$selected_job" | cut -d' ' -f2-)
+  circleci_ui="${circleci_ui}/jobs/${job_number}"
+  steps_file=$(mktemp)
+
+  step_name=$(get_step "$job_number" "$steps_file" "$step_name")
+
+  if [[ -z "$step_name" ]]; then
+    echo "$circleci_ui"
+    exit 0
+  fi
+
+  if [[ "$1" == "logs" ]]; then
+    circle-log-fetch.sh "$steps_file" "$step_name"
+  else
+    echo "You can go straight to these logs with:"
+    echo "circle logs '$job_name' '$step_name'"
+    circle-log-fetch.sh "$steps_file" "$step_name" | less -R
+  fi
+}
+
+function get_a_job() {
+  workflow_id="$1"
+  job_name="$2"
+
+  jobs=$( \
+    curl --fail --silent --show-error --location \
+      --header "Circle-Token: ${circle_token}" \
+      --url "https://circleci.com/api/v2/workflow/${workflow_id}/job" \
+    | jq '.items' \
+  )
+
+  if [[ -z "$job_name" ]]; then
+    job_name=$( \
+      echo "$jobs" \
+      | jq -r '.[].name' \
+      | gum choose --header "What job do you want to see?" \
+    )
+  fi
+
+  if [[ -n "$job_name" ]]; then
+    job_number=$( \
+      echo "$jobs" \
+      | jq -r --arg job_name "$job_name" 'map(select(.name == $job_name)) | .[0].job_number' \
+    )
+    echo "$job_number $job_name"
+  fi
+}
+
+function get_step() {
+  job_number="$1"
+  steps_file="$2"
+  step_name="$3"
+
+  curl --fail --silent --show-error --location \
+    --header "Circle-Token: ${circle_token}" \
+    --url "https://circleci.com/api/v1.1/project/${CIRCLECI_PROJECT_SLUG}/${job_number}" \
+  | jq '.steps' \
+  > $steps_file
+
+  if [[ -z "$step_name" ]]; then
+    cat $steps_file \
+    | jq -r '.[].name' \
+    | fzf --ansi \
+          --delimiter='\x01' \
+          --preview="circle-log-preview.sh $steps_file {}"
+  else
+    echo "$step_name"
+  fi
+}
+
+main "$@"

scripts/.local/bin/circle-log-fetch.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+function main() {
+  steps_file="$1"
+  step_name="$2"
+
+  cache=""
+  if command -v bkt &> /dev/null; then
+    cache="bkt --ttl=30m --stale=1m --"
+  fi
+
+  cat $steps_file \
+  | filter-json name "$step_name" \
+  | jq -r '.[].actions[].output_url' \
+  | while read -r output_url; do
+    $cache bash -c "$GET_CIRCLECI_LOGS; get_circleci_logs '$output_url'"
+  done
+}
+
+function get_circleci_logs() {
+  output_url="$1"
+
+  curl --fail --silent --show-error --location \
+    --header "Circle-Token: ${circle_token}" \
+    --url "$output_url" \
+  | jq -r ".[].message"
+}
+# export -f get_circleci_logs
+export GET_CIRCLECI_LOGS="$(declare -f get_circleci_logs)"
+
+main "$@"

scripts/.local/bin/circle-log-preview.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+steps_file="$1"
+step_name="$2"
+
+circle-log-fetch.sh "$steps_file" "$step_name"
+
+echo "\n--------------------------------\n"
+
+cat "$steps_file" \
+  | filter-json name "$step_name" \
+  | jq -r '.[0].actions[0].bash_command' \
+  | bat --color=always --language=sh # could be better

scripts/.local/bin/filter-json

@@ -0,0 +1,21 @@
+#!/usr/bin/env -S uv --quiet run --script
+# /// script
+# requires-python = ">=3.12"
+# ///
+
+import json
+import sys
+
+if len(sys.argv) < 3:
+  print("Usage: filter-json <filter_key> <filter_text>", file=sys.stderr)
+  sys.exit(2)
+
+filter_key = sys.argv[1]
+filter_text = sys.argv[2]
+
+data = json.load(sys.stdin)
+if not isinstance(data, list):
+  raise RuntimeError('JSON must be a list')
+
+filtered = [item for item in data if filter_text == str(item.get(filter_key))]
+json.dump(filtered, sys.stdout)