diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 856d69c..761e2cf 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -13,6 +13,7 @@ jobs: - name: Run unit tests run: | + bash tests/test_command_utils.sh bash tests/test_update_pr_stack.sh bash tests/test_rebase_workflow.sh bash tests/test_mixed_workflows.sh diff --git a/command_utils.sh b/command_utils.sh index a78d278..56212df 100644 --- a/command_utils.sh +++ b/command_utils.sh @@ -7,3 +7,26 @@ log_cmd() { printf "\n" >&2 "$@" } + +die() { + echo "❌ $*" >&2 + exit 1 +} + +# Log and execute a command, aborting the run if it fails. The explicit exit +# in die aborts from any context; `set -e` does not, because it is suppressed +# inside if/&&/|| conditions and everything they call, including the whole +# body of a function invoked as a condition. +# +# Note: inside a command substitution, exit only leaves the subshell, so +# `VAR=$(run ...)` does not abort the script. Use `VAR=$(try ...) || die ...` +# instead. +run() { + log_cmd "$@" || die "command failed (exit $?): $*" +} + +# Log and execute a command whose failure is an expected outcome (e.g. a +# merge that may conflict), handing the exit status to the caller. +try() { + log_cmd "$@" +} diff --git a/tests/test_command_utils.sh b/tests/test_command_utils.sh new file mode 100755 index 0000000..aa07d43 --- /dev/null +++ b/tests/test_command_utils.sh @@ -0,0 +1,56 @@ +#!/bin/bash +# +# Tests for the run/try/die wrappers. The property that matters: run aborts +# the whole script even where `set -e` is suppressed, i.e. inside an `if` +# condition, including the body of a function invoked as the condition. That +# is exactly where update-pr-stack.sh does most of its work, so `set -e` +# alone cannot be relied on there. + +set -ueo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)" + +PASS=0 +fail() { echo "❌ $1"; exit 1; } +ok() { echo "✅ $1"; PASS=$((PASS+1)); } + +# Baseline first, to document the trap that motivates run: with plain set -e, +# a failure inside a function called as an if-condition does NOT stop it. +OUT=$(bash -c ' + set -ueo pipefail + f() { false; echo "after-false"; } + if f; then :; fi +' 2>&1) +grep -q "after-false" <<<"$OUT" || fail "baseline: expected set -e to be suppressed in condition context" +ok "baseline: set -e is suppressed inside an if-condition function" + +# run must abort both the function and the script from that same context. +STATUS=0 +OUT=$(ROOT_DIR="$ROOT_DIR" bash -c ' + set -ueo pipefail + source "$ROOT_DIR/command_utils.sh" + f() { run false; echo "after-run"; } + if f; then :; fi + echo "survived" +' 2>&1) || STATUS=$? +[[ "$STATUS" -ne 0 ]] || fail "run: script should exit nonzero" +grep -q "after-run" <<<"$OUT" && fail "run: function continued after the failure" +grep -q "survived" <<<"$OUT" && fail "run: script continued after the failure" +grep -q "command failed" <<<"$OUT" || fail "run: no failure message printed" +ok "run aborts the script from a condition context" + +# try hands the status back without aborting. +OUT=$(ROOT_DIR="$ROOT_DIR" bash -c ' + set -ueo pipefail + source "$ROOT_DIR/command_utils.sh" + if ! try false; then echo "handled"; fi + try true || exit 9 + echo "done" +' 2>&1) +grep -q "handled" <<<"$OUT" || fail "try: failure status not handed to caller" +grep -q "done" <<<"$OUT" || fail "try: success path broken" +ok "try returns the status to the caller" + +echo +echo "All command_utils tests passed 🎉 ($PASS)" diff --git a/tests/test_conflict_resolution_resume.sh b/tests/test_conflict_resolution_resume.sh index 1ac02d4..c0e1cec 100644 --- a/tests/test_conflict_resolution_resume.sh +++ b/tests/test_conflict_resolution_resume.sh @@ -22,6 +22,7 @@ ok() { echo "✅ $1"; PASS=$((PASS+1)); } # $CALLS and is driven by env vars set per scenario: # MOCK_LABELS newline-separated labels returned by `pr view --json labels` # MOCK_COMMENTS_FILE file whose contents are returned by `pr view --json comments` +# MOCK_LABELS_FAIL set to 1 to make `pr view --json labels` fail # The PR's base branch is not mocked: the script must take it from PR_BASE # (event payload), so a baseRefName query is an unhandled call and fails. make_mock_gh() { @@ -32,7 +33,9 @@ set -ueo pipefail echo "gh $*" >> "$CALLS" if [[ "$1 $2" == "pr view" ]]; then case "$*" in - *--json\ labels*) printf '%s\n' "${MOCK_LABELS:-}";; + *--json\ labels*) + [[ "${MOCK_LABELS_FAIL:-}" == 1 ]] && { echo "mock gh: labels API down" >&2; exit 1; } + printf '%s\n' "${MOCK_LABELS:-}";; *--json\ comments*) # The comments file stands for our own comments only, so the query # must restrict itself to those. @@ -94,7 +97,7 @@ setup_repo() { run_resume() { env ACTION_MODE=conflict-resolved PR_BRANCH=child PR_NUMBER=5 PR_BASE="$PR_BASE" \ GH="$MOCK_DIR/mock_gh.sh" GIT="$MOCK_DIR/mock_git.sh" \ - MOCK_LABELS="$MOCK_LABELS" \ + MOCK_LABELS="$MOCK_LABELS" MOCK_LABELS_FAIL="${MOCK_LABELS_FAIL:-}" \ MOCK_COMMENTS_FILE="$MOCK_COMMENTS_FILE" CALLS="$CALLS" \ bash "$ROOT_DIR/update-pr-stack.sh" >"$WORK/out.log" 2>&1 || echo "EXIT=$?" >>"$WORK/out.log" } @@ -217,5 +220,39 @@ grep -q -- "--base" "$CALLS" && fail "F: base must NOT be edited" [[ "$(git -C "$ORIGIN" rev-parse child)" == "$CHILD_BEFORE" ]] || fail "F: child was pushed" ok "F: missing base branch detected, no crash, label removed" +# --------------------------------------------------------------------------- +echo "### Scenario G: reading the PR comments fails -> fail the run, keep the label" +setup_repo +# An API failure must not pass for "no state marker": that path removes the +# conflict label and permanently cancels the auto-resume. Fail loudly instead, +# so the label stays on and the next push retries. +MOCK_LABELS="autorestack-needs-conflict-resolution" +PR_BASE="parent" +MOCK_COMMENTS_FILE="$WORK/does-not-exist" # makes the mock gh fail on pr view --json comments +run_resume + +grep -q "EXIT=" "$WORK/out.log" || fail "G: run should have failed" +grep -q "remove-label" "$CALLS" && fail "G: label must NOT be removed on an API failure" +grep -q "gh pr comment" "$CALLS" && fail "G: no comment must be posted on an API failure" +[[ "$(git -C "$ORIGIN" rev-parse child)" == "$CHILD_BEFORE" ]] || fail "G: child was pushed" +ok "G: comments API failure fails the run and keeps the resume armed" + +# --------------------------------------------------------------------------- +echo "### Scenario H: reading the labels fails -> fail the run, do nothing" +setup_repo +# An API failure must not pass for "no conflict label": that ends the run +# green without resuming anything. +MOCK_LABELS="" +MOCK_LABELS_FAIL=1 +PR_BASE="parent" +MOCK_COMMENTS_FILE="$WORK/comments.txt" +{ echo "### conflict"; echo; marker parent main "$SQUASH"; } > "$MOCK_COMMENTS_FILE" +run_resume + +grep -q "EXIT=" "$WORK/out.log" || fail "H: run should have failed, not ended green" +grep -q "remove-label" "$CALLS" && fail "H: label must NOT be touched on an API failure" +[[ "$(git -C "$ORIGIN" rev-parse child)" == "$CHILD_BEFORE" ]] || fail "H: child was pushed" +ok "H: labels API failure fails the run instead of skipping the resume" + echo echo "All conflict-resume tests passed 🎉 ($PASS scenarios)" diff --git a/update-pr-stack.sh b/update-pr-stack.sh index 78b1c18..a53d939 100755 --- a/update-pr-stack.sh +++ b/update-pr-stack.sh @@ -20,7 +20,11 @@ # possible, so the logged commands are self-contained and reproducible # - We strive to keep commands as simple as possible -set -ueo pipefail # Exit on error, undefined var, or pipeline failure +# set -u and pipefail do the real work here; set -e is only a backstop. It is +# suppressed inside if/&&/|| conditions and everything they call, including +# the whole body of update_direct_target (always invoked as a condition), so +# failure handling is explicit instead: run/try/die from command_utils.sh. +set -ueo pipefail SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" source "$SCRIPT_DIR/command_utils.sh" @@ -44,11 +48,9 @@ format_state_marker() { read_state_marker() { local PR_NUMBER="$1" local BODIES - if ! BODIES=$(gh pr view "$PR_NUMBER" --json comments \ - --jq '.comments[] | select(.viewerDidAuthor) | .body'); then - echo "Error: could not read comments of PR #$PR_NUMBER" >&2 - exit 1 - fi + BODIES=$(gh pr view "$PR_NUMBER" --json comments \ + --jq '.comments[] | select(.viewerDidAuthor) | .body') \ + || die "could not read comments of PR #$PR_NUMBER" { grep -F "$STATE_MARKER_PREFIX" <<<"$BODIES" || true; } | tail -n1 } @@ -138,8 +140,11 @@ is_rebase_merge() { } # Echoes " " for each open PR based on the merged branch. +# try, not run: callers consume this through a process substitution, which +# swallows the exit status either way; a die in here would only leave that +# subshell. Making the callers notice the failure is a separate concern. list_child_prs() { - log_cmd gh pr list --base "$MERGED_BRANCH" --json number,headRefName --jq '.[] | "\(.number) \(.headRefName)"' + try gh pr list --base "$MERGED_BRANCH" --json number,headRefName --jq '.[] | "\(.number) \(.headRefName)"' } # A failed git merge does not always leave a merge in progress: when the ref to @@ -148,7 +153,7 @@ list_child_prs() { # abort when a merge is actually in progress. abort_merge_if_in_progress() { if git rev-parse --verify --quiet MERGE_HEAD >/dev/null; then - log_cmd git merge --abort + run git merge --abort fi } @@ -162,7 +167,7 @@ update_direct_target() { # Checkout first to ensure the local branch exists (created from origin if # needed). This allows has_squash_commit to compare local refs, which matters # for testing where the script may run multiple times in the same repo. - log_cmd git checkout "$BRANCH" + run git checkout "$BRANCH" if has_squash_commit "$BRANCH" "$TARGET_BRANCH"; then echo "✓ $BRANCH already up-to-date; skipping" @@ -173,8 +178,8 @@ update_direct_target() { CONFLICTS=() local BASE_MERGE_CLEAN=true - log_cmd git update-ref BEFORE_MERGE HEAD - if ! log_cmd git merge --no-edit "origin/$MERGED_BRANCH"; then + run git update-ref BEFORE_MERGE HEAD + if ! try git merge --no-edit "origin/$MERGED_BRANCH"; then CONFLICTS+=("origin/$MERGED_BRANCH") BASE_MERGE_CLEAN=false abort_merge_if_in_progress @@ -182,8 +187,10 @@ update_direct_target() { # Only try merging the pre-squash target state if it's not already # included in the merged branch — otherwise the first merge covers it. if ! git merge-base --is-ancestor SQUASH_COMMIT~ "origin/$MERGED_BRANCH"; then - if ! log_cmd git merge --no-edit SQUASH_COMMIT~; then - CONFLICTS+=( "$(git rev-parse SQUASH_COMMIT~) # $TARGET_BRANCH just before $MERGED_BRANCH was merged" ) + if ! try git merge --no-edit SQUASH_COMMIT~; then + local PRE_SQUASH_HASH + PRE_SQUASH_HASH=$(git rev-parse SQUASH_COMMIT~) || die "cannot resolve SQUASH_COMMIT~" + CONFLICTS+=( "$PRE_SQUASH_HASH # $TARGET_BRANCH just before $MERGED_BRANCH was merged" ) abort_merge_if_in_progress fi fi @@ -200,8 +207,10 @@ update_direct_target() { # Note: ordering is important here: if we label before pushing, we # re-trigger ourselves immediately. if [[ "$BASE_MERGE_CLEAN" == true ]]; then - log_cmd git push origin "$BRANCH" + run git push origin "$BRANCH" fi + local SQUASH_HASH_FOR_MARKER + SQUASH_HASH_FOR_MARKER=$(git rev-parse SQUASH_COMMIT) || die "cannot resolve SQUASH_COMMIT" { echo "### ⚠ī¸ Automatic update blocked by merge conflicts" echo @@ -224,23 +233,25 @@ update_direct_target() { echo echo "Once you push, this action will resume and finish updating this pull request." echo - format_state_marker "$MERGED_BRANCH" "$TARGET_BRANCH" "$(git rev-parse SQUASH_COMMIT)" - } | log_cmd gh pr comment "$PR_NUMBER" -F - + format_state_marker "$MERGED_BRANCH" "$TARGET_BRANCH" "$SQUASH_HASH_FOR_MARKER" + } | try gh pr comment "$PR_NUMBER" -F - \ + || die "could not post the conflict-resolution comment on PR #$PR_NUMBER" # Create the label if it doesn't exist, then add it to the PR gh label create "$CONFLICT_LABEL" --description "PR needs manual conflict resolution" --color "d73a4a" 2>/dev/null || true - log_cmd gh pr edit "$PR_NUMBER" --add-label "$CONFLICT_LABEL" + run gh pr edit "$PR_NUMBER" --add-label "$CONFLICT_LABEL" return 1 else - log_cmd git merge --no-edit -s ours SQUASH_COMMIT - log_cmd git update-ref MERGE_RESULT "HEAD^{tree}" + run git merge --no-edit -s ours SQUASH_COMMIT + run git update-ref MERGE_RESULT "HEAD^{tree}" COMMIT_MSG="Merge updates from $BASE_BRANCH and squash commit" if [[ "${GITHUB_ACTIONS:-}" == "true" ]]; then COMMIT_MSG="$COMMIT_MSG See $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" fi - CUSTOM_COMMIT=$(log_cmd git commit-tree MERGE_RESULT -p BEFORE_MERGE -p "origin/$MERGED_BRANCH" -p SQUASH_COMMIT -m "$COMMIT_MSG") - log_cmd git reset --hard "$CUSTOM_COMMIT" + CUSTOM_COMMIT=$(try git commit-tree MERGE_RESULT -p BEFORE_MERGE -p "origin/$MERGED_BRANCH" -p SQUASH_COMMIT -m "$COMMIT_MSG") \ + || die "could not create the merge-record commit for $BRANCH" + run git reset --hard "$CUSTOM_COMMIT" fi return 0 @@ -250,10 +261,8 @@ See $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" pr_has_conflict_label() { local PR_NUMBER="$1" local LABELS - if ! LABELS=$(gh pr view "$PR_NUMBER" --json labels --jq '.labels[].name'); then - echo "Error: could not read labels of PR #$PR_NUMBER" >&2 - exit 1 - fi + LABELS=$(gh pr view "$PR_NUMBER" --json labels --jq '.labels[].name') \ + || die "could not read labels of PR #$PR_NUMBER" echo "$LABELS" | grep -q "^${CONFLICT_LABEL}$" } @@ -282,8 +291,9 @@ has_sibling_conflicts() { abandon_resume() { local PR_NUMBER="$1" local MESSAGE="$2" - echo "$MESSAGE" | log_cmd gh pr comment "$PR_NUMBER" -F - - log_cmd gh pr edit "$PR_NUMBER" --remove-label "$CONFLICT_LABEL" + echo "$MESSAGE" | try gh pr comment "$PR_NUMBER" -F - \ + || die "could not comment on PR #$PR_NUMBER" + run gh pr edit "$PR_NUMBER" --remove-label "$CONFLICT_LABEL" } # Continue processing after user manually resolved conflicts @@ -307,7 +317,7 @@ continue_after_resolution() { # Recover them from the marker the squash-merge run left in the conflict # comment. local MARKER - MARKER=$(read_state_marker "$PR_NUMBER") + MARKER=$(read_state_marker "$PR_NUMBER") || die "could not read the state marker of PR #$PR_NUMBER" if [[ -z "$MARKER" ]]; then echo "⚠ī¸ No autorestack state marker on $PR_BRANCH; cannot resume safely. Removing the label." abandon_resume "$PR_NUMBER" "ℹī¸ autorestack could not find its state marker on this PR, so it will not update the stack automatically. If this PR still needs its base updated, update its base manually." @@ -319,8 +329,7 @@ continue_after_resolution() { echo "Recorded state: base=$OLD_BASE target=$NEW_TARGET squash=$SQUASH_HASH" if [[ -z "$OLD_BASE" || -z "$NEW_TARGET" || -z "$SQUASH_HASH" ]]; then - echo "Error: malformed state marker on $PR_BRANCH: $MARKER" >&2 - exit 1 + die "malformed state marker on $PR_BRANCH: $MARKER" fi # The PR was left based on the merged parent branch. If the payload shows a @@ -358,7 +367,7 @@ continue_after_resolution() { # resolution in place the base merge and pre-squash merge are no-ops; only the # "-s ours" squash record gets applied, keeping the diff against the new base # clean. has_squash_commit makes this idempotent. - log_cmd git update-ref SQUASH_COMMIT "$SQUASH_HASH" + run git update-ref SQUASH_COMMIT "$SQUASH_HASH" MERGED_BRANCH="$OLD_BASE" TARGET_BRANCH="$NEW_TARGET" if ! update_direct_target "$PR_BRANCH" "$NEW_TARGET" "$PR_NUMBER"; then @@ -371,16 +380,16 @@ continue_after_resolution() { # Push the cleaned-up head before retargeting so the head already contains # NEW_TARGET when the base flips to it, keeping the PR mergeable (GitHub # suppresses CI on a PR that conflicts with its base). - log_cmd git push origin "$PR_BRANCH" - log_cmd gh pr edit "$PR_NUMBER" --base "$NEW_TARGET" - log_cmd gh pr edit "$PR_NUMBER" --remove-label "$CONFLICT_LABEL" + run git push origin "$PR_BRANCH" + run gh pr edit "$PR_NUMBER" --base "$NEW_TARGET" + run gh pr edit "$PR_NUMBER" --remove-label "$CONFLICT_LABEL" # Check if old base branch should be deleted if has_sibling_conflicts "$OLD_BASE" "$PR_BRANCH"; then echo "⚠ī¸ Keeping branch '$OLD_BASE' - still referenced by other conflicted PRs" else echo "Deleting old base branch '$OLD_BASE' (no other PRs depend on it)" - log_cmd git push origin ":$OLD_BASE" || echo "⚠ī¸ Could not delete '$OLD_BASE' (may already be deleted)" + try git push origin ":$OLD_BASE" || echo "⚠ī¸ Could not delete '$OLD_BASE' (may already be deleted)" fi } @@ -391,7 +400,7 @@ main() { check_env_var "TARGET_BRANCH" check_env_var "PR_NUMBER" - log_cmd git update-ref SQUASH_COMMIT "$SQUASH_COMMIT" + run git update-ref SQUASH_COMMIT "$SQUASH_COMMIT" # A merge-commit merge does not rewrite history: each child's head already # contains the merged branch's commits, and the merge commit carries them @@ -401,10 +410,10 @@ main() { echo "✓ '$MERGED_BRANCH' was merged with a merge commit, not squashed; retargeting children without touching their heads" while read -r NUMBER BRANCH; do [[ -n "$BRANCH" ]] || continue - log_cmd gh pr edit "$NUMBER" --base "$TARGET_BRANCH" + run gh pr edit "$NUMBER" --base "$TARGET_BRANCH" done < <(list_child_prs) # Deleting a PR's base branch closes the PR, so the retargets come first. - log_cmd git push origin ":$MERGED_BRANCH" + run git push origin ":$MERGED_BRANCH" return 0 fi @@ -416,7 +425,7 @@ main() { echo "⚠ī¸ '$MERGED_BRANCH' looks rebase-merged; rebase merges are not supported, leaving the stack alone" while read -r NUMBER BRANCH; do [[ -n "$BRANCH" ]] || continue - log_cmd gh pr comment "$NUMBER" --body "ℹī¸ The base branch \`$MERGED_BRANCH\` of this PR was merged with \"Rebase and merge\", which autorestack does not support. Update this PR manually. \`$MERGED_BRANCH\` was kept so this PR stays open." + run gh pr comment "$NUMBER" --body "ℹī¸ The base branch \`$MERGED_BRANCH\` of this PR was merged with \"Rebase and merge\", which autorestack does not support. Update this PR manually. \`$MERGED_BRANCH\` was kept so this PR stays open." done < <(list_child_prs) return 0 fi @@ -448,17 +457,17 @@ main() { # intact on its old base, and the head already contains TARGET_BRANCH when # the base flips to it. if [[ "${#UPDATED_TARGETS[@]}" -gt 0 ]]; then - log_cmd git push origin "${UPDATED_TARGETS[@]}" + run git push origin "${UPDATED_TARGETS[@]}" fi for NUMBER in "${UPDATED_NUMBERS[@]}"; do - log_cmd gh pr edit "$NUMBER" --base "$TARGET_BRANCH" + run gh pr edit "$NUMBER" --base "$TARGET_BRANCH" done # Deleting a PR's base branch closes the PR, so this must come after the # retargets. Keep the branch for reference while conflicted PRs remain. if [[ "${#CONFLICTED_TARGETS[@]}" -eq 0 ]]; then - log_cmd git push origin ":$MERGED_BRANCH" + run git push origin ":$MERGED_BRANCH" else echo "⚠ī¸ Keeping branch '$MERGED_BRANCH' - still referenced by conflicted PRs: ${CONFLICTED_TARGETS[*]}" fi