From 7a38eed18abc83b03c640e8b29f43a2156b8d2d6 Mon Sep 17 00:00:00 2001 From: marcie Date: Fri, 28 Aug 2026 17:53:02 -0500 Subject: [PATCH] framework tools/git: issue-close R1/R4 conversion (P1 first wrapper) Same contract as issue-comment (PR #1462): -b/--body canonical comment flag with -c/--comment alias; usage errors stderr + exit 2 (unknown option, missing -i, value-less flags); provider failures normalized to exit 1 on the GitHub path (gh's own usage errors exit 2 and would collide with the reserved status). New suite test-issue-close-usage-contract.sh, enrolled in framework-shell CI (enumeration guard OK, population 74). Probe assertions split: parser arms must contact zero providers; sandbox arms may issue detection reads only (tea login list), never gh/curl. Existing fail-closed suite still green. Mirrored to the brain tree. --- .../mosaic/framework/tools/git/issue-close.sh | 47 +++++-- .../git/test-issue-close-usage-contract.sh | 129 ++++++++++++++++++ packages/mosaic/package.json | 2 +- 3 files changed, 167 insertions(+), 11 deletions(-) create mode 100755 packages/mosaic/framework/tools/git/test-issue-close-usage-contract.sh diff --git a/packages/mosaic/framework/tools/git/issue-close.sh b/packages/mosaic/framework/tools/git/issue-close.sh index 3d014a59..58850292 100755 --- a/packages/mosaic/framework/tools/git/issue-close.sh +++ b/packages/mosaic/framework/tools/git/issue-close.sh @@ -1,6 +1,7 @@ #!/bin/bash # issue-close.sh - Close an issue on GitHub or Gitea -# Usage: issue-close.sh -i [-c ] +# Usage: issue-close.sh -i [-b ] +# (-c/--comment is a backward-compatible alias for -b/--body; R1/R4 2026-08-28) set -e @@ -12,35 +13,49 @@ source "$SCRIPT_DIR/detect-platform.sh" ISSUE_NUMBER="" COMMENT="" +# Usage-error contract (R4, 2026-08-28): usage errors print to STDERR and exit 2, +# distinct from provider, credential, and verification failures (exit 1), so a +# caller or stop gate can tell an invocation defect from a delivery blocker. +usage_error() { + echo "Error: $*" >&2 + echo "Usage: issue-close.sh -i [-b ] (see --help)" >&2 + exit 2 +} + while [[ $# -gt 0 ]]; do case $1 in -i|--issue) + [[ $# -ge 2 ]] || usage_error "option $1 requires a value" ISSUE_NUMBER="$2" shift 2 ;; - -c|--comment) + -b|--body|-c|--comment) + # R1 (2026-08-28): --body is the canonical flag; -c/--comment stays + # a backward-compatible alias. + [[ $# -ge 2 ]] || usage_error "option $1 requires a value" COMMENT="$2" shift 2 ;; -h|--help) - echo "Usage: issue-close.sh -i [-c ]" + echo "Usage: issue-close.sh -i [-b ]" echo "" echo "Options:" echo " -i, --issue Issue number (required)" - echo " -c, --comment Comment to add before closing (optional)" + echo " -b, --body Comment to add before closing (optional; canonical)" + echo " -c, --comment Alias for --body" echo " -h, --help Show this help" + echo "" + echo "Exit codes: 0 success; 2 usage error (stderr); 1 provider/credential/verification failure." exit 0 ;; *) - echo "Unknown option: $1" - exit 1 + usage_error "unknown option: $1" ;; esac done if [[ -z "$ISSUE_NUMBER" ]]; then - echo "Error: Issue number is required (-i)" - exit 1 + usage_error "issue number is required (-i/--issue)" fi # Detect platform and close issue @@ -82,10 +97,22 @@ gitea_issue_close_api() { } if [[ "$PLATFORM" == "github" ]]; then + # R4: normalize provider failures to exit 1 (gh's own usage errors exit 2 + # and would collide with the reserved usage-error status). if [[ -n "$COMMENT" ]]; then - gh issue comment "$ISSUE_NUMBER" --body "$COMMENT" + gh_rc=0 + gh issue comment "$ISSUE_NUMBER" --body "$COMMENT" || gh_rc=$? + if [[ "$gh_rc" -ne 0 ]]; then + echo "Error: GitHub comment before close failed (gh exit $gh_rc)" >&2 + exit 1 + fi + fi + gh_rc=0 + gh issue close "$ISSUE_NUMBER" || gh_rc=$? + if [[ "$gh_rc" -ne 0 ]]; then + echo "Error: GitHub issue close failed (gh exit $gh_rc)" >&2 + exit 1 fi - gh issue close "$ISSUE_NUMBER" echo "Closed GitHub issue #$ISSUE_NUMBER" elif [[ "$PLATFORM" == "gitea" ]]; then GITEA_LOGIN_NAME=$(get_gitea_login || true) diff --git a/packages/mosaic/framework/tools/git/test-issue-close-usage-contract.sh b/packages/mosaic/framework/tools/git/test-issue-close-usage-contract.sh new file mode 100755 index 00000000..1a58618e --- /dev/null +++ b/packages/mosaic/framework/tools/git/test-issue-close-usage-contract.sh @@ -0,0 +1,129 @@ +#!/usr/bin/env bash +# Usage-error contract for issue-close.sh (R1/R4, 2026-08-28). +# +# R4: usage errors print to STDERR and exit 2, distinct from provider, +# credential, and verification failures (exit 1). R1: -b/--body is the +# canonical comment flag; -c/--comment remains a compatible alias. +# The comment is OPTIONAL here (an issue may close without one), so unlike +# issue-comment there is no missing-comment arm. +# +# Arms: +# 1. --help and -h exit 0 and print usage. +# 2. Unknown option exits 2 with the message on stderr. +# 3. Missing required -i exits 2 (stderr). +# 4. A value-less flag (-i -b -c and long forms) exits 2 (stderr). +# 5. -b and -c both pass parsing (sandboxed runner: the run then fails +# at credential resolution, nonzero and NOT 2) — no real token is +# ever read and no provider is contacted. +# 6. No arm performs any provider request (PATH shims record every +# invocation; the probe log must stay empty). +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +WORK_DIR="${MOSAIC_TEST_WORK_DIR:-$PWD/.mosaic-test-work/issue-close-usage}" +BIN_DIR="$WORK_DIR/bin" +PROBE_LOG="$WORK_DIR/provider-probes.log" +OUT_FILE="$WORK_DIR/out.log" +ERR_FILE="$WORK_DIR/err.log" + +cleanup() { + rm -rf "$WORK_DIR" +} +trap cleanup EXIT + +mkdir -p "$BIN_DIR" +: > "$PROBE_LOG" + +for tool in gh tea curl; do + cat > "$BIN_DIR/$tool" <> "$PROBE_LOG" +exit 0 +STUB + chmod +x "$BIN_DIR/$tool" +done + +run_wrapper() { + ( cd "$WORK_DIR" && PATH="$BIN_DIR:$PATH" "$SCRIPT_DIR/issue-close.sh" "$@" ) +} + +# Hermetic variant: neutralizes every identity/credential source the wrapper +# consults so parse-acceptance arms fail at credential resolution in ANY cwd +# repo (see test-issue-comment-usage-contract.sh for the measured incident). +run_wrapper_sandboxed() { + mkdir -p "$WORK_DIR/home" "$WORK_DIR/xdg" + ( + cd "$WORK_DIR" + PATH="$BIN_DIR:$PATH" HOME="$WORK_DIR/home" XDG_CONFIG_HOME="$WORK_DIR/xdg" \ + MOSAIC_GIT_IDENTITY="" MOSAIC_BRAIN_HOME="" \ + "$SCRIPT_DIR/issue-close.sh" "$@" + ) +} + +fail() { + echo "FAIL: $*" >&2 + echo "--- stderr ---" >&2 + cat "$ERR_FILE" >&2 + exit 1 +} + +expect_rc() { # expect_rc + local want="$1" desc="$2" rc=0 + shift 2 + run_wrapper "$@" >"$OUT_FILE" 2>"$ERR_FILE" || rc=$? + [[ "$rc" -eq "$want" ]] || fail "$desc: rc=$rc, want $want" +} + +expect_stderr() { # expect_stderr + grep -q "$1" "$ERR_FILE" || fail "$desc: stderr missing '$1'" +} + +# 1. Help exits 0 and prints usage. +expect_rc 0 "--help exits 0" --help +grep -q "Usage: issue-close.sh" "$OUT_FILE" || fail "--help did not print usage" +expect_rc 0 "-h exits 0" -h + +# 2. Unknown option: rc 2, stderr. +expect_rc 2 "unknown option exits 2" --bogus +expect_stderr "unknown option" "unknown option names itself on stderr" + +# 3. Missing required issue number: rc 2, stderr. +expect_rc 2 "missing -i exits 2" +expect_stderr "issue number is required" "missing -i message on stderr" + +# 4. Value-less flags: rc 2 with "requires a value" on stderr. +for flag in -i -b -c --issue --body --comment; do + expect_rc 2 "value-less $flag exits 2" "$flag" + expect_stderr "requires a value" "value-less $flag message on stderr" +done + +# 4b. Parser-failure arms (1-4) must have performed ZERO provider contact. +if [[ -s "$PROBE_LOG" ]]; then + echo "FAIL: a parser-failure arm contacted a provider:" >&2 + cat "$PROBE_LOG" >&2 + exit 1 +fi + +# 5. Alias acceptance under the sandbox: both -b and -c carry a value past +# parsing; the run fails at credential resolution nonzero and NOT 2. +for flag in -b -c; do + rc=0 + run_wrapper_sandboxed -i 5 "$flag" "closing note" >"$OUT_FILE" 2>"$ERR_FILE" || rc=$? + [[ "$rc" -ne 0 ]] || fail "$flag arm unexpectedly succeeded in the sandbox" + [[ "$rc" -ne 2 ]] || fail "$flag arm misclassified credential failure as a usage error" +done + +# 6. Sandbox arms may issue DETECTION reads only (tea login list via the +# stub); no gh/curl write or read may occur. +if grep -Ev '^(gh|tea|curl) login list' "$PROBE_LOG" | grep -q .; then + echo "FAIL: a sandbox arm performed a non-detection provider request:" >&2 + grep -Ev '^(gh|tea|curl) login list' "$PROBE_LOG" >&2 + exit 1 +fi +if grep -qE '^(gh|curl)' "$PROBE_LOG"; then + echo "FAIL: gh or curl was invoked during a sandbox arm:" >&2 + grep -E '^(gh|curl)' "$PROBE_LOG" >&2 + exit 1 +fi + +echo "issue-close.sh usage-contract regression passed (R1/R4)" diff --git a/packages/mosaic/package.json b/packages/mosaic/package.json index ce1a3740..15980f6d 100644 --- a/packages/mosaic/package.json +++ b/packages/mosaic/package.json @@ -25,7 +25,7 @@ "lint": "eslint src", "typecheck": "tsc --noEmit", "test": "vitest run --passWithNoTests && pnpm run test:framework-shell", - "test:framework-shell": "bash framework/tools/quality/scripts/check-test-enumeration.sh && bash framework/tools/quality/scripts/test-check-test-enumeration.sh && python3 framework/tools/quality/scripts/test-framework-drift-check.py && bash framework/tools/quality/scripts/test-framework-drift-doctor.sh && bash framework/systemd/user/test-fleet-units.sh && python3 src/lease-broker/daemon_deadline_unittest.py && python3 src/lease-broker/normative_fragments_unittest.py && python3 src/lease-broker/promotion_binding_unittest.py && python3 src/lease-broker/promotion_trigger_unittest.py && python3 src/lease-broker/receipt_challenge_unittest.py && python3 src/lease-broker/context_recovery_unittest.py && python3 src/lease-broker/recovery_runtime_unittest.py && python3 src/lease-broker/recovery_b1_adversarial_unittest.py && python3 src/lease-broker/receipt_observer_client_unittest.py && python3 src/lease-broker/invariant_r_unittest.py && python3 src/lease-broker/framework_skill_portability_unittest.py && python3 src/lease-broker/revoke_noop_unittest.py && python3 src/mutator-gate/runtime_tools_unittest.py && python3 src/mutator-gate/runtime_launch_guard_unittest.py && python3 src/mutator-gate/version_coupling_unittest.py && python3 framework/tools/lease-broker/check-runtime-launches.py --root ../.. && bash framework/tools/codex/test-pr-diff-context.sh && bash framework/tools/qa/test-deps-preflight.sh && bash framework/tools/git/test-pr-edit.sh && bash framework/tools/git/test-pr-create-fallback-default-base.sh && bash framework/tools/git/test-repo-decl-consumption.sh && bash framework/tools/git/test-pr-review-gitea-comment.sh && bash framework/tools/git/test-pr-review-repo-host-override.sh && bash framework/tools/git/test-ci-queue-wait-no-status.sh && bash framework/tools/git/test-ci-queue-wait-branch-absent.sh && bash framework/tools/git/test-ci-queue-wait-tristate.sh && bash framework/tools/git/test-ci-queue-wait-github-checks.sh && bash framework/tools/git/test-ci-queue-wait-no-ci-expected.sh && bash framework/tools/git/test-pr-merge-queue-branch.sh && bash framework/tools/git/test-pr-merge-no-ci-expected.sh && bash framework/tools/git/test-pr-merge-fork-ci-status.sh && bash framework/tools/git/test-pr-merge-head-pin.sh && bash framework/tools/git/test-pr-merge-message-field.sh && bash framework/tools/git/test-git-credential-mosaic.sh && bash framework/tools/git/test-gitea-token-identity.sh && bash framework/tools/git/test-issue-comment-usage-contract.sh && bash framework/tools/git/test-issue-comment-readback.sh && bash framework/tools/git/test-explain-diagnostic-status-neutral.sh && bash framework/tools/git/test-detect-platform-outside-repo.sh && bash framework/tools/woodpecker/test-terminal-green-contract.sh && bash framework/tools/_scripts/test-install-ordering-guard.sh && bash framework/tools/_scripts/test-mosaic-init-rce.sh && bash framework/tools/tmux/agent-send.test.sh && bash framework/tools/wake/test-wake-store-ack.sh && bash framework/tools/wake/test-wake-store-enqueue-race.sh && bash framework/tools/wake/test-wake-digest-hmac.sh && bash framework/tools/wake/test-wake-digest-quarantine.sh && bash framework/tools/wake/test-wake-detector.sh && bash framework/tools/wake/test-wake-fn-oracle.sh && bash framework/tools/wake/test-wake-reconcile.sh && bash framework/tools/wake/test-wake-beacon.sh && bash framework/tools/wake/test-wake-preimage.sh && bash framework/tools/wake/test-wake-install.sh && bash framework/tools/glpi/test-list-http-status.sh && bash framework/tools/orchestrator/test-board-roll.sh && bash framework/tools/woodpecker/test-ci-wait-exit-matrix.sh && bash framework/tools/_scripts/test-fleet-transport-check.sh && bash framework/tools/_scripts/test-brain-home-check.sh && bash framework/tools/_scripts/test-structure-anchor-check.sh && bash framework/tools/fleet/test-agent-session-broker-preflight.sh && bash framework/tools/fleet/test-agent-session-legacy-socket-guard.sh && bash framework/tools/git/test-grant-reviewer.sh" + "test:framework-shell": "bash framework/tools/quality/scripts/check-test-enumeration.sh && bash framework/tools/quality/scripts/test-check-test-enumeration.sh && python3 framework/tools/quality/scripts/test-framework-drift-check.py && bash framework/tools/quality/scripts/test-framework-drift-doctor.sh && bash framework/systemd/user/test-fleet-units.sh && python3 src/lease-broker/daemon_deadline_unittest.py && python3 src/lease-broker/normative_fragments_unittest.py && python3 src/lease-broker/promotion_binding_unittest.py && python3 src/lease-broker/promotion_trigger_unittest.py && python3 src/lease-broker/receipt_challenge_unittest.py && python3 src/lease-broker/context_recovery_unittest.py && python3 src/lease-broker/recovery_runtime_unittest.py && python3 src/lease-broker/recovery_b1_adversarial_unittest.py && python3 src/lease-broker/receipt_observer_client_unittest.py && python3 src/lease-broker/invariant_r_unittest.py && python3 src/lease-broker/framework_skill_portability_unittest.py && python3 src/lease-broker/revoke_noop_unittest.py && python3 src/mutator-gate/runtime_tools_unittest.py && python3 src/mutator-gate/runtime_launch_guard_unittest.py && python3 src/mutator-gate/version_coupling_unittest.py && python3 framework/tools/lease-broker/check-runtime-launches.py --root ../.. && bash framework/tools/codex/test-pr-diff-context.sh && bash framework/tools/qa/test-deps-preflight.sh && bash framework/tools/git/test-pr-edit.sh && bash framework/tools/git/test-pr-create-fallback-default-base.sh && bash framework/tools/git/test-repo-decl-consumption.sh && bash framework/tools/git/test-pr-review-gitea-comment.sh && bash framework/tools/git/test-pr-review-repo-host-override.sh && bash framework/tools/git/test-ci-queue-wait-no-status.sh && bash framework/tools/git/test-ci-queue-wait-branch-absent.sh && bash framework/tools/git/test-ci-queue-wait-tristate.sh && bash framework/tools/git/test-ci-queue-wait-github-checks.sh && bash framework/tools/git/test-ci-queue-wait-no-ci-expected.sh && bash framework/tools/git/test-pr-merge-queue-branch.sh && bash framework/tools/git/test-pr-merge-no-ci-expected.sh && bash framework/tools/git/test-pr-merge-fork-ci-status.sh && bash framework/tools/git/test-pr-merge-head-pin.sh && bash framework/tools/git/test-pr-merge-message-field.sh && bash framework/tools/git/test-git-credential-mosaic.sh && bash framework/tools/git/test-gitea-token-identity.sh && bash framework/tools/git/test-issue-comment-usage-contract.sh && bash framework/tools/git/test-issue-comment-readback.sh && bash framework/tools/git/test-issue-close-usage-contract.sh && bash framework/tools/git/test-explain-diagnostic-status-neutral.sh && bash framework/tools/git/test-detect-platform-outside-repo.sh && bash framework/tools/woodpecker/test-terminal-green-contract.sh && bash framework/tools/_scripts/test-install-ordering-guard.sh && bash framework/tools/_scripts/test-mosaic-init-rce.sh && bash framework/tools/tmux/agent-send.test.sh && bash framework/tools/wake/test-wake-store-ack.sh && bash framework/tools/wake/test-wake-store-enqueue-race.sh && bash framework/tools/wake/test-wake-digest-hmac.sh && bash framework/tools/wake/test-wake-digest-quarantine.sh && bash framework/tools/wake/test-wake-detector.sh && bash framework/tools/wake/test-wake-fn-oracle.sh && bash framework/tools/wake/test-wake-reconcile.sh && bash framework/tools/wake/test-wake-beacon.sh && bash framework/tools/wake/test-wake-preimage.sh && bash framework/tools/wake/test-wake-install.sh && bash framework/tools/glpi/test-list-http-status.sh && bash framework/tools/orchestrator/test-board-roll.sh && bash framework/tools/woodpecker/test-ci-wait-exit-matrix.sh && bash framework/tools/_scripts/test-fleet-transport-check.sh && bash framework/tools/_scripts/test-brain-home-check.sh && bash framework/tools/_scripts/test-structure-anchor-check.sh && bash framework/tools/fleet/test-agent-session-broker-preflight.sh && bash framework/tools/fleet/test-agent-session-legacy-socket-guard.sh && bash framework/tools/git/test-grant-reviewer.sh" }, "dependencies": { "@mosaicstack/brain": "workspace:*",