diff --git a/packages/mosaic/framework/tools/git/pr-review.sh b/packages/mosaic/framework/tools/git/pr-review.sh index 9afd1687..9b95c0ed 100755 --- a/packages/mosaic/framework/tools/git/pr-review.sh +++ b/packages/mosaic/framework/tools/git/pr-review.sh @@ -56,6 +56,125 @@ fi detect_platform >/dev/null +# Post a review comment body to a Gitea PR via the supported comments REST API +# and verify it durably via provider read-back (see docs on durable review +# provenance in README.md). Used by the `comment` action and, since `tea` +# v0.11.1 defines no `--comment`/`-comment` flag on `pr approve`/`pr reject`, +# also by the `approve` and `request-changes` actions to carry an optional +# review body that `tea` itself cannot attach. +# +# Args: $1 = PR number, $2 = comment body +# On success: prints only the created comment ID to stdout, returns 0. +# On failure: prints an error to stderr, returns 1. +gitea_post_verified_comment() { + local pr_number="$1" comment_body="$2" + local host token configured_url repo api_base payload + local write_response_file readback_response_file comment_id + + host=$(get_remote_host) + token=$(get_gitea_token "$host") || { + echo "Error: Gitea token not found for comment persistence" >&2 + return 1 + } + configured_url=$(get_gitea_url_for_host "$host") || { + echo "Error: Configured Gitea URL not found for comment persistence" >&2 + return 1 + } + repo=$(get_gitea_repo_slug_for_url "$configured_url") || { + echo "Error: Could not resolve Gitea owner/repository relative to configured URL" >&2 + return 1 + } + api_base="${configured_url%/}/api/v1/repos/$repo" + payload=$(COMMENT_BODY="$comment_body" python3 -c ' +import json +import os + +print(json.dumps({"body": os.environ["COMMENT_BODY"]})) +') + write_response_file=$(mktemp "${TMPDIR:-/tmp}/mosaic-pr-review-write.XXXXXX") + readback_response_file=$(mktemp "${TMPDIR:-/tmp}/mosaic-pr-review-readback.XXXXXX") + trap 'rm -f "$write_response_file" "$readback_response_file"' RETURN + + if ! write_status=$(curl -sS -o "$write_response_file" -w '%{http_code}' \ + -X POST \ + -H "Authorization: token $token" \ + -H 'Content-Type: application/json' \ + -d "$payload" \ + "$api_base/issues/$pr_number/comments"); then + echo "Error: Gitea comment write transport failed" >&2 + return 1 + fi + if [[ "$write_status" != "201" ]]; then + echo "Error: Gitea comment write failed with HTTP $write_status" >&2 + return 1 + fi + + comment_id=$(python3 - "$write_response_file" <<'PY' +import json +import sys + +try: + with open(sys.argv[1], encoding="utf-8") as response: + comment = json.load(response) + comment_id = comment.get("id") if isinstance(comment, dict) else None + if not isinstance(comment_id, int) or comment_id <= 0: + raise ValueError("missing positive comment id") +except (OSError, json.JSONDecodeError, ValueError) as error: + print(f"Error: could not identify created Gitea comment: {error}", file=sys.stderr) + raise SystemExit(1) +print(comment_id) +PY +) || return 1 + + if ! readback_status=$(curl -sS -o "$readback_response_file" -w '%{http_code}' \ + -H "Authorization: token $token" \ + "$api_base/issues/comments/$comment_id"); then + echo "Error: Gitea comment read-back transport failed" >&2 + return 1 + fi + if [[ "$readback_status" != "200" ]]; then + echo "Error: Gitea comment read-back failed with HTTP $readback_status" >&2 + return 1 + fi + + if EXPECTED_COMMENT_ID="$comment_id" EXPECTED_COMMENT_BODY="$comment_body" EXPECTED_REPO="$repo" EXPECTED_PR_NUMBER="$pr_number" \ + python3 - "$readback_response_file" <<'PY' +import json +import os +import sys +from urllib.parse import urlparse + +try: + with open(sys.argv[1], encoding="utf-8") as response: + comment = json.load(response) + if not isinstance(comment, dict): + raise ValueError("response is not a comment object") + expected_id = int(os.environ["EXPECTED_COMMENT_ID"]) + expected_body = os.environ["EXPECTED_COMMENT_BODY"] + expected_repo = os.environ["EXPECTED_REPO"] + expected_pr = os.environ["EXPECTED_PR_NUMBER"] + issue_path = urlparse(comment.get("issue_url", "")).path.rstrip("/") + expected_suffix = f"/repos/{expected_repo}/issues/{expected_pr}" + if comment.get("id") != expected_id: + raise ValueError("comment id mismatch") + if comment.get("body") != expected_body: + raise ValueError("comment body mismatch") + if not issue_path.endswith(expected_suffix): + raise ValueError("repository or PR mismatch") +except (OSError, json.JSONDecodeError, KeyError, TypeError, ValueError) as error: + print(f"Error: Gitea comment persistence verification failed: {error}", file=sys.stderr) + raise SystemExit(1) +PY + then + true + else + return 1 + fi + + echo "$comment_id" + return 0 +} + if [[ "$PLATFORM" == "github" ]]; then case $ACTION in approve) @@ -89,8 +208,14 @@ elif [[ "$PLATFORM" == "gitea" ]]; then repo=$(get_repo_slug) host=$(get_remote_host) login=$(get_gitea_login_for_host "$host") - tea pr approve "$PR_NUMBER" --repo "$repo" --login "$login" ${COMMENT:+--comment "$COMMENT"} + # tea v0.11.1 defines no --comment/-comment flag on `pr approve`; + # route any review body via the durable comment API instead (#835). + tea pr approve "$PR_NUMBER" --repo "$repo" --login "$login" echo "Approved Gitea PR #$PR_NUMBER" + if [[ -n "$COMMENT" ]]; then + comment_id=$(gitea_post_verified_comment "$PR_NUMBER" "$COMMENT") || exit 1 + echo "Added and verified review comment on Gitea PR #$PR_NUMBER (comment ID $comment_id)" + fi ;; request-changes) if [[ -z "$COMMENT" ]]; then @@ -100,8 +225,12 @@ elif [[ "$PLATFORM" == "gitea" ]]; then repo=$(get_repo_slug) host=$(get_remote_host) login=$(get_gitea_login_for_host "$host") - tea pr reject "$PR_NUMBER" --repo "$repo" --login "$login" --comment "$COMMENT" + # tea v0.11.1 defines no --comment/-comment flag on `pr reject`; + # route the review body via the durable comment API instead (#835). + tea pr reject "$PR_NUMBER" --repo "$repo" --login "$login" echo "Requested changes on Gitea PR #$PR_NUMBER" + comment_id=$(gitea_post_verified_comment "$PR_NUMBER" "$COMMENT") || exit 1 + echo "Added and verified review comment on Gitea PR #$PR_NUMBER (comment ID $comment_id)" ;; comment) if [[ -z "$COMMENT" ]]; then @@ -109,101 +238,7 @@ elif [[ "$PLATFORM" == "gitea" ]]; then exit 1 fi - host=$(get_remote_host) - token=$(get_gitea_token "$host") || { - echo "Error: Gitea token not found for comment persistence" >&2 - exit 1 - } - configured_url=$(get_gitea_url_for_host "$host") || { - echo "Error: Configured Gitea URL not found for comment persistence" >&2 - exit 1 - } - repo=$(get_gitea_repo_slug_for_url "$configured_url") || { - echo "Error: Could not resolve Gitea owner/repository relative to configured URL" >&2 - exit 1 - } - api_base="${configured_url%/}/api/v1/repos/$repo" - payload=$(COMMENT_BODY="$COMMENT" python3 -c ' -import json -import os - -print(json.dumps({"body": os.environ["COMMENT_BODY"]})) -') - write_response_file=$(mktemp "${TMPDIR:-/tmp}/mosaic-pr-review-write.XXXXXX") - readback_response_file=$(mktemp "${TMPDIR:-/tmp}/mosaic-pr-review-readback.XXXXXX") - trap 'rm -f "$write_response_file" "$readback_response_file"' EXIT - - if ! write_status=$(curl -sS -o "$write_response_file" -w '%{http_code}' \ - -X POST \ - -H "Authorization: token $token" \ - -H 'Content-Type: application/json' \ - -d "$payload" \ - "$api_base/issues/$PR_NUMBER/comments"); then - echo "Error: Gitea comment write transport failed" >&2 - exit 1 - fi - if [[ "$write_status" != "201" ]]; then - echo "Error: Gitea comment write failed with HTTP $write_status" >&2 - exit 1 - fi - - comment_id=$(python3 - "$write_response_file" <<'PY' -import json -import sys - -try: - with open(sys.argv[1], encoding="utf-8") as response: - comment = json.load(response) - comment_id = comment.get("id") if isinstance(comment, dict) else None - if not isinstance(comment_id, int) or comment_id <= 0: - raise ValueError("missing positive comment id") -except (OSError, json.JSONDecodeError, ValueError) as error: - print(f"Error: could not identify created Gitea comment: {error}", file=sys.stderr) - raise SystemExit(1) -print(comment_id) -PY -) - - if ! readback_status=$(curl -sS -o "$readback_response_file" -w '%{http_code}' \ - -H "Authorization: token $token" \ - "$api_base/issues/comments/$comment_id"); then - echo "Error: Gitea comment read-back transport failed" >&2 - exit 1 - fi - if [[ "$readback_status" != "200" ]]; then - echo "Error: Gitea comment read-back failed with HTTP $readback_status" >&2 - exit 1 - fi - - EXPECTED_COMMENT_ID="$comment_id" EXPECTED_COMMENT_BODY="$COMMENT" EXPECTED_REPO="$repo" EXPECTED_PR_NUMBER="$PR_NUMBER" \ - python3 - "$readback_response_file" <<'PY' -import json -import os -import sys -from urllib.parse import urlparse - -try: - with open(sys.argv[1], encoding="utf-8") as response: - comment = json.load(response) - if not isinstance(comment, dict): - raise ValueError("response is not a comment object") - expected_id = int(os.environ["EXPECTED_COMMENT_ID"]) - expected_body = os.environ["EXPECTED_COMMENT_BODY"] - expected_repo = os.environ["EXPECTED_REPO"] - expected_pr = os.environ["EXPECTED_PR_NUMBER"] - issue_path = urlparse(comment.get("issue_url", "")).path.rstrip("/") - expected_suffix = f"/repos/{expected_repo}/issues/{expected_pr}" - if comment.get("id") != expected_id: - raise ValueError("comment id mismatch") - if comment.get("body") != expected_body: - raise ValueError("comment body mismatch") - if not issue_path.endswith(expected_suffix): - raise ValueError("repository or PR mismatch") -except (OSError, json.JSONDecodeError, KeyError, TypeError, ValueError) as error: - print(f"Error: Gitea comment persistence verification failed: {error}", file=sys.stderr) - raise SystemExit(1) -PY - + comment_id=$(gitea_post_verified_comment "$PR_NUMBER" "$COMMENT") || exit 1 echo "Added and verified comment on Gitea PR #$PR_NUMBER (comment ID $comment_id)" ;; *) diff --git a/packages/mosaic/framework/tools/git/test-pr-review-gitea-comment.sh b/packages/mosaic/framework/tools/git/test-pr-review-gitea-comment.sh index 16641f56..8b42ee29 100644 --- a/packages/mosaic/framework/tools/git/test-pr-review-gitea-comment.sh +++ b/packages/mosaic/framework/tools/git/test-pr-review-gitea-comment.sh @@ -1,5 +1,11 @@ #!/usr/bin/env bash -# Regression harness for durable Gitea PR review comments (#812). +# Regression harness for durable Gitea PR review comments (#812) and for the +# approve/reject `--comment` flag removal (#835). The `tea` stub below rejects +# any `-comment`/`--comment` flag on `pr approve`/`pr reject` exactly like real +# `tea` v0.11.1 does ("flag provided but not defined: -comment"), so this +# harness fails RED against the pre-#835 wrapper (which passed that flag) and +# only passes once the wrapper routes the review body through the durable +# comment REST API instead. set -euo pipefail @@ -51,12 +57,21 @@ if [[ "$*" == "login list --output json" ]]; then exit 0 fi +# tea v0.11.1 defines no --comment/-comment flag on `pr approve` or `pr +# reject`; it fails closed with this exact message and a nonzero exit. Any +# regression that reintroduces the flag on those subcommands must hit this +# branch and fail RED (#835). +if [[ "$*" == *" -comment "* || "$*" == *" --comment "* || "$*" == *" -comment" || "$*" == *" --comment" ]]; then + echo "flag provided but not defined: -comment" >&2 + exit 1 +fi + case "${PR_REVIEW_TEST_MODE:-}" in approve) [[ "$*" == "pr approve 123 --repo mosaicstack/stack --login mosaicstack" ]] || exit 90 ;; request-changes) - [[ "$*" == "pr reject 123 --repo mosaicstack/stack --login mosaicstack --comment changes-required" ]] || exit 91 + [[ "$*" == "pr reject 123 --repo mosaicstack/stack --login mosaicstack" ]] || exit 91 ;; legacy-fallback|comment-success|http-success|prefix-success|subpath-success|port-success|scp-ssh-success|url-ssh-success|write-transport-failure|write-http-failure|readback-failure) if [[ "$*" == pr\ comment* ]]; then @@ -129,7 +144,7 @@ case "${PR_REVIEW_TEST_MODE:-}" in write-http-failure) write_response 500 '{"message":"simulated rejection"}' ;; - comment-success|http-success|prefix-success|subpath-success|port-success|scp-ssh-success|url-ssh-success|readback-failure) + approve|request-changes|comment-success|http-success|prefix-success|subpath-success|port-success|scp-ssh-success|url-ssh-success|readback-failure) if [[ "$method" == "POST" && "$url" == "$PR_REVIEW_EXPECTED_API_BASE/issues/123/comments" ]]; then PR_REVIEW_PAYLOAD="$payload" python3 - <<'PY' import json @@ -202,10 +217,28 @@ run_review() { run_review approve approve grep -q '^pr approve 123 --repo mosaicstack/stack --login mosaicstack$' "$TEA_LOG" grep -q 'Approved Gitea PR #123' "$OUTPUT_FILE" +if grep -q 'comment' "$TEA_LOG"; then + echo "Plain approve (no review body) unexpectedly touched comment persistence" >&2 + exit 1 +fi +# #835: tea v0.11.1 defines no --comment/-comment flag on `pr approve`. A +# review body supplied alongside approve must be routed through the durable +# comment REST API instead of being passed to `tea` directly. +run_review approve approve approve-note +grep -q '^pr approve 123 --repo mosaicstack/stack --login mosaicstack$' "$TEA_LOG" +grep -q 'Approved Gitea PR #123' "$OUTPUT_FILE" +grep -q '^POST https://git.mosaicstack.dev/api/v1/repos/mosaicstack/stack/issues/123/comments$' "$CURL_LOG" +grep -q '^GET https://git.mosaicstack.dev/api/v1/repos/mosaicstack/stack/issues/comments/456$' "$CURL_LOG" +grep -q 'Added and verified review comment on Gitea PR #123 (comment ID 456)' "$OUTPUT_FILE" + +# #835: same for `pr reject` (request-changes), where a comment is required. run_review request-changes request-changes changes-required -grep -q '^pr reject 123 --repo mosaicstack/stack --login mosaicstack --comment changes-required$' "$TEA_LOG" +grep -q '^pr reject 123 --repo mosaicstack/stack --login mosaicstack$' "$TEA_LOG" grep -q 'Requested changes on Gitea PR #123' "$OUTPUT_FILE" +grep -q '^POST https://git.mosaicstack.dev/api/v1/repos/mosaicstack/stack/issues/123/comments$' "$CURL_LOG" +grep -q '^GET https://git.mosaicstack.dev/api/v1/repos/mosaicstack/stack/issues/comments/456$' "$CURL_LOG" +grep -q 'Added and verified review comment on Gitea PR #123 (comment ID 456)' "$OUTPUT_FILE" if run_review legacy-fallback comment durable-body; then echo "The old nonexistent tea pr comment fallback returned success" >&2