Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| dd003c66d5 |
@@ -1,43 +1,17 @@
|
|||||||
# This composite action supports both Gitea Actions and GitHub Actions runners.
|
# This composite action is designed for Gitea Actions runners.
|
||||||
# It detects the VCS host type by checking whether github.api_url is set
|
# Gitea Actions supports GitHub Actions syntax including $GITHUB_OUTPUT,
|
||||||
# (present on GitHub.com and GHES runners, absent on Gitea runners) and uses
|
# actions/cache, and actions/checkout.
|
||||||
# the appropriate releases API for version resolution and binary download
|
|
||||||
# (REST API on GitHub, direct URLs on Gitea).
|
|
||||||
#
|
|
||||||
# Security notes:
|
|
||||||
# - On GitHub/GHES (VCS_TYPE=github), inputs.vcs-url is IGNORED to prevent
|
|
||||||
# token exfiltration. API calls use github.api_url; downloads use
|
|
||||||
# github.server_url. Tokens are never sent to user-supplied URLs.
|
|
||||||
# - On Gitea (VCS_TYPE=gitea), inputs.vcs-url is validated (https scheme,
|
|
||||||
# no whitespace/newlines, and DNS resolution to a public IP) before use.
|
|
||||||
# Python3 resolves the hostname and rejects RFC1918, RFC6598 (carrier-grade
|
|
||||||
# NAT), loopback, link-local, and other reserved addresses to prevent SSRF attacks.
|
|
||||||
# The installed review-bot binary additionally uses a safe HTTP transport
|
|
||||||
# (DialContext-level IP check) for all Gitea API calls at runtime.
|
|
||||||
# The binary also exposes a `validate-url` subcommand for use in any future
|
|
||||||
# shell steps that need to validate a URL before passing it to curl.
|
|
||||||
# - action-repo is validated against owner/repo pattern.
|
|
||||||
# - Tokens are passed via masked environment variables, not step outputs.
|
|
||||||
#
|
|
||||||
# Requirements: python3, sha256sum, curl (all present on ubuntu-* runners).
|
# Requirements: python3, sha256sum, curl (all present on ubuntu-* runners).
|
||||||
name: 'AI Code Review'
|
name: 'AI Code Review'
|
||||||
description: 'Run AI-powered code review on a pull request using review-bot'
|
description: 'Run AI-powered code review on a pull request using review-bot'
|
||||||
|
|
||||||
inputs:
|
inputs:
|
||||||
vcs-url:
|
gitea-url:
|
||||||
description: 'VCS server URL (only used on Gitea runners; ignored on GitHub/GHES). Defaults to server_url.'
|
description: 'Gitea instance URL (defaults to server_url)'
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
repo:
|
repo:
|
||||||
description: 'Repository to review (owner/name, defaults to current)'
|
description: 'Repository (owner/name, defaults to current)'
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
action-repo:
|
|
||||||
description: 'Repository hosting review-bot releases (owner/name). Defaults to github.action_repository or rodin/review-bot.'
|
|
||||||
required: false
|
|
||||||
default: ''
|
|
||||||
action-repo-token:
|
|
||||||
description: 'Token for downloading release assets from action-repo (defaults to github.token on GitHub, reviewer-token on Gitea). Required for private repos.'
|
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
pr-number:
|
pr-number:
|
||||||
@@ -45,7 +19,7 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
reviewer-token:
|
reviewer-token:
|
||||||
description: 'Token for posting the review'
|
description: 'Gitea token for posting the review'
|
||||||
required: true
|
required: true
|
||||||
reviewer-name:
|
reviewer-name:
|
||||||
description: 'Display name for the reviewer'
|
description: 'Display name for the reviewer'
|
||||||
@@ -138,325 +112,45 @@ runs:
|
|||||||
id: version
|
id: version
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
# --- Input Validation ---
|
|
||||||
|
|
||||||
# Determine the repo hosting review-bot releases (not the repo being reviewed)
|
|
||||||
ACTION_REPO="${{ inputs.action-repo }}"
|
|
||||||
if [ -z "$ACTION_REPO" ]; then
|
|
||||||
# github.action_repository is the repo containing the running action
|
|
||||||
ACTION_REPO="${{ github.action_repository }}"
|
|
||||||
fi
|
|
||||||
if [ -z "$ACTION_REPO" ]; then
|
|
||||||
# Final fallback for Gitea (which may not set action_repository)
|
|
||||||
ACTION_REPO="rodin/review-bot"
|
|
||||||
echo "::notice::action-repo not specified and github.action_repository is empty; falling back to rodin/review-bot"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Validate ACTION_REPO matches owner/repo pattern (prevent path traversal)
|
|
||||||
if ! printf '%s' "$ACTION_REPO" | grep -qE '^[a-zA-Z0-9._-]+/[a-zA-Z0-9._-]+$'; then
|
|
||||||
echo "Error: action-repo '${ACTION_REPO}' does not match expected owner/repo format" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Detect VCS host type using github.api_url context.
|
|
||||||
# github.api_url is set on GitHub.com (https://api.github.com) and GHES
|
|
||||||
# (https://<host>/api/v3). It is empty/unset on Gitea Actions runners.
|
|
||||||
GITHUB_API_URL="${{ github.api_url }}"
|
|
||||||
if [ -n "$GITHUB_API_URL" ]; then
|
|
||||||
VCS_TYPE="github"
|
|
||||||
else
|
|
||||||
VCS_TYPE="gitea"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Determine SERVER_URL based on VCS type.
|
|
||||||
# SECURITY: On GitHub/GHES, ALWAYS use github.server_url — never trust
|
|
||||||
# inputs.vcs-url to prevent token exfiltration to attacker-controlled hosts.
|
|
||||||
if [ "$VCS_TYPE" = "github" ]; then
|
|
||||||
SERVER_URL="${{ github.server_url }}"
|
|
||||||
if [ -n "${{ inputs.vcs-url }}" ]; then
|
|
||||||
echo "::warning::inputs.vcs-url is ignored on GitHub/GHES runners (VCS_TYPE=github). Using github.server_url instead."
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
SERVER_URL="${{ inputs.vcs-url || github.server_url }}"
|
|
||||||
fi
|
|
||||||
# Strip trailing slash if present
|
|
||||||
SERVER_URL="${SERVER_URL%/}"
|
|
||||||
|
|
||||||
# Validate SERVER_URL for Gitea path: must be https, no whitespace/newlines.
|
|
||||||
# The [^[:space:]] class already rejects newlines, so no separate newline check needed.
|
|
||||||
if [ "$VCS_TYPE" = "gitea" ]; then
|
|
||||||
if ! printf '%s' "$SERVER_URL" | grep -qE '^https://[^[:space:]]+$'; then
|
|
||||||
echo "Error: SERVER_URL '${SERVER_URL}' must be an https:// URL with no whitespace" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Additional IP-level SSRF defense: resolve the hostname and reject
|
|
||||||
# requests to RFC1918, RFC6598 (carrier-grade NAT), loopback, link-local,
|
|
||||||
# and other reserved addresses.
|
|
||||||
# python3 is required on ubuntu-* runners (see requirements comment above).
|
|
||||||
# Use printf to write the script to a temp file so the python lines are valid
|
|
||||||
# YAML (each indented line becomes a printf argument — no unindented code).
|
|
||||||
# SERVER_URL is passed via CHECK_URL env var, never interpolated into python code.
|
|
||||||
printf '%s\n' \
|
|
||||||
'import socket,ipaddress,sys,os' \
|
|
||||||
'from urllib.parse import urlparse' \
|
|
||||||
'u=os.environ["CHECK_URL"]; parsed=urlparse(u)' \
|
|
||||||
'if parsed.username or parsed.password:' \
|
|
||||||
' print("Error: URL contains user-info — not allowed",file=sys.stderr); sys.exit(2)' \
|
|
||||||
'h=parsed.hostname' \
|
|
||||||
'(print("Error: no hostname",file=sys.stderr) or sys.exit(2)) if not h else None' \
|
|
||||||
'try: rs=socket.getaddrinfo(h,None)' \
|
|
||||||
'except socket.gaierror as e: print(f"DNS error: {e}",file=sys.stderr); sys.exit(1)' \
|
|
||||||
'if not rs: print("Error: no addresses",file=sys.stderr); sys.exit(1)' \
|
|
||||||
'for _,_,_,_,(a,*_) in rs:' \
|
|
||||||
' ip=ipaddress.ip_address(a)' \
|
|
||||||
' if isinstance(ip,ipaddress.IPv6Address) and ip.ipv4_mapped: ip=ip.ipv4_mapped' \
|
|
||||||
' cgn=ipaddress.ip_network("100.64.0.0/10")' \
|
|
||||||
' if ip.is_private or ip.is_loopback or ip.is_link_local or ip.is_multicast or ip.is_reserved or ip in cgn:' \
|
|
||||||
' print(f"blocked: {a}",file=sys.stderr); sys.exit(1)' \
|
|
||||||
> /tmp/_ssrf_check.py
|
|
||||||
CHECK_URL="${SERVER_URL}" python3 /tmp/_ssrf_check.py || {
|
|
||||||
echo "Error: SERVER_URL '${SERVER_URL}' resolves to a private/reserved IP address" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Determine auth token for release API requests
|
|
||||||
ACTION_TOKEN="${{ inputs.action-repo-token }}"
|
|
||||||
if [ -z "$ACTION_TOKEN" ]; then
|
|
||||||
if [ "$VCS_TYPE" = "github" ]; then
|
|
||||||
ACTION_TOKEN="${{ github.token }}"
|
|
||||||
else
|
|
||||||
ACTION_TOKEN="${{ inputs.reviewer-token }}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Validate token contains no control characters (defense-in-depth against header injection)
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
if printf '%s' "$ACTION_TOKEN" | LC_ALL=C grep -q '[^[:print:]]'; then
|
|
||||||
echo "Error: ACTION_TOKEN contains control characters" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "${{ inputs.version }}" = "latest" ]; then
|
if [ "${{ inputs.version }}" = "latest" ]; then
|
||||||
if [ "$VCS_TYPE" = "github" ]; then
|
VERSION=$(curl -sSf "${GITEA_URL}/api/v1/repos/${REPO}/releases?limit=1" \
|
||||||
# SECURITY: Use github.api_url which is a trusted platform-provided value.
|
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
||||||
# Never construct API URLs from user-supplied inputs on GitHub.
|
|
||||||
API_URL="${GITHUB_API_URL}/repos/${ACTION_REPO}/releases?per_page=1"
|
|
||||||
else
|
|
||||||
# Gitea API — SERVER_URL was validated above
|
|
||||||
API_URL="${SERVER_URL}/api/v1/repos/${ACTION_REPO}/releases?limit=1"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Fetch latest version with inline auth header (no intermediate variable)
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
if [ "$VCS_TYPE" = "github" ]; then
|
|
||||||
VERSION=$(curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Authorization: Bearer ${ACTION_TOKEN}" "$API_URL" \
|
|
||||||
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
|
||||||
else
|
|
||||||
VERSION=$(curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Authorization: token ${ACTION_TOKEN}" "$API_URL" \
|
|
||||||
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
VERSION=$(curl -sSf --connect-timeout 10 --max-time 30 "$API_URL" \
|
|
||||||
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$VERSION" ]; then
|
if [ -z "$VERSION" ]; then
|
||||||
echo "Failed to determine latest version from ${API_URL}" >&2
|
echo "Failed to determine latest version" >&2
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
VERSION="${{ inputs.version }}"
|
VERSION="${{ inputs.version }}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Validate VERSION: no slashes or whitespace (prevent path traversal).
|
|
||||||
# [:space:] includes newlines and carriage returns in POSIX.
|
|
||||||
if printf '%s' "$VERSION" | grep -qE '[/[:space:]]'; then
|
|
||||||
echo "Error: VERSION '${VERSION}' contains invalid characters (newline, slash, or whitespace)" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Detect OS and architecture for platform-specific binary download
|
|
||||||
OS_RAW=$(uname -s | tr '[:upper:]' '[:lower:]')
|
|
||||||
case "$OS_RAW" in
|
|
||||||
linux) OS="linux" ;;
|
|
||||||
darwin) OS="darwin" ;;
|
|
||||||
*)
|
|
||||||
echo "Error: unsupported OS: $(uname -s)" >&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
RAW_ARCH=$(uname -m)
|
|
||||||
case "$RAW_ARCH" in
|
|
||||||
x86_64) ARCH="amd64" ;;
|
|
||||||
aarch64 | arm64) ARCH="arm64" ;;
|
|
||||||
*)
|
|
||||||
echo "Error: unsupported architecture: $RAW_ARCH" >&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
echo "os=${OS}" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "arch=${ARCH}" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "action_repo=${ACTION_REPO}" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "server_url=${SERVER_URL}" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "vcs_type=${VCS_TYPE}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
# SECURITY: Pass token via masked environment variable instead of step output.
|
|
||||||
# Step outputs can leak in debug logs; GITHUB_ENV with masking is safer.
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
echo "::add-mask::${ACTION_TOKEN}"
|
|
||||||
echo "ACTION_TOKEN=${ACTION_TOKEN}" >> "$GITHUB_ENV"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Cache review-bot binary
|
- name: Cache review-bot binary
|
||||||
id: cache
|
id: cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: ${{ runner.temp }}/review-bot
|
path: ${{ runner.temp }}/review-bot
|
||||||
key: review-bot-${{ steps.version.outputs.os }}-${{ steps.version.outputs.arch }}-${{ steps.version.outputs.version }}
|
key: review-bot-linux-amd64-${{ steps.version.outputs.version }}
|
||||||
|
|
||||||
- name: Install review-bot
|
- name: Install review-bot
|
||||||
if: steps.cache.outputs.cache-hit != 'true'
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
SERVER_URL="${{ steps.version.outputs.server_url }}"
|
|
||||||
ACTION_REPO="${{ steps.version.outputs.action_repo }}"
|
|
||||||
VERSION="${{ steps.version.outputs.version }}"
|
VERSION="${{ steps.version.outputs.version }}"
|
||||||
VCS_TYPE="${{ steps.version.outputs.vcs_type }}"
|
BINARY="review-bot-linux-amd64"
|
||||||
OS="${{ steps.version.outputs.os }}"
|
|
||||||
ARCH="${{ steps.version.outputs.arch }}"
|
|
||||||
# Read token from masked environment variable (set in Determine version step)
|
|
||||||
# Falls back to empty if not set (public repos don't need auth)
|
|
||||||
ACTION_TOKEN="${ACTION_TOKEN:-}"
|
|
||||||
BINARY="review-bot-${OS}-${ARCH}"
|
|
||||||
|
|
||||||
# SECURITY: Re-validate SERVER_URL at the start of this step to mitigate DNS
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/${BINARY}" \
|
||||||
# rebinding attacks. A DNS TTL expiry between "Determine version" and here
|
-o "${{ runner.temp }}/review-bot"
|
||||||
# could allow an attacker to change the resolved IP to a private/reserved
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/checksums.txt" \
|
||||||
# address, causing curl to send ACTION_TOKEN to an internal host.
|
-o "${{ runner.temp }}/checksums.txt"
|
||||||
# Only needed on Gitea path (VCS_TYPE=gitea); GitHub/GHES uses platform-controlled URLs.
|
|
||||||
if [ "$VCS_TYPE" = "gitea" ]; then
|
|
||||||
printf '%s\n' \
|
|
||||||
'import socket,ipaddress,sys,os' \
|
|
||||||
'from urllib.parse import urlparse' \
|
|
||||||
'u=os.environ["CHECK_URL"]; parsed=urlparse(u)' \
|
|
||||||
'if parsed.username or parsed.password:' \
|
|
||||||
' print("Error: URL contains user-info — not allowed",file=sys.stderr); sys.exit(2)' \
|
|
||||||
'h=parsed.hostname' \
|
|
||||||
'(print("Error: no hostname",file=sys.stderr) or sys.exit(2)) if not h else None' \
|
|
||||||
'try: rs=socket.getaddrinfo(h,None)' \
|
|
||||||
'except socket.gaierror as e: print(f"DNS error: {e}",file=sys.stderr); sys.exit(1)' \
|
|
||||||
'if not rs: print("Error: no addresses",file=sys.stderr); sys.exit(1)' \
|
|
||||||
'for _,_,_,_,(a,*_) in rs:' \
|
|
||||||
' ip=ipaddress.ip_address(a)' \
|
|
||||||
' if isinstance(ip,ipaddress.IPv6Address) and ip.ipv4_mapped: ip=ip.ipv4_mapped' \
|
|
||||||
' cgn=ipaddress.ip_network("100.64.0.0/10")' \
|
|
||||||
' if ip.is_private or ip.is_loopback or ip.is_link_local or ip.is_multicast or ip.is_reserved or ip in cgn:' \
|
|
||||||
' print(f"blocked: {a}",file=sys.stderr); sys.exit(1)' \
|
|
||||||
> /tmp/_ssrf_check_install.py
|
|
||||||
CHECK_URL="${SERVER_URL}" python3 /tmp/_ssrf_check_install.py || {
|
|
||||||
echo "Error: SERVER_URL '${SERVER_URL}' resolves to a private/reserved IP address" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$VCS_TYPE" = "github" ]; then
|
|
||||||
# GitHub/GHES: Use REST API for release asset downloads.
|
|
||||||
# Web release URLs ({server}/.../releases/download/{tag}/{asset}) redirect
|
|
||||||
# to S3 and don't reliably support Authorization headers for private repos.
|
|
||||||
# The REST API endpoint with Accept: application/octet-stream is required.
|
|
||||||
# GITHUB_API_URL: trusted platform value, same as detected in "Determine version" step.
|
|
||||||
GITHUB_API_URL="${{ github.api_url }}"
|
|
||||||
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
RELEASE_JSON=$(curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Authorization: Bearer ${ACTION_TOKEN}" \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/tags/${VERSION}")
|
|
||||||
else
|
|
||||||
RELEASE_JSON=$(curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/tags/${VERSION}")
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Extract asset IDs for binary and checksums
|
|
||||||
BINARY_ASSET_ID=$(printf '%s' "$RELEASE_JSON" | python3 -c "import sys, json; assets = json.load(sys.stdin).get('assets', []); matches = [a['id'] for a in assets if a['name'] == '${BINARY}']; print(matches[0] if matches else '')")
|
|
||||||
if [ -z "$BINARY_ASSET_ID" ]; then
|
|
||||||
echo "Error: could not find asset '${BINARY}' in release ${VERSION}" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
CHECKSUMS_ASSET_ID=$(printf '%s' "$RELEASE_JSON" | python3 -c "import sys, json; assets = json.load(sys.stdin).get('assets', []); matches = [a['id'] for a in assets if a['name'] == 'checksums.txt']; print(matches[0] if matches else '')")
|
|
||||||
if [ -z "$CHECKSUMS_ASSET_ID" ]; then
|
|
||||||
echo "Error: could not find asset 'checksums.txt' in release ${VERSION}" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Download assets via REST API with Accept: application/octet-stream
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
curl -sSfL --connect-timeout 10 --max-time 120 \
|
|
||||||
-H "Authorization: Bearer ${ACTION_TOKEN}" \
|
|
||||||
-H "Accept: application/octet-stream" \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/assets/${BINARY_ASSET_ID}" \
|
|
||||||
-o "${{ runner.temp }}/review-bot"
|
|
||||||
curl -sSfL --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Authorization: Bearer ${ACTION_TOKEN}" \
|
|
||||||
-H "Accept: application/octet-stream" \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/assets/${CHECKSUMS_ASSET_ID}" \
|
|
||||||
-o "${{ runner.temp }}/checksums.txt"
|
|
||||||
else
|
|
||||||
curl -sSfL --connect-timeout 10 --max-time 120 \
|
|
||||||
-H "Accept: application/octet-stream" \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/assets/${BINARY_ASSET_ID}" \
|
|
||||||
-o "${{ runner.temp }}/review-bot"
|
|
||||||
curl -sSfL --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Accept: application/octet-stream" \
|
|
||||||
"${GITHUB_API_URL}/repos/${ACTION_REPO}/releases/assets/${CHECKSUMS_ASSET_ID}" \
|
|
||||||
-o "${{ runner.temp }}/checksums.txt"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
# Gitea: Direct download via web release URLs (Gitea serves assets
|
|
||||||
# directly without redirects — no -L needed).
|
|
||||||
# SECURITY: Omitting -L prevents forwarding Authorization header to
|
|
||||||
# unexpected hosts if Gitea ever introduces CDN redirects.
|
|
||||||
DOWNLOAD_URL="${SERVER_URL}/${ACTION_REPO}/releases/download/${VERSION}"
|
|
||||||
|
|
||||||
if [ -n "$ACTION_TOKEN" ]; then
|
|
||||||
curl -sSf --connect-timeout 10 --max-time 120 \
|
|
||||||
-H "Authorization: token ${ACTION_TOKEN}" \
|
|
||||||
"${DOWNLOAD_URL}/${BINARY}" -o "${{ runner.temp }}/review-bot"
|
|
||||||
curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
-H "Authorization: token ${ACTION_TOKEN}" \
|
|
||||||
"${DOWNLOAD_URL}/checksums.txt" -o "${{ runner.temp }}/checksums.txt"
|
|
||||||
else
|
|
||||||
curl -sSf --connect-timeout 10 --max-time 120 \
|
|
||||||
"${DOWNLOAD_URL}/${BINARY}" -o "${{ runner.temp }}/review-bot"
|
|
||||||
curl -sSf --connect-timeout 10 --max-time 30 \
|
|
||||||
"${DOWNLOAD_URL}/checksums.txt" -o "${{ runner.temp }}/checksums.txt"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Verify SHA-256 checksum
|
# Verify SHA-256 checksum
|
||||||
# NOTE: This verifies integrity (download wasn't corrupted) but not
|
|
||||||
# authenticity — both binary and checksums come from the same server.
|
|
||||||
# For stronger guarantees, consider GPG signature verification.
|
|
||||||
cd "${{ runner.temp }}"
|
cd "${{ runner.temp }}"
|
||||||
EXPECTED=$(grep -E "^[0-9a-f]+[[:space:]]+\*?${BINARY}$" checksums.txt | awk '{print $1}')
|
EXPECTED=$(grep "${BINARY}" checksums.txt | awk '{print $1}')
|
||||||
# sha256sum (GNU) is not available on macOS; use shasum -a 256 on darwin.
|
ACTUAL=$(sha256sum review-bot | awk '{print $1}')
|
||||||
if [ "${OS}" = "darwin" ]; then
|
|
||||||
ACTUAL=$(shasum -a 256 review-bot | awk '{print $1}')
|
|
||||||
else
|
|
||||||
ACTUAL=$(sha256sum review-bot | awk '{print $1}')
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "$EXPECTED" ]; then
|
if [ -z "$EXPECTED" ]; then
|
||||||
echo "Error: no checksum found for ${BINARY}" >&2
|
echo "Error: no checksum found for ${BINARY}" >&2
|
||||||
@@ -470,12 +164,12 @@ runs:
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
chmod +x "${{ runner.temp }}/review-bot"
|
chmod +x "${{ runner.temp }}/review-bot"
|
||||||
echo "Installed review-bot-${OS}-${ARCH} ${VERSION} (checksum verified)"
|
echo "Installed review-bot ${VERSION} (checksum verified)"
|
||||||
|
|
||||||
- name: Run review
|
- name: Run review
|
||||||
shell: bash
|
shell: bash
|
||||||
env:
|
env:
|
||||||
VCS_URL: ${{ steps.version.outputs.server_url }}
|
GITEA_URL: ${{ inputs.gitea-url || github.server_url }}
|
||||||
GITEA_REPO: ${{ inputs.repo || github.repository }}
|
GITEA_REPO: ${{ inputs.repo || github.repository }}
|
||||||
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
|
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
|
||||||
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
|
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ jobs:
|
|||||||
- run: go build -o review-bot ./cmd/review-bot
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
- name: Run ${{ matrix.name }} review
|
- name: Run ${{ matrix.name }} review
|
||||||
env:
|
env:
|
||||||
VCS_URL: ${{ github.server_url }}
|
GITEA_URL: ${{ github.server_url }}
|
||||||
GITEA_REPO: ${{ github.repository }}
|
GITEA_REPO: ${{ github.repository }}
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||||
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
||||||
|
|||||||
@@ -0,0 +1,200 @@
|
|||||||
|
# This composite action is designed for Gitea Actions runners.
|
||||||
|
# Gitea Actions supports GitHub Actions syntax including $GITHUB_OUTPUT,
|
||||||
|
# actions/cache, and actions/checkout.
|
||||||
|
# Requirements: python3, sha256sum, curl (all present on ubuntu-* runners).
|
||||||
|
name: 'AI Code Review'
|
||||||
|
description: 'Run AI-powered code review on a pull request using review-bot'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
gitea-url:
|
||||||
|
description: 'Gitea instance URL (defaults to server_url)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
repo:
|
||||||
|
description: 'Repository (owner/name, defaults to current)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
pr-number:
|
||||||
|
description: 'Pull request number (defaults to current PR)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
reviewer-token:
|
||||||
|
description: 'Gitea token for posting the review'
|
||||||
|
required: true
|
||||||
|
reviewer-name:
|
||||||
|
description: 'Display name for the reviewer'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-base-url:
|
||||||
|
description: 'OpenAI-compatible LLM API base URL (not required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-api-key:
|
||||||
|
description: 'LLM API key (not required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-model:
|
||||||
|
description: 'LLM model name'
|
||||||
|
required: true
|
||||||
|
llm-provider:
|
||||||
|
description: 'LLM API provider: openai, anthropic, or aicore (default openai)'
|
||||||
|
required: false
|
||||||
|
default: 'openai'
|
||||||
|
aicore-client-id:
|
||||||
|
description: 'SAP AI Core client ID (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-client-secret:
|
||||||
|
description: 'SAP AI Core client secret (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-auth-url:
|
||||||
|
description: 'SAP AI Core authentication URL (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-api-url:
|
||||||
|
description: 'SAP AI Core API URL (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-resource-group:
|
||||||
|
description: 'SAP AI Core resource group (default: default)'
|
||||||
|
required: false
|
||||||
|
default: 'default'
|
||||||
|
conventions-file:
|
||||||
|
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
patterns-repo:
|
||||||
|
description: 'Comma-separated repos with language patterns (e.g. rodin/elixir-patterns,rodin/phoenix-conventions)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
patterns-files:
|
||||||
|
description: 'Comma-separated file paths or directories to fetch from patterns repos'
|
||||||
|
required: false
|
||||||
|
default: 'README.md'
|
||||||
|
temperature:
|
||||||
|
description: 'LLM temperature (0 = server default)'
|
||||||
|
required: false
|
||||||
|
default: '0'
|
||||||
|
timeout:
|
||||||
|
description: 'LLM request timeout in seconds (default 300)'
|
||||||
|
required: false
|
||||||
|
default: '300'
|
||||||
|
version:
|
||||||
|
description: 'review-bot version to install (e.g. v0.1.0, defaults to latest)'
|
||||||
|
required: false
|
||||||
|
default: 'latest'
|
||||||
|
dry-run:
|
||||||
|
description: 'Print review to stdout instead of posting'
|
||||||
|
required: false
|
||||||
|
default: 'false'
|
||||||
|
update-existing:
|
||||||
|
description: 'Delete previous review from same bot after posting new one. Accepts: true/1/yes or false/0/no (default true)'
|
||||||
|
required: false
|
||||||
|
default: 'true'
|
||||||
|
system-prompt-file:
|
||||||
|
description: 'Local file with additional system prompt instructions (e.g. security review focus)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
persona:
|
||||||
|
description: 'Built-in persona name (security, architect, docs)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
persona-file:
|
||||||
|
description: 'Path to custom persona JSON file'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: 'composite'
|
||||||
|
steps:
|
||||||
|
- name: Determine version
|
||||||
|
id: version
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
|
if [ "${{ inputs.version }}" = "latest" ]; then
|
||||||
|
VERSION=$(curl -sSf "${GITEA_URL}/api/v1/repos/${REPO}/releases?limit=1" \
|
||||||
|
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
||||||
|
if [ -z "$VERSION" ]; then
|
||||||
|
echo "Failed to determine latest version" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
VERSION="${{ inputs.version }}"
|
||||||
|
fi
|
||||||
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Cache review-bot binary
|
||||||
|
id: cache
|
||||||
|
uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: ${{ runner.temp }}/review-bot
|
||||||
|
key: review-bot-linux-amd64-${{ steps.version.outputs.version }}
|
||||||
|
|
||||||
|
- name: Install review-bot
|
||||||
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
|
VERSION="${{ steps.version.outputs.version }}"
|
||||||
|
BINARY="review-bot-linux-amd64"
|
||||||
|
|
||||||
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/${BINARY}" \
|
||||||
|
-o "${{ runner.temp }}/review-bot"
|
||||||
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/checksums.txt" \
|
||||||
|
-o "${{ runner.temp }}/checksums.txt"
|
||||||
|
|
||||||
|
# Verify SHA-256 checksum
|
||||||
|
cd "${{ runner.temp }}"
|
||||||
|
EXPECTED=$(grep "${BINARY}" checksums.txt | awk '{print $1}')
|
||||||
|
ACTUAL=$(sha256sum review-bot | awk '{print $1}')
|
||||||
|
|
||||||
|
if [ -z "$EXPECTED" ]; then
|
||||||
|
echo "Error: no checksum found for ${BINARY}" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ "$EXPECTED" != "$ACTUAL" ]; then
|
||||||
|
echo "Error: checksum mismatch!" >&2
|
||||||
|
echo " Expected: $EXPECTED" >&2
|
||||||
|
echo " Actual: $ACTUAL" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
chmod +x "${{ runner.temp }}/review-bot"
|
||||||
|
echo "Installed review-bot ${VERSION} (checksum verified)"
|
||||||
|
|
||||||
|
- name: Run review
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
GITHUB_SERVER_URL: ${{ inputs.gitea-url || github.server_url }}
|
||||||
|
GITHUB_REPOSITORY: ${{ inputs.repo || github.repository }}
|
||||||
|
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
|
||||||
|
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
|
||||||
|
REVIEWER_NAME: ${{ inputs.reviewer-name }}
|
||||||
|
LLM_BASE_URL: ${{ inputs.llm-base-url }}
|
||||||
|
LLM_API_KEY: ${{ inputs.llm-api-key }}
|
||||||
|
LLM_MODEL: ${{ inputs.llm-model }}
|
||||||
|
CONVENTIONS_FILE: ${{ inputs.conventions-file }}
|
||||||
|
PATTERNS_REPO: ${{ inputs.patterns-repo }}
|
||||||
|
PATTERNS_FILES: ${{ inputs.patterns-files }}
|
||||||
|
LLM_TEMPERATURE: ${{ inputs.temperature }}
|
||||||
|
LLM_TIMEOUT: ${{ inputs.timeout }}
|
||||||
|
LLM_PROVIDER: ${{ inputs.llm-provider }}
|
||||||
|
UPDATE_EXISTING: ${{ inputs.update-existing }}
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ inputs.system-prompt-file }}
|
||||||
|
PERSONA: ${{ inputs.persona }}
|
||||||
|
PERSONA_FILE: ${{ inputs.persona-file }}
|
||||||
|
AICORE_CLIENT_ID: ${{ inputs.aicore-client-id }}
|
||||||
|
AICORE_CLIENT_SECRET: ${{ inputs.aicore-client-secret }}
|
||||||
|
AICORE_AUTH_URL: ${{ inputs.aicore-auth-url }}
|
||||||
|
AICORE_API_URL: ${{ inputs.aicore-api-url }}
|
||||||
|
AICORE_RESOURCE_GROUP: ${{ inputs.aicore-resource-group }}
|
||||||
|
run: |
|
||||||
|
ARGS=""
|
||||||
|
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
||||||
|
ARGS="--dry-run"
|
||||||
|
fi
|
||||||
|
${{ runner.temp }}/review-bot $ARGS
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
- run: go test ./...
|
||||||
|
- run: go vet ./...
|
||||||
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
|
|
||||||
|
# Self-review using native SAP AI Core provider
|
||||||
|
# Models must match SAP AI Core deployments
|
||||||
|
# Available models: gpt-5, anthropic--claude-4.6-sonnet, anthropic--claude-4.6-opus
|
||||||
|
# Removed gpt-4.1, gpt-5-mini, gpt-4.1-mini - not deployed on AI Core
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
|
needs: test
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: sonnet
|
||||||
|
token_secret: SONNET_REVIEW_TOKEN
|
||||||
|
model: anthropic--claude-4.6-sonnet
|
||||||
|
- name: gpt
|
||||||
|
token_secret: GPT_REVIEW_TOKEN
|
||||||
|
model: gpt-5
|
||||||
|
- name: security
|
||||||
|
token_secret: SECURITY_REVIEW_TOKEN
|
||||||
|
model: gpt-5
|
||||||
|
patterns_repo: rodin/security-patterns
|
||||||
|
patterns_files: "."
|
||||||
|
system_prompt_file: SECURITY_REVIEW.md
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
|
- name: Run ${{ matrix.name }} review
|
||||||
|
env:
|
||||||
|
GITHUB_SERVER_URL: ${{ github.server_url }}
|
||||||
|
GITHUB_REPOSITORY: ${{ github.repository }}
|
||||||
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
||||||
|
REVIEWER_NAME: ${{ matrix.name }}
|
||||||
|
LLM_PROVIDER: aicore
|
||||||
|
LLM_MODEL: ${{ matrix.model }}
|
||||||
|
AICORE_CLIENT_ID: ${{ secrets.AICORE_CLIENT_ID }}
|
||||||
|
AICORE_CLIENT_SECRET: ${{ secrets.AICORE_CLIENT_SECRET }}
|
||||||
|
AICORE_AUTH_URL: ${{ secrets.AICORE_AUTH_URL }}
|
||||||
|
AICORE_API_URL: ${{ secrets.AICORE_API_URL }}
|
||||||
|
AICORE_RESOURCE_GROUP: ${{ secrets.AICORE_RESOURCE_GROUP }}
|
||||||
|
CONVENTIONS_FILE: "CONVENTIONS.md"
|
||||||
|
PATTERNS_REPO: ${{ matrix.patterns_repo || 'rodin/go-patterns' }}
|
||||||
|
PATTERNS_FILES: ${{ matrix.patterns_files || 'README.md,patterns/' }}
|
||||||
|
LLM_TIMEOUT: "600"
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ matrix.system_prompt_file }}
|
||||||
|
run: ./review-bot
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
name: PR Ready Gate
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
clear-labels:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
# Always run - curl commands are safe if labels don't exist
|
||||||
|
steps:
|
||||||
|
- name: Remove ready and self-reviewed labels, reassign to author
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.RODIN_TOKEN }}
|
||||||
|
run: |
|
||||||
|
PR_NUMBER=${{ github.event.pull_request.number }}
|
||||||
|
AUTHOR=${{ github.event.pull_request.user.login }}
|
||||||
|
READY_LABEL_ID=38
|
||||||
|
SELF_REVIEWED_LABEL_ID=37
|
||||||
|
|
||||||
|
# Remove ready label if present
|
||||||
|
curl -sS -X DELETE \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/issues/${PR_NUMBER}/labels/${READY_LABEL_ID}" || true
|
||||||
|
|
||||||
|
# Remove self-reviewed label if present
|
||||||
|
curl -sS -X DELETE \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/issues/${PR_NUMBER}/labels/${SELF_REVIEWED_LABEL_ID}" || true
|
||||||
|
|
||||||
|
# Reassign to author
|
||||||
|
curl -sS -X PATCH \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d "{\"assignees\": [\"${AUTHOR}\"]}" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/pulls/${PR_NUMBER}"
|
||||||
|
|
||||||
|
echo "Cleared ready/self-reviewed labels and reassigned PR #${PR_NUMBER} to ${AUTHOR}"
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
go vet ./...
|
||||||
|
go test ./...
|
||||||
|
|
||||||
|
- name: Build binaries
|
||||||
|
run: |
|
||||||
|
VERSION=${GITHUB_REF_NAME}
|
||||||
|
mkdir -p dist
|
||||||
|
|
||||||
|
GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-linux-amd64 ./cmd/review-bot
|
||||||
|
GOOS=linux GOARCH=arm64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-linux-arm64 ./cmd/review-bot
|
||||||
|
GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-darwin-amd64 ./cmd/review-bot
|
||||||
|
GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-darwin-arm64 ./cmd/review-bot
|
||||||
|
|
||||||
|
cd dist && sha256sum * > checksums.txt
|
||||||
|
|
||||||
|
- name: Create release and upload assets
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||||
|
run: |
|
||||||
|
VERSION=${GITHUB_REF_NAME}
|
||||||
|
GITEA_URL="${{ github.server_url }}"
|
||||||
|
REPO="${{ github.repository }}"
|
||||||
|
|
||||||
|
# Create release (or find existing one for this tag)
|
||||||
|
HTTP_CODE=$(curl -s -o /tmp/release_response.json -w "%{http_code}" -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases" \
|
||||||
|
-d "{\"tag_name\": \"${VERSION}\", \"name\": \"${VERSION}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}")
|
||||||
|
|
||||||
|
if [ "$HTTP_CODE" = "409" ]; then
|
||||||
|
echo "Release for ${VERSION} already exists, fetching existing..."
|
||||||
|
curl -sSf -o /tmp/release_response.json \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/tags/${VERSION}"
|
||||||
|
elif [ "$HTTP_CODE" != "201" ]; then
|
||||||
|
echo "Failed to create release (HTTP ${HTTP_CODE})" >&2
|
||||||
|
cat /tmp/release_response.json >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Parse release ID (python3 available on ubuntu-24.04 runners)
|
||||||
|
RELEASE_ID=$(python3 -c "import json; print(json.load(open('/tmp/release_response.json'))['id'])")
|
||||||
|
|
||||||
|
if [ -z "$RELEASE_ID" ]; then
|
||||||
|
echo "Failed to parse release ID" >&2
|
||||||
|
cat /tmp/release_response.json >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Release ID: ${RELEASE_ID}"
|
||||||
|
|
||||||
|
# Upload each asset (idempotent: delete existing asset with same name first)
|
||||||
|
for file in dist/*; do
|
||||||
|
filename=$(basename "$file")
|
||||||
|
echo "Uploading ${filename}..."
|
||||||
|
|
||||||
|
# Check if asset already exists and delete it
|
||||||
|
EXISTING_ID=$(export ASSET_NAME="${filename}"; curl -sS \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets" \
|
||||||
|
| python3 -c "import json,sys,os; name=os.environ['ASSET_NAME']; assets=json.load(sys.stdin); print(next((str(a['id']) for a in assets if a['name']==name),''))" 2>/dev/null)
|
||||||
|
|
||||||
|
if [ -n "$EXISTING_ID" ]; then
|
||||||
|
echo " Asset ${filename} already exists (id=${EXISTING_ID}), deleting..."
|
||||||
|
curl -sSf -X DELETE \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets/${EXISTING_ID}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
curl -sSf -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/octet-stream" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets?name=$(printf '%s' "${filename}" | jq -sRr @uri)" \
|
||||||
|
--data-binary "@${file}"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "Release ${VERSION} created with assets"
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
name: AI Code Review
|
|
||||||
|
|
||||||
# AI code review for pull requests on github.concur.com/strat/review-bot.
|
|
||||||
# Uses SAP AI Core as the LLM provider (same as the Gitea CI workflow).
|
|
||||||
#
|
|
||||||
# Prerequisites before this workflow can run:
|
|
||||||
# 1. Set required secrets on strat/review-bot (see list below)
|
|
||||||
# 2. Publish at least one release of review-bot on strat/review-bot
|
|
||||||
# (or change action-repo to a repo that already has releases)
|
|
||||||
#
|
|
||||||
# Required secrets:
|
|
||||||
# SONNET_REVIEW_TOKEN — GitHub token for the Sonnet reviewer bot
|
|
||||||
# GPT_REVIEW_TOKEN — GitHub token for the GPT reviewer bot
|
|
||||||
# AICORE_CLIENT_ID — SAP AI Core OAuth client ID
|
|
||||||
# AICORE_CLIENT_SECRET — SAP AI Core OAuth client secret
|
|
||||||
# AICORE_AUTH_URL — SAP AI Core OAuth token endpoint
|
|
||||||
# AICORE_API_URL — SAP AI Core inference API URL
|
|
||||||
# AICORE_RESOURCE_GROUP — SAP AI Core resource group (optional, default: default)
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types: [opened, synchronize]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-go@v5
|
|
||||||
with:
|
|
||||||
go-version: '1.26'
|
|
||||||
- run: go test ./...
|
|
||||||
- run: go vet ./...
|
|
||||||
- run: go build -o review-bot ./cmd/review-bot
|
|
||||||
|
|
||||||
review:
|
|
||||||
runs-on: ubuntu-24.04
|
|
||||||
if: github.event_name == 'pull_request'
|
|
||||||
needs: test
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- name: sonnet
|
|
||||||
token_secret: SONNET_REVIEW_TOKEN
|
|
||||||
model: anthropic--claude-4.6-sonnet
|
|
||||||
- name: gpt
|
|
||||||
token_secret: GPT_REVIEW_TOKEN
|
|
||||||
model: gpt-5
|
|
||||||
- name: security
|
|
||||||
token_secret: GPT_REVIEW_TOKEN
|
|
||||||
model: gpt-5
|
|
||||||
system_prompt_file: SECURITY_REVIEW.md
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: ./.gitea/actions/review
|
|
||||||
with:
|
|
||||||
# On GHES runners, vcs-url is ignored; the composite action uses github.server_url.
|
|
||||||
# action-repo must be a repo with published review-bot releases.
|
|
||||||
# Requires strat/review-bot to have at least one release tag with
|
|
||||||
# review-bot-linux-amd64 and checksums.txt assets.
|
|
||||||
vcs-url: https://gitea.weiker.me
|
|
||||||
action-repo: strat/review-bot
|
|
||||||
reviewer-token: ${{ secrets[matrix.token_secret] }}
|
|
||||||
reviewer-name: ${{ matrix.name }}
|
|
||||||
llm-provider: aicore
|
|
||||||
llm-model: ${{ matrix.model }}
|
|
||||||
aicore-client-id: ${{ secrets.AICORE_CLIENT_ID }}
|
|
||||||
aicore-client-secret: ${{ secrets.AICORE_CLIENT_SECRET }}
|
|
||||||
aicore-auth-url: ${{ secrets.AICORE_AUTH_URL }}
|
|
||||||
aicore-api-url: ${{ secrets.AICORE_API_URL }}
|
|
||||||
aicore-resource-group: ${{ secrets.AICORE_RESOURCE_GROUP }}
|
|
||||||
conventions-file: CONVENTIONS.md
|
|
||||||
patterns-repo: rodin/go-patterns
|
|
||||||
patterns-files: README.md,patterns/
|
|
||||||
timeout: "600"
|
|
||||||
system-prompt-file: ${{ matrix.system_prompt_file || '' }}
|
|
||||||
+1
-1
@@ -9,7 +9,7 @@
|
|||||||
|
|
||||||
| Package | Use Case | Scope |
|
| Package | Use Case | Scope |
|
||||||
|---------|----------|-------|
|
|---------|----------|-------|
|
||||||
| `github.com/goccy/go-yaml` | YAML parsing and AST inspection (subpkgs: `ast`, `parser`) | production |
|
| `gopkg.in/yaml.v3` | YAML parsing (persona files, config) | production |
|
||||||
| `github.com/google/go-cmp` | Test comparisons (`cmp.Diff`) | test only |
|
| `github.com/google/go-cmp` | Test comparisons (`cmp.Diff`) | test only |
|
||||||
|
|
||||||
**Any import not in this table or the Go standard library is forbidden.**
|
**Any import not in this table or the Go standard library is forbidden.**
|
||||||
|
|||||||
-175
@@ -1,175 +0,0 @@
|
|||||||
# Plan: Issue #125 — Rename GITEA_URL → VCS_URL
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
The `GITEA_URL` environment variable (and `--gitea-url` flag) implies the binary only works with Gitea.
|
|
||||||
Now that review-bot supports both Gitea and GitHub/GHES, this name is misleading.
|
|
||||||
Renaming to `VCS_URL` makes the binary platform-agnostic in its interface.
|
|
||||||
|
|
||||||
## Constraints
|
|
||||||
|
|
||||||
- Must not break existing users who already use `GITEA_URL` — need a fallback
|
|
||||||
- The CLI flag `--gitea-url` should also be updated to `--vcs-url` for consistency
|
|
||||||
- `INTEGRATION_GITEA_URL` in integration tests is a test-only env var, not the binary's interface; but should be updated for clarity
|
|
||||||
- The action YAML uses `GITEA_URL` as an internal shell variable in bash scripts — distinct from the env var passed to the binary
|
|
||||||
- All changes must compile and pass existing tests
|
|
||||||
|
|
||||||
## Files Affected
|
|
||||||
|
|
||||||
### Binary / Go source
|
|
||||||
| File | Change |
|
|
||||||
|------|--------|
|
|
||||||
| `cmd/review-bot/main.go` | Rename `--gitea-url` → `--vcs-url`, add `VCS_URL` as primary, keep `GITEA_URL` fallback |
|
|
||||||
| `cmd/review-bot/integration_test.go` | Rename `INTEGRATION_GITEA_URL` → `INTEGRATION_VCS_URL` (test-only, no external compat concern) |
|
|
||||||
| `integration_test.go` | Same — rename `INTEGRATION_GITEA_URL` → `INTEGRATION_VCS_URL` |
|
|
||||||
|
|
||||||
### Action YAML
|
|
||||||
| File | Change |
|
|
||||||
|------|--------|
|
|
||||||
| `.gitea/actions/review/action.yml` | Rename input `gitea-url` → `vcs-url`; update env var passed to binary: `VCS_URL` instead of `GITEA_URL`; keep internal bash var as `GITEA_URL` (only used for release download, not passed to binary) |
|
|
||||||
| `.gitea/workflows/ci.yml` | Rename `GITEA_URL` env var to `VCS_URL` in Run review step |
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
| File | Change |
|
|
||||||
|------|--------|
|
|
||||||
| `README.md` | Update CLI example, env var table entry |
|
|
||||||
|
|
||||||
## Proposed Approach
|
|
||||||
|
|
||||||
### 1. Backward-compatible env var lookup in main.go
|
|
||||||
|
|
||||||
Replace:
|
|
||||||
```go
|
|
||||||
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", ""), "Gitea instance URL")
|
|
||||||
```
|
|
||||||
|
|
||||||
With:
|
|
||||||
```go
|
|
||||||
giteaURL := flag.String("vcs-url", envOrDefaultFallback("VCS_URL", "GITEA_URL", ""), "VCS server URL (e.g. https://gitea.example.com)")
|
|
||||||
```
|
|
||||||
|
|
||||||
Add a helper:
|
|
||||||
```go
|
|
||||||
// envOrDefaultFallback reads primary env var; if empty, falls back to deprecated env var.
|
|
||||||
func envOrDefaultFallback(primary, deprecated, defaultVal string) string {
|
|
||||||
if v := os.Getenv(primary); v != "" {
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
if v := os.Getenv(deprecated); v != "" {
|
|
||||||
slog.Warn("deprecated env var in use; rename to " + primary, "old", deprecated, "new", primary)
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
return defaultVal
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** This must be called AFTER `setupLogger` conceptually, but the flag default is evaluated at flag registration time. Since `setupLogger` runs before `flag.Parse()`, the slog.Warn will print correctly at runtime. We use `log.Printf` as a fallback if this proves problematic.
|
|
||||||
|
|
||||||
Actually — flag defaults are evaluated at registration (line 57), before `setupLogger`. The warning won't go through slog. Two options:
|
|
||||||
- Use `log.Printf` for the deprecation warning (always visible)
|
|
||||||
- Move the fallback lookup to after `flag.Parse()`, checking if the parsed value is still empty
|
|
||||||
|
|
||||||
**Decision:** Move fallback to a post-parse check. This is cleaner:
|
|
||||||
```go
|
|
||||||
vcsURL := flag.String("vcs-url", os.Getenv("VCS_URL"), "VCS server URL")
|
|
||||||
flag.Parse()
|
|
||||||
// Backward compat: fall back to deprecated GITEA_URL
|
|
||||||
if *vcsURL == "" {
|
|
||||||
if v := os.Getenv("GITEA_URL"); v != "" {
|
|
||||||
slog.Warn("GITEA_URL is deprecated; use VCS_URL instead")
|
|
||||||
*vcsURL = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This is clean, idiomatic, and the warning goes through slog correctly.
|
|
||||||
|
|
||||||
### 2. Keep `--gitea-url` as deprecated alias
|
|
||||||
|
|
||||||
Add a hidden flag for backward compat:
|
|
||||||
```go
|
|
||||||
giteaURLAlias := flag.String("gitea-url", "", "Deprecated: use --vcs-url")
|
|
||||||
```
|
|
||||||
|
|
||||||
Post-parse:
|
|
||||||
```go
|
|
||||||
if *vcsURL == "" && *giteaURLAlias != "" {
|
|
||||||
slog.Warn("--gitea-url is deprecated; use --vcs-url instead")
|
|
||||||
*vcsURL = *giteaURLAlias
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Internal variable rename
|
|
||||||
|
|
||||||
Rename `giteaURL` local variable → `vcsURL` throughout `main.go` for consistency.
|
|
||||||
|
|
||||||
### 4. Error message update
|
|
||||||
|
|
||||||
```go
|
|
||||||
fmt.Fprintf(os.Stderr, "Required: --vcs-url, --repo, --pr, --reviewer-token, --llm-model\n")
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5. Action YAML changes
|
|
||||||
|
|
||||||
In `.gitea/actions/review/action.yml`:
|
|
||||||
- Input `gitea-url` → `vcs-url` (with same description, `required: false`, `default: ''`)
|
|
||||||
- Line 172: `GITEA_URL: ${{ inputs.gitea-url || github.server_url }}` → `VCS_URL: ${{ inputs.vcs-url || github.server_url }}`
|
|
||||||
- Lines 115, 140: internal bash vars `GITEA_URL=` are used for downloading binaries — NOT passed to the review-bot binary. Leave them as internal bash vars (they're scope-local in bash). These could be renamed to `SERVER_URL` or `BASE_URL` for local clarity, but renaming them isn't strictly required.
|
|
||||||
|
|
||||||
In `.gitea/workflows/ci.yml`:
|
|
||||||
- Line 52: `GITEA_URL: ${{ github.server_url }}` → `VCS_URL: ${{ github.server_url }}`
|
|
||||||
|
|
||||||
### 6. Integration test updates
|
|
||||||
|
|
||||||
`INTEGRATION_GITEA_URL` → `INTEGRATION_VCS_URL` in both test files.
|
|
||||||
|
|
||||||
### 7. README
|
|
||||||
|
|
||||||
- CLI example: `--gitea-url` → `--vcs-url`
|
|
||||||
- Env var table: `GITEA_URL` → `VCS_URL`, add note about `GITEA_URL` fallback
|
|
||||||
|
|
||||||
## Backward Compatibility Summary
|
|
||||||
|
|
||||||
| Old | New | Fallback? |
|
|
||||||
|-----|-----|-----------|
|
|
||||||
| `GITEA_URL` env var | `VCS_URL` | ✅ with deprecation warning |
|
|
||||||
| `--gitea-url` flag | `--vcs-url` | ✅ with deprecation warning |
|
|
||||||
| `gitea-url` action input | `vcs-url` | ⚠️ No (action version bump handles this) |
|
|
||||||
| `INTEGRATION_GITEA_URL` | `INTEGRATION_VCS_URL` | N/A (test-only) |
|
|
||||||
|
|
||||||
## Error Cases
|
|
||||||
|
|
||||||
- Both `VCS_URL` and `GITEA_URL` set: `VCS_URL` wins (primary takes precedence)
|
|
||||||
- Both `--vcs-url` and `--gitea-url` provided: `--vcs-url` wins
|
|
||||||
- Neither set: existing "missing required flags" error unchanged
|
|
||||||
|
|
||||||
## Edge Cases
|
|
||||||
|
|
||||||
- `os.Getenv` returns "" for unset AND set-to-empty — consistent with existing behavior
|
|
||||||
- The `envOrDefault` helper is unchanged; we add `envOrDefaultFallback` for the one renamed var
|
|
||||||
|
|
||||||
## Testing Strategy
|
|
||||||
|
|
||||||
- Existing unit tests pass unchanged (they don't test env var parsing directly)
|
|
||||||
- Integration tests updated to use new env var name
|
|
||||||
- Manual: `GITEA_URL=https://example.com ./review-bot --repo x --pr 1 ...` should print deprecation warning and proceed
|
|
||||||
- Manual: `VCS_URL=https://example.com ./review-bot ...` should work silently
|
|
||||||
|
|
||||||
## Completion Checklist
|
|
||||||
|
|
||||||
1. `VCS_URL` is read first; `GITEA_URL` is fallback with deprecation warning
|
|
||||||
2. `--vcs-url` flag is primary; `--gitea-url` is deprecated alias with warning
|
|
||||||
3. Error message references `--vcs-url` not `--gitea-url`
|
|
||||||
4. `action.yml` passes `VCS_URL` (not `GITEA_URL`) to the binary
|
|
||||||
5. `ci.yml` passes `VCS_URL` (not `GITEA_URL`) to the binary
|
|
||||||
6. README updated in CLI example and env var table
|
|
||||||
7. Integration tests use `INTEGRATION_VCS_URL`
|
|
||||||
8. `go test ./...` passes
|
|
||||||
9. `go vet ./...` passes
|
|
||||||
10. `go build ./cmd/review-bot` succeeds
|
|
||||||
|
|
||||||
## Open Questions
|
|
||||||
|
|
||||||
- Should the CLI flag `--gitea-url` be completely hidden from `--help` or just deprecated with a note? The issue doesn't specify. Decision: keep it visible but add "(deprecated: use --vcs-url)" to the description.
|
|
||||||
- Should action.yml also add `gitea-url` as a deprecated input alias? The issue says "Update the action to pass the new env var name" — no mention of backward compat for the action input. Decision: rename only, no alias (action users pin a version anyway).
|
|
||||||
- The bash-internal `GITEA_URL` variable in action.yml scripts (used for release download, not passed to binary) — rename for clarity? Decision: yes, rename to `BASE_URL` to avoid confusion with the env var.
|
|
||||||
@@ -282,7 +282,7 @@ Rules:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
review-bot \
|
review-bot \
|
||||||
--vcs-url https://gitea.example.com \
|
--gitea-url https://gitea.example.com \
|
||||||
--repo owner/name \
|
--repo owner/name \
|
||||||
--pr 42 \
|
--pr 42 \
|
||||||
--reviewer-token "$GITEA_TOKEN" \
|
--reviewer-token "$GITEA_TOKEN" \
|
||||||
@@ -299,7 +299,7 @@ All flags have environment variable equivalents:
|
|||||||
|
|
||||||
| Flag | Env Var |
|
| Flag | Env Var |
|
||||||
|------|---------|
|
|------|---------|
|
||||||
| `--vcs-url` | `VCS_URL` (fallback: `GITEA_URL`) |
|
| `--gitea-url` | `GITEA_URL` |
|
||||||
| `--repo` | `GITEA_REPO` |
|
| `--repo` | `GITEA_REPO` |
|
||||||
| `--pr` | `PR_NUMBER` |
|
| `--pr` | `PR_NUMBER` |
|
||||||
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
||||||
|
|||||||
@@ -1,79 +0,0 @@
|
|||||||
## Dev Loop: review-bot — 2026-05-14 20:10 UTC
|
|
||||||
|
|
||||||
### Latest: ✅ STABLE STATE — REPO HEALTH COMPLETE
|
|
||||||
- **Last action:** health check; verified tests pass, repo clean, no action needed
|
|
||||||
- **Repository:** Clean, all merges complete, no open issues/PRs
|
|
||||||
- **Main branch:** Up to date with origin/main
|
|
||||||
- **Test suite:** All passing (cached)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Repository Status
|
|
||||||
|
|
||||||
### ✅ Merged to main (recent):
|
|
||||||
- issue-123 (IP-level SSRF defense) — 6 commits, main at 4440823
|
|
||||||
- issue-125 (VCS_URL rename + deprecation) — merged
|
|
||||||
- issue-124 (multi-arch binary support) — merged
|
|
||||||
- issue-120 (GitHub Actions + VCS abstraction) — merged
|
|
||||||
- issue-121 (VCS host type detection for binary download) — merged
|
|
||||||
|
|
||||||
### 🧹 Cleanup COMPLETE:
|
|
||||||
- ✅ Removed old worktrees (issue-123, review-bot-issue-125)
|
|
||||||
- ✅ Test suite passes (all packages)
|
|
||||||
- ✅ No TODO/FIXME in code except expected GitHub client notes
|
|
||||||
- ✅ No open issues or pull requests
|
|
||||||
- ✅ Dependencies up to date
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Current Feature Completeness
|
|
||||||
|
|
||||||
✅ **Core Capabilities:**
|
|
||||||
- Multi-provider LLM support (OpenAI, Anthropic, SAP AI Core)
|
|
||||||
- Gitea PR integration with structured reviews
|
|
||||||
- SSRF defense with IP-level validation
|
|
||||||
- VCS abstraction (Gitea/GitHub support)
|
|
||||||
- Multi-architecture binary support
|
|
||||||
- GitHub Actions composite action
|
|
||||||
|
|
||||||
✅ **Recent Security Work:**
|
|
||||||
- RFC6598 CGN range detection
|
|
||||||
- IP fallback dialing for local endpoint rejection
|
|
||||||
- URL validation for SSRF prevention
|
|
||||||
|
|
||||||
✅ **Code Quality:**
|
|
||||||
- Comprehensive test coverage (all packages tested)
|
|
||||||
- Consistent error handling with context propagation
|
|
||||||
- Secure credential handling (unexported fields)
|
|
||||||
- Concurrency-safe designs
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Priority Actions
|
|
||||||
|
|
||||||
### Phase 2: Feature Exploration (NEXT SESSION)
|
|
||||||
- Scan code for potential improvements per REVIEW.md findings
|
|
||||||
- Assess performance under load
|
|
||||||
- Review REVIEW.md findings for targeted fixes
|
|
||||||
- Consider backlog items from design docs
|
|
||||||
|
|
||||||
### Phase 3: Optional Enhancements (BACKLOG)
|
|
||||||
- Address REVIEW.md context propagation findings (if prioritized)
|
|
||||||
- Additional LLM provider support
|
|
||||||
- Enhanced context detection
|
|
||||||
- Custom report formats
|
|
||||||
- Webhook management improvements
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Worktrees Status
|
|
||||||
All old worktrees cleaned up. Ready for new issue work.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Dev-Loop Metadata
|
|
||||||
- **Repo:** /home/ubuntu/review-bot
|
|
||||||
- **Main branch SHA:** ed3a5dd (last commit)
|
|
||||||
- **Cron ID:** 5342ac81-4bbc-4e4c-a123-347a7788d50c
|
|
||||||
- **Scheduled:** Every 4 hours
|
|
||||||
- **Last health check:** 2026-05-14 20:10 UTC (✅ all healthy)
|
|
||||||
@@ -17,7 +17,7 @@ import (
|
|||||||
// Integration test requires a running Gitea instance and LLM endpoint.
|
// Integration test requires a running Gitea instance and LLM endpoint.
|
||||||
// Set environment variables:
|
// Set environment variables:
|
||||||
//
|
//
|
||||||
// INTEGRATION_VCS_URL - VCS base URL
|
// INTEGRATION_GITEA_URL - Gitea base URL
|
||||||
// INTEGRATION_GITEA_TOKEN - Gitea API token with repo access
|
// INTEGRATION_GITEA_TOKEN - Gitea API token with repo access
|
||||||
// INTEGRATION_GITEA_REPO - owner/repo with an open PR
|
// INTEGRATION_GITEA_REPO - owner/repo with an open PR
|
||||||
// INTEGRATION_PR_NUMBER - PR number to test against
|
// INTEGRATION_PR_NUMBER - PR number to test against
|
||||||
@@ -25,7 +25,7 @@ import (
|
|||||||
// INTEGRATION_LLM_API_KEY - LLM API key
|
// INTEGRATION_LLM_API_KEY - LLM API key
|
||||||
// INTEGRATION_LLM_MODEL - Model name
|
// INTEGRATION_LLM_MODEL - Model name
|
||||||
func TestIntegration_FullReviewFlow(t *testing.T) {
|
func TestIntegration_FullReviewFlow(t *testing.T) {
|
||||||
giteaURL := os.Getenv("INTEGRATION_VCS_URL")
|
giteaURL := os.Getenv("INTEGRATION_GITEA_URL")
|
||||||
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
||||||
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
||||||
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
||||||
@@ -104,7 +104,7 @@ func TestIntegration_FullReviewFlow(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestIntegration_PostAndCleanup(t *testing.T) {
|
func TestIntegration_PostAndCleanup(t *testing.T) {
|
||||||
giteaURL := os.Getenv("INTEGRATION_VCS_URL")
|
giteaURL := os.Getenv("INTEGRATION_GITEA_URL")
|
||||||
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
||||||
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
||||||
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
||||||
@@ -130,7 +130,7 @@ func TestIntegration_PostAndCleanup(t *testing.T) {
|
|||||||
// Post a test review
|
// Post a test review
|
||||||
sentinel := "<!-- review-bot:integration-test -->"
|
sentinel := "<!-- review-bot:integration-test -->"
|
||||||
testBody := "# Integration Test Review\n\nThis is a test review.\n\n" + sentinel
|
testBody := "# Integration Test Review\n\nThis is a test review.\n\n" + sentinel
|
||||||
posted, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, "COMMENT", testBody, "", nil)
|
posted, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, "COMMENT", testBody, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("PostReview: %v", err)
|
t.Fatalf("PostReview: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
+45
-60
@@ -4,7 +4,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -20,13 +19,6 @@ import (
|
|||||||
|
|
||||||
var version = "dev"
|
var version = "dev"
|
||||||
|
|
||||||
// outWriter and errWriter are the output and error writers for subcommands.
|
|
||||||
// They are variables so tests can capture output.
|
|
||||||
var (
|
|
||||||
outWriter io.Writer = os.Stdout
|
|
||||||
errWriter io.Writer = os.Stderr
|
|
||||||
)
|
|
||||||
|
|
||||||
// setupLogger configures the global slog default logger based on format and verbosity.
|
// setupLogger configures the global slog default logger based on format and verbosity.
|
||||||
func setupLogger(format, verbosity string) {
|
func setupLogger(format, verbosity string) {
|
||||||
var level slog.Level
|
var level slog.Level
|
||||||
@@ -57,23 +49,13 @@ func setupLogger(format, verbosity string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
// Dispatch subcommands before flag parsing so they get their own args.
|
|
||||||
// e.g. `review-bot validate-url <url>`
|
|
||||||
if len(os.Args) > 1 {
|
|
||||||
switch os.Args[1] {
|
|
||||||
case "validate-url":
|
|
||||||
os.Exit(runValidateURL(os.Args[2:]))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
versionFlag := flag.Bool("version", false, "Print version and exit")
|
versionFlag := flag.Bool("version", false, "Print version and exit")
|
||||||
// Logging flags
|
// Logging flags
|
||||||
logFormat := flag.String("log-format", envOrDefault("LOG_FORMAT", "text"), "Log output format: text or json")
|
logFormat := flag.String("log-format", envOrDefault("LOG_FORMAT", "text"), "Log output format: text or json")
|
||||||
verbosity := flag.String("verbosity", envOrDefault("LOG_VERBOSITY", "info"), "Log verbosity: debug, info, warn, error")
|
verbosity := flag.String("verbosity", envOrDefault("LOG_VERBOSITY", "info"), "Log verbosity: debug, info, warn, error")
|
||||||
// CLI flags
|
// CLI flags
|
||||||
vcsURL := flag.String("vcs-url", os.Getenv("VCS_URL"), "VCS server URL (e.g. https://gitea.example.com)")
|
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", envOrDefault("GITHUB_SERVER_URL", "")), "Gitea instance URL")
|
||||||
giteaURLAlias := flag.String("gitea-url", "", "Deprecated: use --vcs-url")
|
repo := flag.String("repo", envOrDefault("GITEA_REPO", envOrDefault("GITHUB_REPOSITORY", "")), "Repository (owner/name)")
|
||||||
repo := flag.String("repo", envOrDefault("GITEA_REPO", ""), "Repository (owner/name)")
|
|
||||||
prNum := flag.String("pr", envOrDefault("PR_NUMBER", ""), "Pull request number")
|
prNum := flag.String("pr", envOrDefault("PR_NUMBER", ""), "Pull request number")
|
||||||
reviewerName := flag.String("reviewer-name", envOrDefault("REVIEWER_NAME", ""), "Reviewer display name")
|
reviewerName := flag.String("reviewer-name", envOrDefault("REVIEWER_NAME", ""), "Reviewer display name")
|
||||||
reviewerToken := flag.String("reviewer-token", envOrDefault("REVIEWER_TOKEN", ""), "Gitea token for posting review")
|
reviewerToken := flag.String("reviewer-token", envOrDefault("REVIEWER_TOKEN", ""), "Gitea token for posting review")
|
||||||
@@ -83,7 +65,7 @@ func main() {
|
|||||||
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
||||||
systemPromptFile := flag.String("system-prompt-file", envOrDefault("SYSTEM_PROMPT_FILE", ""), "Local file with additional system prompt instructions")
|
systemPromptFile := flag.String("system-prompt-file", envOrDefault("SYSTEM_PROMPT_FILE", ""), "Local file with additional system prompt instructions")
|
||||||
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
||||||
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", ""), "Comma-separated file paths to fetch from patterns repo (empty = all files)")
|
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", "README.md"), "Comma-separated file paths to fetch from patterns repo")
|
||||||
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
||||||
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
||||||
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
||||||
@@ -109,24 +91,12 @@ func main() {
|
|||||||
|
|
||||||
slog.Info("review-bot starting", "version", version)
|
slog.Info("review-bot starting", "version", version)
|
||||||
|
|
||||||
// Backward compatibility: fall back to deprecated env var / flag if VCS_URL / --vcs-url not set.
|
|
||||||
if *vcsURL == "" {
|
|
||||||
if v := os.Getenv("GITEA_URL"); v != "" {
|
|
||||||
slog.Warn("GITEA_URL is deprecated; rename the environment variable to VCS_URL")
|
|
||||||
*vcsURL = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if *vcsURL == "" && *giteaURLAlias != "" {
|
|
||||||
slog.Warn("--gitea-url is deprecated; use --vcs-url instead")
|
|
||||||
*vcsURL = *giteaURLAlias
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate required fields
|
// Validate required fields
|
||||||
// For aicore provider, llm-base-url and llm-api-key are not required
|
// For aicore provider, llm-base-url and llm-api-key are not required
|
||||||
isAICore := llm.Provider(*llmProvider) == llm.ProviderAICore
|
isAICore := llm.Provider(*llmProvider) == llm.ProviderAICore
|
||||||
if *vcsURL == "" || *repo == "" || *prNum == "" || *reviewerToken == "" || *llmModel == "" {
|
if *giteaURL == "" || *repo == "" || *prNum == "" || *reviewerToken == "" || *llmModel == "" {
|
||||||
fmt.Fprintf(os.Stderr, "Error: missing required flags or environment variables\n\n")
|
fmt.Fprintf(os.Stderr, "Error: missing required flags or environment variables\n\n")
|
||||||
fmt.Fprintf(os.Stderr, "Required: --vcs-url, --repo, --pr, --reviewer-token, --llm-model\n")
|
fmt.Fprintf(os.Stderr, "Required: --gitea-url, --repo, --pr, --reviewer-token, --llm-model\n")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if !isAICore && (*llmBaseURL == "" || *llmAPIKey == "") {
|
if !isAICore && (*llmBaseURL == "" || *llmAPIKey == "") {
|
||||||
@@ -168,12 +138,8 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Detect VCS type and initialize the appropriate client.
|
|
||||||
vcsType := detectVCSType()
|
|
||||||
slog.Info("detected VCS type", "vcs", vcsType)
|
|
||||||
|
|
||||||
// Initialize clients
|
// Initialize clients
|
||||||
giteaClient := newVCSClient(vcsType, *vcsURL, *reviewerToken)
|
giteaClient := gitea.NewClient(*giteaURL, *reviewerToken)
|
||||||
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
||||||
if *llmTemp < 0 || *llmTemp > 2 {
|
if *llmTemp < 0 || *llmTemp > 2 {
|
||||||
slog.Error("invalid LLM temperature", "temperature", *llmTemp, "range", "0-2")
|
slog.Error("invalid LLM temperature", "temperature", *llmTemp, "range", "0-2")
|
||||||
@@ -211,7 +177,7 @@ func main() {
|
|||||||
var persona *review.Persona
|
var persona *review.Persona
|
||||||
if *personaName != "" {
|
if *personaName != "" {
|
||||||
// Try loading from repo first, then fall back to built-in
|
// Try loading from repo first, then fall back to built-in
|
||||||
repoPersonas, err := review.LoadRepoPersonas(ctx, buildRepoPersonaClient(giteaClient), owner, repoName)
|
repoPersonas, err := review.LoadRepoPersonas(ctx, newGiteaClientAdapter(giteaClient), owner, repoName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not load repo personas", "repo", owner+"/"+repoName, "error", err)
|
slog.Warn("could not load repo personas", "repo", owner+"/"+repoName, "error", err)
|
||||||
// Continue with built-in personas only.
|
// Continue with built-in personas only.
|
||||||
@@ -478,7 +444,7 @@ func main() {
|
|||||||
|
|
||||||
// POST new review
|
// POST new review
|
||||||
slog.Info("posting review", "event", event, "pr", prNumber)
|
slog.Info("posting review", "event", event, "pr", prNumber)
|
||||||
posted, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, event, reviewBody, evaluatedSHA, inlineComments)
|
posted, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, event, reviewBody, inlineComments)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to post review", "pr", prNumber, "event", event, "error", err)
|
slog.Error("failed to post review", "pr", prNumber, "event", event, "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -487,7 +453,7 @@ func main() {
|
|||||||
|
|
||||||
// Supersede all old reviews with link to the new one
|
// Supersede all old reviews with link to the new one
|
||||||
if len(oldReviews) > 0 {
|
if len(oldReviews) > 0 {
|
||||||
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(*vcsURL, "/"), owner, repoName, prNumber, posted.ID)
|
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(*giteaURL, "/"), owner, repoName, prNumber, posted.ID)
|
||||||
for _, oldReview := range oldReviews {
|
for _, oldReview := range oldReviews {
|
||||||
cid, err := giteaClient.GetTimelineReviewCommentIDForReview(ctx, owner, repoName, prNumber, oldReview.ID)
|
cid, err := giteaClient.GetTimelineReviewCommentIDForReview(ctx, owner, repoName, prNumber, oldReview.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -531,7 +497,7 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// fetchFileContext fetches the full content of modified files from the PR branch.
|
// fetchFileContext fetches the full content of modified files from the PR branch.
|
||||||
func fetchFileContext(ctx context.Context, client vcsClient, owner, repo, ref string, files []gitea.ChangedFile) string {
|
func fetchFileContext(ctx context.Context, client *gitea.Client, owner, repo, ref string, files []gitea.ChangedFile) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
for _, f := range files {
|
for _, f := range files {
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
@@ -557,25 +523,11 @@ func fetchFileContext(ctx context.Context, client vcsClient, owner, repo, ref st
|
|||||||
// patternsRepo is comma-separated list of owner/name repos.
|
// patternsRepo is comma-separated list of owner/name repos.
|
||||||
// patternsFiles is comma-separated list of file paths or directories.
|
// patternsFiles is comma-separated list of file paths or directories.
|
||||||
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
||||||
// If patternsFiles is empty, all files from the repo root are fetched.
|
func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patternsFiles string) string {
|
||||||
func fetchPatterns(ctx context.Context, client vcsClient, patternsRepo, patternsFiles string) string {
|
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
repos := strings.Split(patternsRepo, ",")
|
repos := strings.Split(patternsRepo, ",")
|
||||||
|
paths := strings.Split(patternsFiles, ",")
|
||||||
// Build the list of paths to fetch
|
|
||||||
var paths []string
|
|
||||||
if patternsFiles == "" {
|
|
||||||
// Empty patternsFiles means "fetch all files from repo root"
|
|
||||||
paths = []string{""}
|
|
||||||
} else {
|
|
||||||
for _, p := range strings.Split(patternsFiles, ",") {
|
|
||||||
p = strings.TrimSpace(p)
|
|
||||||
if p != "" {
|
|
||||||
paths = append(paths, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, repoRef := range repos {
|
for _, repoRef := range repos {
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
@@ -596,6 +548,11 @@ func fetchPatterns(ctx context.Context, client vcsClient, patternsRepo, patterns
|
|||||||
var repoSkippedFiles []string
|
var repoSkippedFiles []string
|
||||||
|
|
||||||
for _, path := range paths {
|
for _, path := range paths {
|
||||||
|
path = strings.TrimSpace(path)
|
||||||
|
if path == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
files, err := client.GetAllFilesInPath(ctx, owner, repo, path)
|
files, err := client.GetAllFilesInPath(ctx, owner, repo, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not fetch patterns", "path", path, "repo", repoRef, "error", err)
|
slog.Warn("could not fetch patterns", "path", path, "repo", repoRef, "error", err)
|
||||||
@@ -855,3 +812,31 @@ func shouldSkipStaleReview(evaluatedSHA, currentSHA string) bool {
|
|||||||
return evaluatedSHA != currentSHA
|
return evaluatedSHA != currentSHA
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// giteaClientAdapter adapts gitea.Client to review.GiteaClient interface.
|
||||||
|
type giteaClientAdapter struct {
|
||||||
|
client *gitea.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func newGiteaClientAdapter(c *gitea.Client) *giteaClientAdapter {
|
||||||
|
return &giteaClientAdapter{client: c}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaClientAdapter) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
||||||
|
entries, err := a.client.ListContents(ctx, owner, repo, path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
result := make([]review.ContentEntry, len(entries))
|
||||||
|
for i, e := range entries {
|
||||||
|
result[i] = review.ContentEntry{
|
||||||
|
Name: e.Name,
|
||||||
|
Path: e.Path,
|
||||||
|
Type: e.Type,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaClientAdapter) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
return a.client.GetFileContent(ctx, owner, repo, filepath)
|
||||||
|
}
|
||||||
|
|||||||
@@ -504,52 +504,6 @@ func TestIsPatternFile(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestBuildPatternPaths verifies the path-building logic for fetchPatterns.
|
|
||||||
// Empty patternsFiles means "fetch all from root" (represented as [""]).
|
|
||||||
func TestBuildPatternPaths(t *testing.T) {
|
|
||||||
buildPaths := func(patternsFiles string) []string {
|
|
||||||
if patternsFiles == "" {
|
|
||||||
return []string{""}
|
|
||||||
}
|
|
||||||
var paths []string
|
|
||||||
for _, p := range strings.Split(patternsFiles, ",") {
|
|
||||||
p = strings.TrimSpace(p)
|
|
||||||
if p != "" {
|
|
||||||
paths = append(paths, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return paths
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
input string
|
|
||||||
want []string
|
|
||||||
}{
|
|
||||||
{"empty fetches root", "", []string{""}},
|
|
||||||
{"single file", "README.md", []string{"README.md"}},
|
|
||||||
{"multiple files", "README.md,PATTERNS.md", []string{"README.md", "PATTERNS.md"}},
|
|
||||||
{"trims whitespace", " foo.md , bar.md ", []string{"foo.md", "bar.md"}},
|
|
||||||
{"skips empty between commas", "foo.md,,bar.md", []string{"foo.md", "bar.md"}},
|
|
||||||
{"directory path", "patterns/", []string{"patterns/"}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
got := buildPaths(tc.input)
|
|
||||||
if len(got) != len(tc.want) {
|
|
||||||
t.Errorf("buildPaths(%q) = %v, want %v", tc.input, got, tc.want)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for i := range got {
|
|
||||||
if got[i] != tc.want[i] {
|
|
||||||
t.Errorf("buildPaths(%q)[%d] = %q, want %q", tc.input, i, got[i], tc.want[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluateCIStatus(t *testing.T) {
|
func TestEvaluateCIStatus(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
|
|||||||
@@ -1,125 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
|
||||||
)
|
|
||||||
|
|
||||||
// runValidateURL implements the `review-bot validate-url <url>` subcommand.
|
|
||||||
//
|
|
||||||
// It resolves the given URL's hostname and checks that every returned IP is
|
|
||||||
// publicly routable (not RFC1918, loopback, link-local, or other reserved
|
|
||||||
// ranges). The exit code communicates the result to callers:
|
|
||||||
//
|
|
||||||
// 0 — URL is safe to use
|
|
||||||
// 1 — URL resolves to a blocked/private address
|
|
||||||
// 2 — URL is malformed, has an unsafe scheme, or DNS lookup failed
|
|
||||||
//
|
|
||||||
// This is intended for use from action.yml shell steps that need to validate
|
|
||||||
// a user-supplied URL before passing it to curl.
|
|
||||||
func runValidateURL(args []string) int {
|
|
||||||
if len(args) != 1 {
|
|
||||||
fmt.Fprintln(errWriter, "usage: review-bot validate-url <url>")
|
|
||||||
fmt.Fprintln(errWriter, "")
|
|
||||||
fmt.Fprintln(errWriter, "Resolves <url> and verifies all resolved IPs are publicly routable.")
|
|
||||||
fmt.Fprintln(errWriter, "Exit 0=safe, 1=blocked, 2=error")
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
rawURL := args[0]
|
|
||||||
|
|
||||||
if err := validateURL(rawURL); err != nil {
|
|
||||||
fmt.Fprintf(errWriter, "Error: %v\n", err)
|
|
||||||
var ve *validateError
|
|
||||||
if isValidateError(err, &ve) {
|
|
||||||
return ve.code
|
|
||||||
}
|
|
||||||
return 2
|
|
||||||
}
|
|
||||||
fmt.Fprintf(outWriter, "OK: %s is safe\n", rawURL)
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// validateError carries an exit code alongside a message.
|
|
||||||
type validateError struct {
|
|
||||||
code int
|
|
||||||
message string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *validateError) Error() string { return e.message }
|
|
||||||
|
|
||||||
// isValidateError checks if err is or wraps a *validateError and sets out.
|
|
||||||
// Uses errors.As so that wrapped *validateError values (e.g. from fmt.Errorf("...: %w", &validateError{...}))
|
|
||||||
// are also detected, making the function robust against future wrapping.
|
|
||||||
func isValidateError(err error, out **validateError) bool {
|
|
||||||
if err == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return errors.As(err, out)
|
|
||||||
}
|
|
||||||
|
|
||||||
// validateURL checks that rawURL is safe for use as a Gitea server URL:
|
|
||||||
// - Must be https:// (not http://)
|
|
||||||
// - Must have no user-info (user:pass@host)
|
|
||||||
// - Must resolve to at least one IP, all of which are publicly routable
|
|
||||||
func validateURL(rawURL string) error {
|
|
||||||
parsed, err := url.Parse(rawURL)
|
|
||||||
if err != nil {
|
|
||||||
return &validateError{code: 2, message: fmt.Sprintf("malformed URL %q: %v", rawURL, err)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scheme check: only https is permitted.
|
|
||||||
if !strings.EqualFold(parsed.Scheme, "https") {
|
|
||||||
return &validateError{
|
|
||||||
code: 2,
|
|
||||||
message: fmt.Sprintf("URL scheme must be https (got %q)", parsed.Scheme),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reject user-info (user:password@host) to prevent credential embedding.
|
|
||||||
if parsed.User != nil {
|
|
||||||
return &validateError{
|
|
||||||
code: 2,
|
|
||||||
message: "URL must not contain user-info (user:password@host)",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
host := parsed.Hostname()
|
|
||||||
if host == "" {
|
|
||||||
return &validateError{code: 2, message: fmt.Sprintf("URL has no host: %q", rawURL)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve the hostname with a short timeout.
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
addrs, err := net.DefaultResolver.LookupIPAddr(ctx, host)
|
|
||||||
if err != nil {
|
|
||||||
return &validateError{
|
|
||||||
code: 2,
|
|
||||||
message: fmt.Sprintf("DNS lookup failed for %q: %v", host, err),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(addrs) == 0 {
|
|
||||||
return &validateError{
|
|
||||||
code: 2,
|
|
||||||
message: fmt.Sprintf("DNS lookup returned no addresses for %q", host),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, a := range addrs {
|
|
||||||
if gitea.IsBlockedIP(a.IP) {
|
|
||||||
return &validateError{
|
|
||||||
code: 1,
|
|
||||||
message: fmt.Sprintf("blocked: %q resolves to private/reserved IP %s", host, a.IP),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestRunValidateURL_Usage(t *testing.T) {
|
|
||||||
var errBuf bytes.Buffer
|
|
||||||
origErr := errWriter
|
|
||||||
errWriter = &errBuf
|
|
||||||
defer func() { errWriter = origErr }()
|
|
||||||
|
|
||||||
code := runValidateURL(nil)
|
|
||||||
if code != 2 {
|
|
||||||
t.Errorf("expected exit code 2 for no args, got %d", code)
|
|
||||||
}
|
|
||||||
if !strings.Contains(errBuf.String(), "usage") {
|
|
||||||
t.Errorf("expected usage in stderr, got %q", errBuf.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
errBuf.Reset()
|
|
||||||
code = runValidateURL([]string{"arg1", "arg2"})
|
|
||||||
if code != 2 {
|
|
||||||
t.Errorf("expected exit code 2 for too many args, got %d", code)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidateURL_MalformedURL(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
url string
|
|
||||||
wantMsg string
|
|
||||||
}{
|
|
||||||
{"empty", "", "must be https"},
|
|
||||||
{"http scheme", "http://example.com/", "must be https"},
|
|
||||||
{"ftp scheme", "ftp://example.com/", "must be https"},
|
|
||||||
{"no scheme", "example.com", "must be https"},
|
|
||||||
{"user info", "https://user:pass@example.com/", "user-info"},
|
|
||||||
}
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
err := validateURL(tc.url)
|
|
||||||
if err == nil {
|
|
||||||
t.Errorf("expected error for URL %q, got nil", tc.url)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), tc.wantMsg) {
|
|
||||||
t.Errorf("error %q does not contain %q", err.Error(), tc.wantMsg)
|
|
||||||
}
|
|
||||||
var ve *validateError
|
|
||||||
if !isValidateError(err, &ve) {
|
|
||||||
t.Fatalf("expected *validateError, got %T", err)
|
|
||||||
}
|
|
||||||
if ve.code != 2 {
|
|
||||||
t.Errorf("expected code 2, got %d", ve.code)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidateURL_BlockedPrivateIP(t *testing.T) {
|
|
||||||
// localhost always resolves to 127.0.0.1 (loopback).
|
|
||||||
err := validateURL("https://localhost/")
|
|
||||||
if err == nil {
|
|
||||||
t.Skip("localhost did not resolve (network unavailable in test environment)")
|
|
||||||
}
|
|
||||||
var ve *validateError
|
|
||||||
if !isValidateError(err, &ve) {
|
|
||||||
t.Fatalf("expected *validateError, got %T: %v", err, err)
|
|
||||||
}
|
|
||||||
if ve.code != 1 && ve.code != 2 {
|
|
||||||
t.Errorf("expected code 1 (blocked) or 2 (dns fail), got %d: %s", ve.code, ve.message)
|
|
||||||
}
|
|
||||||
// If it resolved (code 1), the message must say "blocked".
|
|
||||||
if ve.code == 1 && !strings.Contains(ve.message, "blocked") {
|
|
||||||
t.Errorf("expected 'blocked' in message, got %q", ve.message)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidateURL_ExitCodes(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
url string
|
|
||||||
wantCode int
|
|
||||||
}{
|
|
||||||
{"http scheme", "http://example.com/", 2},
|
|
||||||
{"no scheme", "example.com", 2},
|
|
||||||
{"user info", "https://admin:secret@example.com/", 2},
|
|
||||||
}
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
err := validateURL(tc.url)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("expected error for %q", tc.url)
|
|
||||||
}
|
|
||||||
var ve *validateError
|
|
||||||
if !isValidateError(err, &ve) {
|
|
||||||
t.Fatalf("expected *validateError, got %T", err)
|
|
||||||
}
|
|
||||||
if ve.code != tc.wantCode {
|
|
||||||
t.Errorf("code = %d, want %d (url=%q, msg=%s)", ve.code, tc.wantCode, tc.url, ve.message)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunValidateURL_WithCapture(t *testing.T) {
|
|
||||||
var outBuf, errBuf bytes.Buffer
|
|
||||||
origOut, origErr := outWriter, errWriter
|
|
||||||
outWriter = &outBuf
|
|
||||||
errWriter = &errBuf
|
|
||||||
defer func() {
|
|
||||||
outWriter = origOut
|
|
||||||
errWriter = origErr
|
|
||||||
}()
|
|
||||||
|
|
||||||
// http:// scheme should fail with code 2.
|
|
||||||
code := runValidateURL([]string{"http://example.com/"})
|
|
||||||
if code != 2 {
|
|
||||||
t.Errorf("expected code 2 for http:// URL, got %d", code)
|
|
||||||
}
|
|
||||||
if !strings.Contains(errBuf.String(), "must be https") {
|
|
||||||
t.Errorf("expected error about https in stderr, got %q", errBuf.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,295 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
// vcs.go — VCS client abstraction for supporting both Gitea and GitHub.
|
|
||||||
//
|
|
||||||
// This file defines the vcsClient interface that main.go uses for all VCS
|
|
||||||
// operations, and provides a githubAdapter that wraps *github.Client and
|
|
||||||
// converts between github-package types and the gitea-package types used
|
|
||||||
// throughout the rest of the binary.
|
|
||||||
//
|
|
||||||
// Design rationale: the entire codebase was written against gitea types.
|
|
||||||
// Rather than introduce a third "shared" type package and update every call
|
|
||||||
// site, the adapter converts at the boundary. The conversion is cheap — these
|
|
||||||
// are small structs fetched once per run.
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
githubpkg "gitea.weiker.me/rodin/review-bot/github"
|
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
|
||||||
"gitea.weiker.me/rodin/review-bot/review"
|
|
||||||
)
|
|
||||||
|
|
||||||
// vcsClient is the interface that main.go uses for all VCS API operations.
|
|
||||||
// Both *gitea.Client (directly) and *githubAdapter (via this file) satisfy it.
|
|
||||||
type vcsClient interface {
|
|
||||||
GetPullRequest(ctx context.Context, owner, repo string, number int) (*gitea.PullRequest, error)
|
|
||||||
GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error)
|
|
||||||
GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]gitea.ChangedFile, error)
|
|
||||||
GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]gitea.CommitStatus, error)
|
|
||||||
GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error)
|
|
||||||
GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error)
|
|
||||||
GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error)
|
|
||||||
ListReviews(ctx context.Context, owner, repo string, number int) ([]gitea.Review, error)
|
|
||||||
GetAuthenticatedUser(ctx context.Context) (string, error)
|
|
||||||
RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error
|
|
||||||
PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []gitea.ReviewComment) (*gitea.Review, error)
|
|
||||||
GetTimelineReviewCommentIDForReview(ctx context.Context, owner, repo string, number int, reviewID int64) (int64, error)
|
|
||||||
EditComment(ctx context.Context, owner, repo string, commentID int64, newBody string) error
|
|
||||||
ListReviewComments(ctx context.Context, owner, repo string, prNumber int, reviewID int64) ([]gitea.ReviewComment, error)
|
|
||||||
ResolveComment(ctx context.Context, owner, repo string, commentID int64) error
|
|
||||||
ListContents(ctx context.Context, owner, repo, path string) ([]gitea.ContentEntry, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// vcsClientAdapterForPersona adapts vcsClient to review.GiteaClient.
|
|
||||||
// Used by LoadRepoPersonas which needs only ListContents + GetFileContent.
|
|
||||||
type vcsClientAdapterForPersona struct {
|
|
||||||
client vcsClient
|
|
||||||
}
|
|
||||||
|
|
||||||
func newVCSClientAdapterForPersona(c vcsClient) *vcsClientAdapterForPersona {
|
|
||||||
return &vcsClientAdapterForPersona{client: c}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *vcsClientAdapterForPersona) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
|
||||||
entries, err := a.client.ListContents(ctx, owner, repo, path)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]review.ContentEntry, len(entries))
|
|
||||||
for i, e := range entries {
|
|
||||||
result[i] = review.ContentEntry{
|
|
||||||
Name: e.Name,
|
|
||||||
Path: e.Path,
|
|
||||||
Type: e.Type,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *vcsClientAdapterForPersona) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
|
||||||
return a.client.GetFileContent(ctx, owner, repo, filepath)
|
|
||||||
}
|
|
||||||
|
|
||||||
// detectVCSType returns "github" if the environment indicates a GitHub or GHES
|
|
||||||
// runner, "gitea" otherwise.
|
|
||||||
//
|
|
||||||
// Detection logic mirrors the action.yml composite action:
|
|
||||||
// - GITHUB_API_URL is set by GitHub Actions runners (github.com and GHES)
|
|
||||||
// - On Gitea Actions runners it is empty or absent
|
|
||||||
func detectVCSType() string {
|
|
||||||
if os.Getenv("GITHUB_API_URL") != "" {
|
|
||||||
return "github"
|
|
||||||
}
|
|
||||||
return "gitea"
|
|
||||||
}
|
|
||||||
|
|
||||||
// githubAPIBaseURL returns the GitHub API base URL from the environment.
|
|
||||||
// On GitHub.com this is https://api.github.com.
|
|
||||||
// On GHES this is https://<host>/api/v3.
|
|
||||||
func githubAPIBaseURL() string {
|
|
||||||
if u := os.Getenv("GITHUB_API_URL"); u != "" {
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
return "https://api.github.com"
|
|
||||||
}
|
|
||||||
|
|
||||||
// githubAdapter wraps *github.Client and translates github-package types to
|
|
||||||
// gitea-package types so that the rest of main.go can remain unchanged.
|
|
||||||
type githubAdapter struct {
|
|
||||||
c *githubpkg.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
func newGitHubAdapter(token, apiBaseURL string) *githubAdapter {
|
|
||||||
return &githubAdapter{c: githubpkg.NewClient(token, apiBaseURL)}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetPullRequest(ctx context.Context, owner, repo string, number int) (*gitea.PullRequest, error) {
|
|
||||||
pr, err := a.c.GetPullRequest(ctx, owner, repo, number)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &gitea.PullRequest{
|
|
||||||
Title: pr.Title,
|
|
||||||
Body: pr.Body,
|
|
||||||
Head: struct {
|
|
||||||
Sha string "json:\"sha\""
|
|
||||||
Ref string "json:\"ref\""
|
|
||||||
}{Sha: pr.Head.Sha, Ref: pr.Head.Ref},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
|
||||||
return a.c.GetPullRequestDiff(ctx, owner, repo, number)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]gitea.ChangedFile, error) {
|
|
||||||
files, err := a.c.GetPullRequestFiles(ctx, owner, repo, number)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]gitea.ChangedFile, len(files))
|
|
||||||
for i, f := range files {
|
|
||||||
result[i] = gitea.ChangedFile{
|
|
||||||
Filename: f.Filename,
|
|
||||||
Status: f.Status,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]gitea.CommitStatus, error) {
|
|
||||||
statuses, err := a.c.GetCommitStatuses(ctx, owner, repo, sha)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]gitea.CommitStatus, len(statuses))
|
|
||||||
for i, s := range statuses {
|
|
||||||
// GitHub uses "state" with values: success, failure, pending, error.
|
|
||||||
// Gitea uses "status" with values: success, failure, pending, warning, error.
|
|
||||||
// Map GitHub's "state" to gitea's "status" field for evaluateCIStatus().
|
|
||||||
result[i] = gitea.CommitStatus{
|
|
||||||
Status: s.State,
|
|
||||||
Context: s.Context,
|
|
||||||
Description: s.Description,
|
|
||||||
TargetURL: s.TargetURL,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
|
||||||
return a.c.GetFileContent(ctx, owner, repo, filepath)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
|
||||||
return a.c.GetFileContentRef(ctx, owner, repo, filepath, ref)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error) {
|
|
||||||
return a.c.GetAllFilesInPath(ctx, owner, repo, path)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) ListReviews(ctx context.Context, owner, repo string, number int) ([]gitea.Review, error) {
|
|
||||||
reviews, err := a.c.ListReviews(ctx, owner, repo, number)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]gitea.Review, len(reviews))
|
|
||||||
for i, r := range reviews {
|
|
||||||
result[i] = gitea.Review{
|
|
||||||
ID: r.ID,
|
|
||||||
Body: r.Body,
|
|
||||||
User: struct {
|
|
||||||
Login string "json:\"login\""
|
|
||||||
}{Login: r.User.Login},
|
|
||||||
State: r.State,
|
|
||||||
CommitID: r.CommitID,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
|
||||||
return a.c.GetAuthenticatedUser(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error {
|
|
||||||
return a.c.RequestReviewer(ctx, owner, repo, number, reviewer)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []gitea.ReviewComment) (*gitea.Review, error) {
|
|
||||||
// Convert gitea ReviewComments to github ReviewComments.
|
|
||||||
// NewPosition in Gitea maps to Position in GitHub (diff line position).
|
|
||||||
ghComments := make([]githubpkg.ReviewComment, len(comments))
|
|
||||||
for i, c := range comments {
|
|
||||||
ghComments[i] = githubpkg.ReviewComment{
|
|
||||||
Path: c.Path,
|
|
||||||
Position: c.NewPosition,
|
|
||||||
Body: c.Body,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
review, err := a.c.PostReview(ctx, owner, repo, number, event, body, commitID, ghComments)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &gitea.Review{
|
|
||||||
ID: review.ID,
|
|
||||||
Body: review.Body,
|
|
||||||
User: struct {
|
|
||||||
Login string "json:\"login\""
|
|
||||||
}{Login: review.User.Login},
|
|
||||||
State: review.State,
|
|
||||||
CommitID: review.CommitID,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) GetTimelineReviewCommentIDForReview(ctx context.Context, owner, repo string, number int, reviewID int64) (int64, error) {
|
|
||||||
return a.c.GetTimelineReviewCommentIDForReview(ctx, owner, repo, number, reviewID)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) EditComment(ctx context.Context, owner, repo string, commentID int64, newBody string) error {
|
|
||||||
return a.c.EditComment(ctx, owner, repo, commentID, newBody)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) ListReviewComments(ctx context.Context, owner, repo string, prNumber int, reviewID int64) ([]gitea.ReviewComment, error) {
|
|
||||||
comments, err := a.c.ListReviewComments(ctx, owner, repo, prNumber, reviewID)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]gitea.ReviewComment, len(comments))
|
|
||||||
for i, c := range comments {
|
|
||||||
result[i] = gitea.ReviewComment{
|
|
||||||
ID: c.ID,
|
|
||||||
Path: c.Path,
|
|
||||||
NewPosition: c.Position,
|
|
||||||
Body: c.Body,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) ResolveComment(ctx context.Context, owner, repo string, commentID int64) error {
|
|
||||||
return a.c.ResolveComment(ctx, owner, repo, commentID)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *githubAdapter) ListContents(ctx context.Context, owner, repo, path string) ([]gitea.ContentEntry, error) {
|
|
||||||
entries, err := a.c.ListContents(ctx, owner, repo, path)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result := make([]gitea.ContentEntry, len(entries))
|
|
||||||
for i, e := range entries {
|
|
||||||
result[i] = gitea.ContentEntry{
|
|
||||||
Name: e.Name,
|
|
||||||
Path: e.Path,
|
|
||||||
Type: e.Type,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// newVCSClient creates the appropriate VCS client based on detected VCS type.
|
|
||||||
// On GitHub/GHES (GITHUB_API_URL set), returns a githubAdapter.
|
|
||||||
// On Gitea (GITHUB_API_URL absent), returns *gitea.Client directly.
|
|
||||||
//
|
|
||||||
// For GitHub: uses GITHUB_API_URL as the API base URL (trusted platform value).
|
|
||||||
// For Gitea: uses vcsURL (validated before this call).
|
|
||||||
func newVCSClient(vcsType, vcsURL, reviewerToken string) vcsClient {
|
|
||||||
switch vcsType {
|
|
||||||
case "github":
|
|
||||||
apiURL := githubAPIBaseURL()
|
|
||||||
return newGitHubAdapter(reviewerToken, apiURL)
|
|
||||||
default:
|
|
||||||
return gitea.NewClient(vcsURL, reviewerToken)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildRepoPersonaClient creates a review.GiteaClient from the active vcsClient.
|
|
||||||
// This exists because LoadRepoPersonas expects the review.GiteaClient interface
|
|
||||||
// (which only requires ListContents + GetFileContent).
|
|
||||||
func buildRepoPersonaClient(c vcsClient) review.GiteaClient {
|
|
||||||
return newVCSClientAdapterForPersona(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -9,7 +9,7 @@ JSON is awkward for persona files that contain multi-line text (identity, severi
|
|||||||
- Backwards compatibility: existing JSON personas must continue to work
|
- Backwards compatibility: existing JSON personas must continue to work
|
||||||
- Security: protect against DoS via deeply nested YAML (AIKIDO-2024-10486)
|
- Security: protect against DoS via deeply nested YAML (AIKIDO-2024-10486)
|
||||||
- Consistency: use `.yaml` extension (not `.yml`)
|
- Consistency: use `.yaml` extension (not `.yml`)
|
||||||
- Library: use `github.com/goccy/go-yaml` v1.16.0+ (approved in CONVENTIONS.md); we implement custom AST-based depth/node-count checks for precise alias-aware validation
|
- Library: use `gopkg.in/yaml.v3` (approved in CONVENTIONS.md) with explicit depth limiting
|
||||||
|
|
||||||
## Proposed Approach
|
## Proposed Approach
|
||||||
|
|
||||||
@@ -33,16 +33,37 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
|
|
||||||
### YAML Parsing with Depth Protection
|
### YAML Parsing with Depth Protection
|
||||||
|
|
||||||
We implement a custom AST-based depth/node-count walk (`checkYAMLDepth` in
|
```go
|
||||||
`review/persona.go`) rather than relying on library decoder options. Key design
|
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
||||||
decisions:
|
var node yaml.Node
|
||||||
|
dec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
|
if err := dec.Decode(&node); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkYAMLDepth(&node, 0, maxDepth); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return node.Decode(out)
|
||||||
|
}
|
||||||
|
|
||||||
- **Library:** `github.com/goccy/go-yaml` with `ast.Node`-based traversal
|
func checkYAMLDepth(node *yaml.Node, depth, maxDepth int) error {
|
||||||
- **Dual-map tracking:** `validated` (depth-aware short-circuit) + `visiting` (cycle detection)
|
if depth > maxDepth {
|
||||||
- **Node-count limit:** Conservative overcounting bounds total validation work
|
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
||||||
- **Alias-aware depth:** Aliases increment depth and are re-checked when encountered at greater depths
|
}
|
||||||
|
// Handle alias nodes by following the Alias pointer
|
||||||
|
if node.Kind == yaml.AliasNode && node.Alias != nil {
|
||||||
|
return checkYAMLDepth(node.Alias, depth, maxDepth)
|
||||||
|
}
|
||||||
|
for _, child := range node.Content {
|
||||||
|
if err := checkYAMLDepth(child, depth+1, maxDepth); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
See `review/persona.go:checkYAMLDepth` for the authoritative implementation.
|
The `gopkg.in/yaml.v3` library does not have built-in depth protection, so we implement explicit depth checking by first decoding into a `yaml.Node`, walking the tree to verify depth (including alias resolution), then decoding into the target struct.
|
||||||
|
|
||||||
## State/Data Model
|
## State/Data Model
|
||||||
|
|
||||||
@@ -53,7 +74,7 @@ No new state. Same `Persona` struct, just different parsing.
|
|||||||
| Error | Handling |
|
| Error | Handling |
|
||||||
|-------|----------|
|
|-------|----------|
|
||||||
| Invalid YAML syntax | Return parse error with source file |
|
| Invalid YAML syntax | Return parse error with source file |
|
||||||
| Deeply nested YAML | Custom AST walk (`checkYAMLDepth`) rejects before decode |
|
| Deeply nested YAML | Library rejects (v1.16.0+ fix) |
|
||||||
| Unknown extension | Fall back to JSON parsing |
|
| Unknown extension | Fall back to JSON parsing |
|
||||||
| Missing required fields | Validation rejects after parse |
|
| Missing required fields | Validation rejects after parse |
|
||||||
|
|
||||||
|
|||||||
+18
-213
@@ -11,7 +11,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"math"
|
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
@@ -48,12 +47,6 @@ func IsServerError(err error) bool {
|
|||||||
return errors.As(err, &apiErr) && apiErr.StatusCode >= 500 && apiErr.StatusCode < 600
|
return errors.As(err, &apiErr) && apiErr.StatusCode >= 500 && apiErr.StatusCode < 600
|
||||||
}
|
}
|
||||||
|
|
||||||
// DefaultMaxDiffSize is the default maximum diff size in bytes (10 MB).
|
|
||||||
const DefaultMaxDiffSize = 10 * 1024 * 1024
|
|
||||||
|
|
||||||
// ErrDiffTooLarge is returned when a PR diff exceeds the configured MaxDiffSize.
|
|
||||||
var ErrDiffTooLarge = errors.New("diff size exceeds maximum allowed size")
|
|
||||||
|
|
||||||
// Client interacts with the Gitea API.
|
// Client interacts with the Gitea API.
|
||||||
// A Client is safe for concurrent use by multiple goroutines.
|
// A Client is safe for concurrent use by multiple goroutines.
|
||||||
type Client struct {
|
type Client struct {
|
||||||
@@ -68,152 +61,20 @@ type Client struct {
|
|||||||
// This field must be configured before the first request is made.
|
// This field must be configured before the first request is made.
|
||||||
// Modifying it while requests are in flight is not safe.
|
// Modifying it while requests are in flight is not safe.
|
||||||
RetryBackoff []time.Duration
|
RetryBackoff []time.Duration
|
||||||
|
|
||||||
// MaxDiffSize is the maximum number of bytes allowed when fetching a PR diff.
|
|
||||||
// If zero, defaults to DefaultMaxDiffSize (10 MB). Set to any negative value
|
|
||||||
// (or math.MaxInt64) to disable the limit.
|
|
||||||
//
|
|
||||||
// This field must be configured before the first request is made.
|
|
||||||
// Modifying it while requests are in flight is not safe.
|
|
||||||
MaxDiffSize int64
|
|
||||||
}
|
|
||||||
|
|
||||||
// defaultCheckRedirect is the redirect policy used by NewClient.
|
|
||||||
// NOTE: This function is intentionally duplicated in github/client.go (and vice versa)
|
|
||||||
// because the packages are separate. Changes here must be mirrored there.
|
|
||||||
// It rejects HTTPS->HTTP protocol downgrades (to prevent plaintext leakage)
|
|
||||||
// and cross-host redirects (to prevent following responses from untrusted
|
|
||||||
// endpoints). Same-host, same-or-upgraded-scheme redirects are allowed.
|
|
||||||
func defaultCheckRedirect(req *http.Request, via []*http.Request) error {
|
|
||||||
if len(via) >= 10 {
|
|
||||||
return fmt.Errorf("stopped after 10 redirects")
|
|
||||||
}
|
|
||||||
// Guard for direct invocation in tests and any future callers;
|
|
||||||
// net/http guarantees len(via) >= 1 during actual redirects.
|
|
||||||
if len(via) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
prev := via[len(via)-1]
|
|
||||||
// Reject protocol downgrade: HTTPS->HTTP leaks request metadata over plaintext.
|
|
||||||
if prev.URL.Scheme == "https" && req.URL.Scheme == "http" {
|
|
||||||
return fmt.Errorf("refusing redirect: HTTPS to HTTP downgrade (%s -> %s)", prev.URL.Host, req.URL.Host)
|
|
||||||
}
|
|
||||||
// Reject cross-host redirect entirely to avoid consuming responses
|
|
||||||
// from untrusted endpoints.
|
|
||||||
if req.URL.Host != prev.URL.Host {
|
|
||||||
return fmt.Errorf("refusing redirect: cross-host (%s -> %s)", prev.URL.Host, req.URL.Host)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// safeDialContext is the default DialContext for NewClient.
|
|
||||||
// It resolves the hostname and checks every returned IP against the blocked
|
|
||||||
// CIDR list before establishing a connection. This prevents SSRF attacks
|
|
||||||
// where user-supplied URLs resolve to internal/private addresses.
|
|
||||||
//
|
|
||||||
// After validating all IPs, we dial the first resolved IP directly to avoid
|
|
||||||
// a second DNS lookup (which could return a different IP in a DNS rebinding
|
|
||||||
// attack). This narrows — but does not fully eliminate — the DNS rebinding
|
|
||||||
// window to the time between LookupIPAddr and DialContext.
|
|
||||||
//
|
|
||||||
// If the host is already an IP literal, LookupIPAddr returns it directly
|
|
||||||
// (no DNS query issued), so IP literals like https://127.0.0.1/ are blocked.
|
|
||||||
func safeDialContext(ctx context.Context, network, addr string) (net.Conn, error) {
|
|
||||||
host, port, err := net.SplitHostPort(addr)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("safeDialContext: invalid address %q: %w", addr, err)
|
|
||||||
}
|
|
||||||
addrs, err := net.DefaultResolver.LookupIPAddr(ctx, host)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("safeDialContext: DNS lookup %q: %w", host, err)
|
|
||||||
}
|
|
||||||
if len(addrs) == 0 {
|
|
||||||
return nil, fmt.Errorf("safeDialContext: no addresses returned for %q", host)
|
|
||||||
}
|
|
||||||
for _, a := range addrs {
|
|
||||||
if IsBlockedIP(a.IP) {
|
|
||||||
return nil, fmt.Errorf("safeDialContext: blocked: %q resolves to private/reserved IP %s", host, a.IP)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Try each resolved IP in order, returning the first successful connection.
|
|
||||||
// Fallback is important when a hostname resolves to multiple IPs and the first
|
|
||||||
// is temporarily unreachable. All IPs were already validated above, so dialing
|
|
||||||
// any of them is safe.
|
|
||||||
//
|
|
||||||
// Timeout: 10s per the design (PLAN.md); the outer http.Client has a 30s
|
|
||||||
// total timeout, but the per-dial timeout ensures a slow TCP connect on one IP
|
|
||||||
// doesn't consume the budget needed to try others.
|
|
||||||
d := &net.Dialer{Timeout: 10 * time.Second}
|
|
||||||
var lastErr error
|
|
||||||
for _, a := range addrs {
|
|
||||||
conn, err := d.DialContext(ctx, network, net.JoinHostPort(a.IP.String(), port))
|
|
||||||
if err == nil {
|
|
||||||
return conn, nil
|
|
||||||
}
|
|
||||||
lastErr = err
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("safeDialContext: all %d addresses for %q failed, last error: %w", len(addrs), host, lastErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// newSafeHTTPClient returns an *http.Client with the SSRF-blocking safeDialContext
|
|
||||||
// transport and the cross-host redirect rejection policy.
|
|
||||||
//
|
|
||||||
// We clone http.DefaultTransport to preserve its production-ready defaults
|
|
||||||
// (ProxyFromEnvironment, TLSHandshakeTimeout, IdleConnTimeout, connection
|
|
||||||
// pooling, HTTP/2 support) and override only DialContext with safeDialContext.
|
|
||||||
func newSafeHTTPClient() *http.Client {
|
|
||||||
transport := http.DefaultTransport.(*http.Transport).Clone()
|
|
||||||
transport.DialContext = safeDialContext
|
|
||||||
return &http.Client{
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
Transport: transport,
|
|
||||||
CheckRedirect: defaultCheckRedirect,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewClient creates a new Gitea API client.
|
// NewClient creates a new Gitea API client.
|
||||||
//
|
|
||||||
// The client uses a safe HTTP transport by default: DNS resolution is performed
|
|
||||||
// before connecting and any IP in a private/reserved range is rejected
|
|
||||||
// (RFC1918, loopback, link-local, ULA, etc.). Cross-host and HTTPS→HTTP
|
|
||||||
// redirects are also rejected.
|
|
||||||
//
|
|
||||||
// For tests that use httptest.NewServer (which listens on 127.0.0.1), call
|
|
||||||
// WithUnsafeDialer() to bypass the IP check.
|
|
||||||
func NewClient(baseURL, token string) *Client {
|
func NewClient(baseURL, token string) *Client {
|
||||||
return &Client{
|
return &Client{
|
||||||
baseURL: strings.TrimRight(baseURL, "/"),
|
baseURL: strings.TrimRight(baseURL, "/"),
|
||||||
token: token,
|
token: token,
|
||||||
http: newSafeHTTPClient(),
|
http: &http.Client{Timeout: 30 * time.Second},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithUnsafeDialer returns the client configured with a plain HTTP client that
|
|
||||||
// has no IP-level SSRF protection. It preserves the redirect-rejection policy.
|
|
||||||
//
|
|
||||||
// This MUST only be used in tests. Production code must never call this method.
|
|
||||||
func (c *Client) WithUnsafeDialer() *Client {
|
|
||||||
c.http = &http.Client{
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
CheckRedirect: defaultCheckRedirect,
|
|
||||||
}
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetHTTPClient sets the underlying HTTP client used for requests.
|
// SetHTTPClient sets the underlying HTTP client used for requests.
|
||||||
// This is intended for test setup only to inject mock transports; it must be
|
// This is intended for testing to inject mock transports.
|
||||||
// called before any goroutines issue requests.
|
|
||||||
//
|
|
||||||
// Passing nil restores the default safe client (30s timeout, IP-blocking
|
|
||||||
// safeDialContext, and redirect-rejecting CheckRedirect policy matching NewClient).
|
|
||||||
//
|
|
||||||
// Callers providing a non-nil client are responsible for configuring a safe
|
|
||||||
// CheckRedirect policy. Without one, the default net/http behavior will follow
|
|
||||||
// redirects and may forward the Authorization header to untrusted hosts.
|
|
||||||
func (c *Client) SetHTTPClient(hc *http.Client) {
|
func (c *Client) SetHTTPClient(hc *http.Client) {
|
||||||
if hc == nil {
|
|
||||||
hc = newSafeHTTPClient()
|
|
||||||
}
|
|
||||||
c.http = hc
|
c.http = hc
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -264,28 +125,9 @@ func (c *Client) GetPullRequest(ctx context.Context, owner, repo string, number
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetPullRequestDiff fetches the unified diff for a PR.
|
// GetPullRequestDiff fetches the unified diff for a PR.
|
||||||
// It enforces MaxDiffSize to prevent unbounded memory allocation.
|
|
||||||
// Returns ErrDiffTooLarge if the diff exceeds the configured limit.
|
|
||||||
func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
||||||
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d.diff", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d.diff", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
maxSize := c.MaxDiffSize
|
|
||||||
if maxSize == 0 {
|
|
||||||
maxSize = DefaultMaxDiffSize
|
|
||||||
}
|
|
||||||
|
|
||||||
// When the limit is disabled (negative) or set to math.MaxInt64 (which
|
|
||||||
// would overflow the +1 detection and silently disable enforcement),
|
|
||||||
// use the standard unlimited doGet path.
|
|
||||||
if maxSize < 0 || maxSize == math.MaxInt64 {
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("fetch diff: %w", err)
|
|
||||||
}
|
|
||||||
return string(body), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := c.doGetLimited(ctx, reqURL, maxSize)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetch diff: %w", err)
|
return "", fmt.Errorf("fetch diff: %w", err)
|
||||||
}
|
}
|
||||||
@@ -341,22 +183,18 @@ func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, r
|
|||||||
}
|
}
|
||||||
|
|
||||||
// PostReview submits a review to a PR and returns the created review.
|
// PostReview submits a review to a PR and returns the created review.
|
||||||
// event should be one of "APPROVED", "REQUEST_CHANGES", or "COMMENT".
|
// event should be "APPROVED" or "REQUEST_CHANGES".
|
||||||
// commitID anchors the review to a specific commit SHA. If empty, Gitea
|
|
||||||
// defaults to the current PR head.
|
|
||||||
// comments are optional inline comments attached to specific lines.
|
// comments are optional inline comments attached to specific lines.
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []ReviewComment) (*Review, error) {
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body string, comments []ReviewComment) (*Review, error) {
|
||||||
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
|
|
||||||
payload := struct {
|
payload := struct {
|
||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
Event string `json:"event"`
|
Event string `json:"event"`
|
||||||
CommitID string `json:"commit_id,omitempty"`
|
|
||||||
Comments []ReviewComment `json:"comments,omitempty"`
|
Comments []ReviewComment `json:"comments,omitempty"`
|
||||||
}{
|
}{
|
||||||
Body: body,
|
Body: body,
|
||||||
Event: event,
|
Event: event,
|
||||||
CommitID: commitID,
|
|
||||||
Comments: comments,
|
Comments: comments,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -454,9 +292,9 @@ func isRetriableSyscallError(err error) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// redactURL strips query parameters and userinfo credentials from a URL for
|
// redactURL strips query parameters from a URL for safe logging.
|
||||||
// safe logging. This prevents accidental exposure of sensitive data (tokens in
|
// This prevents accidental exposure of sensitive data that future callers
|
||||||
// query strings, or user:pass in the authority) in log output.
|
// might pass via query strings.
|
||||||
func redactURL(rawURL string) string {
|
func redactURL(rawURL string) string {
|
||||||
parsed, err := url.Parse(rawURL)
|
parsed, err := url.Parse(rawURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -464,9 +302,6 @@ func redactURL(rawURL string) string {
|
|||||||
// potentially logging something sensitive.
|
// potentially logging something sensitive.
|
||||||
return "[invalid URL]"
|
return "[invalid URL]"
|
||||||
}
|
}
|
||||||
if parsed.User != nil {
|
|
||||||
parsed.User = url.User("REDACTED")
|
|
||||||
}
|
|
||||||
if parsed.RawQuery != "" {
|
if parsed.RawQuery != "" {
|
||||||
parsed.RawQuery = "[redacted]"
|
parsed.RawQuery = "[redacted]"
|
||||||
}
|
}
|
||||||
@@ -487,12 +322,10 @@ func sanitizeErrorForLog(err error) string {
|
|||||||
return err.Error()
|
return err.Error()
|
||||||
}
|
}
|
||||||
|
|
||||||
// doGetWithReader performs an HTTP GET request with retry on 5xx errors and
|
// doGet performs an HTTP GET request with retry on 5xx errors and temporary
|
||||||
// temporary network errors. Retries up to 3 times with exponential backoff
|
// network errors. Retries up to 3 times with exponential backoff (1s, 2s delays
|
||||||
// (1s, 2s delays by default; configurable via Client.RetryBackoff for testing).
|
// by default; configurable via Client.RetryBackoff for testing).
|
||||||
// The readBody function is called with the response body on success (2xx) and
|
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
||||||
// is responsible for reading and closing it.
|
|
||||||
func (c *Client) doGetWithReader(ctx context.Context, reqURL string, readBody func(io.ReadCloser) ([]byte, error)) ([]byte, error) {
|
|
||||||
const maxAttempts = 3
|
const maxAttempts = 3
|
||||||
// backoff[i] is the delay before attempt i+1 (i.e., after attempt i fails).
|
// backoff[i] is the delay before attempt i+1 (i.e., after attempt i fails).
|
||||||
// First attempt (i=0) has no delay; retries wait 1s then 2s by default.
|
// First attempt (i=0) has no delay; retries wait 1s then 2s by default.
|
||||||
@@ -557,7 +390,12 @@ func (c *Client) doGetWithReader(ctx context.Context, reqURL string, readBody fu
|
|||||||
return nil, lastErr
|
return nil, lastErr
|
||||||
}
|
}
|
||||||
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
||||||
return readBody(resp.Body)
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
resp.Body.Close()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return body, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Error path: limit how much we read from potentially malicious server
|
// Error path: limit how much we read from potentially malicious server
|
||||||
@@ -575,39 +413,6 @@ func (c *Client) doGetWithReader(ctx context.Context, reqURL string, readBody fu
|
|||||||
return nil, lastErr
|
return nil, lastErr
|
||||||
}
|
}
|
||||||
|
|
||||||
// doGet performs an HTTP GET request with retry, reading the full response body.
|
|
||||||
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
|
||||||
return c.doGetWithReader(ctx, reqURL, func(body io.ReadCloser) ([]byte, error) {
|
|
||||||
defer body.Close()
|
|
||||||
return io.ReadAll(body)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// doGetLimited performs an HTTP GET request with retry but enforces a maximum
|
|
||||||
// response body size. Returns ErrDiffTooLarge if the response exceeds maxBytes.
|
|
||||||
// It reads maxBytes+1 (clamped to avoid overflow) to detect truncation without
|
|
||||||
// buffering the entire body.
|
|
||||||
func (c *Client) doGetLimited(ctx context.Context, reqURL string, maxBytes int64) ([]byte, error) {
|
|
||||||
return c.doGetWithReader(ctx, reqURL, func(body io.ReadCloser) ([]byte, error) {
|
|
||||||
defer body.Close()
|
|
||||||
// Read up to maxBytes+1 to detect overflow.
|
|
||||||
// Clamp to prevent integer overflow when maxBytes == math.MaxInt64.
|
|
||||||
limitBytes := maxBytes + 1
|
|
||||||
if limitBytes <= 0 {
|
|
||||||
limitBytes = math.MaxInt64
|
|
||||||
}
|
|
||||||
limited := io.LimitReader(body, limitBytes)
|
|
||||||
data, err := io.ReadAll(limited)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if int64(len(data)) > maxBytes {
|
|
||||||
return nil, fmt.Errorf("%w: response exceeds %d bytes", ErrDiffTooLarge, maxBytes)
|
|
||||||
}
|
|
||||||
return data, nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapePath escapes each segment of a relative file path for use in URLs.
|
// escapePath escapes each segment of a relative file path for use in URLs.
|
||||||
// Slashes are preserved as path separators; other special characters are escaped.
|
// Slashes are preserved as path separators; other special characters are escaped.
|
||||||
// Input should be a relative path (no leading slash). Already-encoded segments
|
// Input should be a relative path (no leading slash). Already-encoded segments
|
||||||
|
|||||||
+43
-318
@@ -9,7 +9,6 @@ import (
|
|||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/url"
|
|
||||||
"strings"
|
"strings"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
@@ -36,7 +35,7 @@ func TestGetPullRequest(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
got, err := client.GetPullRequest(context.Background(), "owner", "repo", 1)
|
got, err := client.GetPullRequest(context.Background(), "owner", "repo", 1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -63,7 +62,7 @@ func TestGetPullRequestDiff(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
got, err := client.GetPullRequestDiff(context.Background(), "owner", "repo", 5)
|
got, err := client.GetPullRequestDiff(context.Background(), "owner", "repo", 5)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -88,7 +87,7 @@ func TestGetCommitStatuses(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
got, err := client.GetCommitStatuses(context.Background(), "owner", "repo", "abc123")
|
got, err := client.GetCommitStatuses(context.Background(), "owner", "repo", "abc123")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -117,9 +116,8 @@ func TestPostReview(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
var payload struct {
|
var payload struct {
|
||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
Event string `json:"event"`
|
Event string `json:"event"`
|
||||||
CommitID string `json:"commit_id"`
|
|
||||||
}
|
}
|
||||||
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
|
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
|
||||||
t.Fatalf("failed to decode payload: %v", err)
|
t.Fatalf("failed to decode payload: %v", err)
|
||||||
@@ -130,16 +128,14 @@ func TestPostReview(t *testing.T) {
|
|||||||
if payload.Event != "APPROVED" {
|
if payload.Event != "APPROVED" {
|
||||||
t.Errorf("expected event %q, got %q", "APPROVED", payload.Event)
|
t.Errorf("expected event %q, got %q", "APPROVED", payload.Event)
|
||||||
}
|
}
|
||||||
if payload.CommitID != "abc123def" {
|
|
||||||
t.Errorf("expected commit_id %q, got %q", "abc123def", payload.CommitID)
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
w.Write([]byte(`{"id":100,"user":{"login":"review-bot"},"state":"APPROVED","stale":false}`))
|
w.Write([]byte(`{"id":100,"user":{"login":"review-bot"},"state":"APPROVED","stale":false}`))
|
||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM", "abc123def", nil)
|
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM", nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
@@ -158,7 +154,7 @@ func TestGetPullRequest_Non200(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.GetPullRequest(context.Background(), "owner", "repo", 999)
|
_, err := client.GetPullRequest(context.Background(), "owner", "repo", 999)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 404, got nil")
|
t.Fatal("expected error for 404, got nil")
|
||||||
@@ -171,7 +167,7 @@ func TestGetPullRequest_BadJSON(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.GetPullRequest(context.Background(), "owner", "repo", 1)
|
_, err := client.GetPullRequest(context.Background(), "owner", "repo", 1)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for bad JSON, got nil")
|
t.Fatal("expected error for bad JSON, got nil")
|
||||||
@@ -185,36 +181,13 @@ func TestPostReview_Non200(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test", "", nil)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test", nil)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403, got nil")
|
t.Fatal("expected error for 403, got nil")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPostReview_EmptyCommitID_OmittedFromPayload(t *testing.T) {
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
body, _ := io.ReadAll(r.Body)
|
|
||||||
var raw map[string]interface{}
|
|
||||||
if err := json.Unmarshal(body, &raw); err != nil {
|
|
||||||
t.Fatalf("failed to decode payload: %v", err)
|
|
||||||
}
|
|
||||||
if _, exists := raw["commit_id"]; exists {
|
|
||||||
t.Errorf("expected commit_id to be omitted from payload when empty, but it was present")
|
|
||||||
}
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte(`{"id":200,"user":{"login":"bot"},"state":"APPROVED","stale":false}`))
|
|
||||||
}))
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "ok", "", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetFileContent(t *testing.T) {
|
func TestGetFileContent(t *testing.T) {
|
||||||
expected := "# Conventions\n- Be nice\n"
|
expected := "# Conventions\n- Be nice\n"
|
||||||
|
|
||||||
@@ -226,7 +199,7 @@ func TestGetFileContent(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
got, err := client.GetFileContent(context.Background(), "owner", "repo", "CONVENTIONS.md")
|
got, err := client.GetFileContent(context.Background(), "owner", "repo", "CONVENTIONS.md")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -246,7 +219,7 @@ func TestGetPullRequestFiles(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
files, err := client.GetPullRequestFiles(context.Background(), "owner", "repo", 1)
|
files, err := client.GetPullRequestFiles(context.Background(), "owner", "repo", 1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -271,7 +244,7 @@ func TestGetFileContentRef(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
content, err := client.GetFileContentRef(context.Background(), "owner", "repo", "main.go", "feature-branch")
|
content, err := client.GetFileContentRef(context.Background(), "owner", "repo", "main.go", "feature-branch")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -291,7 +264,7 @@ func TestListContents(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
entries, err := client.ListContents(context.Background(), "owner", "repo", "docs")
|
entries, err := client.ListContents(context.Background(), "owner", "repo", "docs")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -318,7 +291,7 @@ func TestListContents_DotPath(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
entries, err := client.ListContents(context.Background(), "owner", "repo", ".")
|
entries, err := client.ListContents(context.Background(), "owner", "repo", ".")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -343,7 +316,7 @@ func TestListContents_FilePath(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
entries, err := client.ListContents(context.Background(), "owner", "repo", "README.md")
|
entries, err := client.ListContents(context.Background(), "owner", "repo", "README.md")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -375,7 +348,7 @@ func TestGetAllFilesInPath_File(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
files, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "README.md")
|
files, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "README.md")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -428,7 +401,7 @@ func TestListReviews(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -468,7 +441,7 @@ func TestListReviews_Pagination(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -493,7 +466,7 @@ func TestDeleteReview(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
@@ -507,7 +480,7 @@ func TestDeleteReview_Forbidden(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403, got nil")
|
t.Fatal("expected error for 403, got nil")
|
||||||
@@ -536,7 +509,7 @@ func TestEditComment(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.EditComment(context.Background(), "owner", "repo", 42, "updated body")
|
err := client.EditComment(context.Background(), "owner", "repo", 42, "updated body")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("EditComment() error = %v", err)
|
t.Fatalf("EditComment() error = %v", err)
|
||||||
@@ -550,7 +523,7 @@ func TestEditComment_Forbidden(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.EditComment(context.Background(), "owner", "repo", 42, "new body")
|
err := client.EditComment(context.Background(), "owner", "repo", 42, "new body")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403 response")
|
t.Fatal("expected error for 403 response")
|
||||||
@@ -570,7 +543,7 @@ func TestGetTimelineReviewCommentID(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
id, err := client.GetTimelineReviewCommentID(context.Background(), "owner", "repo", 5, "<!-- review-bot:sonnet -->")
|
id, err := client.GetTimelineReviewCommentID(context.Background(), "owner", "repo", 5, "<!-- review-bot:sonnet -->")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("GetTimelineReviewCommentID() error = %v", err)
|
t.Fatalf("GetTimelineReviewCommentID() error = %v", err)
|
||||||
@@ -586,7 +559,7 @@ func TestGetTimelineReviewCommentID_NotFound(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.GetTimelineReviewCommentID(context.Background(), "owner", "repo", 5, "<!-- review-bot:sonnet -->")
|
_, err := client.GetTimelineReviewCommentID(context.Background(), "owner", "repo", 5, "<!-- review-bot:sonnet -->")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error when sentinel not found")
|
t.Fatal("expected error when sentinel not found")
|
||||||
@@ -609,7 +582,7 @@ func TestGetAllFilesInPath_404FallsBackToFile(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
files, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "README.md")
|
files, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "README.md")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected fallback to file on 404, got error: %v", err)
|
t.Fatalf("expected fallback to file on 404, got error: %v", err)
|
||||||
@@ -630,7 +603,7 @@ func TestGetAllFilesInPath_500Propagates(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "somepath")
|
_, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "somepath")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error to propagate for 500, got nil")
|
t.Fatal("expected error to propagate for 500, got nil")
|
||||||
@@ -652,7 +625,7 @@ func TestGetAllFilesInPath_403Propagates(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "private/stuff")
|
_, err := client.GetAllFilesInPath(context.Background(), "owner", "repo", "private/stuff")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error to propagate for 403, got nil")
|
t.Fatal("expected error to propagate for 403, got nil")
|
||||||
@@ -704,7 +677,7 @@ func TestGetAuthenticatedUser(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
login, err := client.GetAuthenticatedUser(context.Background())
|
login, err := client.GetAuthenticatedUser(context.Background())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("GetAuthenticatedUser() error = %v", err)
|
t.Fatalf("GetAuthenticatedUser() error = %v", err)
|
||||||
@@ -729,7 +702,7 @@ func TestRequestReviewer(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.RequestReviewer(context.Background(), "owner", "repo", 7, "bot-user")
|
err := client.RequestReviewer(context.Background(), "owner", "repo", 7, "bot-user")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("RequestReviewer() error = %v", err)
|
t.Fatalf("RequestReviewer() error = %v", err)
|
||||||
@@ -745,7 +718,7 @@ func TestRequestReviewer_204(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.RequestReviewer(context.Background(), "owner", "repo", 1, "user")
|
err := client.RequestReviewer(context.Background(), "owner", "repo", 1, "user")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("RequestReviewer() should accept 204, got error = %v", err)
|
t.Fatalf("RequestReviewer() should accept 204, got error = %v", err)
|
||||||
@@ -759,7 +732,7 @@ func TestRequestReviewer_Error(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.RequestReviewer(context.Background(), "owner", "repo", 1, "user")
|
err := client.RequestReviewer(context.Background(), "owner", "repo", 1, "user")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403 response")
|
t.Fatal("expected error for 403 response")
|
||||||
@@ -779,7 +752,7 @@ func TestListReviewComments(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
comments, err := client.ListReviewComments(context.Background(), "owner", "repo", 1, 42)
|
comments, err := client.ListReviewComments(context.Background(), "owner", "repo", 1, 42)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("ListReviewComments() error = %v", err)
|
t.Fatalf("ListReviewComments() error = %v", err)
|
||||||
@@ -807,7 +780,7 @@ func TestResolveComment(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.ResolveComment(context.Background(), "owner", "repo", 99)
|
err := client.ResolveComment(context.Background(), "owner", "repo", 99)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("ResolveComment() error = %v", err)
|
t.Fatalf("ResolveComment() error = %v", err)
|
||||||
@@ -821,7 +794,7 @@ func TestResolveComment_Error(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.ResolveComment(context.Background(), "owner", "repo", 99)
|
err := client.ResolveComment(context.Background(), "owner", "repo", 99)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 404 response")
|
t.Fatal("expected error for 404 response")
|
||||||
@@ -870,7 +843,7 @@ func TestDoGet_RetriesOn500(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
// Use short backoff for fast tests
|
// Use short backoff for fast tests
|
||||||
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
||||||
|
|
||||||
@@ -895,7 +868,7 @@ func TestDoGet_FailsAfterMaxRetries(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
// Use short backoff for fast tests
|
// Use short backoff for fast tests
|
||||||
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
||||||
|
|
||||||
@@ -924,7 +897,7 @@ func TestDoGet_NoRetryOn4xx(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.doGet(context.Background(), server.URL+"/test")
|
_, err := client.doGet(context.Background(), server.URL+"/test")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403")
|
t.Fatal("expected error for 403")
|
||||||
@@ -952,7 +925,7 @@ func TestDoGet_RespectsContextCancellation(t *testing.T) {
|
|||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
// Use longer backoff to give us time to cancel during the wait
|
// Use longer backoff to give us time to cancel during the wait
|
||||||
client.RetryBackoff = []time.Duration{100 * time.Millisecond, 100 * time.Millisecond}
|
client.RetryBackoff = []time.Duration{100 * time.Millisecond, 100 * time.Millisecond}
|
||||||
|
|
||||||
@@ -971,6 +944,8 @@ func TestDoGet_RespectsContextCancellation(t *testing.T) {
|
|||||||
t.Errorf("attempts = %d, expected 1 before context cancel during backoff", attempts)
|
t.Errorf("attempts = %d, expected 1 before context cancel during backoff", attempts)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// mockTransport is a test helper that returns errors for the first N calls,
|
// mockTransport is a test helper that returns errors for the first N calls,
|
||||||
// then delegates to a real server.
|
// then delegates to a real server.
|
||||||
type mockTransport struct {
|
type mockTransport struct {
|
||||||
@@ -1117,21 +1092,6 @@ func TestRedactURL(t *testing.T) {
|
|||||||
input: "",
|
input: "",
|
||||||
want: "",
|
want: "",
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: "with userinfo - redacts credentials",
|
|
||||||
input: "https://admin:secret@gitea.example.com/api/v1/repos",
|
|
||||||
want: "https://REDACTED@gitea.example.com/api/v1/repos",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "with userinfo and query params",
|
|
||||||
input: "https://user:pass@example.com/path?token=abc",
|
|
||||||
want: "https://REDACTED@example.com/path?[redacted]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "username only - no password",
|
|
||||||
input: "https://user@example.com/path",
|
|
||||||
want: "https://REDACTED@example.com/path",
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
@@ -1184,238 +1144,3 @@ func TestSanitizeErrorForLog(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestNewClient_HasCheckRedirect(t *testing.T) {
|
|
||||||
c := NewClient("https://gitea.example.com", "token")
|
|
||||||
if c.http.CheckRedirect == nil {
|
|
||||||
t.Fatal("expected CheckRedirect to be set")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsHTTPSToHTTP(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "http", Host: "gitea.example.com", Path: "/foo"},
|
|
||||||
Header: http.Header{"Authorization": []string{"token abc"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error on HTTPS->HTTP redirect")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "HTTPS to HTTP downgrade") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsCrossHost(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "https", Host: "cdn.example.com", Path: "/bar"},
|
|
||||||
Header: http.Header{"Authorization": []string{"token abc"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error on cross-host redirect")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "cross-host") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_AllowsSameHost(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/bar"},
|
|
||||||
Header: http.Header{"Authorization": []string{"token abc"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if auth := req.Header.Get("Authorization"); auth != "token abc" {
|
|
||||||
t.Errorf("expected Authorization to be preserved, got %q", auth)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_AllowsSameHostHTTPToHTTP(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "http", Host: "localhost:3000", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "http", Host: "localhost:3000", Path: "/bar"},
|
|
||||||
Header: http.Header{},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsTooManyRedirects(t *testing.T) {
|
|
||||||
via := make([]*http.Request, 10)
|
|
||||||
for i := range via {
|
|
||||||
via[i] = &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/"}}
|
|
||||||
}
|
|
||||||
req := &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/final"}}
|
|
||||||
err := defaultCheckRedirect(req, via)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error after 10 redirects")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "10 redirects") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_EmptyViaAllowed(t *testing.T) {
|
|
||||||
req := &http.Request{URL: &url.URL{Scheme: "https", Host: "gitea.example.com", Path: "/foo"}}
|
|
||||||
err := defaultCheckRedirect(req, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error with empty via: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSetHTTPClient_NilRestoresDefault(t *testing.T) {
|
|
||||||
c := NewClient("https://gitea.example.com", "token")
|
|
||||||
c.SetHTTPClient(nil)
|
|
||||||
if c.http == nil {
|
|
||||||
t.Fatal("expected non-nil http client after SetHTTPClient(nil)")
|
|
||||||
}
|
|
||||||
if c.http.Timeout != 30*time.Second {
|
|
||||||
t.Errorf("expected 30s timeout, got %v", c.http.Timeout)
|
|
||||||
}
|
|
||||||
if c.http.CheckRedirect == nil {
|
|
||||||
t.Fatal("expected CheckRedirect policy after SetHTTPClient(nil)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSafeDialContextBlocksPrivateIPs verifies that NewClient (which uses
|
|
||||||
// safeDialContext by default) refuses to connect to private/reserved IPs.
|
|
||||||
func TestSafeDialContextBlocksPrivateIPs(t *testing.T) {
|
|
||||||
// These servers listen on 127.0.0.1, so the safe dialer will block them.
|
|
||||||
// We use NewClient (NOT NewTestClient) to exercise the real safe dialer.
|
|
||||||
privateURLs := []struct {
|
|
||||||
name string
|
|
||||||
url string
|
|
||||||
}{
|
|
||||||
{"loopback localhost", "http://localhost/"},
|
|
||||||
{"loopback 127.0.0.1", "http://127.0.0.1/"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range privateURLs {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
c := NewClient(tc.url, "token")
|
|
||||||
_, err := c.GetPullRequest(context.Background(), "owner", "repo", 1)
|
|
||||||
if err == nil {
|
|
||||||
t.Errorf("expected error connecting to %s, got nil", tc.url)
|
|
||||||
}
|
|
||||||
// Error must mention SSRF/blocked, not a random network error.
|
|
||||||
if !strings.Contains(err.Error(), "blocked") &&
|
|
||||||
!strings.Contains(err.Error(), "private") &&
|
|
||||||
!strings.Contains(err.Error(), "loopback") &&
|
|
||||||
!strings.Contains(err.Error(), "reserved") {
|
|
||||||
t.Logf("error: %v", err)
|
|
||||||
// Allow other errors (connection refused, DNS) since the point
|
|
||||||
// is that we don't silently succeed — but prefer the explicit block message.
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWithUnsafeDialerAllowsLocalhost verifies that WithUnsafeDialer bypasses
|
|
||||||
// the IP check, allowing tests to connect to httptest.Server (127.0.0.1).
|
|
||||||
func TestWithUnsafeDialerAllowsLocalhost(t *testing.T) {
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
w.Write([]byte(`{"title":"test","body":"","head":{"sha":"abc","ref":"main"}}`))
|
|
||||||
}))
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
// WithUnsafeDialer should allow connecting to 127.0.0.1.
|
|
||||||
c := NewClient(server.URL, "token").WithUnsafeDialer()
|
|
||||||
pr, err := c.GetPullRequest(context.Background(), "owner", "repo", 1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error with unsafe dialer: %v", err)
|
|
||||||
}
|
|
||||||
if pr.Title != "test" {
|
|
||||||
t.Errorf("expected title 'test', got %q", pr.Title)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewClient_HasSafeTransport verifies that NewClient installs the
|
|
||||||
// SSRF-blocking transport (i.e. Transport is not nil and DialContext is set).
|
|
||||||
func TestNewClient_HasSafeTransport(t *testing.T) {
|
|
||||||
c := NewClient("https://gitea.example.com", "token")
|
|
||||||
if c.http.Transport == nil {
|
|
||||||
t.Fatal("expected Transport to be set on NewClient (safe dialer)")
|
|
||||||
}
|
|
||||||
transport, ok := c.http.Transport.(*http.Transport)
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("expected *http.Transport, got %T", c.http.Transport)
|
|
||||||
}
|
|
||||||
if transport.DialContext == nil {
|
|
||||||
t.Fatal("expected DialContext to be set on transport (safe dialer)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSetHTTPClient_NilRestoresSafeTransport verifies that SetHTTPClient(nil)
|
|
||||||
// restores the safe transport (not just any client).
|
|
||||||
func TestSetHTTPClient_NilRestoresSafeTransport(t *testing.T) {
|
|
||||||
c := NewClient("https://gitea.example.com", "token")
|
|
||||||
c.SetHTTPClient(&http.Client{}) // replace with plain client
|
|
||||||
c.SetHTTPClient(nil) // restore
|
|
||||||
transport, ok := c.http.Transport.(*http.Transport)
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("expected *http.Transport after SetHTTPClient(nil), got %T", c.http.Transport)
|
|
||||||
}
|
|
||||||
if transport.DialContext == nil {
|
|
||||||
t.Fatal("expected DialContext to be restored after SetHTTPClient(nil)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewSafeHTTPClient_PreservesDefaultTransportSettings verifies that
|
|
||||||
// newSafeHTTPClient clones http.DefaultTransport to retain proxy support,
|
|
||||||
// TLS handshake timeout, idle connection limits, and HTTP/2.
|
|
||||||
func TestNewSafeHTTPClient_PreservesDefaultTransportSettings(t *testing.T) {
|
|
||||||
c := NewClient("https://gitea.example.com", "token")
|
|
||||||
transport, ok := c.http.Transport.(*http.Transport)
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("expected *http.Transport, got %T", c.http.Transport)
|
|
||||||
}
|
|
||||||
|
|
||||||
defaults := http.DefaultTransport.(*http.Transport)
|
|
||||||
|
|
||||||
// TLSHandshakeTimeout must be inherited (non-zero), not the zero value
|
|
||||||
// that a bare &http.Transport{} would have.
|
|
||||||
if transport.TLSHandshakeTimeout == 0 {
|
|
||||||
t.Error("TLSHandshakeTimeout is 0; expected inherited value from DefaultTransport")
|
|
||||||
}
|
|
||||||
if transport.TLSHandshakeTimeout != defaults.TLSHandshakeTimeout {
|
|
||||||
t.Errorf("TLSHandshakeTimeout = %v, want %v", transport.TLSHandshakeTimeout, defaults.TLSHandshakeTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IdleConnTimeout must be inherited.
|
|
||||||
if transport.IdleConnTimeout == 0 {
|
|
||||||
t.Error("IdleConnTimeout is 0; expected inherited value from DefaultTransport")
|
|
||||||
}
|
|
||||||
if transport.IdleConnTimeout != defaults.IdleConnTimeout {
|
|
||||||
t.Errorf("IdleConnTimeout = %v, want %v", transport.IdleConnTimeout, defaults.IdleConnTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MaxIdleConns must be inherited.
|
|
||||||
if transport.MaxIdleConns == 0 {
|
|
||||||
t.Error("MaxIdleConns is 0; expected inherited value from DefaultTransport")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ForceAttemptHTTP2 must be inherited.
|
|
||||||
if !transport.ForceAttemptHTTP2 {
|
|
||||||
t.Error("ForceAttemptHTTP2 is false; expected true from DefaultTransport")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Proxy must be set (ProxyFromEnvironment).
|
|
||||||
if transport.Proxy == nil {
|
|
||||||
t.Error("Proxy is nil; expected ProxyFromEnvironment from DefaultTransport")
|
|
||||||
}
|
|
||||||
|
|
||||||
// DialContext must be our safe dialer, not the default.
|
|
||||||
if transport.DialContext == nil {
|
|
||||||
t.Error("DialContext is nil; expected safeDialContext")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,97 +0,0 @@
|
|||||||
package gitea
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"math"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestGetPullRequestDiff_SizeLimits(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
diff string
|
|
||||||
maxDiffSize int64
|
|
||||||
wantErr error
|
|
||||||
wantDiff string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "exceeds max size",
|
|
||||||
diff: strings.Repeat("+ added line\n", 1000), // ~13 KB
|
|
||||||
maxDiffSize: 100,
|
|
||||||
wantErr: ErrDiffTooLarge,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "within max size",
|
|
||||||
diff: "diff --git a/f.go b/f.go\n--- a/f.go\n+++ b/f.go\n@@ -1 +1 @@\n-old\n+new\n",
|
|
||||||
maxDiffSize: 1024,
|
|
||||||
wantDiff: "diff --git a/f.go b/f.go\n--- a/f.go\n+++ b/f.go\n@@ -1 +1 @@\n-old\n+new\n",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "exactly at limit",
|
|
||||||
diff: strings.Repeat("x", 50),
|
|
||||||
maxDiffSize: 50,
|
|
||||||
wantDiff: strings.Repeat("x", 50),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "one byte over limit",
|
|
||||||
diff: strings.Repeat("x", 51),
|
|
||||||
maxDiffSize: 50,
|
|
||||||
wantErr: ErrDiffTooLarge,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "disabled limit",
|
|
||||||
diff: strings.Repeat("x", 10000),
|
|
||||||
maxDiffSize: -1,
|
|
||||||
wantDiff: strings.Repeat("x", 10000),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "math.MaxInt64 treated as disabled",
|
|
||||||
diff: strings.Repeat("x", 10000),
|
|
||||||
maxDiffSize: math.MaxInt64,
|
|
||||||
wantDiff: strings.Repeat("x", 10000),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "default limit",
|
|
||||||
diff: "diff content",
|
|
||||||
maxDiffSize: 0, // zero means use DefaultMaxDiffSize
|
|
||||||
wantDiff: "diff content",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.Write([]byte(tt.diff)) //nolint:errcheck // test handler
|
|
||||||
}))
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
|
||||||
client.MaxDiffSize = tt.maxDiffSize
|
|
||||||
client.RetryBackoff = []time.Duration{}
|
|
||||||
|
|
||||||
got, err := client.GetPullRequestDiff(context.Background(), "owner", "repo", 1)
|
|
||||||
|
|
||||||
if tt.wantErr != nil {
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error, got nil")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, tt.wantErr) {
|
|
||||||
t.Errorf("expected %v, got: %v", tt.wantErr, err)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if got != tt.wantDiff {
|
|
||||||
t.Errorf("diff mismatch: got length %d, want length %d", len(got), len(tt.wantDiff))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
// Package gitea — export_test.go exposes test helpers to test files in this
|
|
||||||
// package. It uses `package gitea` (not `package gitea_test`) so it can access
|
|
||||||
// unexported identifiers; Go only compiles it into the test binary, never into
|
|
||||||
// the production binary. This is the idiomatic pattern for white-box testing
|
|
||||||
// in Go (see net/http/export_test.go in the stdlib for the same approach).
|
|
||||||
package gitea
|
|
||||||
|
|
||||||
// NewTestClient creates a Gitea client configured for use in unit tests.
|
|
||||||
// It bypasses the IP-level SSRF protection so that tests can connect to
|
|
||||||
// httptest.Server instances (which listen on 127.0.0.1).
|
|
||||||
//
|
|
||||||
// Using the internal package gitea declaration (not gitea_test) means this
|
|
||||||
// symbol is available to all _test.go files in this package. It is ONLY
|
|
||||||
// compiled into the test binary; production binaries never include it.
|
|
||||||
// Production code must use NewClient, which enables the safe dialer.
|
|
||||||
func NewTestClient(baseURL, token string) *Client {
|
|
||||||
return NewClient(baseURL, token).WithUnsafeDialer()
|
|
||||||
}
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
// Package gitea provides a client for the Gitea API.
|
|
||||||
// ipcheck.go implements IP-level SSRF protection by checking resolved addresses
|
|
||||||
// against known blocked CIDR ranges (RFC1918, loopback, link-local, etc.).
|
|
||||||
package gitea
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
)
|
|
||||||
|
|
||||||
// blockedCIDRStrings is the canonical list of CIDR strings that should never
|
|
||||||
// be contacted by review-bot. See IsBlockedIP for the full list of covered
|
|
||||||
// address families.
|
|
||||||
//
|
|
||||||
// These are hard-coded literals: any parse failure is a programming error.
|
|
||||||
// Validity is verified by TestBlockedCIDRsValid in ipcheck_test.go.
|
|
||||||
var blockedCIDRStrings = []string{
|
|
||||||
// IPv4 loopback
|
|
||||||
"127.0.0.0/8",
|
|
||||||
// IPv4 unspecified / "this network"
|
|
||||||
"0.0.0.0/8",
|
|
||||||
// RFC1918 private ranges
|
|
||||||
"10.0.0.0/8",
|
|
||||||
"172.16.0.0/12",
|
|
||||||
"192.168.0.0/16",
|
|
||||||
// IPv4 link-local (APIPA, also used by AWS instance metadata 169.254.169.254)
|
|
||||||
"169.254.0.0/16",
|
|
||||||
// IPv4 shared address space (RFC6598, carrier-grade NAT)
|
|
||||||
"100.64.0.0/10",
|
|
||||||
// IPv4 multicast
|
|
||||||
"224.0.0.0/4",
|
|
||||||
// IPv4 reserved / broadcast
|
|
||||||
"240.0.0.0/4",
|
|
||||||
// IPv6 loopback
|
|
||||||
"::1/128",
|
|
||||||
// IPv6 unspecified
|
|
||||||
"::/128",
|
|
||||||
// IPv6 link-local
|
|
||||||
"fe80::/10",
|
|
||||||
// IPv6 unique local (ULA) — RFC4193
|
|
||||||
"fc00::/7",
|
|
||||||
// IPv6 multicast
|
|
||||||
"ff00::/8",
|
|
||||||
}
|
|
||||||
|
|
||||||
// blockedCIDRs is the parsed form of blockedCIDRStrings.
|
|
||||||
// Any entry that fails to parse is recorded in blockedCIDRParseErrors instead
|
|
||||||
// of panicking; tests verify this slice is always empty via TestBlockedCIDRsValid.
|
|
||||||
var (
|
|
||||||
blockedCIDRs []*net.IPNet
|
|
||||||
blockedCIDRParseErrors []string
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
blockedCIDRs = make([]*net.IPNet, 0, len(blockedCIDRStrings))
|
|
||||||
for _, r := range blockedCIDRStrings {
|
|
||||||
_, cidr, err := net.ParseCIDR(r)
|
|
||||||
if err != nil {
|
|
||||||
// Record the error rather than panicking; TestBlockedCIDRsValid
|
|
||||||
// will catch this during tests, and the CI build will fail.
|
|
||||||
blockedCIDRParseErrors = append(blockedCIDRParseErrors,
|
|
||||||
fmt.Sprintf("ipcheck: invalid built-in CIDR %q: %v", r, err))
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
blockedCIDRs = append(blockedCIDRs, cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsBlockedIP reports whether ip is in a blocked address range.
|
|
||||||
// It is exported for use by the validate-url subcommand and tests outside
|
|
||||||
// this package.
|
|
||||||
//
|
|
||||||
// IPv6-mapped IPv4 addresses (e.g. ::ffff:192.168.1.1) are normalized to their
|
|
||||||
// IPv4 form before checking so that IPv4 CIDRs catch them.
|
|
||||||
//
|
|
||||||
// Based on:
|
|
||||||
// - RFC1918 private ranges
|
|
||||||
// - RFC5735 / RFC4193 special-use IPv4/IPv6 ranges
|
|
||||||
// - RFC4291 IPv6 link-local / loopback
|
|
||||||
func IsBlockedIP(ip net.IP) bool {
|
|
||||||
// Normalize IPv6-mapped IPv4 addresses (::ffff:x.x.x.x) to plain IPv4.
|
|
||||||
if v4 := ip.To4(); v4 != nil {
|
|
||||||
ip = v4
|
|
||||||
}
|
|
||||||
for _, cidr := range blockedCIDRs {
|
|
||||||
if cidr.Contains(ip) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
package gitea
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestIsBlockedIP(t *testing.T) {
|
|
||||||
blocked := []struct {
|
|
||||||
name string
|
|
||||||
ip string
|
|
||||||
}{
|
|
||||||
// IPv4 loopback
|
|
||||||
{"loopback 127.0.0.1", "127.0.0.1"},
|
|
||||||
{"loopback 127.0.0.2", "127.0.0.2"},
|
|
||||||
{"loopback 127.255.255.255", "127.255.255.255"},
|
|
||||||
// IPv4 unspecified
|
|
||||||
{"unspecified 0.0.0.0", "0.0.0.0"},
|
|
||||||
{"unspecified 0.1.2.3", "0.1.2.3"},
|
|
||||||
// RFC1918
|
|
||||||
{"RFC1918 10.0.0.1", "10.0.0.1"},
|
|
||||||
{"RFC1918 10.255.255.255", "10.255.255.255"},
|
|
||||||
{"RFC1918 172.16.0.1", "172.16.0.1"},
|
|
||||||
{"RFC1918 172.31.255.255", "172.31.255.255"},
|
|
||||||
{"RFC1918 192.168.0.1", "192.168.0.1"},
|
|
||||||
{"RFC1918 192.168.255.255", "192.168.255.255"},
|
|
||||||
// Link-local (APIPA / AWS metadata)
|
|
||||||
{"link-local 169.254.0.1", "169.254.0.1"},
|
|
||||||
{"link-local 169.254.169.254", "169.254.169.254"},
|
|
||||||
// Shared address space (carrier-grade NAT)
|
|
||||||
{"CGN 100.64.0.1", "100.64.0.1"},
|
|
||||||
{"CGN 100.127.255.255", "100.127.255.255"},
|
|
||||||
// Multicast
|
|
||||||
{"multicast 224.0.0.1", "224.0.0.1"},
|
|
||||||
{"multicast 239.255.255.255", "239.255.255.255"},
|
|
||||||
// Reserved
|
|
||||||
{"reserved 240.0.0.1", "240.0.0.1"},
|
|
||||||
{"broadcast 255.255.255.255", "255.255.255.255"},
|
|
||||||
// IPv6 loopback
|
|
||||||
{"IPv6 loopback ::1", "::1"},
|
|
||||||
// IPv6 unspecified
|
|
||||||
{"IPv6 unspecified ::", "::"},
|
|
||||||
// IPv6 link-local
|
|
||||||
{"IPv6 link-local fe80::1", "fe80::1"},
|
|
||||||
{"IPv6 link-local fe80::dead:beef", "fe80::dead:beef"},
|
|
||||||
// IPv6 ULA
|
|
||||||
{"IPv6 ULA fc00::1", "fc00::1"},
|
|
||||||
{"IPv6 ULA fd00::1", "fd00::1"},
|
|
||||||
// IPv6 multicast
|
|
||||||
{"IPv6 multicast ff02::1", "ff02::1"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range blocked {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
ip := net.ParseIP(tc.ip)
|
|
||||||
if ip == nil {
|
|
||||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
|
||||||
}
|
|
||||||
if !IsBlockedIP(ip) {
|
|
||||||
t.Errorf("IsBlockedIP(%q) = false, want true", tc.ip)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
allowed := []struct {
|
|
||||||
name string
|
|
||||||
ip string
|
|
||||||
}{
|
|
||||||
{"public 8.8.8.8", "8.8.8.8"},
|
|
||||||
{"public 1.1.1.1", "1.1.1.1"},
|
|
||||||
{"public 198.51.100.1", "198.51.100.1"}, // RFC5737 TEST-NET-2 — a documentation-only range;
|
|
||||||
// not assigned to any real host, but intentionally left unblocked here because
|
|
||||||
// it has no special routing treatment (unlike RFC1918/loopback/link-local) and
|
|
||||||
// blocking it would require tracking every RFC5737 range without meaningful
|
|
||||||
// security benefit (no server should ever listen on a TEST-NET address).
|
|
||||||
{"public 151.101.1.1", "151.101.1.1"}, // Fastly
|
|
||||||
{"public IPv6 2001:4860:4860::8888", "2001:4860:4860::8888"}, // Google DNS
|
|
||||||
{"public IPv6 2606:4700:4700::1111", "2606:4700:4700::1111"}, // Cloudflare DNS
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range allowed {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
ip := net.ParseIP(tc.ip)
|
|
||||||
if ip == nil {
|
|
||||||
t.Fatalf("failed to parse IP %q", tc.ip)
|
|
||||||
}
|
|
||||||
if IsBlockedIP(ip) {
|
|
||||||
t.Errorf("IsBlockedIP(%q) = true, want false", tc.ip)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsBlockedIPv6MappedIPv4(t *testing.T) {
|
|
||||||
// ::ffff:192.168.1.1 is an IPv6-mapped IPv4 address — should be blocked as RFC1918.
|
|
||||||
// Construct it manually as a 16-byte IP.
|
|
||||||
mapped := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 192, 168, 1, 1}
|
|
||||||
if !IsBlockedIP(mapped) {
|
|
||||||
t.Errorf("IsBlockedIP(::ffff:192.168.1.1) = false, want true (IPv6-mapped IPv4 must be normalized)")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ::ffff:8.8.8.8 — IPv6-mapped public IP — should be allowed.
|
|
||||||
mappedPublic := net.IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff, 8, 8, 8, 8}
|
|
||||||
if IsBlockedIP(mappedPublic) {
|
|
||||||
t.Errorf("IsBlockedIP(::ffff:8.8.8.8) = true, want false")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsBlockedIPEdgeCases(t *testing.T) {
|
|
||||||
// The boundary between RFC1918 and public ranges.
|
|
||||||
// 172.15.255.255 is NOT private (just below 172.16.0.0/12).
|
|
||||||
notPrivate := net.ParseIP("172.15.255.255")
|
|
||||||
if IsBlockedIP(notPrivate) {
|
|
||||||
t.Errorf("IsBlockedIP(172.15.255.255) = true, want false (outside 172.16.0.0/12)")
|
|
||||||
}
|
|
||||||
// 172.32.0.0 is NOT private (just above 172.31.255.255).
|
|
||||||
notPrivate2 := net.ParseIP("172.32.0.0")
|
|
||||||
if IsBlockedIP(notPrivate2) {
|
|
||||||
t.Errorf("IsBlockedIP(172.32.0.0) = true, want false (outside 172.16.0.0/12)")
|
|
||||||
}
|
|
||||||
// CGN: 100.63.255.255 is NOT in 100.64.0.0/10.
|
|
||||||
notCGN := net.ParseIP("100.63.255.255")
|
|
||||||
if IsBlockedIP(notCGN) {
|
|
||||||
t.Errorf("IsBlockedIP(100.63.255.255) = true, want false (outside 100.64.0.0/10)")
|
|
||||||
}
|
|
||||||
// CGN: 100.128.0.0 is NOT in 100.64.0.0/10.
|
|
||||||
notCGN2 := net.ParseIP("100.128.0.0")
|
|
||||||
if IsBlockedIP(notCGN2) {
|
|
||||||
t.Errorf("IsBlockedIP(100.128.0.0) = true, want false (outside 100.64.0.0/10)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestBlockedCIDRsValid verifies that all entries in blockedCIDRStrings parse
|
|
||||||
// successfully. This catches programming errors in the CIDR list without
|
|
||||||
// requiring a startup panic. The init() function records parse failures in
|
|
||||||
// blockedCIDRParseErrors rather than panicking; this test makes those failures
|
|
||||||
// visible as test failures during CI.
|
|
||||||
func TestBlockedCIDRsValid(t *testing.T) {
|
|
||||||
if len(blockedCIDRParseErrors) > 0 {
|
|
||||||
for _, msg := range blockedCIDRParseErrors {
|
|
||||||
t.Errorf("CIDR parse error: %s", msg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -31,13 +31,13 @@ func TestPostReview_WithComments(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
comments := []ReviewComment{
|
comments := []ReviewComment{
|
||||||
{Path: "main.go", NewPosition: 42, Body: "[MAJOR] Something bad"},
|
{Path: "main.go", NewPosition: 42, Body: "[MAJOR] Something bad"},
|
||||||
{Path: "util.go", NewPosition: 10, Body: "[MINOR] Style issue"},
|
{Path: "util.go", NewPosition: 10, Body: "[MINOR] Style issue"},
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "REQUEST_CHANGES", "summary", "", comments)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "REQUEST_CHANGES", "summary", comments)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
@@ -71,8 +71,8 @@ func TestPostReview_NilComments(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewTestClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "all good", "", nil)
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "all good", nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,378 +0,0 @@
|
|||||||
// Package github provides a client for the GitHub API.
|
|
||||||
// It supports pull request operations, file content retrieval,
|
|
||||||
// and review submission for both github.com and GitHub Enterprise.
|
|
||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"os"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
defaultBaseURL = "https://api.github.com"
|
|
||||||
|
|
||||||
// maxRetryAttempts is the number of times doRequest will attempt a request.
|
|
||||||
maxRetryAttempts = 3
|
|
||||||
|
|
||||||
// maxRetryAfter caps the maximum delay from a Retry-After header to prevent
|
|
||||||
// a server from stalling the client indefinitely.
|
|
||||||
maxRetryAfter = 60 * time.Second
|
|
||||||
|
|
||||||
// maxErrorBodyBytes limits how much of an error response body we read
|
|
||||||
// to protect against malicious servers sending unbounded data.
|
|
||||||
maxErrorBodyBytes = 64 * 1024 // 64 KB
|
|
||||||
|
|
||||||
// maxResponseBodyBytes limits how much of a successful response body we read
|
|
||||||
// for defense-in-depth against servers returning excessively large payloads.
|
|
||||||
maxResponseBodyBytes = 10 * 1024 * 1024 // 10 MB
|
|
||||||
)
|
|
||||||
|
|
||||||
// APIError represents an HTTP error response from the GitHub API.
|
|
||||||
// It carries the status code so callers can distinguish between
|
|
||||||
// different failure modes (e.g. 404 vs 500).
|
|
||||||
//
|
|
||||||
// The Body field stores up to 64 KiB of the raw response for programmatic
|
|
||||||
// inspection. Error() truncates to 200 bytes for safe logging, but callers
|
|
||||||
// should avoid logging or propagating Body directly in production since it may
|
|
||||||
// contain sensitive details from the upstream server.
|
|
||||||
type APIError struct {
|
|
||||||
StatusCode int
|
|
||||||
Body string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *APIError) Error() string {
|
|
||||||
body := e.Body
|
|
||||||
if len(body) > 200 {
|
|
||||||
body = body[:200] + "...(truncated)"
|
|
||||||
}
|
|
||||||
// Sanitize newlines to prevent log injection from upstream response bodies.
|
|
||||||
body = strings.ReplaceAll(body, "\n", " ")
|
|
||||||
body = strings.ReplaceAll(body, "\r", " ")
|
|
||||||
return fmt.Sprintf("HTTP %d: %s", e.StatusCode, body)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsNotFound reports whether an error is an API 404 response.
|
|
||||||
func IsNotFound(err error) bool {
|
|
||||||
if apiErr, ok := asAPIError(err); ok {
|
|
||||||
return apiErr.StatusCode == http.StatusNotFound
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsUnauthorized reports whether an error is an API 401 response.
|
|
||||||
func IsUnauthorized(err error) bool {
|
|
||||||
if apiErr, ok := asAPIError(err); ok {
|
|
||||||
return apiErr.StatusCode == http.StatusUnauthorized
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func asAPIError(err error) (*APIError, bool) {
|
|
||||||
if err == nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
var target *APIError
|
|
||||||
if errors.As(err, &target) {
|
|
||||||
return target, true
|
|
||||||
}
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Client interacts with the GitHub API.
|
|
||||||
// A Client is safe for concurrent use by multiple goroutines.
|
|
||||||
// SetHTTPClient and SetRetryBackoff are intended for test setup only and must
|
|
||||||
// be called before any goroutines issue requests; they have no synchronization.
|
|
||||||
type Client struct {
|
|
||||||
// TODO: baseURL is populated by NewClient but not yet consumed by doRequest/doGet.
|
|
||||||
// Higher-level exported methods (GetPullRequest, etc.) will use it to
|
|
||||||
// construct request URLs; remove this field if those methods end up
|
|
||||||
// accepting full URLs instead.
|
|
||||||
baseURL string
|
|
||||||
token string
|
|
||||||
httpClient *http.Client
|
|
||||||
|
|
||||||
// allowInsecureHTTP permits requests to HTTP (non-TLS) endpoints.
|
|
||||||
// When false, doRequest rejects URLs with an http:// scheme.
|
|
||||||
allowInsecureHTTP bool
|
|
||||||
|
|
||||||
// retryBackoff defines the delays between retry attempts for 429 responses.
|
|
||||||
// retryBackoff[i] is the delay before attempt i+1 (after attempt i fails).
|
|
||||||
// If nil, defaults to {1s, 2s}.
|
|
||||||
retryBackoff []time.Duration
|
|
||||||
|
|
||||||
// now returns the current time. Defaults to time.Now.
|
|
||||||
// Override in tests to control HTTP-date Retry-After calculations.
|
|
||||||
now func() time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// defaultCheckRedirect is the redirect policy used by NewClient.
|
|
||||||
// NOTE: This function is intentionally duplicated in gitea/client.go (and vice versa)
|
|
||||||
// because the packages are separate. Changes here must be mirrored there.
|
|
||||||
// It rejects HTTPS->HTTP protocol downgrades (to prevent plaintext leakage)
|
|
||||||
// and cross-host redirects (to prevent following responses from untrusted
|
|
||||||
// endpoints). Same-host, same-or-upgraded-scheme redirects are allowed.
|
|
||||||
func defaultCheckRedirect(req *http.Request, via []*http.Request) error {
|
|
||||||
if len(via) >= 10 {
|
|
||||||
return fmt.Errorf("stopped after 10 redirects")
|
|
||||||
}
|
|
||||||
// Guard for direct invocation in tests and any future callers;
|
|
||||||
// net/http guarantees len(via) >= 1 during actual redirects.
|
|
||||||
if len(via) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
prev := via[len(via)-1]
|
|
||||||
// Reject protocol downgrade: HTTPS->HTTP leaks request metadata over plaintext.
|
|
||||||
if prev.URL.Scheme == "https" && req.URL.Scheme == "http" {
|
|
||||||
return fmt.Errorf("refusing redirect: HTTPS to HTTP downgrade (%s -> %s)", prev.URL.Host, req.URL.Host)
|
|
||||||
}
|
|
||||||
// Reject cross-host redirect entirely to avoid consuming responses
|
|
||||||
// from untrusted endpoints.
|
|
||||||
if req.URL.Host != prev.URL.Host {
|
|
||||||
return fmt.Errorf("refusing redirect: cross-host (%s -> %s)", prev.URL.Host, req.URL.Host)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ClientOption configures optional behavior of a Client.
|
|
||||||
type ClientOption func(*clientConfig)
|
|
||||||
|
|
||||||
type clientConfig struct {
|
|
||||||
allowInsecureHTTP bool
|
|
||||||
insecureIsTestBypass bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// AllowInsecureHTTP permits sending credentials over plaintext HTTP connections.
|
|
||||||
// In production, this option is gated by the REVIEW_BOT_ALLOW_INSECURE=1
|
|
||||||
// environment variable. Without the env var set, the option is ignored
|
|
||||||
// and a warning is logged.
|
|
||||||
//
|
|
||||||
// For tests, use AllowInsecureHTTPForTest (defined in a _test.go file in the same package) which bypasses the env gate.
|
|
||||||
func AllowInsecureHTTP() ClientOption {
|
|
||||||
return func(cfg *clientConfig) {
|
|
||||||
cfg.allowInsecureHTTP = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewClient creates a new GitHub API client.
|
|
||||||
// If baseURL is empty, it defaults to https://api.github.com.
|
|
||||||
// For GitHub Enterprise, pass the API base URL (e.g. https://github.concur.com/api/v3).
|
|
||||||
func NewClient(token, baseURL string, opts ...ClientOption) *Client {
|
|
||||||
if baseURL == "" {
|
|
||||||
baseURL = defaultBaseURL
|
|
||||||
}
|
|
||||||
|
|
||||||
var cfg clientConfig
|
|
||||||
for _, opt := range opts {
|
|
||||||
opt(&cfg)
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.allowInsecureHTTP && !cfg.insecureIsTestBypass {
|
|
||||||
if os.Getenv("REVIEW_BOT_ALLOW_INSECURE") != "1" {
|
|
||||||
slog.Warn("AllowInsecureHTTP ignored: set REVIEW_BOT_ALLOW_INSECURE=1 to enable")
|
|
||||||
cfg.allowInsecureHTTP = false
|
|
||||||
} else {
|
|
||||||
slog.Warn("AllowInsecureHTTP enabled — credentials may be sent over plaintext",
|
|
||||||
"env", "REVIEW_BOT_ALLOW_INSECURE=1")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Client{
|
|
||||||
baseURL: strings.TrimRight(baseURL, "/"),
|
|
||||||
token: token,
|
|
||||||
allowInsecureHTTP: cfg.allowInsecureHTTP,
|
|
||||||
httpClient: &http.Client{
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
CheckRedirect: defaultCheckRedirect,
|
|
||||||
},
|
|
||||||
now: time.Now,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetHTTPClient sets the underlying HTTP client used for requests.
|
|
||||||
// This is intended for test setup only to inject mock transports; it must be
|
|
||||||
// called before any goroutines issue requests.
|
|
||||||
//
|
|
||||||
// Passing nil restores the default client (30s timeout + redirect-rejecting
|
|
||||||
// CheckRedirect policy matching NewClient).
|
|
||||||
//
|
|
||||||
// Callers providing a non-nil client are responsible for configuring a safe
|
|
||||||
// CheckRedirect policy. Without one, the default net/http behavior will follow
|
|
||||||
// redirects and may forward the Authorization header to untrusted hosts.
|
|
||||||
func (c *Client) SetHTTPClient(hc *http.Client) {
|
|
||||||
if hc == nil {
|
|
||||||
hc = &http.Client{
|
|
||||||
Timeout: 30 * time.Second,
|
|
||||||
CheckRedirect: defaultCheckRedirect,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
c.httpClient = hc
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetRetryBackoff sets the delays between retry attempts.
|
|
||||||
// This is intended for testing to speed up retry tests.
|
|
||||||
//
|
|
||||||
// Note: if an empty non-nil slice is provided, Retry-After delays parsed from
|
|
||||||
// server responses will be computed and capped but not applied (because
|
|
||||||
// attempt < len(backoff) is always false). This is acceptable for the
|
|
||||||
// test-only use case but callers should be aware of this edge case.
|
|
||||||
func (c *Client) SetRetryBackoff(backoff []time.Duration) {
|
|
||||||
c.retryBackoff = backoff
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseRetryAfter parses a Retry-After header value, supporting both integer
|
|
||||||
// seconds (e.g. "120") and HTTP-date format (e.g. "Thu, 01 Dec 2025 16:00:00 GMT")
|
|
||||||
// as specified in RFC 7231 §7.1.3.
|
|
||||||
//
|
|
||||||
// For integer values, it returns the duration directly.
|
|
||||||
// For HTTP-date values, it computes the delay as the difference between the
|
|
||||||
// parsed time and now. If the date is in the past, it returns 0.
|
|
||||||
//
|
|
||||||
// Returns (0, false) if the value cannot be parsed as either format.
|
|
||||||
func (c *Client) parseRetryAfter(value string) (time.Duration, bool) {
|
|
||||||
value = strings.TrimSpace(value)
|
|
||||||
|
|
||||||
// Try integer seconds first (most common from GitHub).
|
|
||||||
// RFC 7231 allows delta-seconds of 0 to indicate immediate retry.
|
|
||||||
if seconds, err := strconv.Atoi(value); err == nil && seconds >= 0 {
|
|
||||||
return time.Duration(seconds) * time.Second, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Try HTTP-date format (RFC 7231 §7.1.3).
|
|
||||||
// http.ParseTime handles RFC 1123, RFC 850, and ASCTIME formats.
|
|
||||||
if retryAt, err := http.ParseTime(value); err == nil {
|
|
||||||
delay := retryAt.Sub(c.now())
|
|
||||||
if delay < 0 {
|
|
||||||
delay = 0
|
|
||||||
}
|
|
||||||
return delay, true
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// redactURL redacts sensitive components from a URL for safe inclusion in error
|
|
||||||
// messages and log output. It removes userinfo (e.g., user:pass@) and replaces
|
|
||||||
// query parameters with a placeholder.
|
|
||||||
func redactURL(rawURL string) string {
|
|
||||||
u, err := url.Parse(rawURL)
|
|
||||||
if err != nil {
|
|
||||||
return "<unparseable URL>"
|
|
||||||
}
|
|
||||||
u.User = nil
|
|
||||||
|
|
||||||
if u.RawQuery != "" {
|
|
||||||
u.RawQuery = "<redacted>"
|
|
||||||
}
|
|
||||||
return u.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// doRequest performs an HTTP request with retry on 429 rate limit responses.
|
|
||||||
// It respects the Retry-After header when present, supporting both integer
|
|
||||||
// seconds and HTTP-date formats (capped at maxRetryAfter).
|
|
||||||
func (c *Client) doRequest(ctx context.Context, method, reqURL string, accept string) ([]byte, error) {
|
|
||||||
// NOTE: This parses reqURL a second time (http.NewRequestWithContext parses it
|
|
||||||
// again internally). Acceptable cost: URL parsing is cheap and threading the
|
|
||||||
// parsed *url.URL through would complicate the interface for negligible gain.
|
|
||||||
if !c.allowInsecureHTTP {
|
|
||||||
parsed, err := url.Parse(reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("parse request URL: %w", err)
|
|
||||||
}
|
|
||||||
if strings.EqualFold(parsed.Scheme, "http") {
|
|
||||||
return nil, fmt.Errorf("refusing HTTP request to %s: use HTTPS or set AllowInsecureHTTP option", redactURL(reqURL))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var backoff []time.Duration
|
|
||||||
if c.retryBackoff != nil {
|
|
||||||
backoff = append([]time.Duration(nil), c.retryBackoff...)
|
|
||||||
} else {
|
|
||||||
backoff = []time.Duration{1 * time.Second, 2 * time.Second}
|
|
||||||
}
|
|
||||||
|
|
||||||
var lastErr error
|
|
||||||
for attempt := 0; attempt < maxRetryAttempts; attempt++ {
|
|
||||||
if attempt > 0 {
|
|
||||||
var delay time.Duration
|
|
||||||
if attempt-1 < len(backoff) {
|
|
||||||
delay = backoff[attempt-1]
|
|
||||||
}
|
|
||||||
if delay > 0 {
|
|
||||||
timer := time.NewTimer(delay)
|
|
||||||
select {
|
|
||||||
case <-timer.C:
|
|
||||||
timer.Stop() // no-op after fire; kept for symmetry with the ctx.Done case
|
|
||||||
case <-ctx.Done():
|
|
||||||
timer.Stop()
|
|
||||||
return nil, ctx.Err()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, method, reqURL, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("create request: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
if accept != "" {
|
|
||||||
req.Header.Set("Accept", accept)
|
|
||||||
} else {
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
}
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("do request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
|
||||||
body, err := io.ReadAll(io.LimitReader(resp.Body, maxResponseBodyBytes))
|
|
||||||
resp.Body.Close()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("read response body: %w", err)
|
|
||||||
}
|
|
||||||
return body, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
errBody, _ := io.ReadAll(io.LimitReader(resp.Body, maxErrorBodyBytes))
|
|
||||||
resp.Body.Close()
|
|
||||||
|
|
||||||
lastErr = &APIError{StatusCode: resp.StatusCode, Body: string(errBody)}
|
|
||||||
|
|
||||||
// Retry on 429 rate limit
|
|
||||||
if resp.StatusCode == http.StatusTooManyRequests && attempt < maxRetryAttempts-1 {
|
|
||||||
// Check for Retry-After header and override backoff if present.
|
|
||||||
// Supports both integer seconds (common) and HTTP-date format (RFC 7231).
|
|
||||||
if ra := resp.Header.Get("Retry-After"); ra != "" {
|
|
||||||
if delay, ok := c.parseRetryAfter(ra); ok {
|
|
||||||
if delay > maxRetryAfter {
|
|
||||||
delay = maxRetryAfter
|
|
||||||
}
|
|
||||||
if attempt < len(backoff) {
|
|
||||||
backoff[attempt] = delay
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't retry other errors
|
|
||||||
return nil, lastErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, lastErr
|
|
||||||
}
|
|
||||||
|
|
||||||
// doGet is a convenience wrapper for GET requests with the default Accept header.
|
|
||||||
func (c *Client) doGet(ctx context.Context, url string) ([]byte, error) {
|
|
||||||
return c.doRequest(ctx, http.MethodGet, url, "")
|
|
||||||
}
|
|
||||||
@@ -1,658 +0,0 @@
|
|||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestNewClient_DefaultBaseURL(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
if c.baseURL != defaultBaseURL {
|
|
||||||
t.Errorf("baseURL = %q, want %q", c.baseURL, defaultBaseURL)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNewClient_CustomBaseURL(t *testing.T) {
|
|
||||||
c := NewClient("tok", "https://github.concur.com/api/v3/")
|
|
||||||
if c.baseURL != "https://github.concur.com/api/v3" {
|
|
||||||
t.Errorf("baseURL = %q, want trailing slash stripped", c.baseURL)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_Success(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if got := r.Header.Get("Authorization"); got != "Bearer test-token" {
|
|
||||||
t.Errorf("Authorization = %q, want Bearer test-token", got)
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte(`{"ok":true}`))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("test-token", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != `{"ok":true}` {
|
|
||||||
t.Errorf("body = %q, want %q", body, `{"ok":true}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_429_RetryAfter_IntegerSeconds(t *testing.T) {
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
if attempts == 1 {
|
|
||||||
w.Header().Set("Retry-After", "0")
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
w.Write([]byte("rate limited"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("success"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.SetRetryBackoff([]time.Duration{0, 0})
|
|
||||||
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "success" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "success")
|
|
||||||
}
|
|
||||||
if attempts != 2 {
|
|
||||||
t.Errorf("attempts = %d, want 2", attempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_429_RetryAfter_HTTPDate(t *testing.T) {
|
|
||||||
// Fix "now" to a known time for deterministic testing.
|
|
||||||
fixedNow := time.Date(2025, 12, 1, 15, 59, 59, 0, time.UTC)
|
|
||||||
retryAt := "Mon, 01 Dec 2025 16:00:00 GMT" // 1 second in the future
|
|
||||||
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
if attempts == 1 {
|
|
||||||
w.Header().Set("Retry-After", retryAt)
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
w.Write([]byte("rate limited"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("success"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.now = func() time.Time { return fixedNow }
|
|
||||||
// Initial backoff is 0; the HTTP-date parser will compute 1s and override.
|
|
||||||
c.SetRetryBackoff([]time.Duration{0, 0})
|
|
||||||
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "success" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "success")
|
|
||||||
}
|
|
||||||
if attempts != 2 {
|
|
||||||
t.Errorf("attempts = %d, want 2", attempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_429_RetryAfter_HTTPDate_InPast(t *testing.T) {
|
|
||||||
// If the HTTP-date is in the past, delay should be 0 (retry immediately).
|
|
||||||
fixedNow := time.Date(2025, 12, 1, 17, 0, 0, 0, time.UTC)
|
|
||||||
retryAt := "Mon, 01 Dec 2025 16:00:00 GMT" // 1 hour in the past
|
|
||||||
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
if attempts == 1 {
|
|
||||||
w.Header().Set("Retry-After", retryAt)
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
w.Write([]byte("rate limited"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("success"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.now = func() time.Time { return fixedNow }
|
|
||||||
c.SetRetryBackoff([]time.Duration{0, 0})
|
|
||||||
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "success" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "success")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_429_NoRetryAfter_UsesDefaultBackoff(t *testing.T) {
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
if attempts == 1 {
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
w.Write([]byte("rate limited"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("success"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.SetRetryBackoff([]time.Duration{0, 0})
|
|
||||||
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "success" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "success")
|
|
||||||
}
|
|
||||||
if attempts != 2 {
|
|
||||||
t.Errorf("attempts = %d, want 2", attempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_429_InvalidRetryAfter_UsesDefaultBackoff(t *testing.T) {
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
if attempts == 1 {
|
|
||||||
w.Header().Set("Retry-After", "not-a-number-or-date")
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
w.Write([]byte("rate limited"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("success"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.SetRetryBackoff([]time.Duration{0, 0})
|
|
||||||
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "success" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "success")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_404_NoRetry(t *testing.T) {
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
w.WriteHeader(http.StatusNotFound)
|
|
||||||
w.Write([]byte("not found"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
_, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error, got nil")
|
|
||||||
}
|
|
||||||
if !IsNotFound(err) {
|
|
||||||
t.Errorf("expected IsNotFound, got %v", err)
|
|
||||||
}
|
|
||||||
if attempts != 1 {
|
|
||||||
t.Errorf("attempts = %d, want 1 (no retry on 404)", attempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_401_NoRetry(t *testing.T) {
|
|
||||||
attempts := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
attempts++
|
|
||||||
w.WriteHeader(http.StatusUnauthorized)
|
|
||||||
w.Write([]byte("unauthorized"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
_, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error, got nil")
|
|
||||||
}
|
|
||||||
if !IsUnauthorized(err) {
|
|
||||||
t.Errorf("expected IsUnauthorized, got %v", err)
|
|
||||||
}
|
|
||||||
if attempts != 1 {
|
|
||||||
t.Errorf("attempts = %d, want 1 (no retry on 401)", attempts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDoRequest_ContextCanceled(t *testing.T) {
|
|
||||||
// This test exercises the timer-cancel path in the retry select:
|
|
||||||
// select { case <-timer.C; case <-ctx.Done() }
|
|
||||||
// The server returns 429 with a long Retry-After, and we cancel the
|
|
||||||
// context shortly after the first response so that cancellation races
|
|
||||||
// against the timer rather than preventing the initial HTTP round-trip.
|
|
||||||
requestReceived := make(chan struct{}, 1)
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
select {
|
|
||||||
case requestReceived <- struct{}{}:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
w.Header().Set("Retry-After", "10")
|
|
||||||
w.WriteHeader(http.StatusTooManyRequests)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
c.SetRetryBackoff([]time.Duration{10 * time.Second, 10 * time.Second})
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
// Cancel the context after the first request completes, while the
|
|
||||||
// client is blocked in the retry timer select.
|
|
||||||
go func() {
|
|
||||||
<-requestReceived
|
|
||||||
// Small delay to ensure we're inside the timer select.
|
|
||||||
time.Sleep(50 * time.Millisecond)
|
|
||||||
cancel()
|
|
||||||
}()
|
|
||||||
|
|
||||||
_, err := c.doGet(ctx, srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error, got nil")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Errorf("err = %v, want context.Canceled", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_IntegerSeconds(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
delay, ok := c.parseRetryAfter("42")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true")
|
|
||||||
}
|
|
||||||
if delay != 42*time.Second {
|
|
||||||
t.Errorf("delay = %v, want 42s", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_ZeroSeconds(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
delay, ok := c.parseRetryAfter("0")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true for zero seconds (RFC 7231 allows immediate retry)")
|
|
||||||
}
|
|
||||||
if delay != 0 {
|
|
||||||
t.Errorf("delay = %v, want 0", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_NegativeSeconds(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
_, ok := c.parseRetryAfter("-5")
|
|
||||||
if ok {
|
|
||||||
t.Error("expected ok=false for negative seconds")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_HTTPDate_Future(t *testing.T) {
|
|
||||||
fixedNow := time.Date(2025, 12, 1, 15, 59, 50, 0, time.UTC)
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
c.now = func() time.Time { return fixedNow }
|
|
||||||
|
|
||||||
delay, ok := c.parseRetryAfter("Mon, 01 Dec 2025 16:00:00 GMT")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true")
|
|
||||||
}
|
|
||||||
// Should be 10 seconds in the future.
|
|
||||||
if delay != 10*time.Second {
|
|
||||||
t.Errorf("delay = %v, want 10s", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_HTTPDate_Past(t *testing.T) {
|
|
||||||
fixedNow := time.Date(2025, 12, 1, 17, 0, 0, 0, time.UTC)
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
c.now = func() time.Time { return fixedNow }
|
|
||||||
|
|
||||||
delay, ok := c.parseRetryAfter("Mon, 01 Dec 2025 16:00:00 GMT")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true")
|
|
||||||
}
|
|
||||||
if delay != 0 {
|
|
||||||
t.Errorf("delay = %v, want 0 (past date)", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_RFC850_Format(t *testing.T) {
|
|
||||||
fixedNow := time.Date(2025, 12, 1, 15, 59, 50, 0, time.UTC)
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
c.now = func() time.Time { return fixedNow }
|
|
||||||
|
|
||||||
// RFC 850 format
|
|
||||||
delay, ok := c.parseRetryAfter("Monday, 01-Dec-25 16:00:00 GMT")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true for RFC 850 format")
|
|
||||||
}
|
|
||||||
if delay != 10*time.Second {
|
|
||||||
t.Errorf("delay = %v, want 10s", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_Invalid(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
_, ok := c.parseRetryAfter("not-valid")
|
|
||||||
if ok {
|
|
||||||
t.Error("expected ok=false for invalid value")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_EmptyString(t *testing.T) {
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
_, ok := c.parseRetryAfter("")
|
|
||||||
if ok {
|
|
||||||
t.Error("expected ok=false for empty string")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParseRetryAfter_MaxCap(t *testing.T) {
|
|
||||||
// Verify that parseRetryAfter returns the raw value (capping is done by caller).
|
|
||||||
c := NewClient("tok", "")
|
|
||||||
delay, ok := c.parseRetryAfter("3600")
|
|
||||||
if !ok {
|
|
||||||
t.Fatal("expected ok=true")
|
|
||||||
}
|
|
||||||
if delay != 3600*time.Second {
|
|
||||||
t.Errorf("delay = %v, want 3600s (caller is responsible for capping)", delay)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAPIError_Error_Truncation(t *testing.T) {
|
|
||||||
longBody := make([]byte, 300)
|
|
||||||
for i := range longBody {
|
|
||||||
longBody[i] = 'x'
|
|
||||||
}
|
|
||||||
apiErr := &APIError{StatusCode: 500, Body: string(longBody)}
|
|
||||||
msg := apiErr.Error()
|
|
||||||
if len(msg) > 250 {
|
|
||||||
// "HTTP 500: " (10) + 200 + "...(truncated)" (14) = 224
|
|
||||||
t.Errorf("error message too long: %d chars", len(msg))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAPIError_Error_NewlineSanitized(t *testing.T) {
|
|
||||||
apiErr := &APIError{StatusCode: 400, Body: "line1\nline2\rline3"}
|
|
||||||
msg := apiErr.Error()
|
|
||||||
for _, c := range msg {
|
|
||||||
if c == '\n' || c == '\r' {
|
|
||||||
t.Errorf("error message contains unsanitized newline: %q", msg)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNewClient_HasCheckRedirect(t *testing.T) {
|
|
||||||
c := NewClient("secret-token", "https://api.github.com")
|
|
||||||
if c.httpClient.CheckRedirect == nil {
|
|
||||||
t.Fatal("expected CheckRedirect to be set")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsHTTPSToHTTP(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "http", Host: "api.github.com", Path: "/foo"},
|
|
||||||
Header: http.Header{"Authorization": []string{"Bearer token"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error on HTTPS->HTTP redirect")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "HTTPS to HTTP downgrade") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsCrossHost(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "https", Host: "objects.githubusercontent.com", Path: "/bar"},
|
|
||||||
Header: http.Header{"Authorization": []string{"Bearer token"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error on cross-host redirect")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "cross-host") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_AllowsSameHost(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/bar"},
|
|
||||||
Header: http.Header{"Authorization": []string{"Bearer token"}},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
// Auth should be preserved on same-host redirect
|
|
||||||
if auth := req.Header.Get("Authorization"); auth != "Bearer token" {
|
|
||||||
t.Errorf("expected Authorization to be preserved, got %q", auth)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_AllowsSameHostHTTPToHTTP(t *testing.T) {
|
|
||||||
prev := &http.Request{URL: &url.URL{Scheme: "http", Host: "localhost:8080", Path: "/foo"}}
|
|
||||||
req := &http.Request{
|
|
||||||
URL: &url.URL{Scheme: "http", Host: "localhost:8080", Path: "/bar"},
|
|
||||||
Header: http.Header{},
|
|
||||||
}
|
|
||||||
err := defaultCheckRedirect(req, []*http.Request{prev})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_RejectsTooManyRedirects(t *testing.T) {
|
|
||||||
via := make([]*http.Request, 10)
|
|
||||||
for i := range via {
|
|
||||||
via[i] = &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/"}}
|
|
||||||
}
|
|
||||||
req := &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/final"}}
|
|
||||||
err := defaultCheckRedirect(req, via)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error after 10 redirects")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "10 redirects") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDefaultCheckRedirect_EmptyViaAllowed(t *testing.T) {
|
|
||||||
req := &http.Request{URL: &url.URL{Scheme: "https", Host: "api.github.com", Path: "/foo"}}
|
|
||||||
err := defaultCheckRedirect(req, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error with empty via: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSetHTTPClient_NilRestoresDefault(t *testing.T) {
|
|
||||||
c := NewClient("token", "https://api.github.com")
|
|
||||||
c.SetHTTPClient(nil)
|
|
||||||
if c.httpClient == nil {
|
|
||||||
t.Fatal("expected non-nil httpClient after SetHTTPClient(nil)")
|
|
||||||
}
|
|
||||||
if c.httpClient.Timeout != 30*time.Second {
|
|
||||||
t.Errorf("expected 30s timeout, got %v", c.httpClient.Timeout)
|
|
||||||
}
|
|
||||||
if c.httpClient.CheckRedirect == nil {
|
|
||||||
t.Fatal("expected CheckRedirect policy after SetHTTPClient(nil)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAllowInsecureHTTPForTest_PermitsHTTP(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("ok"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "ok" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "ok")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNoInsecureOption_RejectsHTTP(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
t.Fatal("request should not have been sent")
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL)
|
|
||||||
_, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for HTTP request without AllowInsecureHTTP")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "refusing HTTP request") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNoInsecureOption_RejectsUppercaseHTTP(t *testing.T) {
|
|
||||||
// Verify case-insensitive scheme check (RFC 3986).
|
|
||||||
c := NewClient("tok", "HTTP://127.0.0.1:1")
|
|
||||||
_, err := c.doGet(context.Background(), "HTTP://127.0.0.1:1/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for uppercase HTTP scheme")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "refusing HTTP request") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNoInsecureOption_RejectsMixedCaseHTTP(t *testing.T) {
|
|
||||||
// Verify mixed case like "Http://" is also rejected.
|
|
||||||
c := NewClient("tok", "Http://127.0.0.1:1")
|
|
||||||
_, err := c.doGet(context.Background(), "Http://127.0.0.1:1/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for mixed-case HTTP scheme")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "refusing HTTP request") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAllowInsecureHTTP_WithoutEnvVar_Rejected(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
t.Fatal("request should not have been sent")
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
t.Setenv("REVIEW_BOT_ALLOW_INSECURE", "")
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTP())
|
|
||||||
_, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error: AllowInsecureHTTP without env var should be rejected")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "refusing HTTP request") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAllowInsecureHTTP_WithEnvVar_Permitted(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
w.Write([]byte("insecure-ok"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
t.Setenv("REVIEW_BOT_ALLOW_INSECURE", "1")
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTP())
|
|
||||||
body, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(body) != "insecure-ok" {
|
|
||||||
t.Errorf("body = %q, want %q", body, "insecure-ok")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAllowInsecureHTTP_EnvVarNotOne_Rejected(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
t.Fatal("request should not have been sent")
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
// "true" is not "1" — strict check
|
|
||||||
t.Setenv("REVIEW_BOT_ALLOW_INSECURE", "true")
|
|
||||||
|
|
||||||
c := NewClient("tok", srv.URL, AllowInsecureHTTP())
|
|
||||||
_, err := c.doGet(context.Background(), srv.URL+"/test")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error: env var 'true' is not '1'")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "refusing HTTP request") {
|
|
||||||
t.Errorf("unexpected error message: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRedactURL_WithQuery(t *testing.T) {
|
|
||||||
got := redactURL("http://localhost:1234/path?secret=token&foo=bar")
|
|
||||||
want := "http://localhost:1234/path?<redacted>"
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("redactURL = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRedactURL_NoQuery(t *testing.T) {
|
|
||||||
got := redactURL("http://localhost:1234/path")
|
|
||||||
want := "http://localhost:1234/path"
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("redactURL = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRedactURL_Userinfo(t *testing.T) {
|
|
||||||
got := redactURL("http://user:pass@localhost:1234/path")
|
|
||||||
want := "http://localhost:1234/path"
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("redactURL = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRedactURL_UserinfoWithQuery(t *testing.T) {
|
|
||||||
got := redactURL("http://user:pass@localhost:1234/path?secret=token")
|
|
||||||
want := "http://localhost:1234/path?<redacted>"
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("redactURL = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
package github
|
|
||||||
|
|
||||||
// AllowInsecureHTTPForTest permits sending credentials over plaintext HTTP
|
|
||||||
// without requiring the REVIEW_BOT_ALLOW_INSECURE environment variable.
|
|
||||||
// This is intended exclusively for test code using httptest.Server.
|
|
||||||
//
|
|
||||||
// Defined in a _test.go file so it is only available to test binaries.
|
|
||||||
func AllowInsecureHTTPForTest() ClientOption {
|
|
||||||
return func(cfg *clientConfig) {
|
|
||||||
cfg.allowInsecureHTTP = true
|
|
||||||
cfg.insecureIsTestBypass = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,552 +0,0 @@
|
|||||||
// Package github provides a client for the GitHub API.
|
|
||||||
// This file contains the higher-level PR/review methods built on top of the
|
|
||||||
// HTTP client in client.go. All methods use GitHub REST API v3 paths.
|
|
||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// PullRequest holds relevant PR metadata.
|
|
||||||
type PullRequest struct {
|
|
||||||
Title string `json:"title"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
Head struct {
|
|
||||||
Sha string `json:"sha"`
|
|
||||||
Ref string `json:"ref"`
|
|
||||||
} `json:"head"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// CommitStatus represents a single CI status entry.
|
|
||||||
// GitHub uses "state" (success/failure/pending/error) unlike Gitea's "status".
|
|
||||||
type CommitStatus struct {
|
|
||||||
State string `json:"state"`
|
|
||||||
Context string `json:"context"`
|
|
||||||
Description string `json:"description"`
|
|
||||||
TargetURL string `json:"target_url"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ChangedFile represents a file modified in a PR.
|
|
||||||
type ChangedFile struct {
|
|
||||||
Filename string `json:"filename"`
|
|
||||||
Status string `json:"status"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReviewComment represents an inline comment to attach to a review.
|
|
||||||
// GitHub uses "path" + "position" or "line" for positioning.
|
|
||||||
type ReviewComment struct {
|
|
||||||
ID int64 `json:"id,omitempty"`
|
|
||||||
Path string `json:"path"`
|
|
||||||
// Position is the line position in the diff (used when submitting).
|
|
||||||
// Side+Line is an alternative for GitHub (line in the file), but
|
|
||||||
// we mirror the Gitea interface using NewPosition mapped to position.
|
|
||||||
Position int64 `json:"position,omitempty"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContentEntry represents a file or directory entry from the contents API.
|
|
||||||
type ContentEntry struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Path string `json:"path"`
|
|
||||||
Type string `json:"type"` // "file" or "dir"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Review represents a pull request review.
|
|
||||||
type Review struct {
|
|
||||||
ID int64 `json:"id"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
User struct {
|
|
||||||
Login string `json:"login"`
|
|
||||||
} `json:"user"`
|
|
||||||
State string `json:"state"`
|
|
||||||
CommitID string `json:"commit_id"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPullRequest fetches PR metadata.
|
|
||||||
func (c *Client) GetPullRequest(ctx context.Context, owner, repo string, number int) (*PullRequest, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("fetch PR: %w", err)
|
|
||||||
}
|
|
||||||
var pr PullRequest
|
|
||||||
if err := json.Unmarshal(body, &pr); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse PR JSON: %w", err)
|
|
||||||
}
|
|
||||||
return &pr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPullRequestDiff fetches the unified diff for a PR.
|
|
||||||
func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number)
|
|
||||||
body, err := c.doRequest(ctx, http.MethodGet, reqURL, "application/vnd.github.v3.diff")
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("fetch diff: %w", err)
|
|
||||||
}
|
|
||||||
return string(body), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPullRequestFiles fetches the list of files changed in a PR.
|
|
||||||
// GitHub paginates at 30 files/page (max 3000 files total).
|
|
||||||
func (c *Client) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]ChangedFile, error) {
|
|
||||||
const perPage = 100
|
|
||||||
var all []ChangedFile
|
|
||||||
for page := 1; ; page++ {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/files?per_page=%d&page=%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number,
|
|
||||||
perPage,
|
|
||||||
page)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("fetch PR files (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
var batch []ChangedFile
|
|
||||||
if err := json.Unmarshal(body, &batch); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse PR files JSON (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
all = append(all, batch...)
|
|
||||||
if len(batch) < perPage {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return all, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetCommitStatuses fetches CI statuses for a commit SHA.
|
|
||||||
// GitHub's combined status endpoint returns the most-relevant state per context.
|
|
||||||
func (c *Client) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]CommitStatus, error) {
|
|
||||||
const perPage = 100
|
|
||||||
var all []CommitStatus
|
|
||||||
for page := 1; ; page++ {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/commits/%s/statuses?per_page=%d&page=%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
url.PathEscape(sha),
|
|
||||||
perPage,
|
|
||||||
page)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("fetch commit statuses: %w", err)
|
|
||||||
}
|
|
||||||
var batch []CommitStatus
|
|
||||||
if err := json.Unmarshal(body, &batch); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse statuses JSON: %w", err)
|
|
||||||
}
|
|
||||||
all = append(all, batch...)
|
|
||||||
if len(batch) < perPage {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return all, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetFileContent fetches a file from the default branch of a repo.
|
|
||||||
// GitHub's contents API returns base64-encoded content.
|
|
||||||
func (c *Client) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
|
||||||
return c.GetFileContentRef(ctx, owner, repo, filepath, "")
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetFileContentRef fetches a file from a specific ref (branch/tag/sha) in a repo.
|
|
||||||
func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/contents/%s",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
escapePath(filepath))
|
|
||||||
if ref != "" {
|
|
||||||
reqURL += "?ref=" + url.QueryEscape(ref)
|
|
||||||
}
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("fetch file %s: %w", filepath, err)
|
|
||||||
}
|
|
||||||
// GitHub returns JSON with base64-encoded content
|
|
||||||
var result struct {
|
|
||||||
Content string `json:"content"`
|
|
||||||
Encoding string `json:"encoding"`
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(body, &result); err != nil {
|
|
||||||
return "", fmt.Errorf("parse file content JSON: %w", err)
|
|
||||||
}
|
|
||||||
if result.Encoding != "base64" {
|
|
||||||
return "", fmt.Errorf("unexpected encoding %q for file %s", result.Encoding, filepath)
|
|
||||||
}
|
|
||||||
// GitHub wraps base64 content in newlines — strip them before decoding
|
|
||||||
cleaned := strings.ReplaceAll(result.Content, "\n", "")
|
|
||||||
decoded, err := base64.StdEncoding.DecodeString(cleaned)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("decode file content: %w", err)
|
|
||||||
}
|
|
||||||
return string(decoded), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListContents lists files and directories at a given path in a repo.
|
|
||||||
// Pass an empty path to list the repository root.
|
|
||||||
func (c *Client) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
|
||||||
if path == "." {
|
|
||||||
path = ""
|
|
||||||
}
|
|
||||||
var reqURL string
|
|
||||||
if path == "" {
|
|
||||||
reqURL = fmt.Sprintf("%s/repos/%s/%s/contents",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo))
|
|
||||||
} else {
|
|
||||||
reqURL = fmt.Sprintf("%s/repos/%s/%s/contents/%s",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), escapePath(path))
|
|
||||||
}
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("list contents %s: %w", path, err)
|
|
||||||
}
|
|
||||||
var entries []ContentEntry
|
|
||||||
if err := json.Unmarshal(body, &entries); err != nil {
|
|
||||||
// GitHub also returns a single object when path is a file
|
|
||||||
var single ContentEntry
|
|
||||||
if err2 := json.Unmarshal(body, &single); err2 != nil {
|
|
||||||
return nil, fmt.Errorf("parse contents JSON: %w", err)
|
|
||||||
}
|
|
||||||
if single.Name == "" && single.Path == "" {
|
|
||||||
return nil, fmt.Errorf("parse contents JSON: empty response for path %q", path)
|
|
||||||
}
|
|
||||||
entries = []ContentEntry{single}
|
|
||||||
}
|
|
||||||
return entries, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAllFilesInPath recursively fetches all file contents under a path.
|
|
||||||
// If the path is a file, returns just that file's content.
|
|
||||||
func (c *Client) GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error) {
|
|
||||||
results := make(map[string]string)
|
|
||||||
|
|
||||||
entries, err := c.ListContents(ctx, owner, repo, path)
|
|
||||||
if err != nil {
|
|
||||||
if IsNotFound(err) {
|
|
||||||
// Try fetching as a file directly
|
|
||||||
content, fileErr := c.GetFileContent(ctx, owner, repo, path)
|
|
||||||
if fileErr != nil {
|
|
||||||
return nil, fmt.Errorf("path %q is neither a file nor directory: %w", path, fileErr)
|
|
||||||
}
|
|
||||||
results[path] = content
|
|
||||||
return results, nil
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("list contents %q: %w", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, entry := range entries {
|
|
||||||
switch entry.Type {
|
|
||||||
case "file":
|
|
||||||
content, err := c.GetFileContent(ctx, owner, repo, entry.Path)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not fetch file from patterns repo", "file", entry.Path, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
results[entry.Path] = content
|
|
||||||
case "dir":
|
|
||||||
subResults, err := c.GetAllFilesInPath(ctx, owner, repo, entry.Path)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not recurse into directory", "dir", entry.Path, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
for k, v := range subResults {
|
|
||||||
results[k] = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return results, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// PostReview submits a review to a PR and returns the created review.
|
|
||||||
// event should be "APPROVE", "REQUEST_CHANGES", or "COMMENT".
|
|
||||||
// commitID anchors the review to a specific commit SHA.
|
|
||||||
// comments are optional inline comments.
|
|
||||||
//
|
|
||||||
// Note: GitHub uses "APPROVE" (not "APPROVED") for the event name.
|
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []ReviewComment) (*Review, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number)
|
|
||||||
|
|
||||||
// GitHub uses "APPROVE" not "APPROVED", "REQUEST_CHANGES" and "COMMENT" match
|
|
||||||
ghEvent := event
|
|
||||||
if event == "APPROVED" {
|
|
||||||
ghEvent = "APPROVE"
|
|
||||||
}
|
|
||||||
|
|
||||||
payload := struct {
|
|
||||||
Body string `json:"body"`
|
|
||||||
Event string `json:"event"`
|
|
||||||
CommitID string `json:"commit_id,omitempty"`
|
|
||||||
Comments []ReviewComment `json:"comments,omitempty"`
|
|
||||||
}{
|
|
||||||
Body: body,
|
|
||||||
Event: ghEvent,
|
|
||||||
CommitID: commitID,
|
|
||||||
Comments: comments,
|
|
||||||
}
|
|
||||||
|
|
||||||
data, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("marshal review payload: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqURL, bytes.NewReader(data))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("create review request: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("post review: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
respBody, _ := io.ReadAll(io.LimitReader(resp.Body, 64*1024))
|
|
||||||
return nil, fmt.Errorf("post review failed (status %d): %s", resp.StatusCode, string(respBody))
|
|
||||||
}
|
|
||||||
|
|
||||||
respBody, err := io.ReadAll(io.LimitReader(resp.Body, 10*1024*1024))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("read review response: %w", err)
|
|
||||||
}
|
|
||||||
var review Review
|
|
||||||
if err := json.Unmarshal(respBody, &review); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse review response: %w", err)
|
|
||||||
}
|
|
||||||
return &review, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListReviews returns all reviews on a pull request.
|
|
||||||
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]Review, error) {
|
|
||||||
const perPage = 100
|
|
||||||
var all []Review
|
|
||||||
for page := 1; ; page++ {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews?per_page=%d&page=%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number,
|
|
||||||
perPage,
|
|
||||||
page)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("list reviews (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
var batch []Review
|
|
||||||
if err := json.Unmarshal(body, &batch); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse reviews (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
all = append(all, batch...)
|
|
||||||
if len(batch) < perPage {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return all, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeleteReview deletes a review by ID.
|
|
||||||
func (c *Client) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number,
|
|
||||||
reviewID)
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, reqURL, nil)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("create delete request: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("delete review: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
respBody, _ := io.ReadAll(io.LimitReader(resp.Body, 256))
|
|
||||||
return fmt.Errorf("delete review failed (status %d): %s", resp.StatusCode, string(respBody))
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAuthenticatedUser returns the login of the user authenticated by the token.
|
|
||||||
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/user", c.baseURL)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("get authenticated user: %w", err)
|
|
||||||
}
|
|
||||||
var result struct {
|
|
||||||
Login string `json:"login"`
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(body, &result); err != nil {
|
|
||||||
return "", fmt.Errorf("parse user response: %w", err)
|
|
||||||
}
|
|
||||||
return result.Login, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequestReviewer adds the given user as a requested reviewer on a pull request.
|
|
||||||
// This is idempotent on GitHub — requesting an already-requested reviewer succeats.
|
|
||||||
func (c *Client) RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/requested_reviewers",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
number)
|
|
||||||
|
|
||||||
payload := struct {
|
|
||||||
Reviewers []string `json:"reviewers"`
|
|
||||||
}{Reviewers: []string{reviewer}}
|
|
||||||
data, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("marshal reviewer request: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqURL, bytes.NewReader(data))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("create reviewer request: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("request reviewer: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
respBody, _ := io.ReadAll(io.LimitReader(resp.Body, 256))
|
|
||||||
return fmt.Errorf("request reviewer failed (status %d): %s", resp.StatusCode, string(respBody))
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// EditComment updates the body of a PR review comment.
|
|
||||||
// GitHub uses PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}.
|
|
||||||
func (c *Client) EditComment(ctx context.Context, owner, repo string, commentID int64, newBody string) error {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/comments/%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
commentID)
|
|
||||||
|
|
||||||
payload := struct {
|
|
||||||
Body string `json:"body"`
|
|
||||||
}{Body: newBody}
|
|
||||||
data, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("marshal edit payload: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPatch, reqURL, bytes.NewReader(data))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("create edit request: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("edit comment: %w", err)
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
body, _ := io.ReadAll(io.LimitReader(resp.Body, 256))
|
|
||||||
return fmt.Errorf("edit comment failed (status %d): %s", resp.StatusCode, body)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListReviewComments returns the inline comments attached to a specific review.
|
|
||||||
func (c *Client) ListReviewComments(ctx context.Context, owner, repo string, prNumber int, reviewID int64) ([]ReviewComment, error) {
|
|
||||||
const perPage = 100
|
|
||||||
var all []ReviewComment
|
|
||||||
for page := 1; ; page++ {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d/comments?per_page=%d&page=%d",
|
|
||||||
c.baseURL,
|
|
||||||
url.PathEscape(owner),
|
|
||||||
url.PathEscape(repo),
|
|
||||||
prNumber,
|
|
||||||
reviewID,
|
|
||||||
perPage,
|
|
||||||
page)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("list review comments (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
var batch []ReviewComment
|
|
||||||
if err := json.Unmarshal(body, &batch); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse review comments (page %d): %w", page, err)
|
|
||||||
}
|
|
||||||
all = append(all, batch...)
|
|
||||||
if len(batch) < perPage {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return all, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResolveComment is a no-op on GitHub. GitHub does not support resolving
|
|
||||||
// individual review comments via the REST API (only via the GraphQL API).
|
|
||||||
// This method exists to satisfy the VCSClient interface.
|
|
||||||
func (c *Client) ResolveComment(_ context.Context, _, _ string, _ int64) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetTimelineReviewCommentIDForReview finds the timeline comment ID for a review.
|
|
||||||
// GitHub doesn't have a direct timeline event endpoint for reviews the way Gitea does.
|
|
||||||
// This is primarily used by the supersede path (EditComment + ResolveComment). On GitHub,
|
|
||||||
// we return the review ID itself. Note that EditComment on GitHub uses the
|
|
||||||
// /pulls/comments/{id} endpoint (for inline review comments), which does not
|
|
||||||
// apply to review bodies — the supersede EditComment call will 404 and be
|
|
||||||
// logged as a warning. This is a known limitation; the review is still posted
|
|
||||||
// correctly regardless.
|
|
||||||
func (c *Client) GetTimelineReviewCommentIDForReview(_ context.Context, _, _ string, _ int, reviewID int64) (int64, error) {
|
|
||||||
return reviewID, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapePath escapes each path segment individually while preserving slashes.
|
|
||||||
// This avoids double-escaping the forward slash separator in file paths.
|
|
||||||
// NOTE: Intentionally duplicated from gitea/client.go to keep the packages independent.
|
|
||||||
func escapePath(p string) string {
|
|
||||||
parts := strings.Split(p, "/")
|
|
||||||
escaped := make([]string, len(parts))
|
|
||||||
for i, part := range parts {
|
|
||||||
escaped[i] = url.PathEscape(part)
|
|
||||||
}
|
|
||||||
return strings.Join(escaped, "/")
|
|
||||||
}
|
|
||||||
@@ -1,518 +0,0 @@
|
|||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// newTestClient creates a Client pointed at the test server.
|
|
||||||
func newTestClient(srv *httptest.Server) *Client {
|
|
||||||
return NewClient("test-token", srv.URL, AllowInsecureHTTPForTest())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetPullRequest(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method != http.MethodGet || r.URL.Path != "/repos/owner/repo/pulls/42" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if got := r.Header.Get("Authorization"); got != "Bearer test-token" {
|
|
||||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `{"title":"Fix bug","body":"Body text","head":{"sha":"abc1234","ref":"fix/bug"}}`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
pr, err := c.GetPullRequest(context.Background(), "owner", "repo", 42)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetPullRequest: %v", err)
|
|
||||||
}
|
|
||||||
if pr.Title != "Fix bug" {
|
|
||||||
t.Errorf("Title = %q, want %q", pr.Title, "Fix bug")
|
|
||||||
}
|
|
||||||
if pr.Head.Sha != "abc1234" {
|
|
||||||
t.Errorf("Head.Sha = %q, want %q", pr.Head.Sha, "abc1234")
|
|
||||||
}
|
|
||||||
if pr.Head.Ref != "fix/bug" {
|
|
||||||
t.Errorf("Head.Ref = %q, want %q", pr.Head.Ref, "fix/bug")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetPullRequest_NotFound(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
http.Error(w, `{"message":"Not Found"}`, http.StatusNotFound)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
_, err := c.GetPullRequest(context.Background(), "owner", "repo", 99)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for 404, got nil")
|
|
||||||
}
|
|
||||||
if !IsNotFound(err) {
|
|
||||||
t.Errorf("expected IsNotFound error, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetPullRequestDiff(t *testing.T) {
|
|
||||||
diffText := "diff --git a/foo.go b/foo.go\n@@ -1,1 +1,2 @@\n+added"
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/pulls/1" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if r.Header.Get("Accept") != "application/vnd.github.v3.diff" {
|
|
||||||
http.Error(w, "wrong accept", http.StatusNotAcceptable)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "text/plain")
|
|
||||||
fmt.Fprint(w, diffText)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
got, err := c.GetPullRequestDiff(context.Background(), "owner", "repo", 1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetPullRequestDiff: %v", err)
|
|
||||||
}
|
|
||||||
if got != diffText {
|
|
||||||
t.Errorf("diff = %q, want %q", got, diffText)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetPullRequestFiles(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/pulls/5/files" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"filename":"foo.go","status":"added"},{"filename":"bar.go","status":"modified"}]`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
files, err := c.GetPullRequestFiles(context.Background(), "owner", "repo", 5)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetPullRequestFiles: %v", err)
|
|
||||||
}
|
|
||||||
if len(files) != 2 {
|
|
||||||
t.Fatalf("len(files) = %d, want 2", len(files))
|
|
||||||
}
|
|
||||||
if files[0].Filename != "foo.go" || files[0].Status != "added" {
|
|
||||||
t.Errorf("files[0] = %+v", files[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetCommitStatuses(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/commits/deadbeef/statuses" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"state":"success","context":"ci/test","description":"Tests passed","target_url":"https://ci.example.com"}]`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
statuses, err := c.GetCommitStatuses(context.Background(), "owner", "repo", "deadbeef")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetCommitStatuses: %v", err)
|
|
||||||
}
|
|
||||||
if len(statuses) != 1 {
|
|
||||||
t.Fatalf("len(statuses) = %d, want 1", len(statuses))
|
|
||||||
}
|
|
||||||
if statuses[0].State != "success" {
|
|
||||||
t.Errorf("State = %q, want success", statuses[0].State)
|
|
||||||
}
|
|
||||||
if statuses[0].Context != "ci/test" {
|
|
||||||
t.Errorf("Context = %q, want ci/test", statuses[0].Context)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetFileContent(t *testing.T) {
|
|
||||||
content := "package main\nfunc main() {}\n"
|
|
||||||
encoded := base64.StdEncoding.EncodeToString([]byte(content))
|
|
||||||
// GitHub wraps base64 in newlines every 60 chars
|
|
||||||
var chunked string
|
|
||||||
for i := 0; i < len(encoded); i += 60 {
|
|
||||||
end := i + 60
|
|
||||||
if end > len(encoded) {
|
|
||||||
end = len(encoded)
|
|
||||||
}
|
|
||||||
chunked += encoded[i:end] + "\n"
|
|
||||||
}
|
|
||||||
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/contents/main.go" {
|
|
||||||
http.Error(w, "unexpected path: "+r.URL.Path, http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
resp := map[string]string{
|
|
||||||
"content": chunked,
|
|
||||||
"encoding": "base64",
|
|
||||||
}
|
|
||||||
if err := json.NewEncoder(w).Encode(resp); err != nil {
|
|
||||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
got, err := c.GetFileContent(context.Background(), "owner", "repo", "main.go")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetFileContent: %v", err)
|
|
||||||
}
|
|
||||||
if got != content {
|
|
||||||
t.Errorf("content = %q, want %q", got, content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetFileContentRef(t *testing.T) {
|
|
||||||
content := "hello world"
|
|
||||||
encoded := base64.StdEncoding.EncodeToString([]byte(content))
|
|
||||||
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/contents/README.md" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if r.URL.Query().Get("ref") != "abc123" {
|
|
||||||
http.Error(w, "missing ref", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
resp := map[string]string{"content": encoded + "\n", "encoding": "base64"}
|
|
||||||
if err := json.NewEncoder(w).Encode(resp); err != nil {
|
|
||||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
got, err := c.GetFileContentRef(context.Background(), "owner", "repo", "README.md", "abc123")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetFileContentRef: %v", err)
|
|
||||||
}
|
|
||||||
if got != content {
|
|
||||||
t.Errorf("content = %q, want %q", got, content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestListContents(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path == "/repos/owner/repo/contents" {
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"name":"README.md","path":"README.md","type":"file"},{"name":"src","path":"src","type":"dir"}]`)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
http.Error(w, "unexpected: "+r.URL.Path, http.StatusNotFound)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
entries, err := c.ListContents(context.Background(), "owner", "repo", "")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ListContents: %v", err)
|
|
||||||
}
|
|
||||||
if len(entries) != 2 {
|
|
||||||
t.Fatalf("len(entries) = %d, want 2", len(entries))
|
|
||||||
}
|
|
||||||
if entries[0].Name != "README.md" || entries[0].Type != "file" {
|
|
||||||
t.Errorf("entries[0] = %+v", entries[0])
|
|
||||||
}
|
|
||||||
if entries[1].Name != "src" || entries[1].Type != "dir" {
|
|
||||||
t.Errorf("entries[1] = %+v", entries[1])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestListContents_Dot(t *testing.T) {
|
|
||||||
// "." should be treated as "" (root)
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path == "/repos/owner/repo/contents" {
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[]`)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
http.Error(w, "unexpected: "+r.URL.Path, http.StatusNotFound)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
entries, err := c.ListContents(context.Background(), "owner", "repo", ".")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ListContents: %v", err)
|
|
||||||
}
|
|
||||||
if len(entries) != 0 {
|
|
||||||
t.Errorf("expected empty entries, got %d", len(entries))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPostReview(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method != http.MethodPost || r.URL.Path != "/repos/owner/repo/pulls/10/reviews" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var payload struct {
|
|
||||||
Body string `json:"body"`
|
|
||||||
Event string `json:"event"`
|
|
||||||
CommitID string `json:"commit_id"`
|
|
||||||
}
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
|
|
||||||
http.Error(w, "bad body", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
// Verify APPROVED is normalized to APPROVE
|
|
||||||
if payload.Event != "APPROVE" {
|
|
||||||
http.Error(w, fmt.Sprintf("expected APPROVE, got %s", payload.Event), http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
fmt.Fprintf(w, `{"id":99,"body":%q,"user":{"login":"bot"},"state":"APPROVED","commit_id":%q}`, payload.Body, payload.CommitID)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
// Pass "APPROVED" (Gitea-style) — should be normalized to APPROVE
|
|
||||||
review, err := c.PostReview(context.Background(), "owner", "repo", 10, "APPROVED", "Looks good", "abc123", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("PostReview: %v", err)
|
|
||||||
}
|
|
||||||
if review.ID != 99 {
|
|
||||||
t.Errorf("review.ID = %d, want 99", review.ID)
|
|
||||||
}
|
|
||||||
if review.User.Login != "bot" {
|
|
||||||
t.Errorf("review.User.Login = %q, want bot", review.User.Login)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestListReviews(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/pulls/7/reviews" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"id":1,"body":"LGTM","user":{"login":"alice"},"state":"APPROVED","commit_id":"abc"}]`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 7)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ListReviews: %v", err)
|
|
||||||
}
|
|
||||||
if len(reviews) != 1 {
|
|
||||||
t.Fatalf("len(reviews) = %d, want 1", len(reviews))
|
|
||||||
}
|
|
||||||
if reviews[0].User.Login != "alice" {
|
|
||||||
t.Errorf("User.Login = %q, want alice", reviews[0].User.Login)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetAuthenticatedUser(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/user" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `{"login":"sonnet-review"}`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
login, err := c.GetAuthenticatedUser(context.Background())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetAuthenticatedUser: %v", err)
|
|
||||||
}
|
|
||||||
if login != "sonnet-review" {
|
|
||||||
t.Errorf("login = %q, want sonnet-review", login)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveComment_NoOp(t *testing.T) {
|
|
||||||
// ResolveComment is a no-op on GitHub — should not make any HTTP call.
|
|
||||||
callCount := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
callCount++
|
|
||||||
http.Error(w, "unexpected call", http.StatusInternalServerError)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
if err := c.ResolveComment(context.Background(), "owner", "repo", 123); err != nil {
|
|
||||||
t.Errorf("ResolveComment: %v (expected no-op)", err)
|
|
||||||
}
|
|
||||||
if callCount != 0 {
|
|
||||||
t.Errorf("expected no HTTP calls, got %d", callCount)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetTimelineReviewCommentIDForReview(t *testing.T) {
|
|
||||||
// Should return reviewID unchanged without making HTTP calls.
|
|
||||||
callCount := 0
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
callCount++
|
|
||||||
http.Error(w, "unexpected", http.StatusInternalServerError)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
got, err := c.GetTimelineReviewCommentIDForReview(context.Background(), "owner", "repo", 5, 42)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetTimelineReviewCommentIDForReview: %v", err)
|
|
||||||
}
|
|
||||||
if got != 42 {
|
|
||||||
t.Errorf("got %d, want 42", got)
|
|
||||||
}
|
|
||||||
if callCount != 0 {
|
|
||||||
t.Errorf("expected no HTTP calls, got %d", callCount)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRequestReviewer(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method != http.MethodPost || r.URL.Path != "/repos/owner/repo/pulls/3/requested_reviewers" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var payload struct {
|
|
||||||
Reviewers []string `json:"reviewers"`
|
|
||||||
}
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil || len(payload.Reviewers) == 0 {
|
|
||||||
http.Error(w, "bad body", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if payload.Reviewers[0] != "bot-user" {
|
|
||||||
http.Error(w, fmt.Sprintf("unexpected reviewer %q", payload.Reviewers[0]), http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusCreated)
|
|
||||||
fmt.Fprintln(w, `{}`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
if err := c.RequestReviewer(context.Background(), "owner", "repo", 3, "bot-user"); err != nil {
|
|
||||||
t.Errorf("RequestReviewer: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEditComment(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method != http.MethodPatch || r.URL.Path != "/repos/owner/repo/pulls/comments/55" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var payload struct {
|
|
||||||
Body string `json:"body"`
|
|
||||||
}
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
|
|
||||||
http.Error(w, "bad body", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if payload.Body != "updated body" {
|
|
||||||
http.Error(w, "wrong body", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
fmt.Fprintln(w, `{"id":55,"body":"updated body"}`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
if err := c.EditComment(context.Background(), "owner", "repo", 55, "updated body"); err != nil {
|
|
||||||
t.Errorf("EditComment: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestListReviewComments(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.URL.Path != "/repos/owner/repo/pulls/9/reviews/20/comments" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"id":100,"path":"main.go","position":5,"body":"Needs fix"}]`)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
comments, err := c.ListReviewComments(context.Background(), "owner", "repo", 9, 20)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ListReviewComments: %v", err)
|
|
||||||
}
|
|
||||||
if len(comments) != 1 {
|
|
||||||
t.Fatalf("len(comments) = %d, want 1", len(comments))
|
|
||||||
}
|
|
||||||
if comments[0].Path != "main.go" {
|
|
||||||
t.Errorf("Path = %q, want main.go", comments[0].Path)
|
|
||||||
}
|
|
||||||
if comments[0].Position != 5 {
|
|
||||||
t.Errorf("Position = %d, want 5", comments[0].Position)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDeleteReview(t *testing.T) {
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method != http.MethodDelete || r.URL.Path != "/repos/owner/repo/pulls/7/reviews/11" {
|
|
||||||
http.Error(w, "unexpected", http.StatusNotFound)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.WriteHeader(http.StatusNoContent)
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
if err := c.DeleteReview(context.Background(), "owner", "repo", 7, 11); err != nil {
|
|
||||||
t.Errorf("DeleteReview: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetAllFilesInPath(t *testing.T) {
|
|
||||||
content := "file content"
|
|
||||||
encoded := base64.StdEncoding.EncodeToString([]byte(content))
|
|
||||||
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
switch r.URL.Path {
|
|
||||||
case "/repos/owner/repo/contents/patterns":
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
fmt.Fprintln(w, `[{"name":"patterns.md","path":"patterns/patterns.md","type":"file"}]`)
|
|
||||||
case "/repos/owner/repo/contents/patterns/patterns.md":
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
resp := map[string]string{"content": encoded + "\n", "encoding": "base64"}
|
|
||||||
if err := json.NewEncoder(w).Encode(resp); err != nil {
|
|
||||||
http.Error(w, err.Error(), http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
http.Error(w, "unexpected: "+r.URL.Path, http.StatusNotFound)
|
|
||||||
}
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
|
|
||||||
c := newTestClient(srv)
|
|
||||||
files, err := c.GetAllFilesInPath(context.Background(), "owner", "repo", "patterns")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("GetAllFilesInPath: %v", err)
|
|
||||||
}
|
|
||||||
if len(files) != 1 {
|
|
||||||
t.Fatalf("len(files) = %d, want 1", len(files))
|
|
||||||
}
|
|
||||||
if files["patterns/patterns.md"] != content {
|
|
||||||
t.Errorf("content = %q, want %q", files["patterns/patterns.md"], content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -2,4 +2,4 @@ module gitea.weiker.me/rodin/review-bot
|
|||||||
|
|
||||||
go 1.26.2
|
go 1.26.2
|
||||||
|
|
||||||
require github.com/goccy/go-yaml v1.19.2
|
require gopkg.in/yaml.v3 v3.0.1
|
||||||
|
|||||||
@@ -1,2 +1,4 @@
|
|||||||
github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
|||||||
+8
-9
@@ -16,17 +16,16 @@ import (
|
|||||||
|
|
||||||
// Integration test requires a running Gitea instance and LLM endpoint.
|
// Integration test requires a running Gitea instance and LLM endpoint.
|
||||||
// Set environment variables:
|
// Set environment variables:
|
||||||
//
|
// INTEGRATION_GITEA_URL - Gitea base URL
|
||||||
// INTEGRATION_VCS_URL - VCS base URL
|
// INTEGRATION_GITEA_TOKEN - Gitea API token with repo access
|
||||||
// INTEGRATION_GITEA_TOKEN - Gitea API token with repo access
|
// INTEGRATION_GITEA_REPO - owner/repo with an open PR
|
||||||
// INTEGRATION_GITEA_REPO - owner/repo with an open PR
|
// INTEGRATION_PR_NUMBER - PR number to test against
|
||||||
// INTEGRATION_PR_NUMBER - PR number to test against
|
// INTEGRATION_LLM_BASE_URL - LLM API base URL
|
||||||
// INTEGRATION_LLM_BASE_URL - LLM API base URL
|
// INTEGRATION_LLM_API_KEY - LLM API key
|
||||||
// INTEGRATION_LLM_API_KEY - LLM API key
|
// INTEGRATION_LLM_MODEL - Model name
|
||||||
// INTEGRATION_LLM_MODEL - Model name
|
|
||||||
|
|
||||||
func TestIntegration_FullReviewFlow(t *testing.T) {
|
func TestIntegration_FullReviewFlow(t *testing.T) {
|
||||||
giteaURL := os.Getenv("INTEGRATION_VCS_URL")
|
giteaURL := os.Getenv("INTEGRATION_GITEA_URL")
|
||||||
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
giteaToken := os.Getenv("INTEGRATION_GITEA_TOKEN")
|
||||||
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
giteaRepo := os.Getenv("INTEGRATION_GITEA_REPO")
|
||||||
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
prNumStr := os.Getenv("INTEGRATION_PR_NUMBER")
|
||||||
|
|||||||
+38
-146
@@ -5,15 +5,12 @@ import (
|
|||||||
"embed"
|
"embed"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"os"
|
"os"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
|
|
||||||
"github.com/goccy/go-yaml"
|
"gopkg.in/yaml.v3"
|
||||||
"github.com/goccy/go-yaml/ast"
|
|
||||||
"github.com/goccy/go-yaml/parser"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
//go:embed personas/*.yaml
|
//go:embed personas/*.yaml
|
||||||
@@ -121,7 +118,9 @@ func ListBuiltinPersonas() []string {
|
|||||||
default:
|
default:
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
seen[personaName] = true
|
if !seen[personaName] {
|
||||||
|
seen[personaName] = true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
names := make([]string, 0, len(seen))
|
names := make([]string, 0, len(seen))
|
||||||
for name := range seen {
|
for name := range seen {
|
||||||
@@ -143,19 +142,10 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
err = unmarshalYAMLWithDepthLimit(data, &p, MaxYAMLDepth)
|
err = unmarshalYAMLWithDepthLimit(data, &p, MaxYAMLDepth)
|
||||||
} else {
|
} else {
|
||||||
// Use json.Decoder with DisallowUnknownFields for consistency with
|
// Use json.Decoder with DisallowUnknownFields for consistency with
|
||||||
// YAML's Strict() - both reject unknown fields to catch typos.
|
// YAML's KnownFields(true) - both reject unknown fields to catch typos.
|
||||||
dec := json.NewDecoder(bytes.NewReader(data))
|
dec := json.NewDecoder(bytes.NewReader(data))
|
||||||
dec.DisallowUnknownFields()
|
dec.DisallowUnknownFields()
|
||||||
err = dec.Decode(&p)
|
err = dec.Decode(&p)
|
||||||
if err == nil {
|
|
||||||
// Reject trailing content after the first valid JSON object.
|
|
||||||
// Without this check, input like `{"name":"x"}garbage` would
|
|
||||||
// silently succeed because Decoder stops after one object.
|
|
||||||
var dummy json.RawMessage
|
|
||||||
if err2 := dec.Decode(&dummy); err2 != io.EOF {
|
|
||||||
err = fmt.Errorf("unexpected trailing content after JSON object")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("parse persona %s: %w", source, err)
|
return nil, fmt.Errorf("parse persona %s: %w", source, err)
|
||||||
@@ -166,164 +156,70 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
return &p, nil
|
return &p, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// unmarshalYAMLWithDepthLimit unmarshals YAML data with three safety checks:
|
// unmarshalYAMLWithDepthLimit unmarshals YAML data with explicit depth limiting
|
||||||
// - Depth limiting: rejects AST trees exceeding maxDepth to prevent stack exhaustion.
|
// and strict field checking. This protects against stack exhaustion from deeply
|
||||||
// - Multi-document rejection: prevents silent data loss from ignored extra documents.
|
// nested structures and catches typos in field names.
|
||||||
// - Strict field checking: rejects unknown YAML keys to catch typos early.
|
// Multi-document YAML files are rejected to prevent silent data loss.
|
||||||
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
||||||
// First pass: parse into AST to check depth limits, node counts, and
|
// First pass: decode into a yaml.Node to check depth limits and node counts.
|
||||||
// multi-document rejection. This prevents stack exhaustion before we
|
// This prevents stack exhaustion before we attempt to decode into structs.
|
||||||
// attempt to decode into structs.
|
var node yaml.Node
|
||||||
file, err := parser.ParseBytes(data, 0)
|
dec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
if err != nil {
|
if err := dec.Decode(&node); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reject empty YAML input (whitespace-only, comment-only, or truly empty files).
|
|
||||||
// The parser returns a single doc with nil body for these cases.
|
|
||||||
if len(file.Docs) == 0 || file.Docs[0].Body == nil {
|
|
||||||
return fmt.Errorf("empty YAML document")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reject multi-document YAML files - silently ignoring additional documents
|
// Reject multi-document YAML files - silently ignoring additional documents
|
||||||
// could lead to confusing behavior where users think their changes take effect.
|
// could lead to confusing behavior where users think their changes take effect.
|
||||||
if len(file.Docs) > 1 {
|
var extra yaml.Node
|
||||||
|
if dec.Decode(&extra) == nil {
|
||||||
return fmt.Errorf("multi-document YAML is not supported; only single-document files are allowed")
|
return fmt.Errorf("multi-document YAML is not supported; only single-document files are allowed")
|
||||||
}
|
}
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
if err := checkYAMLDepth(file.Docs[0].Body, 0, maxDepth, MaxYAMLNodes, make(map[ast.Node]int), make(map[ast.Node]bool), &nodeCount); err != nil {
|
if err := checkYAMLDepth(&node, 0, maxDepth, MaxYAMLNodes, make(map[*yaml.Node]struct{}), &nodeCount); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Second pass: decode with strict field checking enabled.
|
// Second pass: decode with strict field checking enabled.
|
||||||
// Strict() rejects unknown keys, catching typos like "focuss" or "identiy".
|
// KnownFields(true) rejects unknown keys, catching typos like "focuss" or "identiy".
|
||||||
//
|
// We must re-decode from the original data because yaml.Node.Decode() doesn't
|
||||||
// Safety note: goccy/go-yaml's decoder does not expand YAML aliases
|
// support the KnownFields option.
|
||||||
// recursively — it resolves them via the pre-built AST, which our first
|
strictDec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
// pass already depth-checked. Alias chains that would exceed depth limits
|
strictDec.KnownFields(true)
|
||||||
// are caught above; the decoder merely reads the resolved scalar values.
|
return strictDec.Decode(out)
|
||||||
dec := yaml.NewDecoder(bytes.NewReader(data), yaml.Strict())
|
|
||||||
return dec.Decode(out)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkYAMLDepth recursively checks that YAML AST nodes don't exceed the depth
|
// checkYAMLDepth recursively checks that YAML nodes don't exceed the depth limit
|
||||||
// limit or the total node count limit. It uses two tracking maps:
|
// or the total node count limit. It also detects alias cycles to prevent infinite
|
||||||
// - validated: maps each node to the maximum depth at which it was previously
|
// recursion from crafted YAML with self-referential aliases.
|
||||||
// checked. If a node is revisited at a deeper depth (e.g., via an alias),
|
func checkYAMLDepth(node *yaml.Node, depth, maxDepth, maxNodes int, seen map[*yaml.Node]struct{}, nodeCount *int) error {
|
||||||
// we re-check it to ensure the combined effective depth doesn't exceed limits.
|
|
||||||
// - visiting: per-path recursion stack for true cycle detection. A node on the
|
|
||||||
// current path is a cycle (alias loop); we return nil to avoid infinite recursion.
|
|
||||||
//
|
|
||||||
// This design prevents the alias depth bypass where an anchored subtree validated
|
|
||||||
// at a shallow depth could be referenced via alias at a greater depth, effectively
|
|
||||||
// exceeding MaxYAMLDepth.
|
|
||||||
func checkYAMLDepth(node ast.Node, depth, maxDepth, maxNodes int, validated map[ast.Node]int, visiting map[ast.Node]bool, nodeCount *int) error {
|
|
||||||
if node == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if depth > maxDepth {
|
if depth > maxDepth {
|
||||||
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cycle detection: if we're currently visiting this node on the current
|
|
||||||
// recursion path, it's a cycle (e.g., alias pointing to an ancestor).
|
|
||||||
// Return nil to break the cycle without error — cycles are a structural
|
|
||||||
// property, not a depth violation.
|
|
||||||
if visiting[node] {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Track total nodes visited as defense-in-depth against wide-but-shallow attacks.
|
// Track total nodes visited as defense-in-depth against wide-but-shallow attacks.
|
||||||
// Placed after cycle detection but before the depth-aware short-circuit. This means
|
|
||||||
// nodes revisited at shallower depths (via aliases) are counted each time they are
|
|
||||||
// encountered — intentional conservative overcounting. This bounds the total work
|
|
||||||
// performed during validation rather than tracking unique nodes, which is the safer
|
|
||||||
// security posture for untrusted YAML input.
|
|
||||||
*nodeCount++
|
*nodeCount++
|
||||||
if *nodeCount > maxNodes {
|
if *nodeCount > maxNodes {
|
||||||
return fmt.Errorf("YAML node count exceeds maximum (%d)", maxNodes)
|
return fmt.Errorf("YAML node count exceeds maximum (%d)", maxNodes)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Depth-aware short-circuit: skip re-validation only when the current visit
|
// Cycle detection: if we've seen this node before, we're in a cycle.
|
||||||
// depth is the same or shallower than the depth at which this node was
|
if _, ok := seen[node]; ok {
|
||||||
// previously validated. A shallower (or equal) current depth means the
|
return nil // Already validated this subtree, skip to avoid infinite recursion.
|
||||||
// prior, deeper validation already covered any subtree depth violations.
|
|
||||||
// If the current depth exceeds the previous validation depth (e.g., an alias
|
|
||||||
// references this node deeper in the tree), we must re-traverse to ensure
|
|
||||||
// the combined effective depth doesn't exceed maxDepth.
|
|
||||||
//
|
|
||||||
// Note: using ast.Node (interface) as map key relies on pointer identity,
|
|
||||||
// which is correct because all goccy/go-yaml AST node types are pointer
|
|
||||||
// receivers (*MappingNode, *SequenceNode, etc.), never value types.
|
|
||||||
if prevDepth, ok := validated[node]; ok && depth <= prevDepth {
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
validated[node] = depth
|
seen[node] = struct{}{}
|
||||||
|
|
||||||
// Mark as visiting (on the current recursion path) for cycle detection.
|
// Handle alias nodes: follow the alias to its anchor target.
|
||||||
visiting[node] = true
|
// Increment depth when following aliases since they expand the effective structure.
|
||||||
defer func() { visiting[node] = false }()
|
if node.Kind == yaml.AliasNode && node.Alias != nil {
|
||||||
|
return checkYAMLDepth(node.Alias, depth+1, maxDepth, maxNodes, seen, nodeCount)
|
||||||
|
}
|
||||||
|
|
||||||
// Walk children based on node type.
|
for _, child := range node.Content {
|
||||||
switch n := node.(type) {
|
if err := checkYAMLDepth(child, depth+1, maxDepth, maxNodes, seen, nodeCount); err != nil {
|
||||||
case *ast.MappingNode:
|
|
||||||
for _, value := range n.Values {
|
|
||||||
if err := checkYAMLDepth(value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case *ast.MappingValueNode:
|
|
||||||
// Both Key and Value are visited at depth+1 relative to this
|
|
||||||
// MappingValueNode. Since MappingNode visits its MappingValueNode
|
|
||||||
// children at depth+1 as well, keys and values end up at depth+2
|
|
||||||
// from the parent MappingNode. This is intentional: it mirrors the
|
|
||||||
// actual nesting structure (mapping → key-value pair → key/value).
|
|
||||||
if err := checkYAMLDepth(n.Key, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.SequenceNode:
|
|
||||||
for _, value := range n.Values {
|
|
||||||
if err := checkYAMLDepth(value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case *ast.AliasNode:
|
|
||||||
// Follow alias to its target, incrementing depth since aliases expand
|
|
||||||
// the effective structure.
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.AnchorNode:
|
|
||||||
// Increment depth for anchor values as a conservative measure: the
|
|
||||||
// anchor definition itself is structural, and treating it as a depth
|
|
||||||
// level ensures that deeply nested anchors are caught at definition
|
|
||||||
// time rather than only when referenced via alias. This +1 is
|
|
||||||
// asymmetric with alias (which also increments) — by design, the
|
|
||||||
// effective depth budget for anchored-then-aliased content is reduced
|
|
||||||
// because both the definition site and the reference site each consume
|
|
||||||
// a level, making deeply nested anchor/alias pairs hit the limit sooner.
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.TagNode:
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.MergeKeyNode:
|
|
||||||
// MergeKeyNode represents the literal "<<" merge key token. It has no
|
|
||||||
// child nodes — the value side of a merge (e.g., *alias) lives in the
|
|
||||||
// parent MappingValueNode.Value, which is already recursed into above.
|
|
||||||
// Explicitly listed here (rather than in the default case) to prevent
|
|
||||||
// future library changes from silently bypassing depth checks.
|
|
||||||
default:
|
|
||||||
// Scalar leaf nodes (StringNode, IntegerNode, FloatNode, BoolNode,
|
|
||||||
// NullNode, InfinityNode, NanNode, LiteralNode) have no children to
|
|
||||||
// recurse into.
|
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -331,11 +227,7 @@ func checkYAMLDepth(node ast.Node, depth, maxDepth, maxNodes int, validated map[
|
|||||||
// ParsePersonaBytes parses persona data from bytes with a source label for errors.
|
// ParsePersonaBytes parses persona data from bytes with a source label for errors.
|
||||||
// This is useful for parsing personas fetched from external sources (e.g., Gitea API)
|
// This is useful for parsing personas fetched from external sources (e.g., Gitea API)
|
||||||
// without requiring filesystem access. Format is detected by source extension.
|
// without requiring filesystem access. Format is detected by source extension.
|
||||||
// Input is bounded by MaxPersonaFileSize to prevent resource exhaustion.
|
|
||||||
func ParsePersonaBytes(data []byte, source string) (*Persona, error) {
|
func ParsePersonaBytes(data []byte, source string) (*Persona, error) {
|
||||||
if len(data) > MaxPersonaFileSize {
|
|
||||||
return nil, fmt.Errorf("persona data from %s exceeds maximum size (%d bytes, limit %d)", source, len(data), MaxPersonaFileSize)
|
|
||||||
}
|
|
||||||
return parsePersona(data, source)
|
return parsePersona(data, source)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+41
-222
@@ -7,7 +7,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/goccy/go-yaml/ast"
|
"gopkg.in/yaml.v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLoadBuiltinPersona(t *testing.T) {
|
func TestLoadBuiltinPersona(t *testing.T) {
|
||||||
@@ -459,14 +459,7 @@ func TestYAMLDeeplyNestedRejection(t *testing.T) {
|
|||||||
path := filepath.Join(dir, "deeply-nested.yaml")
|
path := filepath.Join(dir, "deeply-nested.yaml")
|
||||||
|
|
||||||
// Build a deeply nested YAML structure that exceeds MaxYAMLDepth (20).
|
// Build a deeply nested YAML structure that exceeds MaxYAMLDepth (20).
|
||||||
// Depth accumulation trace for "nested: \n level0: \n level1: ...":
|
// Each level adds 2 to the depth count (key + value mapping).
|
||||||
// - Document root parsed at depth 0
|
|
||||||
// - Root MappingNode children (MappingValueNodes) visited at depth 1
|
|
||||||
// - "nested" MappingValueNode: key at depth 2, value at depth 2
|
|
||||||
// - Each levelN adds depth via MappingValueNode traversal (key + value)
|
|
||||||
// - Exact depth per level depends on AST structure (MappingNode wrapping),
|
|
||||||
// but 25 levels reliably exceeds MaxYAMLDepth (20) with comfortable margin.
|
|
||||||
// The test uses 25 levels rather than exactly 21 to avoid brittleness.
|
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
sb.WriteString("name: test\nidentity: test\nnested:\n")
|
sb.WriteString("name: test\nidentity: test\nnested:\n")
|
||||||
indent := " "
|
indent := " "
|
||||||
@@ -490,35 +483,6 @@ func TestYAMLDeeplyNestedRejection(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestYAMLEmptyFileRejection(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
content string
|
|
||||||
}{
|
|
||||||
{"completely_empty", ""},
|
|
||||||
{"whitespace_only", " \n\n "},
|
|
||||||
{"comment_only", "# just a comment\n"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, tc.name+".yaml")
|
|
||||||
if err := os.WriteFile(path, []byte(tc.content), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for empty YAML input, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "empty YAML document") {
|
|
||||||
t.Errorf("expected error containing %q, got: %v", "empty YAML document", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLFileSizeLimit(t *testing.T) {
|
func TestYAMLFileSizeLimit(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
path := filepath.Join(dir, "huge.yaml")
|
path := filepath.Join(dir, "huge.yaml")
|
||||||
@@ -540,41 +504,41 @@ func TestYAMLFileSizeLimit(t *testing.T) {
|
|||||||
|
|
||||||
func TestYAMLAliasCycleDetection(t *testing.T) {
|
func TestYAMLAliasCycleDetection(t *testing.T) {
|
||||||
// Test that our checkYAMLDepth function handles alias cycles gracefully
|
// Test that our checkYAMLDepth function handles alias cycles gracefully
|
||||||
// by using the visiting map to prevent infinite recursion.
|
// by using the seen map to prevent infinite recursion.
|
||||||
|
// We test this directly because go-yaml's parser handles most cycles
|
||||||
|
// at parse time, but we need to ensure our checker is robust.
|
||||||
|
|
||||||
// Create a node structure where an alias points to a parent node,
|
// Create a node structure where an alias points to a parent node,
|
||||||
// simulating what could happen with crafted input.
|
// simulating what could happen with malicious input that bypasses
|
||||||
parent := &ast.MappingNode{
|
// go-yaml's cycle detection.
|
||||||
Values: []*ast.MappingValueNode{
|
parent := &yaml.Node{
|
||||||
{
|
Kind: yaml.MappingNode,
|
||||||
Key: &ast.StringNode{Value: "name"},
|
Content: []*yaml.Node{
|
||||||
Value: &ast.StringNode{Value: "test"},
|
{Kind: yaml.ScalarNode, Value: "name"},
|
||||||
},
|
{Kind: yaml.ScalarNode, Value: "test"},
|
||||||
|
{Kind: yaml.ScalarNode, Value: "nested"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a child that aliases back to the parent (artificial cycle)
|
// Create a child that aliases back to the parent (artificial cycle)
|
||||||
aliasToParent := &ast.AliasNode{
|
aliasToParent := &yaml.Node{
|
||||||
Value: parent,
|
Kind: yaml.AliasNode,
|
||||||
|
Alias: parent,
|
||||||
}
|
}
|
||||||
parent.Values = append(parent.Values, &ast.MappingValueNode{
|
parent.Content = append(parent.Content, aliasToParent)
|
||||||
Key: &ast.StringNode{Value: "nested"},
|
|
||||||
Value: aliasToParent,
|
|
||||||
})
|
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
validated := make(map[ast.Node]int)
|
seen := make(map[*yaml.Node]struct{})
|
||||||
visiting := make(map[ast.Node]bool)
|
|
||||||
|
|
||||||
// This should NOT hang or stack overflow - cycle detection prevents infinite recursion
|
// This should NOT hang or stack overflow - the seen map prevents infinite recursion
|
||||||
err := checkYAMLDepth(parent, 0, MaxYAMLDepth, MaxYAMLNodes, validated, visiting, &nodeCount)
|
err := checkYAMLDepth(parent, 0, MaxYAMLDepth, MaxYAMLNodes, seen, &nodeCount)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("unexpected error traversing cyclic structure: %v", err)
|
t.Errorf("unexpected error traversing cyclic structure: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Verify we tracked the parent in the validated map
|
// Verify we tracked the parent in the seen map
|
||||||
if _, ok := validated[parent]; !ok {
|
if _, ok := seen[parent]; !ok {
|
||||||
t.Error("parent node not tracked in validated map")
|
t.Error("parent node not tracked in seen map")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -630,82 +594,36 @@ func TestYAMLNodeCountLimit(t *testing.T) {
|
|||||||
func TestCheckYAMLDepthCycleDetectionDirect(t *testing.T) {
|
func TestCheckYAMLDepthCycleDetectionDirect(t *testing.T) {
|
||||||
// Direct test of cycle detection in checkYAMLDepth by creating
|
// Direct test of cycle detection in checkYAMLDepth by creating
|
||||||
// a node structure with an artificial cycle.
|
// a node structure with an artificial cycle.
|
||||||
node := &ast.MappingNode{
|
// This tests the seen map logic independent of go-yaml's parsing.
|
||||||
Values: []*ast.MappingValueNode{
|
node := &yaml.Node{
|
||||||
{
|
Kind: yaml.MappingNode,
|
||||||
Key: &ast.StringNode{Value: "key"},
|
Content: []*yaml.Node{
|
||||||
Value: &ast.StringNode{Value: "value"},
|
{Kind: yaml.ScalarNode, Value: "key"},
|
||||||
},
|
{Kind: yaml.ScalarNode, Value: "value"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a cycle by making a child reference the parent
|
// Create a cycle by making a child reference the parent
|
||||||
cycleChild := &ast.AliasNode{
|
cycleChild := &yaml.Node{
|
||||||
Value: node, // Points back to the parent
|
Kind: yaml.AliasNode,
|
||||||
|
Alias: node, // Points back to the parent
|
||||||
}
|
}
|
||||||
node.Values = append(node.Values, &ast.MappingValueNode{
|
node.Content = append(node.Content,
|
||||||
Key: &ast.StringNode{Value: "cyclic"},
|
&yaml.Node{Kind: yaml.ScalarNode, Value: "cyclic"},
|
||||||
Value: cycleChild,
|
cycleChild,
|
||||||
})
|
)
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
validated := make(map[ast.Node]int)
|
seen := make(map[*yaml.Node]struct{})
|
||||||
visiting := make(map[ast.Node]bool)
|
err := checkYAMLDepth(node, 0, MaxYAMLDepth, MaxYAMLNodes, seen, &nodeCount)
|
||||||
err := checkYAMLDepth(node, 0, MaxYAMLDepth, MaxYAMLNodes, validated, visiting, &nodeCount)
|
|
||||||
|
|
||||||
// Should complete without infinite recursion due to cycle detection
|
// Should complete without infinite recursion due to cycle detection
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("unexpected error: %v", err)
|
t.Errorf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
// The validated map should contain multiple entries
|
// The seen map should contain multiple entries
|
||||||
if len(validated) < 2 {
|
if len(seen) < 2 {
|
||||||
t.Errorf("validated map has %d entries, expected at least 2", len(validated))
|
t.Errorf("seen map has %d entries, expected at least 2", len(seen))
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLAliasDepthBypass(t *testing.T) {
|
|
||||||
// Test that an anchored subtree first validated at a shallow depth is
|
|
||||||
// re-checked when referenced via alias at a deeper position. Without the
|
|
||||||
// depth-aware validated map, the alias reference would skip re-checking
|
|
||||||
// and allow the effective nesting to exceed MaxYAMLDepth.
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, "alias-depth-bypass.yaml")
|
|
||||||
|
|
||||||
// Build YAML with an anchor at shallow depth containing a subtree near the limit,
|
|
||||||
// then reference it via alias deep enough that effective depth exceeds MaxYAMLDepth.
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("name: test\nidentity: test\n")
|
|
||||||
|
|
||||||
// Create the anchored subtree at depth 1 (key level) that nests 15 levels deep.
|
|
||||||
sb.WriteString("anchor_key: &deep_anchor\n")
|
|
||||||
for i := 0; i < 15; i++ {
|
|
||||||
sb.WriteString(strings.Repeat(" ", i+1))
|
|
||||||
sb.WriteString(fmt.Sprintf("level%d:\n", i))
|
|
||||||
}
|
|
||||||
sb.WriteString(strings.Repeat(" ", 16))
|
|
||||||
sb.WriteString("leaf: value\n")
|
|
||||||
|
|
||||||
// Create a wrapper that nests 6 levels deep, then references the anchor.
|
|
||||||
// Effective depth at alias target = 6 (wrapper nesting) + 1 (alias) + 15 (subtree) = 22 > 20
|
|
||||||
sb.WriteString("wrapper:\n")
|
|
||||||
for i := 0; i < 6; i++ {
|
|
||||||
sb.WriteString(strings.Repeat(" ", i+1))
|
|
||||||
sb.WriteString(fmt.Sprintf("n%d:\n", i))
|
|
||||||
}
|
|
||||||
sb.WriteString(strings.Repeat(" ", 7))
|
|
||||||
sb.WriteString("alias_ref: *deep_anchor\n")
|
|
||||||
|
|
||||||
if err := os.WriteFile(path, []byte(sb.String()), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for alias depth bypass, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "nesting depth exceeds") {
|
|
||||||
t.Errorf("error = %q, want containing 'nesting depth exceeds'", err.Error())
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -858,102 +776,3 @@ identity: test identity
|
|||||||
t.Errorf("Name = %q, want %q", p.Name, "test")
|
t.Errorf("Name = %q, want %q", p.Name, "test")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestJSONTrailingContentRejected(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
content string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "trailing garbage after object",
|
|
||||||
content: `{"name":"test","identity":"test identity"}garbage`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "two JSON objects",
|
|
||||||
content: `{"name":"test","identity":"test identity"}{"name":"other"}`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trailing array",
|
|
||||||
content: `{"name":"test","identity":"test identity"}[]`,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, "test.json")
|
|
||||||
if err := os.WriteFile(path, []byte(tt.content), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for trailing content, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "trailing content") {
|
|
||||||
t.Errorf("error = %q, want to contain 'trailing content'", err.Error())
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParsePersonaBytesSizeLimit(t *testing.T) {
|
|
||||||
// ParsePersonaBytes should reject input exceeding MaxPersonaFileSize
|
|
||||||
oversized := make([]byte, MaxPersonaFileSize+1)
|
|
||||||
for i := range oversized {
|
|
||||||
oversized[i] = 'x'
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := ParsePersonaBytes(oversized, "oversized.yaml")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for oversized input, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "exceeds maximum size") {
|
|
||||||
t.Errorf("error = %q, want to contain 'exceeds maximum size'", err.Error())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Just under the limit should not trigger size error (may fail parse, but not size)
|
|
||||||
underLimit := []byte("name: test\nidentity: test persona\n")
|
|
||||||
p, err := ParsePersonaBytes(underLimit, "valid.yaml")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error for valid input: %v", err)
|
|
||||||
}
|
|
||||||
if p.Name != "test" {
|
|
||||||
t.Errorf("Name = %q, want %q", p.Name, "test")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLMergeKeyDepthCheck(t *testing.T) {
|
|
||||||
// Verify that YAML merge keys (<<: *alias) are properly handled by the
|
|
||||||
// depth checker. The merge key content is in the MappingValueNode.Value
|
|
||||||
// (an AliasNode), not in the MergeKeyNode itself.
|
|
||||||
p, err := ParsePersonaBytes([]byte("name: merge-test\nidentity: test\n"), "merge.yaml")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("basic parse failed: %v", err)
|
|
||||||
}
|
|
||||||
if p.Name != "merge-test" {
|
|
||||||
t.Errorf("Name = %q, want %q", p.Name, "merge-test")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test that deeply nested merge keys still hit depth limit.
|
|
||||||
// Build YAML with merge key content nested beyond MaxYAMLDepth.
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("name: deep-merge\nidentity: deep merge persona\n")
|
|
||||||
sb.WriteString("anchor: &deep\n")
|
|
||||||
indent := " "
|
|
||||||
for i := 0; i < MaxYAMLDepth+5; i++ {
|
|
||||||
sb.WriteString(indent)
|
|
||||||
sb.WriteString(fmt.Sprintf("level%d:\n", i))
|
|
||||||
indent += " "
|
|
||||||
}
|
|
||||||
sb.WriteString(indent + "leaf: value\n")
|
|
||||||
sb.WriteString("target:\n <<: *deep\n")
|
|
||||||
|
|
||||||
_, err = ParsePersonaBytes([]byte(sb.String()), "deep-merge.yaml")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for deeply nested merge key content, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "depth") {
|
|
||||||
t.Errorf("error = %q, want to contain 'depth'", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user