Compare commits
114 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f28c792bda | |||
| b534247c85 | |||
| 6f02cef662 | |||
| fccfdd2ff7 | |||
| e3fb19fa1b | |||
| a1bbab406d | |||
| 4d48917e36 | |||
| bd516cd044 | |||
| 1f67954da7 | |||
| d396599d05 | |||
| 9f3f32174b | |||
| c53a07b230 | |||
| bbf3dfbf0d | |||
| ed3a5dddf1 | |||
| 449a24e4c5 | |||
| 4440823571 | |||
| c349986187 | |||
| 934c6728ee | |||
| 5ac93bea70 | |||
| f84cc3bbcf | |||
| 8c8f3ab4b3 | |||
| 50facefdd6 | |||
| bd2df7d986 | |||
| d3bb83a10a | |||
| c56f5fec52 | |||
| b80a1517ed | |||
| 5f7ffab487 | |||
| f8b9d7d282 | |||
| 7a8fc166ec | |||
| 5e351b85f0 | |||
| ab2a6c8aef | |||
| 6b7f3f6924 | |||
| 4c032a3b53 | |||
| 64c9d551ba | |||
| db7b7e66bf | |||
| 0232343126 | |||
| b26514714f | |||
| 028d46942a | |||
| e59c2bc831 | |||
| dc2e1ca5de | |||
| 7de6fdd9ec | |||
| 1e0959b077 | |||
| 67c3db70cb | |||
| a845ce32eb | |||
| 49d6ca77a3 | |||
| 6ebf66aefb | |||
| 004343d05f | |||
| 92b84976cf | |||
| 9f8e9aa8d3 | |||
| 881ce232eb | |||
| 31a28b1dd5 | |||
| e414471a16 | |||
| 41e1d48b54 | |||
| bf52fceea0 | |||
| d722035629 | |||
| b9b7be3b4e | |||
| baa917f228 | |||
| b0352ba1c9 | |||
| 0b16c4143a | |||
| 493349e11a | |||
| 5cedeee9f4 | |||
| 01b6af03a8 | |||
| 80091fb080 | |||
| b5f17ddfc4 | |||
| 144a36a2a7 | |||
| 12f5f5a5e4 | |||
| 45d009dd06 | |||
| 8991260333 | |||
| 6f86e66943 | |||
| 019b815280 | |||
| c27dfd0f08 | |||
| 1b6c37605f | |||
| 036e96d9b7 | |||
| ea74f7e088 | |||
| e6b1840ffc | |||
| 1ca9250e4a | |||
| 1b38e6ad00 | |||
| 5498dccd60 | |||
| ecfbfddc7c | |||
| ac53ecfa5d | |||
| 090ae3848c | |||
| 23da7eedf5 | |||
| 7279cdd216 | |||
| 4c327b61d4 | |||
| 877dbf9999 | |||
| 4a1cb6b47c | |||
| deade3c5a0 | |||
| c54cee134e | |||
| 1dd73bc4df | |||
| 8f564ea4f8 | |||
| 9775cb098c | |||
| 3f06ba2ea6 | |||
| 593b249e09 | |||
| 10cd6203d4 | |||
| 26f326cf51 | |||
| 4fed59ac85 | |||
| 6035afeea7 | |||
| c3e8f0f231 | |||
| 7898dd939f | |||
| fededd18ad | |||
| 01cde16d47 | |||
| aeb0c8cb79 | |||
| 70267b68f4 | |||
| 4b96231b32 | |||
| 230419f0e2 | |||
| 7dab35de41 | |||
| c41c9590b7 | |||
| 4dd67742f9 | |||
| 57e62a345f | |||
| 44d6fa9d57 | |||
| 4ea41e164e | |||
| 0e3c85f05c | |||
| b24c4dcc86 | |||
| 4bb3a2f960 |
@@ -1,17 +1,43 @@
|
|||||||
# This composite action is designed for Gitea Actions runners.
|
# This composite action supports both Gitea Actions and GitHub Actions runners.
|
||||||
# Gitea Actions supports GitHub Actions syntax including $GITHUB_OUTPUT,
|
# It detects the VCS host type by checking whether github.api_url is set
|
||||||
# actions/cache, and actions/checkout.
|
# (present on GitHub.com and GHES runners, absent on Gitea runners) and uses
|
||||||
|
# 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:
|
||||||
gitea-url:
|
vcs-url:
|
||||||
description: 'Gitea instance URL (defaults to server_url)'
|
description: 'VCS server URL (only used on Gitea runners; ignored on GitHub/GHES). Defaults to server_url.'
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
repo:
|
repo:
|
||||||
description: 'Repository (owner/name, defaults to current)'
|
description: 'Repository to review (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:
|
||||||
@@ -19,25 +45,47 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
reviewer-token:
|
reviewer-token:
|
||||||
description: 'Gitea token for posting the review'
|
description: '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'
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
llm-base-url:
|
llm-base-url:
|
||||||
description: 'OpenAI-compatible LLM API base URL'
|
description: 'OpenAI-compatible LLM API base URL (not required for aicore provider)'
|
||||||
required: true
|
required: false
|
||||||
|
default: ''
|
||||||
llm-api-key:
|
llm-api-key:
|
||||||
description: 'LLM API key'
|
description: 'LLM API key (not required for aicore provider)'
|
||||||
required: true
|
required: false
|
||||||
|
default: ''
|
||||||
llm-model:
|
llm-model:
|
||||||
description: 'LLM model name'
|
description: 'LLM model name'
|
||||||
required: true
|
required: true
|
||||||
llm-provider:
|
llm-provider:
|
||||||
description: 'LLM API provider: openai or anthropic (default openai)'
|
description: 'LLM API provider: openai, anthropic, or aicore (default openai)'
|
||||||
required: false
|
required: false
|
||||||
default: 'openai'
|
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:
|
conventions-file:
|
||||||
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
||||||
required: false
|
required: false
|
||||||
@@ -74,6 +122,14 @@ inputs:
|
|||||||
description: 'Local file with additional system prompt instructions (e.g. security review focus)'
|
description: 'Local file with additional system prompt instructions (e.g. security review focus)'
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
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:
|
runs:
|
||||||
using: 'composite'
|
using: 'composite'
|
||||||
@@ -82,45 +138,325 @@ runs:
|
|||||||
id: version
|
id: version
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
set -euo pipefail
|
||||||
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
|
||||||
VERSION=$(curl -sSf "${GITEA_URL}/api/v1/repos/${REPO}/releases?limit=1" \
|
if [ "$VCS_TYPE" = "github" ]; then
|
||||||
|
# SECURITY: Use github.api_url which is a trusted platform-provided value.
|
||||||
|
# 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 '')")
|
| 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" >&2
|
echo "Failed to determine latest version from ${API_URL}" >&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-linux-amd64-${{ steps.version.outputs.version }}
|
key: review-bot-${{ steps.version.outputs.os }}-${{ steps.version.outputs.arch }}-${{ 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: |
|
||||||
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
set -euo pipefail
|
||||||
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}" \
|
SERVER_URL="${{ steps.version.outputs.server_url }}"
|
||||||
|
ACTION_REPO="${{ steps.version.outputs.action_repo }}"
|
||||||
|
VERSION="${{ steps.version.outputs.version }}"
|
||||||
|
VCS_TYPE="${{ steps.version.outputs.vcs_type }}"
|
||||||
|
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
|
||||||
|
# rebinding attacks. A DNS TTL expiry between "Determine version" and here
|
||||||
|
# could allow an attacker to change the resolved IP to a private/reserved
|
||||||
|
# address, causing curl to send ACTION_TOKEN to an internal host.
|
||||||
|
# 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"
|
-o "${{ runner.temp }}/review-bot"
|
||||||
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/checksums.txt" \
|
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"
|
-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 "${BINARY}" checksums.txt | awk '{print $1}')
|
EXPECTED=$(grep -E "^[0-9a-f]+[[:space:]]+\*?${BINARY}$" checksums.txt | awk '{print $1}')
|
||||||
|
# sha256sum (GNU) is not available on macOS; use shasum -a 256 on darwin.
|
||||||
|
if [ "${OS}" = "darwin" ]; then
|
||||||
|
ACTUAL=$(shasum -a 256 review-bot | awk '{print $1}')
|
||||||
|
else
|
||||||
ACTUAL=$(sha256sum review-bot | awk '{print $1}')
|
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
|
||||||
@@ -134,12 +470,12 @@ runs:
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
chmod +x "${{ runner.temp }}/review-bot"
|
chmod +x "${{ runner.temp }}/review-bot"
|
||||||
echo "Installed review-bot ${VERSION} (checksum verified)"
|
echo "Installed review-bot-${OS}-${ARCH} ${VERSION} (checksum verified)"
|
||||||
|
|
||||||
- name: Run review
|
- name: Run review
|
||||||
shell: bash
|
shell: bash
|
||||||
env:
|
env:
|
||||||
GITEA_URL: ${{ inputs.gitea-url || github.server_url }}
|
VCS_URL: ${{ steps.version.outputs.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 }}
|
||||||
@@ -155,6 +491,13 @@ runs:
|
|||||||
LLM_PROVIDER: ${{ inputs.llm-provider }}
|
LLM_PROVIDER: ${{ inputs.llm-provider }}
|
||||||
UPDATE_EXISTING: ${{ inputs.update-existing }}
|
UPDATE_EXISTING: ${{ inputs.update-existing }}
|
||||||
SYSTEM_PROMPT_FILE: ${{ inputs.system-prompt-file }}
|
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: |
|
run: |
|
||||||
ARGS=""
|
ARGS=""
|
||||||
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
||||||
|
|||||||
+15
-14
@@ -18,8 +18,10 @@ jobs:
|
|||||||
- run: go vet ./...
|
- run: go vet ./...
|
||||||
- run: go build -o review-bot ./cmd/review-bot
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
|
|
||||||
# Self-review: builds from source since we're pre-release
|
# Self-review using native SAP AI Core provider
|
||||||
# Models configured to match SAP AI Core deployments
|
# 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:
|
review:
|
||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-24.04
|
||||||
if: github.event_name == 'pull_request'
|
if: github.event_name == 'pull_request'
|
||||||
@@ -29,19 +31,15 @@ jobs:
|
|||||||
include:
|
include:
|
||||||
- name: sonnet
|
- name: sonnet
|
||||||
token_secret: SONNET_REVIEW_TOKEN
|
token_secret: SONNET_REVIEW_TOKEN
|
||||||
provider: anthropic
|
|
||||||
llm_path: /anthropic/v1
|
|
||||||
model: anthropic--claude-4.6-sonnet
|
model: anthropic--claude-4.6-sonnet
|
||||||
- name: gpt
|
- name: gpt
|
||||||
token_secret: GPT_REVIEW_TOKEN
|
token_secret: GPT_REVIEW_TOKEN
|
||||||
provider: openai
|
|
||||||
llm_path: /openai/v1
|
|
||||||
model: gpt-5
|
model: gpt-5
|
||||||
- name: security
|
- name: security
|
||||||
token_secret: SECURITY_REVIEW_TOKEN
|
token_secret: SECURITY_REVIEW_TOKEN
|
||||||
provider: openai
|
|
||||||
llm_path: /openai/v1
|
|
||||||
model: gpt-5
|
model: gpt-5
|
||||||
|
patterns_repo: rodin/security-patterns
|
||||||
|
patterns_files: "."
|
||||||
system_prompt_file: SECURITY_REVIEW.md
|
system_prompt_file: SECURITY_REVIEW.md
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -51,18 +49,21 @@ 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:
|
||||||
GITEA_URL: ${{ github.server_url }}
|
VCS_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] }}
|
||||||
REVIEWER_NAME: ${{ matrix.name }}
|
REVIEWER_NAME: ${{ matrix.name }}
|
||||||
LLM_BASE_URL: ${{ secrets.LLM_BASE_URL }}${{ matrix.llm_path }}
|
LLM_PROVIDER: aicore
|
||||||
LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
|
|
||||||
LLM_MODEL: ${{ matrix.model }}
|
LLM_MODEL: ${{ matrix.model }}
|
||||||
LLM_PROVIDER: ${{ matrix.provider }}
|
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"
|
CONVENTIONS_FILE: "CONVENTIONS.md"
|
||||||
PATTERNS_REPO: "rodin/go-patterns"
|
PATTERNS_REPO: ${{ matrix.patterns_repo || 'rodin/go-patterns' }}
|
||||||
PATTERNS_FILES: "README.md,patterns/"
|
PATTERNS_FILES: ${{ matrix.patterns_files || 'README.md,patterns/' }}
|
||||||
LLM_TIMEOUT: "600"
|
LLM_TIMEOUT: "600"
|
||||||
SYSTEM_PROMPT_FILE: ${{ matrix.system_prompt_file }}
|
SYSTEM_PROMPT_FILE: ${{ matrix.system_prompt_file }}
|
||||||
run: ./review-bot
|
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}"
|
||||||
+19
-1
@@ -2,8 +2,26 @@
|
|||||||
|
|
||||||
## Language & Dependencies
|
## Language & Dependencies
|
||||||
|
|
||||||
- Go standard library only — no external dependencies.
|
|
||||||
- Target the latest stable Go release.
|
- Target the latest stable Go release.
|
||||||
|
- **STRICT ALLOWLIST:** Only packages listed below may be imported. No exceptions.
|
||||||
|
|
||||||
|
### Approved Third-Party Packages
|
||||||
|
|
||||||
|
| Package | Use Case | Scope |
|
||||||
|
|---------|----------|-------|
|
||||||
|
| `github.com/goccy/go-yaml` | YAML parsing and AST inspection (subpkgs: `ast`, `parser`) | production |
|
||||||
|
| `github.com/google/go-cmp` | Test comparisons (`cmp.Diff`) | test only |
|
||||||
|
|
||||||
|
**Any import not in this table or the Go standard library is forbidden.**
|
||||||
|
|
||||||
|
Transitive dependencies of approved packages are automatically allowed.
|
||||||
|
|
||||||
|
To request a new dependency:
|
||||||
|
1. Open a PR that ONLY updates this table
|
||||||
|
2. Requires explicit approval from Aaron
|
||||||
|
3. After merge, a separate PR may use the package
|
||||||
|
|
||||||
|
*Enforcement: `scripts/check-deps.sh` parses this table — update only here.*
|
||||||
|
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# Dev Loop Health Check — 2026-05-14 23:33 UTC
|
||||||
|
|
||||||
|
## Status: ✅ OPTIMAL
|
||||||
|
|
||||||
|
### Test Results
|
||||||
|
- All packages: **PASS** ✅
|
||||||
|
- Test count: 150+ tests across:
|
||||||
|
- `./cmd/review-bot`: review, persona, schema, LLM routing
|
||||||
|
- `./internal/gitea`: Gitea client, URL validation, SSRF defense
|
||||||
|
- `./internal/github`: GitHub client, API routing
|
||||||
|
- `./review`: persona loading, file content fetching, review logic
|
||||||
|
|
||||||
|
### Recent Activity
|
||||||
|
1. **Tests added:** GetTimelineReviewCommentIDForReview, GetAllFilesInPath, fetchFileContext, fetchPatterns, persona edge cases
|
||||||
|
2. **Code quality:** `go fmt`, `go mod tidy` clean
|
||||||
|
3. **Branches:** All worktrees cleaned up, working on `review-bot-fixes` (in sync with origin/main)
|
||||||
|
|
||||||
|
### Current HEAD
|
||||||
|
- SHA: `b534247`
|
||||||
|
- Message: `[dev-loop] Update TODO.md with current cycle status and coverage metrics`
|
||||||
|
- Time: Clean, no uncommitted changes
|
||||||
|
|
||||||
|
### Next Phase Priorities
|
||||||
|
1. **PR Submission (#132+)** — Enable review-bot to create PRs (3–5 days)
|
||||||
|
2. **GitHub Enterprise Support** — Enterprise URL patterns, token scopes (2–3 days)
|
||||||
|
3. **Performance & Observability** — Metrics, load testing, audit logging (5–7 days)
|
||||||
|
|
||||||
|
### System Health
|
||||||
|
- ✅ All tests passing
|
||||||
|
- ✅ No warnings or lint issues
|
||||||
|
- ✅ Code is clean and organized
|
||||||
|
- ✅ Ready for next development cycle
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Next check:** ~6:10 AM UTC (May 15)
|
||||||
|
**Action:** Ready for issue creation or new feature work
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: build test test-integration lint clean coverage
|
.PHONY: build test test-integration lint clean coverage check-deps precommit
|
||||||
|
|
||||||
build:
|
build:
|
||||||
go build -o review-bot ./cmd/review-bot/
|
go build -o review-bot ./cmd/review-bot/
|
||||||
@@ -12,9 +12,15 @@ test-integration:
|
|||||||
lint:
|
lint:
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|
||||||
|
check-deps:
|
||||||
|
@./scripts/check-deps.sh
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f review-bot
|
rm -f review-bot
|
||||||
|
|
||||||
coverage:
|
coverage:
|
||||||
go test -coverprofile=coverage.out ./...
|
go test -coverprofile=coverage.out ./...
|
||||||
go tool cover -func=coverage.out
|
go tool cover -func=coverage.out
|
||||||
|
|
||||||
|
# Precommit runs all checks required before pushing
|
||||||
|
precommit: check-deps lint test
|
||||||
|
|||||||
+175
@@ -0,0 +1,175 @@
|
|||||||
|
# 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.
|
||||||
@@ -4,12 +4,12 @@ AI-powered code review bot for Gitea pull requests. Fetches diff + context, send
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Multi-provider**: OpenAI-compatible and Anthropic Messages API
|
- **Multi-provider**: OpenAI-compatible, Anthropic Messages API, and SAP AI Core
|
||||||
- **Context-aware**: Fetches full file content, conventions, language patterns, CI status
|
- **Context-aware**: Fetches full file content, conventions, language patterns, CI status
|
||||||
- **Smart budget**: Automatically trims context to fit model token limits
|
- **Smart budget**: Automatically trims context to fit model token limits
|
||||||
- **Idempotent reviews**: Posts new review, then cleans up stale ones (one review per bot)
|
- **Idempotent reviews**: Posts new review, then cleans up stale ones (one review per bot)
|
||||||
- **Custom prompts**: Load additional instructions from a file (e.g. security-focused review)
|
- **Custom prompts**: Load additional instructions from a file (e.g. security-focused review)
|
||||||
- **Zero dependencies**: Go stdlib only
|
- **Minimal dependencies**: Go stdlib + `gopkg.in/yaml.v3` only
|
||||||
|
|
||||||
## Quick Start: Composite Action
|
## Quick Start: Composite Action
|
||||||
|
|
||||||
@@ -168,26 +168,56 @@ Prints the review to CI logs without posting to the PR. Useful for testing promp
|
|||||||
llm-provider: anthropic
|
llm-provider: anthropic
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Using SAP AI Core
|
||||||
|
|
||||||
|
For SAP environments with AI Core deployments, use the `aicore` provider for native authentication:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: aicore-review
|
||||||
|
llm-model: anthropic--claude-4.6-sonnet # or gpt-5
|
||||||
|
llm-provider: aicore
|
||||||
|
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: default
|
||||||
|
```
|
||||||
|
|
||||||
|
AI Core handles OAuth token management and deployment discovery automatically. Model names must match the deployment name in AI Core (e.g. `anthropic--claude-4.6-sonnet`, `gpt-5`).
|
||||||
|
|
||||||
## Action Inputs
|
## Action Inputs
|
||||||
|
|
||||||
| Input | Required | Default | Description |
|
| Input | Required | Default | Description |
|
||||||
|-------|----------|---------|-------------|
|
|-------|----------|---------|-------------|
|
||||||
| `reviewer-token` | Yes | — | Gitea token for posting reviews (needs `write:issue`, `write:repository`) |
|
| `reviewer-token` | Yes | — | Gitea token for posting reviews (needs `write:issue`, `write:repository`) |
|
||||||
| `reviewer-name` | No | `""` | Logical identity for this reviewer. Used as sentinel for idempotent cleanup. Set this when running multiple review bots on the same PR. |
|
| `reviewer-name` | No | `""` | Logical identity for this reviewer. Used as sentinel for idempotent cleanup. Set this when running multiple review bots on the same PR. |
|
||||||
| `llm-base-url` | Yes | — | LLM API base URL |
|
| `llm-base-url` | No* | `""` | LLM API base URL (required unless using aicore provider) |
|
||||||
| `llm-api-key` | Yes | — | LLM API key |
|
| `llm-api-key` | No* | `""` | LLM API key (required unless using aicore provider) |
|
||||||
| `llm-model` | Yes | — | Model name |
|
| `llm-model` | Yes | — | Model name |
|
||||||
| `llm-provider` | No | `openai` | API provider: `openai` or `anthropic` |
|
| `llm-provider` | No | `openai` | API provider: `openai`, `anthropic`, or `aicore` |
|
||||||
|
| `aicore-client-id` | No** | `""` | SAP AI Core client ID |
|
||||||
|
| `aicore-client-secret` | No** | `""` | SAP AI Core client secret |
|
||||||
|
| `aicore-auth-url` | No** | `""` | SAP AI Core authentication URL |
|
||||||
|
| `aicore-api-url` | No** | `""` | SAP AI Core API URL |
|
||||||
|
| `aicore-resource-group` | No | `default` | SAP AI Core resource group |
|
||||||
| `conventions-file` | No | `""` | Path to coding conventions file in the repo |
|
| `conventions-file` | No | `""` | Path to coding conventions file in the repo |
|
||||||
| `patterns-repo` | No | `""` | Comma-separated repos with language patterns (e.g. `rodin/go-patterns`) |
|
| `patterns-repo` | No | `""` | Comma-separated repos with language patterns (e.g. `rodin/go-patterns`) |
|
||||||
| `patterns-files` | No | `README.md` | Files/directories to fetch from pattern repos |
|
| `patterns-files` | No | `README.md` | Files/directories to fetch from pattern repos |
|
||||||
| `system-prompt-file` | No | `""` | Local file with additional system prompt instructions |
|
| `system-prompt-file` | No | `""` | Local file with additional system prompt instructions |
|
||||||
|
| `persona` | No | `""` | Built-in persona name (security, architect, docs) |
|
||||||
|
| `persona-file` | No | `""` | Path to persona file (YAML or JSON) with custom review focus |
|
||||||
| `temperature` | No | `0` | LLM temperature (0 = server default) |
|
| `temperature` | No | `0` | LLM temperature (0 = server default) |
|
||||||
| `timeout` | No | `300` | LLM request timeout in seconds |
|
| `timeout` | No | `300` | LLM request timeout in seconds |
|
||||||
| `dry-run` | No | `false` | Print review to stdout instead of posting |
|
| `dry-run` | No | `false` | Print review to stdout instead of posting |
|
||||||
| `update-existing` | No | `true` | Delete previous review from same bot before posting. Accepts: true/1/yes or false/0/no |
|
| `update-existing` | No | `true` | Delete previous review from same bot before posting. Accepts: true/1/yes or false/0/no |
|
||||||
| `version` | No | `latest` | review-bot version to install |
|
| `version` | No | `latest` | review-bot version to install |
|
||||||
|
|
||||||
|
*Required for `openai` and `anthropic` providers, not for `aicore`.
|
||||||
|
**Required only for `aicore` provider.
|
||||||
|
|
||||||
## Runner Requirements
|
## Runner Requirements
|
||||||
|
|
||||||
The composite action requires these tools on the runner:
|
The composite action requires these tools on the runner:
|
||||||
@@ -252,7 +282,7 @@ Rules:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
review-bot \
|
review-bot \
|
||||||
--gitea-url https://gitea.example.com \
|
--vcs-url https://gitea.example.com \
|
||||||
--repo owner/name \
|
--repo owner/name \
|
||||||
--pr 42 \
|
--pr 42 \
|
||||||
--reviewer-token "$GITEA_TOKEN" \
|
--reviewer-token "$GITEA_TOKEN" \
|
||||||
@@ -269,7 +299,7 @@ All flags have environment variable equivalents:
|
|||||||
|
|
||||||
| Flag | Env Var |
|
| Flag | Env Var |
|
||||||
|------|---------|
|
|------|---------|
|
||||||
| `--gitea-url` | `GITEA_URL` |
|
| `--vcs-url` | `VCS_URL` (fallback: `GITEA_URL`) |
|
||||||
| `--repo` | `GITEA_REPO` |
|
| `--repo` | `GITEA_REPO` |
|
||||||
| `--pr` | `PR_NUMBER` |
|
| `--pr` | `PR_NUMBER` |
|
||||||
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
||||||
@@ -299,11 +329,12 @@ All flags have environment variable equivalents:
|
|||||||
### Token Scopes Required
|
### Token Scopes Required
|
||||||
|
|
||||||
| Scope | Purpose |
|
| Scope | Purpose |
|
||||||
|-------|---------|
|
|-------|--------|
|
||||||
| `write:issue` | Post and delete reviews |
|
| `write:issue` | Post and delete reviews |
|
||||||
| `write:repository` | Read PR diffs, file content, commit statuses |
|
| `write:repository` | Read PR diffs, file content, commit statuses |
|
||||||
|
| `read:user` | Self-request as reviewer (optional but recommended) |
|
||||||
|
|
||||||
No `read:user` scope needed — the bot identifies itself from the review response.
|
Without `read:user`, the bot still works but cannot add itself to the PR's reviewer list.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -329,3 +360,116 @@ budget/ Token estimation + context trimming
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
||||||
|
## Review Personas
|
||||||
|
|
||||||
|
Personas provide role-based review specialization. Instead of generic code review, each persona focuses on a specific domain (security, architecture, documentation) with tailored prompts and severity calibration.
|
||||||
|
|
||||||
|
### Built-in Personas
|
||||||
|
|
||||||
|
| Persona | Focus |
|
||||||
|
|---------|-------|
|
||||||
|
| `security` | Vulnerabilities, auth bypass, secrets exposure, injection attacks |
|
||||||
|
| `architect` | Design patterns, code organization, API contracts, testability |
|
||||||
|
| `docs` | Documentation quality, API clarity, error messages |
|
||||||
|
|
||||||
|
### Using Built-in Personas
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: security
|
||||||
|
persona: security
|
||||||
|
llm-model: claude-opus-4-20250514 # Security benefits from strong reasoning
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multiple Personas in Parallel
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: security
|
||||||
|
persona: security
|
||||||
|
- name: architect
|
||||||
|
persona: architect
|
||||||
|
steps:
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: ${{ matrix.name }}
|
||||||
|
persona: ${{ matrix.persona }}
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Each persona posts independently with its own sentinel, so reviews don't interfere.
|
||||||
|
|
||||||
|
|
||||||
|
### Custom Personas
|
||||||
|
|
||||||
|
Create a YAML file with your domain-specific review focus:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# .review/personas/trading.yaml
|
||||||
|
name: trading
|
||||||
|
display_name: Trading Domain Expert
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
You are a trading systems expert reviewing code for correctness.
|
||||||
|
|
||||||
|
Your expertise:
|
||||||
|
- Order lifecycle and state machines
|
||||||
|
- Fill handling and partial fills
|
||||||
|
- Position tracking and P&L calculations
|
||||||
|
- Event sourcing invariants
|
||||||
|
|
||||||
|
focus:
|
||||||
|
- Order state machine correctness
|
||||||
|
- Fill handling edge cases (partial, overfill)
|
||||||
|
- Position and P&L calculation accuracy
|
||||||
|
- Event replay determinism
|
||||||
|
- Decimal precision for money
|
||||||
|
|
||||||
|
ignore:
|
||||||
|
- Code style
|
||||||
|
- General performance
|
||||||
|
- Documentation formatting
|
||||||
|
|
||||||
|
severity:
|
||||||
|
major: "Bugs that cause incorrect positions, fills, or money calculations"
|
||||||
|
minor: "Edge cases that could cause issues under unusual conditions"
|
||||||
|
nit: "Clarity improvements for domain logic"
|
||||||
|
```
|
||||||
|
|
||||||
|
Use it in CI:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: trading
|
||||||
|
persona-file: .review/personas/trading.yaml
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
YAML is the recommended format for personas because it supports:
|
||||||
|
- Multi-line strings with `|` blocks (cleaner identity definitions)
|
||||||
|
- Comments for documentation
|
||||||
|
- More readable arrays and nested structures
|
||||||
|
|
||||||
|
JSON is also supported for backwards compatibility—just use `.json` extension.
|
||||||
|
|
||||||
|
|
||||||
|
### Persona vs system-prompt-file
|
||||||
|
|
||||||
|
| Feature | `persona` / `persona-file` | `system-prompt-file` |
|
||||||
|
|---------|---------------------------|----------------------|
|
||||||
|
| Replaces base prompt | Yes | No (appends) |
|
||||||
|
| Structured format | Yes (YAML/JSON) | No (freeform) |
|
||||||
|
| Focus/ignore lists | Yes | Manual |
|
||||||
|
| Severity calibration | Yes | Manual |
|
||||||
|
| Header display name | Yes | No |
|
||||||
|
| Built-in options | Yes | No |
|
||||||
|
|
||||||
|
Use personas for domain-specialized reviews. Use `system-prompt-file` for minor tweaks to the generic review.
|
||||||
|
|||||||
@@ -0,0 +1,151 @@
|
|||||||
|
## Dev Loop: review-bot — Continuous Health Monitor
|
||||||
|
|
||||||
|
### Current Cycle: 2026-05-14 23:11 UTC ✅
|
||||||
|
|
||||||
|
**Repository Status:** OPTIMAL
|
||||||
|
- Main: `6f02cef` (clean, all tests pass)
|
||||||
|
- Working tree: clean
|
||||||
|
- Build: ✅ successful
|
||||||
|
- Vet: ✅ clean
|
||||||
|
- Test suite: ALL PASS
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Latest Delivered: Test Coverage Sprint 2026-05-14 ✅
|
||||||
|
|
||||||
|
### Coverage Improvements
|
||||||
|
|
||||||
|
22 new tests added across 4 packages:
|
||||||
|
|
||||||
|
| Package | Before | After | Delta |
|
||||||
|
|---------|--------|-------|-------|
|
||||||
|
| cmd/review-bot | 37.6% | 46.1% | +8.5% |
|
||||||
|
| gitea | 80.0% | 85.2% | +5.2% |
|
||||||
|
| github | 79.9% | 86.3% | +6.4% |
|
||||||
|
| review | 91.5% | 92.0% | +0.5% |
|
||||||
|
|
||||||
|
**What was tested:**
|
||||||
|
- `fetchFileContext`: empty, removed files, content fetching, error recovery, context cancellation
|
||||||
|
- `fetchPatterns`: empty repo, all files, specific files, invalid format, errors, multiple repos
|
||||||
|
- `LoadPersona`: nonexistent file, non-regular file (directory), oversized file
|
||||||
|
- `CapitalizeFirst`: RuneError (invalid UTF-8)
|
||||||
|
- `GetTimelineReviewCommentIDForReview` (gitea): 4 cases including user+body matching
|
||||||
|
- `GetAllFilesInPath` (github): directory listing, 404 fallback, recursive subdirectory
|
||||||
|
|
||||||
|
**Commits:** `fccfdd2`, `6f02cef`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Repository Status Post-Merge
|
||||||
|
|
||||||
|
### Main Branch
|
||||||
|
- Commit: `9f3f321`
|
||||||
|
- Status: ✅ All systems healthy
|
||||||
|
|
||||||
|
### Recent Merged PRs
|
||||||
|
| PR | Issue | Title | Status |
|
||||||
|
|---|---|---|---|
|
||||||
|
| #131 | #130 | GitHub API methods & VCS routing | ✅ MERGED |
|
||||||
|
| #129 | #123 | IP-level SSRF defense | ✅ MERGED |
|
||||||
|
| #128 | #125 | VCS_URL deprecation & renaming | ✅ MERGED |
|
||||||
|
| #127 | #124 | Multi-arch binary support | ✅ MERGED |
|
||||||
|
| #126 | #120 | GitHub Actions composite action | ✅ MERGED |
|
||||||
|
|
||||||
|
### Recent Direct Commits
|
||||||
|
| SHA | Description | Date |
|
||||||
|
|-----|-------------|------|
|
||||||
|
| `fccfdd2` | [dev-loop] fetchFileContext/fetchPatterns/persona tests | 2026-05-14 |
|
||||||
|
| `6f02cef` | [dev-loop] GetTimelineReviewCommentIDForReview/GetAllFilesInPath tests | 2026-05-14 |
|
||||||
|
|
||||||
|
### Closed Issues
|
||||||
|
- #130, #123, #125, #124, #120
|
||||||
|
|
||||||
|
### Open Issues
|
||||||
|
- None blocking; backlog tracked in Gitea project board
|
||||||
|
|
||||||
|
### Worktrees
|
||||||
|
- All cleaned up; no stale branches
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Feature Completeness Summary
|
||||||
|
|
||||||
|
### ✅ Core Functionality
|
||||||
|
- Multi-provider LLM support (OpenAI, Anthropic, SAP AI Core)
|
||||||
|
- Gitea PR review (mature, proven)
|
||||||
|
- **NEW: GitHub PR review (fully implemented)**
|
||||||
|
- VCS abstraction (Gitea/GitHub transparent routing)
|
||||||
|
- SSRF defense with IP-level validation
|
||||||
|
- Multi-architecture binary deployment
|
||||||
|
|
||||||
|
### ✅ Review Quality
|
||||||
|
- Structured reviews with code snippets
|
||||||
|
- LLM-driven analysis
|
||||||
|
- Persona-based customization
|
||||||
|
- Context awareness
|
||||||
|
|
||||||
|
### ✅ Security
|
||||||
|
- RFC6598 CGN detection
|
||||||
|
- HTTPS enforcement
|
||||||
|
- Redirect safety
|
||||||
|
- Credential handling (no logs, no reflection leaks)
|
||||||
|
- URL validation for VCS API access
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Phase: Backlog Priorities
|
||||||
|
|
||||||
|
### Priority 1: PR Submission
|
||||||
|
**Issue:** #132+ (create)
|
||||||
|
**Goal:** Enable review-bot to create PRs (not just post reviews)
|
||||||
|
**Scope:** PR creation flow, commit logic, test coverage
|
||||||
|
**Est. Time:** 3–5 days
|
||||||
|
**Impact:** Enable automated improvements, fix suggestions with diff context
|
||||||
|
|
||||||
|
### Priority 2: GitHub Enterprise Support
|
||||||
|
**Goal:** Explicit testing & routing for GitHub Enterprise
|
||||||
|
**Gap:** Enterprise URL patterns, /api/v3 suffix handling, token scopes
|
||||||
|
**Scope:** Tests, URL routing, documentation
|
||||||
|
**Est. Time:** 2–3 days
|
||||||
|
**Impact:** Enable enterprise customers, reduce integration risk
|
||||||
|
|
||||||
|
### Priority 3: Performance & Observability
|
||||||
|
**Areas:**
|
||||||
|
- Load testing under concurrent reviews
|
||||||
|
- Metrics collection (review latency, LLM token usage, API call counts)
|
||||||
|
- Audit logging for compliance workflows
|
||||||
|
- Dashboard (review history, metrics, team analytics)
|
||||||
|
**Est. Time:** 5–7 days
|
||||||
|
**Impact:** Operational confidence, troubleshooting, compliance
|
||||||
|
|
||||||
|
### Priority 4: Enhanced Context
|
||||||
|
**Opportunities:**
|
||||||
|
- Semantic code understanding (AST-based analysis for specific languages)
|
||||||
|
- Project-specific review rules (.review-bot.yaml in repo root)
|
||||||
|
- Team-level customization
|
||||||
|
**Est. Time:** 7–10 days
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Dev Loop Schedule
|
||||||
|
|
||||||
|
- **Interval:** 4 hours
|
||||||
|
- **Next check:** ~6:10 AM UTC (May 15)
|
||||||
|
- **Health:** ✅ Optimal — all systems running
|
||||||
|
- **Status:** Ready for next phase work
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
|
||||||
|
| Key | Value |
|
||||||
|
|---|---|
|
||||||
|
| Repo | `/home/ubuntu/review-bot` |
|
||||||
|
| Main SHA | `6f02cef` |
|
||||||
|
| Last update | 2026-05-14 23:11 UTC |
|
||||||
|
| Status | All systems optimal |
|
||||||
|
| Next phase | PR submission or GitHub Enterprise support |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Summary:** review-bot now supports both GitHub and Gitea PR reviews with a unified abstraction layer. All tests pass, code is clean, security is approved. Ready to move to PR submission or GitHub Enterprise support in the next cycle.
|
||||||
@@ -157,7 +157,6 @@ func TestFit_PreservesNoteInOutput(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func TestFit_HugeUserMeta(t *testing.T) {
|
func TestFit_HugeUserMeta(t *testing.T) {
|
||||||
// UserMeta so large that base alone exceeds limit
|
// UserMeta so large that base alone exceeds limit
|
||||||
// Use a unique marker past the truncation point
|
// Use a unique marker past the truncation point
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/github"
|
||||||
"gitea.weiker.me/rodin/review-bot/llm"
|
"gitea.weiker.me/rodin/review-bot/llm"
|
||||||
"gitea.weiker.me/rodin/review-bot/review"
|
"gitea.weiker.me/rodin/review-bot/review"
|
||||||
)
|
)
|
||||||
@@ -17,7 +18,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_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
|
||||||
@@ -25,7 +26,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_GITEA_URL")
|
giteaURL := os.Getenv("INTEGRATION_VCS_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 +105,7 @@ func TestIntegration_FullReviewFlow(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestIntegration_PostAndCleanup(t *testing.T) {
|
func TestIntegration_PostAndCleanup(t *testing.T) {
|
||||||
giteaURL := os.Getenv("INTEGRATION_GITEA_URL")
|
giteaURL := os.Getenv("INTEGRATION_VCS_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 +131,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)
|
||||||
}
|
}
|
||||||
@@ -159,3 +160,85 @@ func TestIntegration_PostAndCleanup(t *testing.T) {
|
|||||||
t.Logf("Warning: could not delete test review %d: %v", posted.ID, err)
|
t.Logf("Warning: could not delete test review %d: %v", posted.ID, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestIntegration_GitHub_PostAndVerifyReview exercises the full VCS routing path
|
||||||
|
// for GitHub when INTEGRATION_GITHUB_TOKEN and INTEGRATION_GITHUB_REPO are set.
|
||||||
|
// It verifies that the GitHub adapter is selected via VCS_TYPE=github and that
|
||||||
|
// PostReview succeeds against a real GitHub PR.
|
||||||
|
//
|
||||||
|
// Required environment variables:
|
||||||
|
//
|
||||||
|
// INTEGRATION_GITHUB_TOKEN - GitHub personal access token with repo access
|
||||||
|
// INTEGRATION_GITHUB_REPO - owner/repo with an open PR (e.g. Rodin-AI/review-bot)
|
||||||
|
// INTEGRATION_GITHUB_PR - PR number to test against
|
||||||
|
//
|
||||||
|
// The test skips gracefully when these variables are absent.
|
||||||
|
func TestIntegration_GitHub_PostAndVerifyReview(t *testing.T) {
|
||||||
|
githubToken := os.Getenv("INTEGRATION_GITHUB_TOKEN")
|
||||||
|
githubRepo := os.Getenv("INTEGRATION_GITHUB_REPO")
|
||||||
|
prNumStr := os.Getenv("INTEGRATION_GITHUB_PR")
|
||||||
|
|
||||||
|
if githubToken == "" || githubRepo == "" || prNumStr == "" {
|
||||||
|
t.Skip("INTEGRATION_GITHUB_TOKEN, INTEGRATION_GITHUB_REPO, and INTEGRATION_GITHUB_PR not set, skipping")
|
||||||
|
}
|
||||||
|
|
||||||
|
prNumber, err := strconv.Atoi(prNumStr)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Invalid PR number %q: %v", prNumStr, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := strings.SplitN(githubRepo, "/", 2)
|
||||||
|
if len(parts) != 2 || parts[0] == "" || parts[1] == "" {
|
||||||
|
t.Fatalf("Invalid repo format %q, expected owner/repo", githubRepo)
|
||||||
|
}
|
||||||
|
owner, repoName := parts[0], parts[1]
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
ghClient := github.NewClient(githubToken, "https://api.github.com")
|
||||||
|
|
||||||
|
// Verify adapter selection: GetAuthenticatedUser must succeed.
|
||||||
|
user, err := ghClient.GetAuthenticatedUser(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetAuthenticatedUser: %v — check INTEGRATION_GITHUB_TOKEN", err)
|
||||||
|
}
|
||||||
|
t.Logf("Authenticated as: %s", user)
|
||||||
|
|
||||||
|
// Verify PR is accessible via GitHub adapter.
|
||||||
|
pr, err := ghClient.GetPullRequest(ctx, owner, repoName, prNumber)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetPullRequest: %v", err)
|
||||||
|
}
|
||||||
|
t.Logf("PR: %s (sha: %s)", pr.Title, pr.Head.Sha)
|
||||||
|
|
||||||
|
// Post a COMMENT review — does not require PR approval permissions.
|
||||||
|
sentinel := "<!-- review-bot:integration-test -->"
|
||||||
|
testBody := "# Integration Test Review (GitHub)\n\nThis is an automated integration test.\n\n" + sentinel
|
||||||
|
posted, err := ghClient.PostReview(ctx, owner, repoName, prNumber, "COMMENT", testBody, "", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("PostReview: %v", err)
|
||||||
|
}
|
||||||
|
t.Logf("Posted review ID: %d", posted.ID)
|
||||||
|
|
||||||
|
// Verify the review appears in ListReviews.
|
||||||
|
reviews, err := ghClient.ListReviews(ctx, owner, repoName, prNumber)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ListReviews: %v", err)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, r := range reviews {
|
||||||
|
if r.ID == posted.ID && strings.Contains(r.Body, sentinel) {
|
||||||
|
found = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Errorf("posted review ID %d not found in ListReviews output", posted.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Attempt cleanup — GitHub does not allow deleting submitted reviews,
|
||||||
|
// so this is expected to fail with ErrCannotDeleteSubmittedReview (422).
|
||||||
|
// Log it as informational only.
|
||||||
|
if err := ghClient.DeleteReview(ctx, owner, repoName, prNumber, posted.ID); err != nil {
|
||||||
|
t.Logf("Note: DeleteReview returned (expected for submitted GitHub reviews): %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+273
-69
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -13,12 +14,20 @@ import (
|
|||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/budget"
|
"gitea.weiker.me/rodin/review-bot/budget"
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/github"
|
||||||
"gitea.weiker.me/rodin/review-bot/llm"
|
"gitea.weiker.me/rodin/review-bot/llm"
|
||||||
"gitea.weiker.me/rodin/review-bot/review"
|
"gitea.weiker.me/rodin/review-bot/review"
|
||||||
)
|
)
|
||||||
|
|
||||||
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
|
||||||
@@ -49,12 +58,22 @@ 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
|
||||||
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", ""), "Gitea instance URL")
|
vcsURL := flag.String("vcs-url", os.Getenv("VCS_URL"), "VCS server URL (e.g. https://gitea.example.com)")
|
||||||
|
giteaURLAlias := flag.String("gitea-url", "", "Deprecated: use --vcs-url")
|
||||||
repo := flag.String("repo", envOrDefault("GITEA_REPO", ""), "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")
|
||||||
@@ -65,11 +84,19 @@ 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", "README.md"), "Comma-separated file paths to fetch from patterns repo")
|
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", ""), "Comma-separated file paths to fetch from patterns repo (empty = all files)")
|
||||||
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)")
|
||||||
llmProvider := flag.String("llm-provider", envOrDefault("LLM_PROVIDER", "openai"), "LLM API provider: openai or anthropic")
|
llmProvider := flag.String("llm-provider", envOrDefault("LLM_PROVIDER", "openai"), "LLM API provider: openai, anthropic, or aicore")
|
||||||
|
personaName := flag.String("persona", envOrDefault("PERSONA", ""), "Built-in persona name (security, architect, docs)")
|
||||||
|
personaFile := flag.String("persona-file", envOrDefault("PERSONA_FILE", ""), "Path to persona JSON file")
|
||||||
|
// AI Core specific flags (only used when provider=aicore)
|
||||||
|
aicoreClientID := flag.String("aicore-client-id", envOrDefault("AICORE_CLIENT_ID", ""), "SAP AI Core client ID (for provider=aicore)")
|
||||||
|
aicoreClientSecret := flag.String("aicore-client-secret", envOrDefault("AICORE_CLIENT_SECRET", ""), "SAP AI Core client secret (for provider=aicore)")
|
||||||
|
aicoreAuthURL := flag.String("aicore-auth-url", envOrDefault("AICORE_AUTH_URL", ""), "SAP AI Core auth URL (for provider=aicore)")
|
||||||
|
aicoreAPIURL := flag.String("aicore-api-url", envOrDefault("AICORE_API_URL", ""), "SAP AI Core API URL (for provider=aicore)")
|
||||||
|
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
@@ -83,13 +110,43 @@ 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
|
||||||
if *giteaURL == "" || *repo == "" || *prNum == "" || *reviewerToken == "" ||
|
// For aicore provider, llm-base-url and llm-api-key are not required
|
||||||
*llmBaseURL == "" || *llmAPIKey == "" || *llmModel == "" {
|
isAICore := llm.Provider(*llmProvider) == llm.ProviderAICore
|
||||||
|
if *vcsURL == "" || *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: --gitea-url, --repo, --pr, --reviewer-token, --llm-base-url, --llm-api-key, --llm-model\n")
|
fmt.Fprintf(os.Stderr, "Required: --vcs-url, --repo, --pr, --reviewer-token, --llm-model\n")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
if !isAICore && (*llmBaseURL == "" || *llmAPIKey == "") {
|
||||||
|
fmt.Fprintf(os.Stderr, "Error: --llm-base-url and --llm-api-key are required for provider=%s\n", *llmProvider)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
if isAICore && (*aicoreClientID == "" || *aicoreClientSecret == "" || *aicoreAuthURL == "" || *aicoreAPIURL == "") {
|
||||||
|
fmt.Fprintf(os.Stderr, "Error: AI Core credentials required for provider=aicore\n\n")
|
||||||
|
fmt.Fprintf(os.Stderr, "Required: --aicore-client-id, --aicore-client-secret, --aicore-auth-url, --aicore-api-url\n")
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate persona flags are mutually exclusive
|
||||||
|
if *personaName != "" && *personaFile != "" {
|
||||||
|
slog.Error("--persona and --persona-file are mutually exclusive")
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NOTE: Persona loading deferred until after Gitea client init to support repo personas
|
||||||
|
|
||||||
// Validate reviewer-name: only safe characters allowed in sentinel
|
// Validate reviewer-name: only safe characters allowed in sentinel
|
||||||
if err := validateReviewerName(*reviewerName); err != nil {
|
if err := validateReviewerName(*reviewerName); err != nil {
|
||||||
@@ -113,7 +170,39 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Initialize clients
|
// Initialize clients
|
||||||
giteaClient := gitea.NewClient(*giteaURL, *reviewerToken)
|
// Detect VCS type: explicit flag > env var > URL heuristic (default: gitea).
|
||||||
|
vcsType := envOrDefault("VCS_TYPE", "")
|
||||||
|
if vcsType == "" {
|
||||||
|
// Heuristic: if the URL looks like github.com or a GitHub Enterprise host,
|
||||||
|
// default to GitHub. The composite action sets VCS_TYPE explicitly, so this
|
||||||
|
// is a fallback for manual invocations.
|
||||||
|
if strings.Contains(*vcsURL, "github.com") || strings.Contains(*vcsURL, "github.concur.com") {
|
||||||
|
vcsType = "github"
|
||||||
|
} else {
|
||||||
|
vcsType = "gitea"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slog.Info("VCS type detected", "vcs_type", vcsType, "vcs_url", *vcsURL)
|
||||||
|
|
||||||
|
var vcs vcsClient
|
||||||
|
switch vcsType {
|
||||||
|
case "github":
|
||||||
|
// GitHub: baseURL is the API URL, derived from server URL.
|
||||||
|
// github.com → https://api.github.com
|
||||||
|
// GHES (e.g. https://ghe.example.com) → https://ghe.example.com/api/v3
|
||||||
|
apiURL := githubAPIURL(*vcsURL)
|
||||||
|
ghClient := github.NewClient(*reviewerToken, apiURL)
|
||||||
|
vcs = newGithubVCSAdapter(ghClient)
|
||||||
|
slog.Info("using GitHub VCS client", "api_url", apiURL)
|
||||||
|
case "gitea":
|
||||||
|
giteaClient := gitea.NewClient(*vcsURL, *reviewerToken)
|
||||||
|
vcs = newGiteaVCSAdapter(giteaClient)
|
||||||
|
slog.Info("using Gitea VCS client", "url", *vcsURL)
|
||||||
|
default:
|
||||||
|
slog.Error("unsupported VCS type", "vcs_type", vcsType, "valid", "gitea, github")
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
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")
|
||||||
@@ -125,8 +214,17 @@ func main() {
|
|||||||
switch llm.Provider(*llmProvider) {
|
switch llm.Provider(*llmProvider) {
|
||||||
case llm.ProviderOpenAI, llm.ProviderAnthropic:
|
case llm.ProviderOpenAI, llm.ProviderAnthropic:
|
||||||
llmClient.WithProvider(llm.Provider(*llmProvider))
|
llmClient.WithProvider(llm.Provider(*llmProvider))
|
||||||
|
case llm.ProviderAICore:
|
||||||
|
llmClient.WithAICore(llm.AICoreConfig{
|
||||||
|
ClientID: *aicoreClientID,
|
||||||
|
ClientSecret: *aicoreClientSecret,
|
||||||
|
AuthURL: *aicoreAuthURL,
|
||||||
|
APIURL: *aicoreAPIURL,
|
||||||
|
ResourceGroup: *aicoreResourceGroup,
|
||||||
|
})
|
||||||
|
slog.Info("using SAP AI Core provider", "resource_group", *aicoreResourceGroup)
|
||||||
default:
|
default:
|
||||||
slog.Error("invalid LLM provider", "provider", *llmProvider, "valid", "openai, anthropic")
|
slog.Error("invalid LLM provider", "provider", *llmProvider, "valid", "openai, anthropic, aicore")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if *llmTimeout > 0 {
|
if *llmTimeout > 0 {
|
||||||
@@ -138,10 +236,47 @@ func main() {
|
|||||||
ctx, cancel := context.WithTimeout(context.Background(), overallTimeout)
|
ctx, cancel := context.WithTimeout(context.Background(), overallTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
|
// Load persona if specified (after Gitea client init to support repo personas)
|
||||||
|
var persona *review.Persona
|
||||||
|
if *personaName != "" {
|
||||||
|
// Try loading from repo first, then fall back to built-in
|
||||||
|
repoPersonas, err := review.LoadRepoPersonas(ctx, vcs, owner, repoName)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not load repo personas", "repo", owner+"/"+repoName, "error", err)
|
||||||
|
// Continue with built-in personas only.
|
||||||
|
// NOTE: repoPersonas is nil here, but map indexing on a nil map is safe in Go
|
||||||
|
// (returns the zero value), so the fallback to built-in below works correctly.
|
||||||
|
}
|
||||||
|
if p, ok := repoPersonas[*personaName]; ok {
|
||||||
|
persona = p
|
||||||
|
slog.Info("loaded repo persona", "persona", persona.Name, "display", persona.DisplayName, "repo", owner+"/"+repoName)
|
||||||
|
} else {
|
||||||
|
// Fall back to built-in
|
||||||
|
persona, err = review.LoadBuiltinPersona(*personaName)
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("failed to load persona", "persona", *personaName, "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
slog.Info("loaded built-in persona", "persona", persona.Name, "display", persona.DisplayName)
|
||||||
|
}
|
||||||
|
} else if *personaFile != "" {
|
||||||
|
resolvedPath, err := validateWorkspacePath(*personaFile, "persona-file")
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("invalid persona-file path", "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
persona, err = review.LoadPersona(resolvedPath)
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("failed to load persona file", "file", *personaFile, "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
slog.Info("loaded persona from file", "file", *personaFile, "persona", persona.Name)
|
||||||
|
}
|
||||||
|
|
||||||
slog.Info("reviewing pull request", "pr", prNumber, "repo", fmt.Sprintf("%s/%s", owner, repoName))
|
slog.Info("reviewing pull request", "pr", prNumber, "repo", fmt.Sprintf("%s/%s", owner, repoName))
|
||||||
|
|
||||||
// Step 1: Fetch PR metadata
|
// Step 1: Fetch PR metadata
|
||||||
pr, err := giteaClient.GetPullRequest(ctx, owner, repoName, prNumber)
|
pr, err := vcs.GetPullRequest(ctx, owner, repoName, prNumber)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to fetch PR", "pr", prNumber, "error", err)
|
slog.Error("failed to fetch PR", "pr", prNumber, "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -149,7 +284,7 @@ func main() {
|
|||||||
slog.Info("fetched PR metadata", "pr", prNumber, "title", pr.Title)
|
slog.Info("fetched PR metadata", "pr", prNumber, "title", pr.Title)
|
||||||
|
|
||||||
// Step 2: Fetch diff
|
// Step 2: Fetch diff
|
||||||
diff, err := giteaClient.GetPullRequestDiff(ctx, owner, repoName, prNumber)
|
diff, err := vcs.GetPullRequestDiff(ctx, owner, repoName, prNumber)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to fetch diff", "pr", prNumber, "error", err)
|
slog.Error("failed to fetch diff", "pr", prNumber, "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -158,11 +293,11 @@ func main() {
|
|||||||
|
|
||||||
// Step 3: Fetch full file content for modified files
|
// Step 3: Fetch full file content for modified files
|
||||||
fileContext := ""
|
fileContext := ""
|
||||||
files, err := giteaClient.GetPullRequestFiles(ctx, owner, repoName, prNumber)
|
files, err := vcs.GetPullRequestFiles(ctx, owner, repoName, prNumber)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not fetch PR files list", "pr", prNumber, "error", err)
|
slog.Warn("could not fetch PR files list", "pr", prNumber, "error", err)
|
||||||
} else {
|
} else {
|
||||||
fileContext = fetchFileContext(ctx, giteaClient, owner, repoName, pr.Head.Ref, files)
|
fileContext = fetchFileContext(ctx, vcs, owner, repoName, pr.Head.Ref, files)
|
||||||
slog.Debug("fetched file context", "files", len(files))
|
slog.Debug("fetched file context", "files", len(files))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -170,7 +305,7 @@ func main() {
|
|||||||
ciPassed := true
|
ciPassed := true
|
||||||
ciDetails := ""
|
ciDetails := ""
|
||||||
if pr.Head.Sha != "" {
|
if pr.Head.Sha != "" {
|
||||||
statuses, err := giteaClient.GetCommitStatuses(ctx, owner, repoName, pr.Head.Sha)
|
statuses, err := vcs.GetCommitStatuses(ctx, owner, repoName, pr.Head.Sha)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not fetch CI status", "sha", pr.Head.Sha, "error", err)
|
slog.Warn("could not fetch CI status", "sha", pr.Head.Sha, "error", err)
|
||||||
} else {
|
} else {
|
||||||
@@ -182,7 +317,7 @@ func main() {
|
|||||||
// Step 5: Load conventions file if specified
|
// Step 5: Load conventions file if specified
|
||||||
conventions := ""
|
conventions := ""
|
||||||
if *conventionsFile != "" {
|
if *conventionsFile != "" {
|
||||||
content, err := giteaClient.GetFileContent(ctx, owner, repoName, *conventionsFile)
|
content, err := vcs.GetFileContent(ctx, owner, repoName, *conventionsFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not load conventions file", "file", *conventionsFile, "error", err)
|
slog.Warn("could not load conventions file", "file", *conventionsFile, "error", err)
|
||||||
} else {
|
} else {
|
||||||
@@ -194,41 +329,21 @@ func main() {
|
|||||||
// Step 6: Load patterns from external repo if specified
|
// Step 6: Load patterns from external repo if specified
|
||||||
patterns := ""
|
patterns := ""
|
||||||
if *patternsRepo != "" {
|
if *patternsRepo != "" {
|
||||||
patterns = fetchPatterns(ctx, giteaClient, *patternsRepo, *patternsFiles)
|
patterns = fetchPatterns(ctx, vcs, *patternsRepo, *patternsFiles)
|
||||||
slog.Debug("loaded patterns", "repo", *patternsRepo, "bytes", len(patterns))
|
slog.Debug("loaded patterns", "repo", *patternsRepo, "bytes", len(patterns))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Step 6b: Load additional system prompt if specified
|
// Step 6b: Load additional system prompt if specified
|
||||||
additionalPrompt := ""
|
additionalPrompt := ""
|
||||||
if *systemPromptFile != "" {
|
if *systemPromptFile != "" {
|
||||||
workspace := os.Getenv("GITHUB_WORKSPACE")
|
resolvedPath, err := validateWorkspacePath(*systemPromptFile, "system-prompt-file")
|
||||||
if workspace == "" {
|
|
||||||
workspace, _ = os.Getwd()
|
|
||||||
}
|
|
||||||
absWorkspace, err := filepath.Abs(workspace)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to resolve workspace path", "error", err)
|
slog.Error("invalid system-prompt-file path", "error", err)
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
promptPath := filepath.Join(absWorkspace, *systemPromptFile)
|
|
||||||
promptPath = filepath.Clean(promptPath)
|
|
||||||
if !strings.HasPrefix(promptPath, absWorkspace+string(filepath.Separator)) && promptPath != absWorkspace {
|
|
||||||
slog.Error("system-prompt-file resolves outside workspace", "path", promptPath, "workspace", absWorkspace)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
// Resolve symlinks and re-validate to prevent symlink traversal
|
|
||||||
resolvedPath, err := filepath.EvalSymlinks(promptPath)
|
|
||||||
if err != nil {
|
|
||||||
slog.Error("failed to resolve system prompt file", "path", promptPath, "error", err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
if !strings.HasPrefix(resolvedPath, absWorkspace+string(filepath.Separator)) && resolvedPath != absWorkspace {
|
|
||||||
slog.Error("system-prompt-file symlink resolves outside workspace", "resolved", resolvedPath, "workspace", absWorkspace)
|
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
data, err := os.ReadFile(resolvedPath)
|
data, err := os.ReadFile(resolvedPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to read system prompt file", "path", promptPath, "error", err)
|
slog.Error("failed to read system prompt file", "path", *systemPromptFile, "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
additionalPrompt = string(data)
|
additionalPrompt = string(data)
|
||||||
@@ -236,7 +351,13 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Step 7: Budget-aware prompt assembly
|
// Step 7: Budget-aware prompt assembly
|
||||||
systemBase := review.BuildSystemBase()
|
var systemBase string
|
||||||
|
if persona != nil {
|
||||||
|
systemBase = review.BuildPersonaSystemPrompt(persona)
|
||||||
|
slog.Debug("using persona system prompt", "persona", persona.Name)
|
||||||
|
} else {
|
||||||
|
systemBase = review.BuildSystemBase()
|
||||||
|
}
|
||||||
if additionalPrompt != "" {
|
if additionalPrompt != "" {
|
||||||
systemBase += "\n\n## Additional Review Instructions\n\n" + additionalPrompt
|
systemBase += "\n\n## Additional Review Instructions\n\n" + additionalPrompt
|
||||||
}
|
}
|
||||||
@@ -293,7 +414,12 @@ func main() {
|
|||||||
slog.Info("review parsed", "verdict", result.Verdict, "findings", len(result.Findings))
|
slog.Info("review parsed", "verdict", result.Verdict, "findings", len(result.Findings))
|
||||||
|
|
||||||
// Step 10: Format and post review
|
// Step 10: Format and post review
|
||||||
reviewBody := review.FormatMarkdown(result, *reviewerName)
|
var reviewBody string
|
||||||
|
if persona != nil && persona.DisplayName != "" {
|
||||||
|
reviewBody = review.FormatMarkdownWithDisplay(result, persona.DisplayName, *reviewerName)
|
||||||
|
} else {
|
||||||
|
reviewBody = review.FormatMarkdown(result, *reviewerName)
|
||||||
|
}
|
||||||
|
|
||||||
// Add commit footer so readers know which commit was evaluated
|
// Add commit footer so readers know which commit was evaluated
|
||||||
if pr.Head.Sha != "" {
|
if pr.Head.Sha != "" {
|
||||||
@@ -318,7 +444,7 @@ func main() {
|
|||||||
// Stale check: verify HEAD hasn't moved since we started
|
// Stale check: verify HEAD hasn't moved since we started
|
||||||
evaluatedSHA := pr.Head.Sha
|
evaluatedSHA := pr.Head.Sha
|
||||||
var currentSHA string
|
var currentSHA string
|
||||||
currentPR, err := giteaClient.GetPullRequest(ctx, owner, repoName, prNumber)
|
currentPR, err := vcs.GetPullRequest(ctx, owner, repoName, prNumber)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not re-fetch PR for stale check", "pr", prNumber, "error", err)
|
slog.Warn("could not re-fetch PR for stale check", "pr", prNumber, "error", err)
|
||||||
// currentSHA stays empty — shouldSkipStaleReview will return false
|
// currentSHA stays empty — shouldSkipStaleReview will return false
|
||||||
@@ -335,10 +461,10 @@ func main() {
|
|||||||
|
|
||||||
// Map findings to inline comments for lines present in the diff
|
// Map findings to inline comments for lines present in the diff
|
||||||
diffRanges := gitea.ParseDiffNewLines(diff)
|
diffRanges := gitea.ParseDiffNewLines(diff)
|
||||||
var inlineComments []gitea.ReviewComment
|
var inlineComments []vcsReviewComment
|
||||||
for _, f := range result.Findings {
|
for _, f := range result.Findings {
|
||||||
if f.File != "" && f.Line > 0 && diffRanges.Contains(f.File, f.Line) {
|
if f.File != "" && f.Line > 0 && diffRanges.Contains(f.File, f.Line) {
|
||||||
inlineComments = append(inlineComments, gitea.ReviewComment{
|
inlineComments = append(inlineComments, vcsReviewComment{
|
||||||
Path: f.File,
|
Path: f.File,
|
||||||
NewPosition: int64(f.Line),
|
NewPosition: int64(f.Line),
|
||||||
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
Body: fmt.Sprintf("**[%s]** %s", f.Severity, f.Finding),
|
||||||
@@ -353,9 +479,9 @@ func main() {
|
|||||||
// 1. POST new review first (gets non-stale approval badge on HEAD)
|
// 1. POST new review first (gets non-stale approval badge on HEAD)
|
||||||
// 2. Then supersede old review with link to the new one
|
// 2. Then supersede old review with link to the new one
|
||||||
// Order matters: post first so we have the new review's URL for the supersede message.
|
// Order matters: post first so we have the new review's URL for the supersede message.
|
||||||
var oldReviews []gitea.Review
|
var oldReviews []vcsReview
|
||||||
if *reviewerName != "" {
|
if *reviewerName != "" {
|
||||||
existingReviews, err := giteaClient.ListReviews(ctx, owner, repoName, prNumber)
|
existingReviews, err := vcs.ListReviews(ctx, owner, repoName, prNumber)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not list existing reviews", "pr", prNumber, "error", err)
|
slog.Warn("could not list existing reviews", "pr", prNumber, "error", err)
|
||||||
} else {
|
} else {
|
||||||
@@ -368,11 +494,11 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Self-request as reviewer (ensures we appear in required-reviewer checks)
|
// Self-request as reviewer (ensures we appear in required-reviewer checks)
|
||||||
authUser, err := giteaClient.GetAuthenticatedUser(ctx)
|
authUser, err := vcs.GetAuthenticatedUser(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not determine authenticated user for reviewer self-request", "error", err)
|
slog.Warn("could not determine authenticated user for reviewer self-request", "error", err)
|
||||||
} else if authUser != "" {
|
} else if authUser != "" {
|
||||||
if err := giteaClient.RequestReviewer(ctx, owner, repoName, prNumber, authUser); err != nil {
|
if err := vcs.RequestReviewer(ctx, owner, repoName, prNumber, authUser); err != nil {
|
||||||
slog.Warn("could not self-request as reviewer", "user", authUser, "error", err)
|
slog.Warn("could not self-request as reviewer", "user", authUser, "error", err)
|
||||||
} else {
|
} else {
|
||||||
slog.Debug("self-requested as reviewer", "user", authUser, "pr", prNumber)
|
slog.Debug("self-requested as reviewer", "user", authUser, "pr", prNumber)
|
||||||
@@ -381,31 +507,34 @@ 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, inlineComments)
|
posted, err := vcs.PostReview(ctx, owner, repoName, prNumber, event, reviewBody, evaluatedSHA, 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)
|
||||||
}
|
}
|
||||||
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
||||||
|
|
||||||
// Supersede all old reviews with link to the new one
|
// Supersede all old reviews with link to the new one.
|
||||||
if len(oldReviews) > 0 {
|
// This is only supported on Gitea (requires timeline API); GitHub reviews cannot
|
||||||
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(*giteaURL, "/"), owner, repoName, prNumber, posted.ID)
|
// be edited after submission, so we skip the supersede step there.
|
||||||
|
extVCS, isGiteaExt := vcs.(giteaExtClient)
|
||||||
|
if len(oldReviews) > 0 && isGiteaExt {
|
||||||
|
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(*vcsURL, "/"), 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 := extVCS.GetTimelineReviewCommentIDForReview(ctx, owner, repoName, int64(prNumber), oldReview.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
||||||
if err := giteaClient.EditComment(ctx, owner, repoName, cid, supersededBody); err != nil {
|
if err := extVCS.EditComment(ctx, owner, repoName, cid, supersededBody); err != nil {
|
||||||
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "comment_id", cid, "error", err)
|
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "comment_id", cid, "error", err)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
slog.Info("marked old review as superseded", "review_id", oldReview.ID, "new_review_id", posted.ID, "pr", prNumber)
|
slog.Info("marked old review as superseded", "review_id", oldReview.ID, "new_review_id", posted.ID, "pr", prNumber)
|
||||||
|
|
||||||
// Resolve old review's inline comments
|
// Resolve old review's inline comments
|
||||||
oldComments, err := giteaClient.ListReviewComments(ctx, owner, repoName, prNumber, oldReview.ID)
|
oldComments, err := extVCS.ListReviewComments(ctx, owner, repoName, int64(prNumber), oldReview.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
||||||
continue
|
continue
|
||||||
@@ -415,7 +544,7 @@ func main() {
|
|||||||
if c.ID == 0 {
|
if c.ID == 0 {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if err := giteaClient.ResolveComment(ctx, owner, repoName, c.ID); err != nil {
|
if err := extVCS.ResolveComment(ctx, owner, repoName, c.ID); err != nil {
|
||||||
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
||||||
failed++
|
failed++
|
||||||
} else {
|
} else {
|
||||||
@@ -429,12 +558,14 @@ func main() {
|
|||||||
slog.Warn("some inline comments could not be resolved", "review_id", oldReview.ID, "failed", failed, "pr", prNumber)
|
slog.Warn("some inline comments could not be resolved", "review_id", oldReview.ID, "failed", failed, "pr", prNumber)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} else if len(oldReviews) > 0 {
|
||||||
|
slog.Info("skipping supersede of old reviews (not supported on this VCS)", "old_count", len(oldReviews), "pr", prNumber)
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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 *gitea.Client, owner, repo, ref string, files []gitea.ChangedFile) string {
|
func fetchFileContext(ctx context.Context, client vcsClient, owner, repo, ref string, files []vcsChangedFile) 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 {
|
||||||
@@ -460,11 +591,25 @@ func fetchFileContext(ctx context.Context, client *gitea.Client, owner, repo, re
|
|||||||
// 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.
|
||||||
func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patternsFiles string) string {
|
// If patternsFiles is empty, all files from the repo root are fetched.
|
||||||
|
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 {
|
||||||
@@ -481,12 +626,10 @@ func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patt
|
|||||||
}
|
}
|
||||||
owner, repo := parts[0], parts[1]
|
owner, repo := parts[0], parts[1]
|
||||||
|
|
||||||
for _, path := range paths {
|
var repoLoadedFiles []string
|
||||||
path = strings.TrimSpace(path)
|
var repoSkippedFiles []string
|
||||||
if path == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
|
for _, path := range paths {
|
||||||
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)
|
||||||
@@ -496,11 +639,22 @@ func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patt
|
|||||||
for filePath, content := range files {
|
for filePath, content := range files {
|
||||||
// Only include markdown and text files as patterns
|
// Only include markdown and text files as patterns
|
||||||
if !isPatternFile(filePath) {
|
if !isPatternFile(filePath) {
|
||||||
|
repoSkippedFiles = append(repoSkippedFiles, filePath)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
repoLoadedFiles = append(repoLoadedFiles, filePath)
|
||||||
sb.WriteString(fmt.Sprintf("### %s/%s\n\n%s\n\n", repoRef, filePath, content))
|
sb.WriteString(fmt.Sprintf("### %s/%s\n\n%s\n\n", repoRef, filePath, content))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(repoLoadedFiles) > 0 {
|
||||||
|
slog.Info("loaded pattern files", "repo", repoRef, "count", len(repoLoadedFiles), "files", repoLoadedFiles)
|
||||||
|
} else {
|
||||||
|
slog.Warn("no pattern files loaded", "repo", repoRef, "paths", paths)
|
||||||
|
}
|
||||||
|
if len(repoSkippedFiles) > 0 {
|
||||||
|
slog.Debug("skipped non-pattern files", "repo", repoRef, "count", len(repoSkippedFiles), "files", repoSkippedFiles)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return sb.String()
|
return sb.String()
|
||||||
}
|
}
|
||||||
@@ -515,7 +669,7 @@ func isPatternFile(path string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// evaluateCIStatus checks if all CI statuses indicate success.
|
// evaluateCIStatus checks if all CI statuses indicate success.
|
||||||
func evaluateCIStatus(statuses []gitea.CommitStatus) (passed bool, details string) {
|
func evaluateCIStatus(statuses []vcsCommitStatus) (passed bool, details string) {
|
||||||
if len(statuses) == 0 {
|
if len(statuses) == 0 {
|
||||||
return true, "no CI statuses found"
|
return true, "no CI statuses found"
|
||||||
}
|
}
|
||||||
@@ -538,6 +692,19 @@ func evaluateCIStatus(statuses []gitea.CommitStatus) (passed bool, details strin
|
|||||||
return true, "all checks passed"
|
return true, "all checks passed"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// githubAPIURL converts a GitHub server URL to its API base URL.
|
||||||
|
// github.com → https://api.github.com
|
||||||
|
// GHES (e.g. https://ghe.example.com) → https://ghe.example.com/api/v3
|
||||||
|
func githubAPIURL(serverURL string) string {
|
||||||
|
const canonicalGitHub = "https://github.com"
|
||||||
|
const githubAPIBase = "https://api.github.com"
|
||||||
|
if serverURL == "" || strings.TrimRight(serverURL, "/") == canonicalGitHub {
|
||||||
|
return githubAPIBase
|
||||||
|
}
|
||||||
|
// GitHub Enterprise Server: /api/v3 suffix
|
||||||
|
return strings.TrimRight(serverURL, "/") + "/api/v3"
|
||||||
|
}
|
||||||
|
|
||||||
func envOrDefault(key, defaultVal string) string {
|
func envOrDefault(key, defaultVal string) string {
|
||||||
if v := os.Getenv(key); v != "" {
|
if v := os.Getenv(key); v != "" {
|
||||||
return v
|
return v
|
||||||
@@ -587,6 +754,43 @@ func validateReviewerName(name string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// validateWorkspacePath ensures a file path is within the workspace and resolves
|
||||||
|
// symlinks to prevent traversal attacks. Returns the resolved absolute path or
|
||||||
|
// an error if the path is outside the workspace.
|
||||||
|
func validateWorkspacePath(path, pathName string) (string, error) {
|
||||||
|
workspace := os.Getenv("GITHUB_WORKSPACE")
|
||||||
|
if workspace == "" {
|
||||||
|
workspace, _ = os.Getwd()
|
||||||
|
}
|
||||||
|
absWorkspace, err := filepath.Abs(workspace)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to resolve workspace path: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Join and clean the path
|
||||||
|
fullPath := filepath.Join(absWorkspace, path)
|
||||||
|
fullPath = filepath.Clean(fullPath)
|
||||||
|
|
||||||
|
// Check path is within workspace using filepath.Rel (more robust than HasPrefix)
|
||||||
|
rel, err := filepath.Rel(absWorkspace, fullPath)
|
||||||
|
if err != nil || strings.HasPrefix(rel, "..") {
|
||||||
|
return "", fmt.Errorf("%s resolves outside workspace: path=%s workspace=%s", pathName, fullPath, absWorkspace)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve symlinks and re-validate to prevent symlink traversal
|
||||||
|
resolvedPath, err := filepath.EvalSymlinks(fullPath)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to resolve %s: %w", pathName, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
relResolved, err := filepath.Rel(absWorkspace, resolvedPath)
|
||||||
|
if err != nil || strings.HasPrefix(relResolved, "..") {
|
||||||
|
return "", fmt.Errorf("%s symlink resolves outside workspace: resolved=%s workspace=%s", pathName, resolvedPath, absWorkspace)
|
||||||
|
}
|
||||||
|
|
||||||
|
return resolvedPath, nil
|
||||||
|
}
|
||||||
|
|
||||||
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
||||||
// with collapsed original content and the commit it was evaluated against.
|
// with collapsed original content and the commit it was evaluated against.
|
||||||
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
||||||
@@ -616,7 +820,7 @@ func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string)
|
|||||||
// Gitea user. This indicates misconfiguration where two roles share a token
|
// Gitea user. This indicates misconfiguration where two roles share a token
|
||||||
// instead of having separate Gitea accounts. Returns true if shared token
|
// instead of having separate Gitea accounts. Returns true if shared token
|
||||||
// detected (caller should skip update-in-place logic to avoid clobbering).
|
// detected (caller should skip update-in-place logic to avoid clobbering).
|
||||||
func hasSharedToken(reviews []gitea.Review, ownSentinel string) bool {
|
func hasSharedToken(reviews []vcsReview, ownSentinel string) bool {
|
||||||
ownLogin := ""
|
ownLogin := ""
|
||||||
for _, r := range reviews {
|
for _, r := range reviews {
|
||||||
if strings.Contains(r.Body, ownSentinel) {
|
if strings.Contains(r.Body, ownSentinel) {
|
||||||
@@ -654,8 +858,8 @@ func extractSentinelName(body string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// findOwnReview locates the most recent non-superseded review matching the sentinel.
|
// findOwnReview locates the most recent non-superseded review matching the sentinel.
|
||||||
func findOwnReview(reviews []gitea.Review, sentinel string) *gitea.Review {
|
func findOwnReview(reviews []vcsReview, sentinel string) *vcsReview {
|
||||||
var best *gitea.Review
|
var best *vcsReview
|
||||||
for i := range reviews {
|
for i := range reviews {
|
||||||
if !strings.Contains(reviews[i].Body, sentinel) {
|
if !strings.Contains(reviews[i].Body, sentinel) {
|
||||||
continue
|
continue
|
||||||
@@ -671,8 +875,8 @@ func findOwnReview(reviews []gitea.Review, sentinel string) *gitea.Review {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// findAllOwnReviews returns all non-superseded reviews matching the sentinel.
|
// findAllOwnReviews returns all non-superseded reviews matching the sentinel.
|
||||||
func findAllOwnReviews(reviews []gitea.Review, sentinel string) []gitea.Review {
|
func findAllOwnReviews(reviews []vcsReview, sentinel string) []vcsReview {
|
||||||
var result []gitea.Review
|
var result []vcsReview
|
||||||
for i := range reviews {
|
for i := range reviews {
|
||||||
if !strings.Contains(reviews[i].Body, sentinel) {
|
if !strings.Contains(reviews[i].Body, sentinel) {
|
||||||
continue
|
continue
|
||||||
|
|||||||
+506
-35
@@ -2,14 +2,17 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"context"
|
||||||
"flag"
|
"flag"
|
||||||
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
"gitea.weiker.me/rodin/review-bot/review"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestValidateReviewerName(t *testing.T) {
|
func TestValidateReviewerName(t *testing.T) {
|
||||||
@@ -45,18 +48,124 @@ func TestValidateReviewerName(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func makeReview(id int64, login, state string, stale bool, body string) gitea.Review {
|
func TestValidateWorkspacePath(t *testing.T) {
|
||||||
r := gitea.Review{
|
// Create a temp directory as our workspace
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
|
// Create a valid file inside the workspace
|
||||||
|
validFile := filepath.Join(tmpDir, "valid.json")
|
||||||
|
if err := os.WriteFile(validFile, []byte("{}"), 0644); err != nil {
|
||||||
|
t.Fatalf("failed to create test file: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a subdirectory with a file
|
||||||
|
subDir := filepath.Join(tmpDir, "subdir")
|
||||||
|
if err := os.MkdirAll(subDir, 0755); err != nil {
|
||||||
|
t.Fatalf("failed to create subdir: %v", err)
|
||||||
|
}
|
||||||
|
nestedFile := filepath.Join(subDir, "nested.json")
|
||||||
|
if err := os.WriteFile(nestedFile, []byte("{}"), 0644); err != nil {
|
||||||
|
t.Fatalf("failed to create nested file: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a symlink pointing outside the workspace
|
||||||
|
symlinkPath := filepath.Join(tmpDir, "evil-symlink.json")
|
||||||
|
if err := os.Symlink("/etc/passwd", symlinkPath); err != nil {
|
||||||
|
t.Fatalf("failed to create symlink: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Save and restore GITHUB_WORKSPACE
|
||||||
|
origWorkspace := os.Getenv("GITHUB_WORKSPACE")
|
||||||
|
defer os.Setenv("GITHUB_WORKSPACE", origWorkspace)
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
workspace string
|
||||||
|
path string
|
||||||
|
wantErr bool
|
||||||
|
errMatch string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid relative path",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "valid.json",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid nested path",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "subdir/nested.json",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "path traversal attempt",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "../../../etc/passwd",
|
||||||
|
wantErr: true,
|
||||||
|
errMatch: "resolves outside workspace",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "absolute path normalized to workspace-relative",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "/etc/passwd",
|
||||||
|
wantErr: true,
|
||||||
|
// Go 1.21+ filepath.Join normalizes absolute paths: Join("/tmp/x", "/etc/passwd")
|
||||||
|
// becomes "/tmp/x/etc/passwd", which is within workspace but doesn't exist.
|
||||||
|
errMatch: "failed to resolve",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "nonexistent file",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "nonexistent.json",
|
||||||
|
wantErr: true,
|
||||||
|
errMatch: "failed to resolve",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "symlink escaping workspace",
|
||||||
|
workspace: tmpDir,
|
||||||
|
path: "evil-symlink.json",
|
||||||
|
wantErr: true,
|
||||||
|
errMatch: "symlink resolves outside workspace",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
os.Setenv("GITHUB_WORKSPACE", tc.workspace)
|
||||||
|
resolved, err := validateWorkspacePath(tc.path, "test-file")
|
||||||
|
|
||||||
|
if tc.wantErr {
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf("expected error for %q, got nil", tc.path)
|
||||||
|
} else if tc.errMatch != "" && !strings.Contains(err.Error(), tc.errMatch) {
|
||||||
|
t.Errorf("error %q should contain %q", err.Error(), tc.errMatch)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("expected no error for %q, got %v", tc.path, err)
|
||||||
|
}
|
||||||
|
if resolved == "" {
|
||||||
|
t.Error("expected non-empty resolved path")
|
||||||
|
}
|
||||||
|
// Verify resolved path is within workspace
|
||||||
|
if !strings.HasPrefix(resolved, tc.workspace) {
|
||||||
|
t.Errorf("resolved path %q not within workspace %q", resolved, tc.workspace)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeReview(id int64, login, state string, _ bool, body string) vcsReview {
|
||||||
|
r := vcsReview{
|
||||||
ID: id,
|
ID: id,
|
||||||
Body: body,
|
Body: body,
|
||||||
State: state,
|
State: state,
|
||||||
Stale: stale,
|
|
||||||
}
|
}
|
||||||
r.User.Login = login
|
r.User.Login = login
|
||||||
return r
|
return r
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func TestBuildSupersededBody(t *testing.T) {
|
func TestBuildSupersededBody(t *testing.T) {
|
||||||
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
||||||
sentinel := "<!-- review-bot:sonnet -->"
|
sentinel := "<!-- review-bot:sonnet -->"
|
||||||
@@ -108,7 +217,7 @@ func TestBuildSupersededBodyShortSHA(t *testing.T) {
|
|||||||
func TestFindOwnReview(t *testing.T) {
|
func TestFindOwnReview(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
reviews []gitea.Review
|
reviews []vcsReview
|
||||||
sentinel string
|
sentinel string
|
||||||
wantID int64
|
wantID int64
|
||||||
wantNil bool
|
wantNil bool
|
||||||
@@ -121,7 +230,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "found by sentinel",
|
name: "found by sentinel",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(42, "bot", "APPROVED", false, "review body\n<!-- review-bot:sonnet -->"),
|
makeReview(42, "bot", "APPROVED", false, "review body\n<!-- review-bot:sonnet -->"),
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
@@ -129,7 +238,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "wrong sentinel",
|
name: "wrong sentinel",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(42, "bot", "APPROVED", false, "body\n<!-- review-bot:gpt -->"),
|
makeReview(42, "bot", "APPROVED", false, "body\n<!-- review-bot:gpt -->"),
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
@@ -137,7 +246,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "multiple reviews, returns first match",
|
name: "multiple reviews, returns first match",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(10, "bot", "APPROVED", false, "old\n<!-- review-bot:gpt -->"),
|
makeReview(10, "bot", "APPROVED", false, "old\n<!-- review-bot:gpt -->"),
|
||||||
makeReview(20, "bot", "APPROVED", false, "new\n<!-- review-bot:sonnet -->"),
|
makeReview(20, "bot", "APPROVED", false, "new\n<!-- review-bot:sonnet -->"),
|
||||||
},
|
},
|
||||||
@@ -146,7 +255,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "skips superseded review",
|
name: "skips superseded review",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(10, "bot", "APPROVED", false, "~~Original review~~\n\n**Superseded**\n<!-- review-bot:sonnet -->"),
|
makeReview(10, "bot", "APPROVED", false, "~~Original review~~\n\n**Superseded**\n<!-- review-bot:sonnet -->"),
|
||||||
makeReview(20, "bot", "APPROVED", false, "fresh review\n<!-- review-bot:sonnet -->"),
|
makeReview(20, "bot", "APPROVED", false, "fresh review\n<!-- review-bot:sonnet -->"),
|
||||||
},
|
},
|
||||||
@@ -155,7 +264,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "only superseded reviews exist",
|
name: "only superseded reviews exist",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(10, "bot", "APPROVED", false, "~~Original review~~\n\n<!-- review-bot:sonnet -->"),
|
makeReview(10, "bot", "APPROVED", false, "~~Original review~~\n\n<!-- review-bot:sonnet -->"),
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
@@ -163,7 +272,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "picks highest ID among matches",
|
name: "picks highest ID among matches",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
makeReview(50, "bot", "APPROVED", false, "v1\n<!-- review-bot:sonnet -->"),
|
makeReview(50, "bot", "APPROVED", false, "v1\n<!-- review-bot:sonnet -->"),
|
||||||
makeReview(30, "bot", "APPROVED", false, "v0\n<!-- review-bot:sonnet -->"),
|
makeReview(30, "bot", "APPROVED", false, "v0\n<!-- review-bot:sonnet -->"),
|
||||||
},
|
},
|
||||||
@@ -194,7 +303,7 @@ func TestFindOwnReview(t *testing.T) {
|
|||||||
func TestHasSharedToken(t *testing.T) {
|
func TestHasSharedToken(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
reviews []gitea.Review
|
reviews []vcsReview
|
||||||
sentinel string
|
sentinel string
|
||||||
want bool
|
want bool
|
||||||
}{
|
}{
|
||||||
@@ -206,36 +315,36 @@ func TestHasSharedToken(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "no own review yet - cannot detect",
|
name: "no own review yet - cannot detect",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
{ID: 1, User: struct{ Login string `json:"login"` }{Login: "other"}, Body: "<!-- review-bot:gpt --> body"},
|
{ID: 1, User: struct{ Login string }{Login: "other"}, Body: "<!-- review-bot:gpt --> body"},
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
want: false,
|
want: false,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "separate users - no shared token",
|
name: "separate users - no shared token",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
{ID: 1, User: struct{ Login string `json:"login"` }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
{ID: 1, User: struct{ Login string }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
||||||
{ID: 2, User: struct{ Login string `json:"login"` }{Login: "security-review-bot"}, Body: "<!-- review-bot:security --> body"},
|
{ID: 2, User: struct{ Login string }{Login: "security-review-bot"}, Body: "<!-- review-bot:security --> body"},
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
want: false,
|
want: false,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "shared token detected - same user different sentinels",
|
name: "shared token detected - same user different sentinels",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
{ID: 1, User: struct{ Login string `json:"login"` }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
{ID: 1, User: struct{ Login string }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
||||||
{ID: 2, User: struct{ Login string `json:"login"` }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:security --> body"},
|
{ID: 2, User: struct{ Login string }{Login: "sonnet-review-bot"}, Body: "<!-- review-bot:security --> body"},
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
want: true,
|
want: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "three roles same user",
|
name: "three roles same user",
|
||||||
reviews: []gitea.Review{
|
reviews: []vcsReview{
|
||||||
{ID: 1, User: struct{ Login string `json:"login"` }{Login: "bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
{ID: 1, User: struct{ Login string }{Login: "bot"}, Body: "<!-- review-bot:sonnet --> body"},
|
||||||
{ID: 2, User: struct{ Login string `json:"login"` }{Login: "bot"}, Body: "<!-- review-bot:security --> body"},
|
{ID: 2, User: struct{ Login string }{Login: "bot"}, Body: "<!-- review-bot:security --> body"},
|
||||||
{ID: 3, User: struct{ Login string `json:"login"` }{Login: "bot"}, Body: "<!-- review-bot:gpt --> body"},
|
{ID: 3, User: struct{ Login string }{Login: "bot"}, Body: "<!-- review-bot:gpt --> body"},
|
||||||
},
|
},
|
||||||
sentinel: "<!-- review-bot:sonnet -->",
|
sentinel: "<!-- review-bot:sonnet -->",
|
||||||
want: true,
|
want: true,
|
||||||
@@ -396,10 +505,56 @@ 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
|
||||||
statuses []gitea.CommitStatus
|
statuses []vcsCommitStatus
|
||||||
wantPassed bool
|
wantPassed bool
|
||||||
wantSubstr string
|
wantSubstr string
|
||||||
}{
|
}{
|
||||||
@@ -411,7 +566,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "all success",
|
name: "all success",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
||||||
{Status: "success", Context: "ci/test", Description: "Tests passed"},
|
{Status: "success", Context: "ci/test", Description: "Tests passed"},
|
||||||
},
|
},
|
||||||
@@ -420,7 +575,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "one failure",
|
name: "one failure",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
||||||
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
||||||
},
|
},
|
||||||
@@ -429,7 +584,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "error status",
|
name: "error status",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "error", Context: "ci/lint", Description: "Lint error"},
|
{Status: "error", Context: "ci/lint", Description: "Lint error"},
|
||||||
},
|
},
|
||||||
wantPassed: false,
|
wantPassed: false,
|
||||||
@@ -437,7 +592,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "pending treated as not-failed",
|
name: "pending treated as not-failed",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "pending", Context: "ci/build", Description: "In progress"},
|
{Status: "pending", Context: "ci/build", Description: "In progress"},
|
||||||
{Status: "success", Context: "ci/test", Description: "Tests passed"},
|
{Status: "success", Context: "ci/test", Description: "Tests passed"},
|
||||||
},
|
},
|
||||||
@@ -446,7 +601,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "multiple failures",
|
name: "multiple failures",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "failure", Context: "ci/build", Description: "Build failed"},
|
{Status: "failure", Context: "ci/build", Description: "Build failed"},
|
||||||
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
||||||
},
|
},
|
||||||
@@ -455,7 +610,7 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "mixed with pending and failure",
|
name: "mixed with pending and failure",
|
||||||
statuses: []gitea.CommitStatus{
|
statuses: []vcsCommitStatus{
|
||||||
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
{Status: "success", Context: "ci/build", Description: "Build passed"},
|
||||||
{Status: "pending", Context: "ci/deploy", Description: "Deploying"},
|
{Status: "pending", Context: "ci/deploy", Description: "Deploying"},
|
||||||
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
{Status: "failure", Context: "ci/test", Description: "Tests failed"},
|
||||||
@@ -478,6 +633,48 @@ func TestEvaluateCIStatus(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGithubAPIURL(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "empty string defaults to api.github.com",
|
||||||
|
input: "",
|
||||||
|
want: "https://api.github.com",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "github.com maps to api.github.com",
|
||||||
|
input: "https://github.com",
|
||||||
|
want: "https://api.github.com",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "github.com with trailing slash maps to api.github.com",
|
||||||
|
input: "https://github.com/",
|
||||||
|
want: "https://api.github.com",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "GHES host gets /api/v3 suffix",
|
||||||
|
input: "https://ghe.example.com",
|
||||||
|
want: "https://ghe.example.com/api/v3",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "GHES concur domain does not map to api.github.com",
|
||||||
|
input: "https://github.concur.com",
|
||||||
|
want: "https://github.concur.com/api/v3",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := githubAPIURL(tt.input)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("githubAPIURL(%q) = %q, want %q", tt.input, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestEnvOrDefault(t *testing.T) {
|
func TestEnvOrDefault(t *testing.T) {
|
||||||
// Test with unset env var
|
// Test with unset env var
|
||||||
os.Unsetenv("TEST_ENV_OR_DEFAULT_UNSET")
|
os.Unsetenv("TEST_ENV_OR_DEFAULT_UNSET")
|
||||||
@@ -818,7 +1015,7 @@ func TestMainSubprocess_InvalidProvider(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// cleanEnv returns environ without any GITEA/LLM/REVIEWER env vars that would
|
// cleanEnv returns environ without any GITEA/LLM/REVIEWER/VCS env vars that would
|
||||||
// interfere with testing missing-flag scenarios.
|
// interfere with testing missing-flag scenarios.
|
||||||
func cleanEnv() []string {
|
func cleanEnv() []string {
|
||||||
var env []string
|
var env []string
|
||||||
@@ -833,7 +1030,8 @@ func cleanEnv() []string {
|
|||||||
strings.HasPrefix(key, "CONVENTIONS_"),
|
strings.HasPrefix(key, "CONVENTIONS_"),
|
||||||
strings.HasPrefix(key, "SYSTEM_PROMPT_"),
|
strings.HasPrefix(key, "SYSTEM_PROMPT_"),
|
||||||
strings.HasPrefix(key, "PATTERNS_"),
|
strings.HasPrefix(key, "PATTERNS_"),
|
||||||
strings.HasPrefix(key, "UPDATE_"):
|
strings.HasPrefix(key, "UPDATE_"),
|
||||||
|
strings.HasPrefix(key, "VCS_"):
|
||||||
continue
|
continue
|
||||||
default:
|
default:
|
||||||
env = append(env, e)
|
env = append(env, e)
|
||||||
@@ -843,7 +1041,7 @@ func cleanEnv() []string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestFindAllOwnReviews(t *testing.T) {
|
func TestFindAllOwnReviews(t *testing.T) {
|
||||||
reviews := []gitea.Review{
|
reviews := []vcsReview{
|
||||||
{ID: 1, Body: "<!-- review-bot:sonnet -->\nfirst review"},
|
{ID: 1, Body: "<!-- review-bot:sonnet -->\nfirst review"},
|
||||||
{ID: 2, Body: "<!-- review-bot:gpt -->\nother bot"},
|
{ID: 2, Body: "<!-- review-bot:gpt -->\nother bot"},
|
||||||
{ID: 3, Body: "<!-- review-bot:sonnet -->\nsecond review"},
|
{ID: 3, Body: "<!-- review-bot:sonnet -->\nsecond review"},
|
||||||
@@ -912,3 +1110,276 @@ func TestShouldSkipStaleReview(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ============================================================
|
||||||
|
// Mock vcsClient for unit tests
|
||||||
|
// ============================================================
|
||||||
|
|
||||||
|
// mockVCSClient is a minimal mock of vcsClient for testing helper functions.
|
||||||
|
// Only the methods exercised by the test code need implementations; all others
|
||||||
|
// panic with a clear message to catch accidental calls.
|
||||||
|
type mockVCSClient struct {
|
||||||
|
fileContents map[string]string // key: "owner/repo/ref/path"
|
||||||
|
fileContentsErr map[string]error // key same as above → error to return
|
||||||
|
dirContents map[string][]review.ContentEntry
|
||||||
|
dirContentsErr map[string]error
|
||||||
|
allFiles map[string]map[string]string // key: "owner/repo/path"
|
||||||
|
allFilesErr map[string]error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) key(owner, repo, extra string) string {
|
||||||
|
return owner + "/" + repo + "/" + extra
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetPullRequest(ctx context.Context, owner, repo string, number int) (*vcsPullRequest, error) {
|
||||||
|
panic("GetPullRequest not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
||||||
|
panic("GetPullRequestDiff not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]vcsChangedFile, error) {
|
||||||
|
panic("GetPullRequestFiles not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]vcsCommitStatus, error) {
|
||||||
|
panic("GetCommitStatuses not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
panic("GetFileContent not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetFileContentRef(ctx context.Context, owner, repo, path, ref string) (string, error) {
|
||||||
|
k := m.key(owner, repo, ref+"/"+path)
|
||||||
|
if err, ok := m.fileContentsErr[k]; ok {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if content, ok := m.fileContents[k]; ok {
|
||||||
|
return content, nil
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("HTTP 404: not found")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
||||||
|
k := m.key(owner, repo, path)
|
||||||
|
if err, ok := m.dirContentsErr[k]; ok {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if entries, ok := m.dirContents[k]; ok {
|
||||||
|
return entries, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("HTTP 404: not found")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error) {
|
||||||
|
k := m.key(owner, repo, path)
|
||||||
|
if err, ok := m.allFilesErr[k]; ok {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if files, ok := m.allFiles[k]; ok {
|
||||||
|
return files, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("HTTP 404: not found")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
|
||||||
|
panic("PostReview not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcsReview, error) {
|
||||||
|
panic("ListReviews not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
||||||
|
panic("DeleteReview not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
panic("GetAuthenticatedUser not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockVCSClient) RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error {
|
||||||
|
panic("RequestReviewer not implemented in mockVCSClient")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================================
|
||||||
|
// fetchFileContext tests
|
||||||
|
// ============================================================
|
||||||
|
|
||||||
|
func TestFetchFileContext_NoFiles(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{}
|
||||||
|
got := fetchFileContext(ctx, client, "owner", "repo", "main", nil)
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string for no files, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchFileContext_SkipsRemovedFiles(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{}
|
||||||
|
files := []vcsChangedFile{
|
||||||
|
{Filename: "gone.go", Status: "removed"},
|
||||||
|
}
|
||||||
|
got := fetchFileContext(ctx, client, "owner", "repo", "main", files)
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string for removed file, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchFileContext_FetchesModifiedFiles(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
fileContents: map[string]string{
|
||||||
|
"owner/repo/main/foo.go": "package main\n\nfunc main() {}\n",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
files := []vcsChangedFile{
|
||||||
|
{Filename: "foo.go", Status: "modified"},
|
||||||
|
}
|
||||||
|
got := fetchFileContext(ctx, client, "owner", "repo", "main", files)
|
||||||
|
if !strings.Contains(got, "--- foo.go ---") {
|
||||||
|
t.Errorf("expected file header in output, got: %q", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, "package main") {
|
||||||
|
t.Errorf("expected file content in output, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchFileContext_ContinuesOnError(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
fileContents: map[string]string{
|
||||||
|
"owner/repo/main/good.go": "package good\n",
|
||||||
|
},
|
||||||
|
fileContentsErr: map[string]error{
|
||||||
|
"owner/repo/main/bad.go": fmt.Errorf("network error"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
files := []vcsChangedFile{
|
||||||
|
{Filename: "bad.go", Status: "modified"},
|
||||||
|
{Filename: "good.go", Status: "modified"},
|
||||||
|
}
|
||||||
|
got := fetchFileContext(ctx, client, "owner", "repo", "main", files)
|
||||||
|
// bad.go fails, good.go should still be included
|
||||||
|
if strings.Contains(got, "bad.go") {
|
||||||
|
t.Errorf("should not include failed file, got: %q", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, "good.go") {
|
||||||
|
t.Errorf("should include successful file, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchFileContext_RespectsContextCancellation(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel() // Cancel immediately
|
||||||
|
|
||||||
|
client := &mockVCSClient{
|
||||||
|
fileContents: map[string]string{
|
||||||
|
"owner/repo/main/foo.go": "package foo\n",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
files := []vcsChangedFile{
|
||||||
|
{Filename: "foo.go", Status: "modified"},
|
||||||
|
}
|
||||||
|
got := fetchFileContext(ctx, client, "owner", "repo", "main", files)
|
||||||
|
// With cancelled context, the loop breaks before fetching
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string with cancelled context, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================================
|
||||||
|
// fetchPatterns tests
|
||||||
|
// ============================================================
|
||||||
|
|
||||||
|
func TestFetchPatterns_EmptyRepo(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{}
|
||||||
|
got := fetchPatterns(ctx, client, "", "")
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string for empty patternsRepo, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchPatterns_SingleRepoAllFiles(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
allFiles: map[string]map[string]string{
|
||||||
|
"rodin/patterns/": {
|
||||||
|
"patterns/go.md": "# Go patterns\n\nUse interfaces.",
|
||||||
|
"patterns/binary": "binary data",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
got := fetchPatterns(ctx, client, "rodin/patterns", "")
|
||||||
|
if !strings.Contains(got, "# Go patterns") {
|
||||||
|
t.Errorf("expected markdown content, got: %q", got)
|
||||||
|
}
|
||||||
|
// Binary file should be excluded
|
||||||
|
if strings.Contains(got, "binary data") {
|
||||||
|
t.Errorf("binary file should be excluded, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchPatterns_SpecificFiles(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
allFiles: map[string]map[string]string{
|
||||||
|
"rodin/patterns/go.md": {
|
||||||
|
"go.md": "# Go idioms\n",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
got := fetchPatterns(ctx, client, "rodin/patterns", "go.md")
|
||||||
|
if !strings.Contains(got, "# Go idioms") {
|
||||||
|
t.Errorf("expected go idioms content, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchPatterns_SkipsInvalidRepo(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{}
|
||||||
|
// "badrepo" has no slash, should be skipped
|
||||||
|
got := fetchPatterns(ctx, client, "badrepo", "")
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string for invalid repo format, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchPatterns_ContinuesOnFetchError(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
allFilesErr: map[string]error{
|
||||||
|
"owner/repo/": fmt.Errorf("server error"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
// Should not panic; should return empty string
|
||||||
|
got := fetchPatterns(ctx, client, "owner/repo", "")
|
||||||
|
if got != "" {
|
||||||
|
t.Errorf("expected empty string on fetch error, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFetchPatterns_MultipleRepos(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &mockVCSClient{
|
||||||
|
allFiles: map[string]map[string]string{
|
||||||
|
"org/go-patterns/": {
|
||||||
|
"idioms.md": "# Go idioms\n",
|
||||||
|
},
|
||||||
|
"org/elixir-patterns/": {
|
||||||
|
"pipes.md": "# Elixir pipes\n",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
got := fetchPatterns(ctx, client, "org/go-patterns, org/elixir-patterns", "")
|
||||||
|
if !strings.Contains(got, "# Go idioms") {
|
||||||
|
t.Errorf("expected Go idioms content, got: %q", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(got, "# Elixir pipes") {
|
||||||
|
t.Errorf("expected Elixir pipes content, got: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,125 @@
|
|||||||
|
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
|
||||||
|
}
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
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())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,361 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
// vcs.go defines the vcsClient interface that both gitea.Client (via giteaVCSAdapter)
|
||||||
|
// and github.Client (via githubVCSAdapter) satisfy, enabling VCS-type routing in main.go.
|
||||||
|
//
|
||||||
|
// Interface design:
|
||||||
|
// - Methods cover all PR review operations used by main.go.
|
||||||
|
// - Gitea-specific operations (supersede, comment resolution) are in the separate
|
||||||
|
// giteaExtClient interface. GitHub implementations return ErrNotSupported for those.
|
||||||
|
// - Types are defined here as package-local VCS types; each adapter converts from
|
||||||
|
// its respective client package's types.
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/github"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/review"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotSupported is returned by VCS methods that have no implementation for
|
||||||
|
// a particular VCS backend (e.g., Gitea-specific timeline APIs on GitHub).
|
||||||
|
var ErrNotSupported = errors.New("operation not supported on this VCS backend")
|
||||||
|
|
||||||
|
// vcsClient is the interface for all PR operations used by main.go.
|
||||||
|
// It is implemented by both giteaVCSAdapter and githubVCSAdapter.
|
||||||
|
// Interface defined here (in the consumer package) per Go idiom.
|
||||||
|
type vcsClient interface {
|
||||||
|
// PR metadata and content
|
||||||
|
GetPullRequest(ctx context.Context, owner, repo string, number int) (*vcsPullRequest, error)
|
||||||
|
GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error)
|
||||||
|
GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]vcsChangedFile, error)
|
||||||
|
GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]vcsCommitStatus, error)
|
||||||
|
GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error)
|
||||||
|
GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error)
|
||||||
|
ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error)
|
||||||
|
GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error)
|
||||||
|
|
||||||
|
// Review operations
|
||||||
|
PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error)
|
||||||
|
ListReviews(ctx context.Context, owner, repo string, number int) ([]vcsReview, error)
|
||||||
|
DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error
|
||||||
|
GetAuthenticatedUser(ctx context.Context) (string, error)
|
||||||
|
RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// giteaExtClient extends vcsClient with Gitea-specific operations that have no
|
||||||
|
// GitHub equivalent. Code that uses these methods should first do a type assertion.
|
||||||
|
type giteaExtClient interface {
|
||||||
|
vcsClient
|
||||||
|
GetTimelineReviewCommentIDForReview(ctx context.Context, owner, repo string, prNum, reviewID int64) (int64, error)
|
||||||
|
EditComment(ctx context.Context, owner, repo string, commentID int64, body string) error
|
||||||
|
ListReviewComments(ctx context.Context, owner, repo string, prNum, reviewID int64) ([]gitea.ReviewComment, error)
|
||||||
|
ResolveComment(ctx context.Context, owner, repo string, commentID int64) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- shared VCS types ---
|
||||||
|
|
||||||
|
// vcsPullRequest is VCS-agnostic PR metadata.
|
||||||
|
type vcsPullRequest struct {
|
||||||
|
Title string
|
||||||
|
Body string
|
||||||
|
Head struct {
|
||||||
|
Sha string
|
||||||
|
Ref string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// vcsChangedFile is a file changed in a PR.
|
||||||
|
type vcsChangedFile struct {
|
||||||
|
Filename string
|
||||||
|
Status string
|
||||||
|
}
|
||||||
|
|
||||||
|
// vcsCommitStatus is a CI status entry.
|
||||||
|
type vcsCommitStatus struct {
|
||||||
|
Status string
|
||||||
|
Context string
|
||||||
|
Description string
|
||||||
|
TargetURL string
|
||||||
|
}
|
||||||
|
|
||||||
|
// vcsReviewComment is an inline review comment.
|
||||||
|
type vcsReviewComment struct {
|
||||||
|
Path string
|
||||||
|
NewPosition int64 // Gitea: absolute line; GitHub: diff hunk position
|
||||||
|
Body string
|
||||||
|
}
|
||||||
|
|
||||||
|
// vcsReview is a submitted PR review.
|
||||||
|
type vcsReview struct {
|
||||||
|
ID int64
|
||||||
|
Body string
|
||||||
|
CommitID string
|
||||||
|
User struct {
|
||||||
|
Login string
|
||||||
|
}
|
||||||
|
State string
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================================
|
||||||
|
// giteaVCSAdapter
|
||||||
|
// ============================================================
|
||||||
|
|
||||||
|
// giteaVCSAdapter wraps gitea.Client to implement vcsClient + giteaExtClient.
|
||||||
|
type giteaVCSAdapter struct {
|
||||||
|
c *gitea.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func newGiteaVCSAdapter(c *gitea.Client) *giteaVCSAdapter { return &giteaVCSAdapter{c: c} }
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetPullRequest(ctx context.Context, owner, repo string, number int) (*vcsPullRequest, error) {
|
||||||
|
pr, err := a.c.GetPullRequest(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
r := &vcsPullRequest{Title: pr.Title, Body: pr.Body}
|
||||||
|
r.Head.Sha = pr.Head.Sha
|
||||||
|
r.Head.Ref = pr.Head.Ref
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
||||||
|
return a.c.GetPullRequestDiff(ctx, owner, repo, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]vcsChangedFile, error) {
|
||||||
|
files, err := a.c.GetPullRequestFiles(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsChangedFile, len(files))
|
||||||
|
for i, f := range files {
|
||||||
|
out[i] = vcsChangedFile{Filename: f.Filename, Status: f.Status}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]vcsCommitStatus, error) {
|
||||||
|
statuses, err := a.c.GetCommitStatuses(ctx, owner, repo, sha)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsCommitStatus, len(statuses))
|
||||||
|
for i, s := range statuses {
|
||||||
|
out[i] = vcsCommitStatus{Status: s.Status, Context: s.Context, Description: s.Description, TargetURL: s.TargetURL}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
return a.c.GetFileContent(ctx, owner, repo, filepath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
||||||
|
return a.c.GetFileContentRef(ctx, owner, repo, filepath, ref)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
||||||
|
entries, err := a.c.ListContents(ctx, owner, repo, path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]review.ContentEntry, len(entries))
|
||||||
|
for i, e := range entries {
|
||||||
|
out[i] = review.ContentEntry{Name: e.Name, Path: e.Path, Type: e.Type}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error) {
|
||||||
|
return a.c.GetAllFilesInPath(ctx, owner, repo, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
|
||||||
|
gc := make([]gitea.ReviewComment, len(comments))
|
||||||
|
for i, c := range comments {
|
||||||
|
gc[i] = gitea.ReviewComment{Path: c.Path, NewPosition: c.NewPosition, Body: c.Body}
|
||||||
|
}
|
||||||
|
r, err := a.c.PostReview(ctx, owner, repo, number, event, body, commitID, gc)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := &vcsReview{ID: r.ID, Body: r.Body, CommitID: r.CommitID, State: r.State}
|
||||||
|
out.User.Login = r.User.Login
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcsReview, error) {
|
||||||
|
reviews, err := a.c.ListReviews(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsReview, len(reviews))
|
||||||
|
for i, r := range reviews {
|
||||||
|
out[i] = vcsReview{ID: r.ID, Body: r.Body, CommitID: r.CommitID, State: r.State}
|
||||||
|
out[i].User.Login = r.User.Login
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
||||||
|
return a.c.DeleteReview(ctx, owner, repo, number, reviewID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
return a.c.GetAuthenticatedUser(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error {
|
||||||
|
return a.c.RequestReviewer(ctx, owner, repo, number, reviewer)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gitea-specific extension methods.
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) GetTimelineReviewCommentIDForReview(ctx context.Context, owner, repo string, prNum, reviewID int64) (int64, error) {
|
||||||
|
return a.c.GetTimelineReviewCommentIDForReview(ctx, owner, repo, int(prNum), reviewID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) EditComment(ctx context.Context, owner, repo string, commentID int64, body string) error {
|
||||||
|
return a.c.EditComment(ctx, owner, repo, commentID, body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) ListReviewComments(ctx context.Context, owner, repo string, prNum, reviewID int64) ([]gitea.ReviewComment, error) {
|
||||||
|
return a.c.ListReviewComments(ctx, owner, repo, int(prNum), reviewID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaVCSAdapter) ResolveComment(ctx context.Context, owner, repo string, commentID int64) error {
|
||||||
|
return a.c.ResolveComment(ctx, owner, repo, commentID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ============================================================
|
||||||
|
// githubVCSAdapter
|
||||||
|
// ============================================================
|
||||||
|
|
||||||
|
// githubVCSAdapter wraps github.Client to implement vcsClient.
|
||||||
|
// Gitea-specific extension methods (GetTimelineReviewCommentIDForReview, EditComment,
|
||||||
|
// ListReviewComments, ResolveComment) are not available on GitHub and will not be called
|
||||||
|
// because main.go gates them with a type assertion to giteaExtClient.
|
||||||
|
type githubVCSAdapter struct {
|
||||||
|
c *github.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func newGithubVCSAdapter(c *github.Client) *githubVCSAdapter { return &githubVCSAdapter{c: c} }
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetPullRequest(ctx context.Context, owner, repo string, number int) (*vcsPullRequest, error) {
|
||||||
|
pr, err := a.c.GetPullRequest(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
r := &vcsPullRequest{Title: pr.Title, Body: pr.Body}
|
||||||
|
r.Head.Sha = pr.Head.Sha
|
||||||
|
r.Head.Ref = pr.Head.Ref
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
||||||
|
return a.c.GetPullRequestDiff(ctx, owner, repo, number)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]vcsChangedFile, error) {
|
||||||
|
files, err := a.c.GetPullRequestFiles(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsChangedFile, len(files))
|
||||||
|
for i, f := range files {
|
||||||
|
out[i] = vcsChangedFile{Filename: f.Filename, Status: f.Status}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]vcsCommitStatus, error) {
|
||||||
|
statuses, err := a.c.GetCommitStatuses(ctx, owner, repo, sha)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsCommitStatus, len(statuses))
|
||||||
|
for i, s := range statuses {
|
||||||
|
// CommitStatus.Status is tagged as json:"state" — already the normalized "state" value
|
||||||
|
out[i] = vcsCommitStatus{Status: s.Status, Context: s.Context, Description: s.Description, TargetURL: s.TargetURL}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
return a.c.GetFileContent(ctx, owner, repo, filepath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
||||||
|
return a.c.GetFileContentRef(ctx, owner, repo, filepath, ref)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
||||||
|
entries, err := a.c.ListContents(ctx, owner, repo, path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]review.ContentEntry, len(entries))
|
||||||
|
for i, e := range entries {
|
||||||
|
out[i] = review.ContentEntry{Name: e.Name, Path: e.Path, Type: e.Type}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetAllFilesInPath(ctx context.Context, owner, repo, path string) (map[string]string, error) {
|
||||||
|
return a.c.GetAllFilesInPath(ctx, owner, repo, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID string, comments []vcsReviewComment) (*vcsReview, error) {
|
||||||
|
gc := make([]github.ReviewComment, len(comments))
|
||||||
|
for i, c := range comments {
|
||||||
|
// GitHub inline comments use diff hunk "position", not absolute line numbers.
|
||||||
|
// NewPosition from gitea diff parsing gives absolute line numbers, which
|
||||||
|
// will not match GitHub's position values. For initial GitHub support, we
|
||||||
|
// attach comments with Line+Side (absolute line on the RIGHT side) instead.
|
||||||
|
// Comments that cannot be mapped will be omitted (GitHub rejects invalid positions).
|
||||||
|
gc[i] = github.ReviewComment{
|
||||||
|
Path: c.Path,
|
||||||
|
Line: c.NewPosition,
|
||||||
|
Side: "RIGHT",
|
||||||
|
Body: c.Body,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
r, err := a.c.PostReview(ctx, owner, repo, number, event, body, commitID, gc)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := &vcsReview{ID: r.ID, Body: r.Body, State: r.State}
|
||||||
|
out.User.Login = r.User.Login
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcsReview, error) {
|
||||||
|
reviews, err := a.c.ListReviews(ctx, owner, repo, number)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make([]vcsReview, len(reviews))
|
||||||
|
for i, r := range reviews {
|
||||||
|
out[i] = vcsReview{ID: r.ID, Body: r.Body, State: r.State}
|
||||||
|
out[i].User.Login = r.User.Login
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
||||||
|
// GitHub only allows deleting PENDING (draft) reviews. review-bot posts submitted
|
||||||
|
// reviews, so this will return an error for any review we actually posted.
|
||||||
|
// Callers should treat 422 errors here gracefully.
|
||||||
|
return a.c.DeleteReview(ctx, owner, repo, number, reviewID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
return a.c.GetAuthenticatedUser(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *githubVCSAdapter) RequestReviewer(ctx context.Context, owner, repo string, number int, reviewer string) error {
|
||||||
|
return a.c.RequestReviewer(ctx, owner, repo, number, reviewer)
|
||||||
|
}
|
||||||
@@ -0,0 +1,334 @@
|
|||||||
|
# Design: Role-based Review Personas (Issue #51)
|
||||||
|
|
||||||
|
> **Note:** This design was revised during implementation to use JSON instead of YAML
|
||||||
|
> to maintain the repository's zero-external-dependencies convention. All persona
|
||||||
|
> files use JSON format. See "Design Revision" section at the end for details.
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
Current review-bot performs generic code review. Every reviewer (regardless of `reviewer-name`) uses the same base prompt and evaluates the same concerns. This leads to:
|
||||||
|
|
||||||
|
1. **Redundancy** — Two reviewers (e.g., GPT + Claude twins) often flag identical issues
|
||||||
|
2. **Gaps** — Generic reviewers miss specialized concerns (security, domain logic, architecture)
|
||||||
|
3. **Noise** — NITs about style mixed with critical security findings
|
||||||
|
4. **No ownership** — Findings lack clear domain attribution
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
- Must work with existing CLI flags and CI workflow patterns
|
||||||
|
- Must not break backwards compatibility (existing configs still work)
|
||||||
|
- Must integrate cleanly with the budget system (personas add to context)
|
||||||
|
- Multiple personas running in parallel must not interfere with each other
|
||||||
|
- Each persona must have clear scope boundaries (no duplication)
|
||||||
|
|
||||||
|
## Proposed Approach
|
||||||
|
|
||||||
|
### 1. Persona Definition
|
||||||
|
|
||||||
|
A persona is a named review role with:
|
||||||
|
- **Identity** — Who am I? What's my expertise?
|
||||||
|
- **Focus** — What do I look for?
|
||||||
|
- **Scope boundaries** — What do I explicitly NOT comment on?
|
||||||
|
- **Severity calibration** — What counts as MAJOR/MINOR/NIT for MY domain?
|
||||||
|
|
||||||
|
Personas are defined in JSON files that can live:
|
||||||
|
1. In the pattern repos (shared across projects)
|
||||||
|
2. In the target repo (project-specific personas)
|
||||||
|
3. Inline via a new `--persona-file` flag (JSON format)
|
||||||
|
|
||||||
|
### 2. Persona File Format
|
||||||
|
|
||||||
|
```json
|
||||||
|
# .review/personas/security.yaml
|
||||||
|
name: security
|
||||||
|
display_name: Security Specialist
|
||||||
|
model_preference: opus # optional hint for expensive analysis
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
You are a security specialist reviewing code for vulnerabilities.
|
||||||
|
Your expertise: OWASP Top 10, injection attacks, auth/authz, secrets management,
|
||||||
|
event sourcing security (replay attacks, event injection).
|
||||||
|
|
||||||
|
focus:
|
||||||
|
- Injection attacks (SQL, command, path traversal, template)
|
||||||
|
- Authentication and authorization gaps
|
||||||
|
- Secrets exposure (hardcoded credentials, tokens in logs)
|
||||||
|
- Input validation (unsanitized input, unsafe deserialization)
|
||||||
|
- Race conditions with security implications
|
||||||
|
- Event sourcing attack vectors
|
||||||
|
|
||||||
|
ignore:
|
||||||
|
- Code style and naming conventions
|
||||||
|
- Performance (unless security-related)
|
||||||
|
- Documentation
|
||||||
|
- General code quality
|
||||||
|
- Test coverage
|
||||||
|
|
||||||
|
severity:
|
||||||
|
critical: "Remote code execution, auth bypass, data exfiltration"
|
||||||
|
major: "Privilege escalation, information disclosure, DoS"
|
||||||
|
minor: "Missing rate limiting, verbose errors"
|
||||||
|
nit: "Theoretical risk with low exploitability"
|
||||||
|
|
||||||
|
output_format: |
|
||||||
|
For each finding:
|
||||||
|
- Severity: [CRITICAL|MAJOR|MINOR|NIT]
|
||||||
|
- Attack vector: How could this be exploited?
|
||||||
|
- Evidence: Code snippet showing the vulnerability
|
||||||
|
- Recommendation: Specific fix
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. New CLI Flags
|
||||||
|
|
||||||
|
```
|
||||||
|
--persona-file PATH Path to persona JSON file (local or in repo)
|
||||||
|
--persona NAME Built-in persona name (security, architect, domain)
|
||||||
|
```
|
||||||
|
|
||||||
|
Either flag sets the persona. If neither is provided, behavior is unchanged (generic review).
|
||||||
|
|
||||||
|
### 4. Prompt Assembly
|
||||||
|
|
||||||
|
Current flow:
|
||||||
|
```
|
||||||
|
SystemBase → Patterns → Conventions → [LLM]
|
||||||
|
```
|
||||||
|
|
||||||
|
New flow with persona:
|
||||||
|
```
|
||||||
|
PersonaPrompt (from YAML) → Patterns (filtered?) → Conventions → [LLM]
|
||||||
|
```
|
||||||
|
|
||||||
|
The persona's identity/focus/ignore/severity sections become the system prompt, replacing the generic "You are an expert code reviewer" base.
|
||||||
|
|
||||||
|
### 5. Built-in Personas
|
||||||
|
|
||||||
|
Ship with these built-in personas (loadable via `--persona NAME`):
|
||||||
|
|
||||||
|
| Name | Focus |
|
||||||
|
|------|-------|
|
||||||
|
| `security` | Vulnerabilities, auth, secrets |
|
||||||
|
| `architect` | Patterns, consistency, design |
|
||||||
|
| `domain` | Business logic (requires repo-specific config) |
|
||||||
|
| `docs` | Documentation, API clarity |
|
||||||
|
|
||||||
|
Built-in personas live in `review/personas/` as embedded Go assets or YAML shipped with the binary.
|
||||||
|
|
||||||
|
### 6. CI Workflow Integration
|
||||||
|
|
||||||
|
Single persona:
|
||||||
|
```yaml
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: security
|
||||||
|
persona: security
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Multiple personas (parallel jobs):
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: security
|
||||||
|
persona: security
|
||||||
|
- name: architect
|
||||||
|
persona: architect
|
||||||
|
steps:
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: ${{ matrix.name }}
|
||||||
|
persona: ${{ matrix.persona }}
|
||||||
|
```
|
||||||
|
|
||||||
|
Custom persona from repo:
|
||||||
|
```yaml
|
||||||
|
- uses: rodin/review-bot/.gitea/actions/review@v1
|
||||||
|
with:
|
||||||
|
reviewer-name: trading
|
||||||
|
persona-file: .review/personas/trading.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7. Persona + Patterns Interaction
|
||||||
|
|
||||||
|
Some personas benefit from filtered patterns:
|
||||||
|
- Security → only security-related patterns
|
||||||
|
- Architect → all patterns (structural focus)
|
||||||
|
- Domain → domain docs, not language patterns
|
||||||
|
|
||||||
|
For v1, keep it simple: all patterns are included regardless of persona. Future enhancement could add `patterns_filter` to persona YAML.
|
||||||
|
|
||||||
|
### 8. Output Format Changes
|
||||||
|
|
||||||
|
Persona name appears in the review header:
|
||||||
|
```markdown
|
||||||
|
# Security Review
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
No critical vulnerabilities found in this change.
|
||||||
|
|
||||||
|
## Findings
|
||||||
|
| # | Severity | File | Line | Finding |
|
||||||
|
...
|
||||||
|
|
||||||
|
## Recommendation
|
||||||
|
**APPROVE** — No security-relevant issues detected.
|
||||||
|
|
||||||
|
---
|
||||||
|
*Review by security*
|
||||||
|
<!-- review-bot:security -->
|
||||||
|
```
|
||||||
|
|
||||||
|
## State/Data Model
|
||||||
|
|
||||||
|
### Persona struct
|
||||||
|
|
||||||
|
```go
|
||||||
|
// review/persona.go
|
||||||
|
type Persona struct {
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
DisplayName string `yaml:"display_name"`
|
||||||
|
ModelPref string `yaml:"model_preference,omitempty"`
|
||||||
|
Identity string `yaml:"identity"`
|
||||||
|
Focus []string `yaml:"focus"`
|
||||||
|
Ignore []string `yaml:"ignore"`
|
||||||
|
Severity Severity `yaml:"severity"`
|
||||||
|
OutputFormat string `yaml:"output_format,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Severity struct {
|
||||||
|
Critical string `yaml:"critical"`
|
||||||
|
Major string `yaml:"major"`
|
||||||
|
Minor string `yaml:"minor"`
|
||||||
|
Nit string `yaml:"nit"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Loading precedence
|
||||||
|
|
||||||
|
1. `--persona-file PATH` → load from local file system
|
||||||
|
2. `--persona NAME` → load from embedded built-ins
|
||||||
|
3. Neither → use generic system prompt (current behavior)
|
||||||
|
|
||||||
|
## Error Cases
|
||||||
|
|
||||||
|
| Error | Handling |
|
||||||
|
|-------|----------|
|
||||||
|
| Persona file not found | Fatal exit with clear message |
|
||||||
|
| Invalid YAML in persona file | Fatal exit with parse error |
|
||||||
|
| Both `--persona` and `--persona-file` specified | Fatal exit: mutually exclusive |
|
||||||
|
| Unknown built-in persona name | Fatal exit with list of valid names |
|
||||||
|
| Empty identity in persona | Warning, fall back to generic prompt |
|
||||||
|
|
||||||
|
## Edge Cases
|
||||||
|
|
||||||
|
- **Empty focus list**: Valid — persona relies on identity alone
|
||||||
|
- **Empty ignore list**: Valid — no explicit scope exclusions
|
||||||
|
- **No severity section**: Use default MAJOR/MINOR/NIT definitions
|
||||||
|
- **Model preference set but budget insufficient**: Ignore preference, log warning
|
||||||
|
- **Persona file in pattern repo**: Fetch like other pattern files
|
||||||
|
|
||||||
|
## Testing Strategy
|
||||||
|
|
||||||
|
### Unit tests
|
||||||
|
- `persona_test.go`: Parse valid/invalid YAML, validate required fields
|
||||||
|
- `prompt_test.go`: Verify persona prompt assembly
|
||||||
|
- Integration with budget: persona prompts count toward token limit
|
||||||
|
|
||||||
|
### Integration tests
|
||||||
|
- End-to-end with `--persona security` (built-in)
|
||||||
|
- End-to-end with `--persona-file custom.yaml`
|
||||||
|
- Backwards compatibility: no flags = generic behavior
|
||||||
|
|
||||||
|
### Manual verification
|
||||||
|
- Run security persona on a PR with obvious vulnerability
|
||||||
|
- Verify security persona ignores style issues
|
||||||
|
- Verify non-security persona doesn't flag security issues
|
||||||
|
|
||||||
|
## Implementation Phases
|
||||||
|
|
||||||
|
### Phase 1: Persona types and loading
|
||||||
|
- [ ] `review/persona.go`: Persona struct + YAML parsing
|
||||||
|
- [ ] `review/persona_test.go`: Unit tests
|
||||||
|
- [ ] Embed built-in personas in binary
|
||||||
|
- [ ] Compiles clean, tests pass
|
||||||
|
|
||||||
|
### Phase 2: Prompt generation
|
||||||
|
- [ ] `review/prompt.go`: `BuildPersonaPrompt(p Persona) string`
|
||||||
|
- [ ] Modify `BuildSystemBase()` to accept optional persona
|
||||||
|
- [ ] Integrate persona prompt with budget system
|
||||||
|
- [ ] Tests for prompt assembly
|
||||||
|
|
||||||
|
### Phase 3: CLI integration
|
||||||
|
- [ ] Add `--persona` and `--persona-file` flags
|
||||||
|
- [ ] Flag validation (mutually exclusive, valid names)
|
||||||
|
- [ ] Load persona based on flags
|
||||||
|
- [ ] Pass persona to prompt builder
|
||||||
|
|
||||||
|
### Phase 4: Action integration
|
||||||
|
- [ ] Add `persona` and `persona-file` inputs to action.yml
|
||||||
|
- [ ] Update README with persona examples
|
||||||
|
- [ ] End-to-end CI test
|
||||||
|
|
||||||
|
### Phase 5: Built-in personas
|
||||||
|
- [ ] `security.yaml` built-in
|
||||||
|
- [ ] `architect.yaml` built-in
|
||||||
|
- [ ] `docs.yaml` built-in
|
||||||
|
- [ ] Document each persona's focus
|
||||||
|
|
||||||
|
## Open Questions
|
||||||
|
|
||||||
|
1. **Persona file location in repo**: Should we support `--persona-file .review/security.yaml` where the file is fetched from the PR's repo (like conventions)? This adds complexity but enables project-specific personas without action changes.
|
||||||
|
|
||||||
|
2. **Model preference enforcement**: If persona specifies `model_preference: opus` but the action uses a different model, should we warn? Override? Ignore? Current thinking: log warning, use the specified model (user controls model via action input).
|
||||||
|
|
||||||
|
3. **Severity override output**: If persona defines custom severity levels (CRITICAL), should the JSON output include them, or map back to standard MAJOR/MINOR/NIT? Current thinking: keep standard output format, use severity calibration only for prompt guidance.
|
||||||
|
|
||||||
|
## Completion Checklist
|
||||||
|
|
||||||
|
1. Persona struct matches YAML schema exactly?
|
||||||
|
2. Built-in personas embedded in binary (not external files)?
|
||||||
|
3. `--persona` and `--persona-file` are mutually exclusive?
|
||||||
|
4. Unknown persona name produces clear error with valid options?
|
||||||
|
5. Empty persona file fields have sensible defaults?
|
||||||
|
6. Persona prompt integrates with budget system (token counting)?
|
||||||
|
7. Backwards compatibility: no flags = current behavior?
|
||||||
|
8. Review header shows persona display name?
|
||||||
|
9. Sentinel still uses reviewer-name (not persona name)?
|
||||||
|
10. Unit tests cover parse errors, missing fields, valid YAML?
|
||||||
|
|
||||||
|
## Design Review Findings (Self-Review)
|
||||||
|
|
||||||
|
### Finding 1: Severity Mapping
|
||||||
|
The persona YAML allows `critical` severity, but the LLM output parser (`review/parser.go`) only accepts MAJOR/MINOR/NIT.
|
||||||
|
|
||||||
|
**Resolution:** Keep standard output format. Persona severity section is ONLY for calibrating the LLM's judgment (prompt guidance). Output must still use MAJOR/MINOR/NIT. Document this clearly in persona format docs.
|
||||||
|
|
||||||
|
### Finding 2: Embedding Built-in Personas
|
||||||
|
Go doesn't natively embed YAML. Must use `//go:embed` directive (Go 1.16+).
|
||||||
|
|
||||||
|
**Resolution:** Create `review/personas/` directory with YAML files and use:
|
||||||
|
```go
|
||||||
|
//go:embed personas/*.yaml
|
||||||
|
var embeddedPersonas embed.FS
|
||||||
|
```
|
||||||
|
|
||||||
|
### Finding 3: display_name vs reviewer-name
|
||||||
|
Design says header shows "persona display name" but sentinel uses "reviewer-name". This is correct - they serve different purposes:
|
||||||
|
- `display_name` → human-readable header ("Security Specialist Review")
|
||||||
|
- `reviewer-name` → machine sentinel for cleanup (`<!-- review-bot:security -->`)
|
||||||
|
|
||||||
|
When persona is used, `display_name` takes precedence for the header title, but `reviewer-name` (CLI flag) is still used for the sentinel.
|
||||||
|
|
||||||
|
## Design Revision: YAML with gopkg.in/yaml.v3
|
||||||
|
|
||||||
|
**Decision:** Add `gopkg.in/yaml.v3` as a dependency.
|
||||||
|
|
||||||
|
YAML is preferred over JSON for persona files because:
|
||||||
|
- Multi-line strings are cleaner (no escaping quotes in identity/focus text)
|
||||||
|
- Comments are supported for documentation
|
||||||
|
- More human-readable for complex persona definitions
|
||||||
|
|
||||||
|
The implementation supports both YAML (`.yaml`, `.yml`) and JSON (`.json`) for backwards compatibility, with YAML as the default for built-in personas.
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
# Design: YAML Support for Persona Files (#57)
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
JSON is awkward for persona files that contain multi-line text (identity, severity descriptions). YAML supports cleaner multi-line strings and comments, improving readability and maintainability.
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
- Backwards compatibility: existing JSON personas must continue to work
|
||||||
|
- Security: protect against DoS via deeply nested YAML (AIKIDO-2024-10486)
|
||||||
|
- 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
|
||||||
|
|
||||||
|
## Proposed Approach
|
||||||
|
|
||||||
|
1. **Update `parsePersona`** to detect format from file extension
|
||||||
|
2. **Add YAML parsing** with explicit depth limit (defense in depth)
|
||||||
|
3. **Keep JSON as fallback** for files without `.yaml`/`.yml` extension
|
||||||
|
4. **Convert built-in personas** to YAML format
|
||||||
|
5. **Update embed directive** to include both formats
|
||||||
|
|
||||||
|
### File Extension Detection
|
||||||
|
|
||||||
|
```go
|
||||||
|
func parsePersona(data []byte, source string) (*Persona, error) {
|
||||||
|
isYAML := strings.HasSuffix(source, ".yaml") || strings.HasSuffix(source, ".yml")
|
||||||
|
if isYAML {
|
||||||
|
return parseYAML(data, source)
|
||||||
|
}
|
||||||
|
return parseJSON(data, source)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### YAML Parsing with Depth Protection
|
||||||
|
|
||||||
|
We implement a custom AST-based depth/node-count walk (`checkYAMLDepth` in
|
||||||
|
`review/persona.go`) rather than relying on library decoder options. Key design
|
||||||
|
decisions:
|
||||||
|
|
||||||
|
- **Library:** `github.com/goccy/go-yaml` with `ast.Node`-based traversal
|
||||||
|
- **Dual-map tracking:** `validated` (depth-aware short-circuit) + `visiting` (cycle detection)
|
||||||
|
- **Node-count limit:** Conservative overcounting bounds total validation work
|
||||||
|
- **Alias-aware depth:** Aliases increment depth and are re-checked when encountered at greater depths
|
||||||
|
|
||||||
|
See `review/persona.go:checkYAMLDepth` for the authoritative implementation.
|
||||||
|
|
||||||
|
## State/Data Model
|
||||||
|
|
||||||
|
No new state. Same `Persona` struct, just different parsing.
|
||||||
|
|
||||||
|
## Error Cases
|
||||||
|
|
||||||
|
| Error | Handling |
|
||||||
|
|-------|----------|
|
||||||
|
| Invalid YAML syntax | Return parse error with source file |
|
||||||
|
| Deeply nested YAML | Custom AST walk (`checkYAMLDepth`) rejects before decode |
|
||||||
|
| Unknown extension | Fall back to JSON parsing |
|
||||||
|
| Missing required fields | Validation rejects after parse |
|
||||||
|
|
||||||
|
## Edge Cases
|
||||||
|
|
||||||
|
- File with `.json` extension but YAML content → JSON parse fails, user sees error
|
||||||
|
- File with no extension → defaults to JSON
|
||||||
|
- Embedded persona reference like `builtin:security` → detect by embed path (`personas/X.yaml`)
|
||||||
|
|
||||||
|
## Testing Strategy
|
||||||
|
|
||||||
|
1. Unit tests for YAML parsing (valid, invalid, deeply nested)
|
||||||
|
2. Unit tests for extension detection
|
||||||
|
3. Integration test for built-in personas (now YAML)
|
||||||
|
4. Backwards compat test: verify JSON still works for external files
|
||||||
|
|
||||||
|
## Completion Checklist
|
||||||
|
|
||||||
|
1. [ ] `go-yaml` dependency added at v1.16.0+
|
||||||
|
2. [ ] Extension detection uses case-insensitive comparison
|
||||||
|
3. [ ] YAML parse errors include source file name
|
||||||
|
4. [ ] JSON parsing still works for `.json` files
|
||||||
|
5. [ ] Built-in personas converted to YAML with readable multi-line strings
|
||||||
|
6. [ ] Embed directive updated to include `*.yaml`
|
||||||
|
7. [ ] Test for deeply nested YAML rejection
|
||||||
|
8. [ ] All existing tests pass
|
||||||
|
|
||||||
|
## Open Questions
|
||||||
|
|
||||||
|
- Should we support both `.yaml` AND `.yml`? Issue says `.yaml` only for consistency, but some users expect `.yml`. **Decision:** Support both for reading, recommend `.yaml` in docs.
|
||||||
|
- Should we add a "format" field to detect mismatched extension/content? **Decision:** No, keep it simple. Extension determines format.
|
||||||
+403
-10
@@ -11,9 +11,12 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"math"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -39,23 +42,181 @@ func IsNotFound(err error) bool {
|
|||||||
return errors.As(err, &apiErr) && apiErr.StatusCode == http.StatusNotFound
|
return errors.As(err, &apiErr) && apiErr.StatusCode == http.StatusNotFound
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IsServerError reports whether an error is an API 5xx response.
|
||||||
|
func IsServerError(err error) bool {
|
||||||
|
var apiErr *APIError
|
||||||
|
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 {
|
||||||
baseURL string
|
baseURL string
|
||||||
token string
|
token string
|
||||||
http *http.Client
|
http *http.Client
|
||||||
|
|
||||||
|
// RetryBackoff defines the delays between retry attempts.
|
||||||
|
// RetryBackoff[i] is the delay before attempt i+1 (after attempt i fails).
|
||||||
|
// If nil, defaults to {1s, 2s}. Set to shorter durations in tests.
|
||||||
|
//
|
||||||
|
// This field must be configured before the first request is made.
|
||||||
|
// Modifying it while requests are in flight is not safe.
|
||||||
|
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: &http.Client{Timeout: 30 * time.Second},
|
http: newSafeHTTPClient(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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.
|
||||||
|
// 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 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) {
|
||||||
|
if hc == nil {
|
||||||
|
hc = newSafeHTTPClient()
|
||||||
|
}
|
||||||
|
c.http = hc
|
||||||
|
}
|
||||||
|
|
||||||
// PullRequest holds relevant PR metadata.
|
// PullRequest holds relevant PR metadata.
|
||||||
type PullRequest struct {
|
type PullRequest struct {
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
@@ -103,13 +264,32 @@ 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)
|
||||||
|
|
||||||
|
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)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetch diff: %w", err)
|
return "", fmt.Errorf("fetch diff: %w", err)
|
||||||
}
|
}
|
||||||
return string(body), nil
|
return string(body), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := c.doGetLimited(ctx, reqURL, maxSize)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("fetch diff: %w", err)
|
||||||
|
}
|
||||||
|
return string(body), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetPullRequestFiles fetches the list of files changed in a PR.
|
// GetPullRequestFiles fetches the list of files changed in a PR.
|
||||||
@@ -161,18 +341,22 @@ 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 "APPROVED" or "REQUEST_CHANGES".
|
// event should be one of "APPROVED", "REQUEST_CHANGES", or "COMMENT".
|
||||||
|
// 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 string, comments []ReviewComment) (*Review, error) {
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body, commitID 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,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -210,7 +394,145 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
return &review, nil
|
return &review, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
// isTemporaryNetError reports whether err is a temporary network error worth retrying.
|
||||||
|
// This includes connection refused, network unreachable, connection reset, and DNS
|
||||||
|
// timeouts. It explicitly excludes permanent errors like permission denied or
|
||||||
|
// "no such host" DNS failures.
|
||||||
|
func isTemporaryNetError(err error) bool {
|
||||||
|
if err == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for OpError and inspect the underlying syscall error.
|
||||||
|
// Not all OpErrors are transient — permission denied, for example, is permanent.
|
||||||
|
var opErr *net.OpError
|
||||||
|
if errors.As(err, &opErr) {
|
||||||
|
return isRetriableSyscallError(opErr.Err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DNS errors: only retry on timeout, not on "no such host" which is permanent.
|
||||||
|
var dnsErr *net.DNSError
|
||||||
|
if errors.As(err, &dnsErr) {
|
||||||
|
return dnsErr.IsTimeout
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for net.Error with Timeout() (Temporary is deprecated)
|
||||||
|
var netErr net.Error
|
||||||
|
if errors.As(err, &netErr) {
|
||||||
|
return netErr.Timeout()
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// isRetriableSyscallError reports whether the underlying error from a net.OpError
|
||||||
|
// is a transient syscall error worth retrying.
|
||||||
|
func isRetriableSyscallError(err error) bool {
|
||||||
|
if err == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for syscall.Errno directly or wrapped
|
||||||
|
var errno syscall.Errno
|
||||||
|
if errors.As(err, &errno) {
|
||||||
|
switch errno {
|
||||||
|
case syscall.ECONNREFUSED, // connection refused — server not listening
|
||||||
|
syscall.ECONNRESET, // connection reset by peer
|
||||||
|
syscall.ENETUNREACH, // network unreachable
|
||||||
|
syscall.EHOSTUNREACH, // host unreachable
|
||||||
|
syscall.ETIMEDOUT: // connection timed out
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
// EACCES, EPERM, etc. are permanent — don't retry
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we can't identify the specific syscall error, be conservative and retry.
|
||||||
|
// This handles wrapped errors or platform-specific error types.
|
||||||
|
// The retry count is limited, so erring on the side of retrying is safe.
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// redactURL strips query parameters and userinfo credentials from a URL for
|
||||||
|
// safe logging. This prevents accidental exposure of sensitive data (tokens in
|
||||||
|
// query strings, or user:pass in the authority) in log output.
|
||||||
|
func redactURL(rawURL string) string {
|
||||||
|
parsed, err := url.Parse(rawURL)
|
||||||
|
if err != nil {
|
||||||
|
// If we cannot parse it, return a safe placeholder rather than
|
||||||
|
// potentially logging something sensitive.
|
||||||
|
return "[invalid URL]"
|
||||||
|
}
|
||||||
|
if parsed.User != nil {
|
||||||
|
parsed.User = url.User("REDACTED")
|
||||||
|
}
|
||||||
|
if parsed.RawQuery != "" {
|
||||||
|
parsed.RawQuery = "[redacted]"
|
||||||
|
}
|
||||||
|
return parsed.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanitizeErrorForLog returns a loggable version of an error that omits
|
||||||
|
// potentially sensitive content like response bodies. For APIError, only
|
||||||
|
// the status code is included; for other errors, the type is preserved.
|
||||||
|
func sanitizeErrorForLog(err error) string {
|
||||||
|
if err == nil {
|
||||||
|
return "<nil>"
|
||||||
|
}
|
||||||
|
var apiErr *APIError
|
||||||
|
if errors.As(err, &apiErr) {
|
||||||
|
return fmt.Sprintf("HTTP %d", apiErr.StatusCode)
|
||||||
|
}
|
||||||
|
return err.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// doGetWithReader performs an HTTP GET request with retry on 5xx errors and
|
||||||
|
// temporary network errors. Retries up to 3 times with exponential backoff
|
||||||
|
// (1s, 2s delays by default; configurable via Client.RetryBackoff for testing).
|
||||||
|
// The readBody function is called with the response body on success (2xx) and
|
||||||
|
// 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
|
||||||
|
// 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.
|
||||||
|
backoff := c.RetryBackoff
|
||||||
|
if backoff == nil {
|
||||||
|
backoff = []time.Duration{1 * time.Second, 2 * time.Second}
|
||||||
|
}
|
||||||
|
|
||||||
|
// maxErrorBodyBytes limits how much of an error response body we read
|
||||||
|
// to protect against malicious servers sending unbounded data.
|
||||||
|
const maxErrorBodyBytes = 64 * 1024 // 64 KB
|
||||||
|
|
||||||
|
var lastErr error
|
||||||
|
for attempt := 0; attempt < maxAttempts; attempt++ {
|
||||||
|
if attempt > 0 {
|
||||||
|
// Determine delay: use backoff slice if available, otherwise retry immediately.
|
||||||
|
// An empty RetryBackoff slice means "retry without delay" — this is intentional
|
||||||
|
// as the caller explicitly configured no delays.
|
||||||
|
var delay time.Duration
|
||||||
|
if attempt-1 < len(backoff) {
|
||||||
|
delay = backoff[attempt-1]
|
||||||
|
}
|
||||||
|
|
||||||
|
if delay > 0 {
|
||||||
|
slog.Warn("retrying request after error",
|
||||||
|
"attempt", attempt+1,
|
||||||
|
"url", redactURL(reqURL),
|
||||||
|
"delay", delay.String(),
|
||||||
|
"lastError", sanitizeErrorForLog(lastErr))
|
||||||
|
|
||||||
|
timer := time.NewTimer(delay)
|
||||||
|
select {
|
||||||
|
case <-timer.C:
|
||||||
|
case <-ctx.Done():
|
||||||
|
timer.Stop()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, nil)
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -218,16 +540,72 @@ func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
|||||||
req.Header.Set("Authorization", "token "+c.token)
|
req.Header.Set("Authorization", "token "+c.token)
|
||||||
|
|
||||||
resp, err := c.http.Do(req)
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
// Always capture the error for consistent return at loop end.
|
||||||
|
// This ensures both network errors and HTTP 5xx return lastErr.
|
||||||
|
lastErr = err
|
||||||
|
|
||||||
|
// Only retry temporary network errors when attempts remain.
|
||||||
|
if attempt < maxAttempts-1 && isTemporaryNetError(err) {
|
||||||
|
slog.Warn("temporary network error, will retry",
|
||||||
|
"attempt", attempt+1,
|
||||||
|
"url", redactURL(reqURL),
|
||||||
|
"error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Non-retryable network error or final attempt exhausted.
|
||||||
|
return nil, lastErr
|
||||||
|
}
|
||||||
|
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
||||||
|
return readBody(resp.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error path: limit how much we read from potentially malicious server
|
||||||
|
errBody, _ := io.ReadAll(io.LimitReader(resp.Body, maxErrorBodyBytes))
|
||||||
|
resp.Body.Close()
|
||||||
|
|
||||||
|
lastErr = &APIError{StatusCode: resp.StatusCode, Body: string(errBody)}
|
||||||
|
|
||||||
|
// Only retry on 5xx server errors
|
||||||
|
if resp.StatusCode < 500 || resp.StatusCode >= 600 {
|
||||||
|
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 {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
defer resp.Body.Close()
|
if int64(len(data)) > maxBytes {
|
||||||
|
return nil, fmt.Errorf("%w: response exceeds %d bytes", ErrDiffTooLarge, maxBytes)
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
body, _ := io.ReadAll(resp.Body)
|
|
||||||
return nil, &APIError{StatusCode: resp.StatusCode, Body: string(body)}
|
|
||||||
}
|
}
|
||||||
return io.ReadAll(resp.Body)
|
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.
|
||||||
@@ -251,7 +629,13 @@ type ContentEntry struct {
|
|||||||
|
|
||||||
// ListContents lists files and directories at a given path in a repo.
|
// ListContents lists files and directories at a given path in a repo.
|
||||||
// Pass an empty path to list the repository root.
|
// Pass an empty path to list the repository root.
|
||||||
|
// If the path points to a file (not a directory), Gitea returns a single
|
||||||
|
// object instead of an array; this method normalizes both cases to a slice.
|
||||||
func (c *Client) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
func (c *Client) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
||||||
|
// Normalize "." to empty string — Gitea API rejects "." with 500
|
||||||
|
if path == "." {
|
||||||
|
path = ""
|
||||||
|
}
|
||||||
var reqURL string
|
var reqURL string
|
||||||
if path == "" {
|
if path == "" {
|
||||||
reqURL = fmt.Sprintf("%s/api/v1/repos/%s/%s/contents", c.baseURL, url.PathEscape(owner), url.PathEscape(repo))
|
reqURL = fmt.Sprintf("%s/api/v1/repos/%s/%s/contents", c.baseURL, url.PathEscape(owner), url.PathEscape(repo))
|
||||||
@@ -264,8 +648,17 @@ func (c *Client) ListContents(ctx context.Context, owner, repo, path string) ([]
|
|||||||
}
|
}
|
||||||
var entries []ContentEntry
|
var entries []ContentEntry
|
||||||
if err := json.Unmarshal(body, &entries); err != nil {
|
if err := json.Unmarshal(body, &entries); err != nil {
|
||||||
|
// Gitea returns a single object (not an array) 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)
|
return nil, fmt.Errorf("parse contents JSON: %w", err)
|
||||||
}
|
}
|
||||||
|
// Guard against empty/malformed responses
|
||||||
|
if single.Name == "" && single.Path == "" {
|
||||||
|
return nil, fmt.Errorf("parse contents JSON: empty response for path %q", path)
|
||||||
|
}
|
||||||
|
entries = []ContentEntry{single}
|
||||||
|
}
|
||||||
return entries, nil
|
return entries, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+789
-35
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,97 @@
|
|||||||
|
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))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
// 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()
|
||||||
|
}
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
// 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
|
||||||
|
}
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
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 := NewClient(server.URL, "test-token")
|
client := NewTestClient(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 := NewClient(server.URL, "test-token")
|
client := NewTestClient(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)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,831 @@
|
|||||||
|
// 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 (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/json"
|
||||||
|
"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 {
|
||||||
|
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, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
// doRequestWithBody performs an HTTP request with an optional body, applying the
|
||||||
|
// same HTTPS enforcement as doRequest. It is used by write methods (POST, PUT,
|
||||||
|
// DELETE) that bypass the retry loop in doRequest because write operations are
|
||||||
|
// not idempotent.
|
||||||
|
//
|
||||||
|
// body may be nil for requests that carry no payload (e.g. DELETE).
|
||||||
|
// When body is non-nil, Content-Type is set to application/json.
|
||||||
|
func (c *Client) doRequestWithBody(ctx context.Context, method, reqURL string, body []byte) ([]byte, error) {
|
||||||
|
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 reqBody io.Reader
|
||||||
|
if body != nil {
|
||||||
|
reqBody = bytes.NewReader(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, method, reqURL, reqBody)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("create request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+c.token)
|
||||||
|
req.Header.Set("Accept", "application/vnd.github+json")
|
||||||
|
if body != nil {
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := c.httpClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("do request: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
||||||
|
respBody, err := io.ReadAll(io.LimitReader(resp.Body, maxResponseBodyBytes))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("read response body: %w", err)
|
||||||
|
}
|
||||||
|
return respBody, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
errBody, _ := io.ReadAll(io.LimitReader(resp.Body, maxErrorBodyBytes))
|
||||||
|
return nil, &APIError{StatusCode: resp.StatusCode, Body: string(errBody)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- API types ---
|
||||||
|
|
||||||
|
// 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"`
|
||||||
|
Draft bool `json:"draft"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommitStatus represents a single CI status entry.
|
||||||
|
// GitHub returns "state" not "status"; this type uses Status for consistency
|
||||||
|
// with the gitea package (both are normalized before use).
|
||||||
|
type CommitStatus struct {
|
||||||
|
Status string `json:"state"` // GitHub field is "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 "position" (diff hunk position), whereas Gitea uses "new_position" (line number).
|
||||||
|
// When posting inline comments on GitHub, position is required; line numbers
|
||||||
|
// from the diff cannot be used directly.
|
||||||
|
type ReviewComment struct {
|
||||||
|
ID int64 `json:"id,omitempty"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
Position int64 `json:"position,omitempty"` // GitHub diff hunk position
|
||||||
|
Line int64 `json:"line,omitempty"` // GitHub absolute line number (alternative to position)
|
||||||
|
Side string `json:"side,omitempty"` // "RIGHT" or "LEFT"
|
||||||
|
Body string `json:"body"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review represents a pull request review from the GitHub API.
|
||||||
|
type Review struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
User struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
} `json:"user"`
|
||||||
|
State string `json:"state"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// contentResponse is the GitHub contents API response for a single file.
|
||||||
|
type contentResponse struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
Type string `json:"type"` // "file" or "dir" or "symlink" or "submodule"
|
||||||
|
Content string `json:"content"` // Base64-encoded file content (with embedded newlines)
|
||||||
|
Encoding string `json:"encoding"` // "base64" or ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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"
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- PR methods ---
|
||||||
|
|
||||||
|
// 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.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 this endpoint (100 per page max).
|
||||||
|
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 has two status systems: legacy "commit statuses" and newer "check runs".
|
||||||
|
// This method returns commit statuses only; check runs are a separate API.
|
||||||
|
// Note: GitHub returns "state" in the JSON; CommitStatus.Status is tagged accordingly.
|
||||||
|
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 (page %d): %w", page, err)
|
||||||
|
}
|
||||||
|
var batch []CommitStatus
|
||||||
|
if err := json.Unmarshal(body, &batch); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse statuses JSON (page %d): %w", page, err)
|
||||||
|
}
|
||||||
|
all = append(all, batch...)
|
||||||
|
if len(batch) < perPage {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return all, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- File content methods ---
|
||||||
|
|
||||||
|
// GetFileContent fetches a file from the default branch of a repo.
|
||||||
|
// GitHub returns base64-encoded content; this method decodes it.
|
||||||
|
func (c *Client) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
return c.getFileContentAtRef(ctx, owner, repo, filepath, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileContentRef fetches a file from a specific ref (branch/tag/sha).
|
||||||
|
func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
||||||
|
return c.getFileContentAtRef(ctx, owner, repo, filepath, ref)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getFileContentAtRef fetches a file at the given ref (empty = default branch).
|
||||||
|
// GitHub's contents API returns base64-encoded file content.
|
||||||
|
func (c *Client) getFileContentAtRef(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)
|
||||||
|
}
|
||||||
|
var resp contentResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse file content JSON for %s: %w", filepath, err)
|
||||||
|
}
|
||||||
|
if resp.Type != "file" {
|
||||||
|
return "", fmt.Errorf("path %s is a %s, not a file", filepath, resp.Type)
|
||||||
|
}
|
||||||
|
if resp.Encoding == "base64" {
|
||||||
|
// GitHub embeds newlines in the base64 content for readability.
|
||||||
|
// Strip them before decoding.
|
||||||
|
cleaned := strings.ReplaceAll(resp.Content, "\n", "")
|
||||||
|
decoded, err := base64.StdEncoding.DecodeString(cleaned)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("decode base64 content for %s: %w", filepath, err)
|
||||||
|
}
|
||||||
|
return string(decoded), nil
|
||||||
|
}
|
||||||
|
// Non-base64 encoding (shouldn't happen normally, but handle gracefully).
|
||||||
|
return resp.Content, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListContents lists files and directories at a given path.
|
||||||
|
// Pass an empty path to list the repository root.
|
||||||
|
// GitHub returns a single object (not array) when path is a file — this
|
||||||
|
// method normalizes both cases to a slice, matching Gitea's behavior.
|
||||||
|
func (c *Client) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
||||||
|
var reqURL string
|
||||||
|
if path == "" || 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 returns a single object when path is a file (not an array).
|
||||||
|
var single contentResponse
|
||||||
|
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{{
|
||||||
|
Name: single.Name,
|
||||||
|
Path: single.Path,
|
||||||
|
Type: single.Type,
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
return entries, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAllFilesInPath recursively fetches all file contents under a path.
|
||||||
|
// If the path is a file, returns just that file's content.
|
||||||
|
// If the path is a directory, recursively fetches all files within it.
|
||||||
|
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) {
|
||||||
|
return nil, fmt.Errorf("list contents %q: %w", path, err)
|
||||||
|
}
|
||||||
|
// 404 means path may be a file — try fetching 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
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Review methods ---
|
||||||
|
|
||||||
|
// PostReview submits a review to a PR.
|
||||||
|
// event should be one of "APPROVE", "REQUEST_CHANGES", or "COMMENT".
|
||||||
|
// commitID anchors the review to a specific commit SHA. If empty, defaults to current HEAD.
|
||||||
|
// comments are optional inline comments; GitHub uses diff hunk position (not line numbers).
|
||||||
|
// Note: unlike Gitea, GitHub does not support deleting submitted reviews.
|
||||||
|
// Use COMMENT event to supersede old reviews.
|
||||||
|
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)
|
||||||
|
|
||||||
|
payload := struct {
|
||||||
|
Body string `json:"body"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
CommitID string `json:"commit_id,omitempty"`
|
||||||
|
Comments []ReviewComment `json:"comments,omitempty"`
|
||||||
|
}{
|
||||||
|
Body: body,
|
||||||
|
Event: event,
|
||||||
|
CommitID: commitID,
|
||||||
|
Comments: comments,
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(payload)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("marshal review payload: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
respBody, err := c.doRequestWithBody(ctx, http.MethodPost, reqURL, data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("post review: %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.
|
||||||
|
// GitHub paginates via Link header; this method uses per_page=100.
|
||||||
|
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 attempts to delete a pull request review.
|
||||||
|
// GitHub only allows deleting PENDING (draft) reviews. Submitted reviews cannot
|
||||||
|
// be deleted via the API; this method returns a descriptive error in that case.
|
||||||
|
// review-bot callers should handle this error gracefully (e.g., by not attempting
|
||||||
|
// supersede and instead posting a new review alongside the old one).
|
||||||
|
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)
|
||||||
|
|
||||||
|
// nil body: the GitHub DELETE endpoint for reviews requires no request body.
|
||||||
|
_, err := c.doRequestWithBody(ctx, http.MethodDelete, reqURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("delete review: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAuthenticatedUser returns the login of the authenticated user.
|
||||||
|
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
reqURL := c.baseURL + "/user"
|
||||||
|
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 a user as a requested reviewer on a pull request.
|
||||||
|
// This is idempotent — requesting an already-requested reviewer is a no-op.
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = c.doRequestWithBody(ctx, http.MethodPost, reqURL, data)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("request reviewer: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- helpers ---
|
||||||
|
|
||||||
|
// escapePath escapes each segment of a relative file path for use in URLs.
|
||||||
|
// Slashes are preserved as path separators; other special characters are escaped.
|
||||||
|
func escapePath(p string) string {
|
||||||
|
parts := strings.Split(p, "/")
|
||||||
|
for i, part := range parts {
|
||||||
|
parts[i] = url.PathEscape(part)
|
||||||
|
}
|
||||||
|
return strings.Join(parts, "/")
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,13 @@
|
|||||||
|
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,3 +1,5 @@
|
|||||||
module gitea.weiker.me/rodin/review-bot
|
module gitea.weiker.me/rodin/review-bot
|
||||||
|
|
||||||
go 1.26.2
|
go 1.26.2
|
||||||
|
|
||||||
|
require github.com/goccy/go-yaml v1.19.2
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM=
|
||||||
|
github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
||||||
+3
-2
@@ -16,7 +16,8 @@ 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
|
||||||
@@ -25,7 +26,7 @@ import (
|
|||||||
// 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_GITEA_URL")
|
giteaURL := os.Getenv("INTEGRATION_VCS_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")
|
||||||
|
|||||||
+391
@@ -0,0 +1,391 @@
|
|||||||
|
package llm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AICoreOpenAIAPIVersion is the API version used for OpenAI models through AI Core.
|
||||||
|
// Update this when SAP AI Core releases a new stable version.
|
||||||
|
const AICoreOpenAIAPIVersion = "2024-12-01-preview"
|
||||||
|
|
||||||
|
// maxErrorBodyLen limits the length of response bodies included in error messages
|
||||||
|
// to prevent leaking potentially sensitive upstream details in logs.
|
||||||
|
const maxErrorBodyLen = 200
|
||||||
|
|
||||||
|
// AICoreConfig holds SAP AI Core authentication and connection settings.
|
||||||
|
type AICoreConfig struct {
|
||||||
|
ClientID string
|
||||||
|
ClientSecret string
|
||||||
|
AuthURL string
|
||||||
|
APIURL string
|
||||||
|
ResourceGroup string
|
||||||
|
}
|
||||||
|
|
||||||
|
// AICoreClient wraps AI Core authentication and deployment discovery.
|
||||||
|
// Thread-safe for concurrent use after construction.
|
||||||
|
//
|
||||||
|
// Design: The deployment cache is populated once and never invalidated. This is
|
||||||
|
// acceptable for short-lived CI runner processes, but longer-lived deployments
|
||||||
|
// may want to add a TTL or re-fetch on errors.
|
||||||
|
type AICoreClient struct {
|
||||||
|
config AICoreConfig
|
||||||
|
http *http.Client
|
||||||
|
|
||||||
|
mu sync.RWMutex
|
||||||
|
token string
|
||||||
|
tokenExpiry time.Time
|
||||||
|
deployments map[string]string // model name -> deployment URL
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewAICoreClient creates a new AI Core client with the given configuration.
|
||||||
|
// The client uses a default 5-minute timeout; use WithTimeout to customize.
|
||||||
|
func NewAICoreClient(cfg AICoreConfig) *AICoreClient {
|
||||||
|
return &AICoreClient{
|
||||||
|
config: cfg,
|
||||||
|
http: &http.Client{Timeout: 5 * time.Minute},
|
||||||
|
deployments: make(map[string]string),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTimeout sets the HTTP request timeout for AI Core calls.
|
||||||
|
// This should be called during construction, before concurrent use.
|
||||||
|
func (c *AICoreClient) WithTimeout(d time.Duration) *AICoreClient {
|
||||||
|
c.http.Timeout = d
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// truncateBody truncates a response body for inclusion in error messages.
|
||||||
|
// This prevents leaking potentially sensitive upstream response details in logs.
|
||||||
|
func truncateBody(body []byte) string {
|
||||||
|
if len(body) <= maxErrorBodyLen {
|
||||||
|
return string(body)
|
||||||
|
}
|
||||||
|
return string(body[:maxErrorBodyLen]) + "..."
|
||||||
|
}
|
||||||
|
|
||||||
|
// getToken returns a valid OAuth token, refreshing if necessary.
|
||||||
|
func (c *AICoreClient) getToken(ctx context.Context) (string, error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
if c.token != "" && time.Now().Add(5*time.Minute).Before(c.tokenExpiry) {
|
||||||
|
token := c.token
|
||||||
|
c.mu.RUnlock()
|
||||||
|
return token, nil
|
||||||
|
}
|
||||||
|
c.mu.RUnlock()
|
||||||
|
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
|
||||||
|
// Double-check after acquiring write lock
|
||||||
|
if c.token != "" && time.Now().Add(5*time.Minute).Before(c.tokenExpiry) {
|
||||||
|
return c.token, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
token, expiry, err := c.fetchToken(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
c.token = token
|
||||||
|
c.tokenExpiry = expiry
|
||||||
|
return token, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *AICoreClient) fetchToken(ctx context.Context) (string, time.Time, error) {
|
||||||
|
tokenURL := strings.TrimRight(c.config.AuthURL, "/") + "/oauth/token"
|
||||||
|
|
||||||
|
data := url.Values{}
|
||||||
|
data.Set("grant_type", "client_credentials")
|
||||||
|
data.Set("client_id", c.config.ClientID)
|
||||||
|
data.Set("client_secret", c.config.ClientSecret)
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, tokenURL, strings.NewReader(data.Encode()))
|
||||||
|
if err != nil {
|
||||||
|
return "", time.Time{}, fmt.Errorf("create token request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
||||||
|
|
||||||
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", time.Time{}, fmt.Errorf("token request: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return "", time.Time{}, fmt.Errorf("read token response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return "", time.Time{}, fmt.Errorf("token request failed (status %d): %s", resp.StatusCode, truncateBody(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
var tokenResp struct {
|
||||||
|
AccessToken string `json:"access_token"`
|
||||||
|
ExpiresIn int `json:"expires_in"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &tokenResp); err != nil {
|
||||||
|
return "", time.Time{}, fmt.Errorf("parse token response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tokenResp.AccessToken == "" {
|
||||||
|
return "", time.Time{}, fmt.Errorf("empty access token in response")
|
||||||
|
}
|
||||||
|
|
||||||
|
expiry := time.Now().Add(time.Duration(tokenResp.ExpiresIn) * time.Second)
|
||||||
|
return tokenResp.AccessToken, expiry, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getDeploymentURL returns the deployment URL for a model, fetching deployments if needed.
|
||||||
|
// getDeploymentURL returns the deployment URL for a model, fetching deployments if needed.
|
||||||
|
// Also returns a valid token for use by the caller, avoiding redundant getToken calls.
|
||||||
|
//
|
||||||
|
// Note: The token is fetched before acquiring the write lock to avoid holding the lock
|
||||||
|
// during network I/O. In rare cases where multiple goroutines race and one waits a long
|
||||||
|
// time for the write lock, the token could theoretically expire. The 5-minute refresh
|
||||||
|
// buffer in getToken makes this extremely unlikely in practice.
|
||||||
|
func (c *AICoreClient) getDeploymentURL(ctx context.Context, model string) (deployURL, token string, err error) {
|
||||||
|
c.mu.RLock()
|
||||||
|
if u, ok := c.deployments[model]; ok {
|
||||||
|
c.mu.RUnlock()
|
||||||
|
// Still need a token for the caller
|
||||||
|
token, err = c.getToken(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", fmt.Errorf("get token: %w", err)
|
||||||
|
}
|
||||||
|
return u, token, nil
|
||||||
|
}
|
||||||
|
c.mu.RUnlock()
|
||||||
|
|
||||||
|
// Fetch token first (before acquiring write lock to avoid holding lock during I/O)
|
||||||
|
token, err = c.getToken(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", fmt.Errorf("get token for deployments: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
c.mu.Lock()
|
||||||
|
defer c.mu.Unlock()
|
||||||
|
|
||||||
|
// Double-check after acquiring write lock
|
||||||
|
if u, ok := c.deployments[model]; ok {
|
||||||
|
return u, token, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := c.fetchDeployments(ctx, token); err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
if u, ok := c.deployments[model]; ok {
|
||||||
|
return u, token, nil
|
||||||
|
}
|
||||||
|
return "", "", fmt.Errorf("no deployment found for model %q", model)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *AICoreClient) fetchDeployments(ctx context.Context, token string) error {
|
||||||
|
deployURL := strings.TrimRight(c.config.APIURL, "/") + "/v2/lm/deployments"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, deployURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("create deployments request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
req.Header.Set("AI-Resource-Group", c.config.ResourceGroup)
|
||||||
|
|
||||||
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deployments request: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read deployments response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return fmt.Errorf("deployments request failed (status %d): %s", resp.StatusCode, truncateBody(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
var deployResp struct {
|
||||||
|
Resources []struct {
|
||||||
|
DeploymentURL string `json:"deploymentUrl"`
|
||||||
|
Status string `json:"status"`
|
||||||
|
Details struct {
|
||||||
|
Resources struct {
|
||||||
|
BackendDetails struct {
|
||||||
|
Model struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
} `json:"model"`
|
||||||
|
} `json:"backend_details"`
|
||||||
|
} `json:"resources"`
|
||||||
|
} `json:"details"`
|
||||||
|
} `json:"resources"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &deployResp); err != nil {
|
||||||
|
return fmt.Errorf("parse deployments response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, r := range deployResp.Resources {
|
||||||
|
if r.Status != "RUNNING" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
modelName := r.Details.Resources.BackendDetails.Model.Name
|
||||||
|
if modelName == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
c.deployments[modelName] = r.DeploymentURL
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompleteAnthropic sends a request to an Anthropic model via AI Core.
|
||||||
|
func (c *AICoreClient) CompleteAnthropic(ctx context.Context, model string, messages []Message, maxTokens int, temperature float64) (string, error) {
|
||||||
|
deployURL, token, err := c.getDeploymentURL(ctx, model)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract system message
|
||||||
|
var system string
|
||||||
|
var userMessages []anthropicMsg
|
||||||
|
for _, m := range messages {
|
||||||
|
if m.Role == "system" {
|
||||||
|
system = m.Content
|
||||||
|
} else {
|
||||||
|
userMessages = append(userMessages, anthropicMsg{
|
||||||
|
Role: m.Role,
|
||||||
|
Content: m.Content,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
reqBody := anthropicRequest{
|
||||||
|
AnthropicVersion: "bedrock-2023-05-31", // SAP AI Core uses Bedrock format
|
||||||
|
// Model omitted - AI Core deployment already specifies model
|
||||||
|
MaxTokens: maxTokens,
|
||||||
|
System: system,
|
||||||
|
Messages: userMessages,
|
||||||
|
}
|
||||||
|
if temperature > 0 {
|
||||||
|
reqBody.Temperature = temperature
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(reqBody)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("marshal request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AI Core uses /invoke for Anthropic models
|
||||||
|
invokeURL := strings.TrimRight(deployURL, "/") + "/invoke"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, invokeURL, bytes.NewReader(data))
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("create request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
req.Header.Set("AI-Resource-Group", c.config.ResourceGroup)
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("AI Core request: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("read response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return "", fmt.Errorf("AI Core API error (status %d): %s", resp.StatusCode, truncateBody(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
var anthropicResp anthropicResponse
|
||||||
|
if err := json.Unmarshal(body, &anthropicResp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(anthropicResp.Content) == 0 {
|
||||||
|
return "", fmt.Errorf("no content in response")
|
||||||
|
}
|
||||||
|
|
||||||
|
var sb strings.Builder
|
||||||
|
for _, block := range anthropicResp.Content {
|
||||||
|
if block.Type == "text" {
|
||||||
|
sb.WriteString(block.Text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result := sb.String()
|
||||||
|
if result == "" {
|
||||||
|
return "", fmt.Errorf("no text content in response")
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompleteOpenAI sends a request to an OpenAI model via AI Core.
|
||||||
|
func (c *AICoreClient) CompleteOpenAI(ctx context.Context, model string, messages []Message, temperature float64) (string, error) {
|
||||||
|
deployURL, token, err := c.getDeploymentURL(ctx, model)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
reqBody := ChatRequest{
|
||||||
|
Model: model,
|
||||||
|
Temperature: temperature,
|
||||||
|
Messages: messages,
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(reqBody)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("marshal request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AI Core uses /chat/completions?api-version=<version> for OpenAI models
|
||||||
|
chatURL := strings.TrimRight(deployURL, "/") + "/chat/completions?api-version=" + AICoreOpenAIAPIVersion
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, chatURL, bytes.NewReader(data))
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("create request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
req.Header.Set("AI-Resource-Group", c.config.ResourceGroup)
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("AI Core request: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("read response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
return "", fmt.Errorf("AI Core API error (status %d): %s", resp.StatusCode, truncateBody(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
var openaiResp ChatResponse
|
||||||
|
if err := json.Unmarshal(body, &openaiResp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(openaiResp.Choices) == 0 {
|
||||||
|
return "", fmt.Errorf("no choices in response")
|
||||||
|
}
|
||||||
|
return openaiResp.Choices[0].Message.Content, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAnthropicModel returns true if the model name indicates an Anthropic model.
|
||||||
|
// SAP AI Core uses "anthropic--" prefix for Anthropic models (e.g., "anthropic--claude-3-5-sonnet").
|
||||||
|
func IsAnthropicModel(model string) bool {
|
||||||
|
return strings.HasPrefix(model, "anthropic--")
|
||||||
|
}
|
||||||
@@ -0,0 +1,535 @@
|
|||||||
|
package llm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAICoreClient_TokenFetch(t *testing.T) {
|
||||||
|
tokenCalls := int32(0)
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path == "/oauth/token" {
|
||||||
|
atomic.AddInt32(&tokenCalls, 1)
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
t.Errorf("expected POST for token, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.Header.Get("Content-Type") != "application/x-www-form-urlencoded" {
|
||||||
|
t.Errorf("expected form content type")
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": "test-token-123",
|
||||||
|
"expires_in": 3600,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
token, err := client.getToken(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if token != "test-token-123" {
|
||||||
|
t.Errorf("expected token 'test-token-123', got %q", token)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second call should use cached token
|
||||||
|
token2, err := client.getToken(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if token2 != "test-token-123" {
|
||||||
|
t.Errorf("expected cached token")
|
||||||
|
}
|
||||||
|
if atomic.LoadInt32(&tokenCalls) != 1 {
|
||||||
|
t.Errorf("expected 1 token call (cached), got %d", tokenCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAICoreClient_DeploymentFetch(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path == "/oauth/token" {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": "test-token",
|
||||||
|
"expires_in": 3600,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if r.URL.Path == "/v2/lm/deployments" {
|
||||||
|
if r.Header.Get("Authorization") != "Bearer test-token" {
|
||||||
|
t.Errorf("expected Bearer auth")
|
||||||
|
}
|
||||||
|
if r.Header.Get("AI-Resource-Group") != "default" {
|
||||||
|
t.Errorf("expected resource group header")
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"resources": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"id": "deploy-123",
|
||||||
|
"deploymentUrl": "https://example.com/v2/inference/deployments/deploy-123",
|
||||||
|
"status": "RUNNING",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "anthropic--claude-4.6-sonnet",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "deploy-456",
|
||||||
|
"deploymentUrl": "https://example.com/v2/inference/deployments/deploy-456",
|
||||||
|
"status": "STOPPED",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "gpt-5",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "deploy-789",
|
||||||
|
"deploymentUrl": "https://example.com/v2/inference/deployments/deploy-789",
|
||||||
|
"status": "RUNNING",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "gpt-5",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
// Should find running deployment
|
||||||
|
url, _, err := client.getDeploymentURL(context.Background(), "anthropic--claude-4.6-sonnet")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if url != "https://example.com/v2/inference/deployments/deploy-123" {
|
||||||
|
t.Errorf("unexpected URL: %s", url)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should find running gpt-5, not stopped one
|
||||||
|
url, _, err = client.getDeploymentURL(context.Background(), "gpt-5")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if url != "https://example.com/v2/inference/deployments/deploy-789" {
|
||||||
|
t.Errorf("unexpected URL: %s", url)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should error on unknown model
|
||||||
|
_, _, err = client.getDeploymentURL(context.Background(), "unknown-model")
|
||||||
|
if err == nil {
|
||||||
|
t.Error("expected error for unknown model")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAICoreClient_CompleteAnthropic(t *testing.T) {
|
||||||
|
// baseURL is set after server creation; captured by closure in handlers
|
||||||
|
var baseURL string
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/oauth/token", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": "test-token",
|
||||||
|
"expires_in": 3600,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/v2/lm/deployments", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"resources": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"id": "deploy-anthropic",
|
||||||
|
"deploymentUrl": baseURL + "/deployments/anthropic",
|
||||||
|
"status": "RUNNING",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "anthropic--claude-4.6-sonnet",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/deployments/anthropic/invoke", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Header.Get("Authorization") != "Bearer test-token" {
|
||||||
|
t.Errorf("expected Bearer auth on invoke")
|
||||||
|
}
|
||||||
|
var req anthropicRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||||
|
t.Fatalf("decode request: %v", err)
|
||||||
|
}
|
||||||
|
if req.AnthropicVersion != "bedrock-2023-05-31" {
|
||||||
|
t.Errorf("expected bedrock anthropic_version in request")
|
||||||
|
}
|
||||||
|
if req.System != "You are helpful" {
|
||||||
|
t.Errorf("expected system prompt: %q", req.System)
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"content": []map[string]interface{}{
|
||||||
|
{"type": "text", "text": "Hello from AI Core!"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
server := httptest.NewServer(mux)
|
||||||
|
baseURL = server.URL
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
result, err := client.CompleteAnthropic(context.Background(), "anthropic--claude-4.6-sonnet", []Message{
|
||||||
|
{Role: "system", Content: "You are helpful"},
|
||||||
|
{Role: "user", Content: "Hello"},
|
||||||
|
}, 8192, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if result != "Hello from AI Core!" {
|
||||||
|
t.Errorf("expected 'Hello from AI Core!', got %q", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAICoreClient_CompleteOpenAI(t *testing.T) {
|
||||||
|
var baseURL string
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/oauth/token", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": "test-token",
|
||||||
|
"expires_in": 3600,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/v2/lm/deployments", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"resources": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"id": "deploy-openai",
|
||||||
|
"deploymentUrl": baseURL + "/deployments/openai",
|
||||||
|
"status": "RUNNING",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "gpt-5",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/deployments/openai/chat/completions", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Query().Get("api-version") != AICoreOpenAIAPIVersion {
|
||||||
|
t.Errorf("expected api-version %s, got %s", AICoreOpenAIAPIVersion, r.URL.Query().Get("api-version"))
|
||||||
|
}
|
||||||
|
var req ChatRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||||
|
t.Fatalf("decode request: %v", err)
|
||||||
|
}
|
||||||
|
if req.Model != "gpt-5" {
|
||||||
|
t.Errorf("expected model gpt-5, got %s", req.Model)
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(ChatResponse{
|
||||||
|
Choices: []struct {
|
||||||
|
Message struct {
|
||||||
|
Content string `json:"content"`
|
||||||
|
} `json:"message"`
|
||||||
|
}{
|
||||||
|
{Message: struct {
|
||||||
|
Content string `json:"content"`
|
||||||
|
}{Content: "Hello from GPT-5!"}},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
server := httptest.NewServer(mux)
|
||||||
|
baseURL = server.URL
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
result, err := client.CompleteOpenAI(context.Background(), "gpt-5", []Message{
|
||||||
|
{Role: "user", Content: "Hello"},
|
||||||
|
}, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if result != "Hello from GPT-5!" {
|
||||||
|
t.Errorf("expected 'Hello from GPT-5!', got %q", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsAnthropicModel(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
model string
|
||||||
|
expected bool
|
||||||
|
}{
|
||||||
|
// SAP AI Core uses "anthropic--" prefix for Anthropic models
|
||||||
|
{"anthropic--claude-4.6-sonnet", true},
|
||||||
|
{"anthropic--claude-4.6-opus", true},
|
||||||
|
{"anthropic--claude-3-5-sonnet", true},
|
||||||
|
// Non-prefixed model names are not detected as Anthropic
|
||||||
|
// (SAP AI Core always uses the prefix for Anthropic models)
|
||||||
|
{"claude-sonnet-4", false},
|
||||||
|
{"gpt-5", false},
|
||||||
|
{"gpt-4.1", false},
|
||||||
|
{"llama-3", false},
|
||||||
|
{"my-claude-model", false}, // Avoid false positives on "claude" substring
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
got := IsAnthropicModel(tt.model)
|
||||||
|
if got != tt.expected {
|
||||||
|
t.Errorf("IsAnthropicModel(%q) = %v, want %v", tt.model, got, tt.expected)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAICoreClient_TokenExpiry(t *testing.T) {
|
||||||
|
tokenCalls := int32(0)
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path == "/oauth/token" {
|
||||||
|
call := atomic.AddInt32(&tokenCalls, 1)
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": fmt.Sprintf("token-%d", call),
|
||||||
|
"expires_in": 1, // 1 second expiry
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
// First call
|
||||||
|
token1, err := client.getToken(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("first getToken: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Force token expiry by manipulating expiry time
|
||||||
|
client.mu.Lock()
|
||||||
|
client.tokenExpiry = time.Now().Add(-time.Hour)
|
||||||
|
client.mu.Unlock()
|
||||||
|
|
||||||
|
// Should fetch new token
|
||||||
|
token2, err := client.getToken(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("second getToken: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if token1 == token2 {
|
||||||
|
t.Error("expected different tokens after expiry")
|
||||||
|
}
|
||||||
|
if atomic.LoadInt32(&tokenCalls) != 2 {
|
||||||
|
t.Errorf("expected 2 token calls, got %d", tokenCalls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAICoreClient_WithTimeout(t *testing.T) {
|
||||||
|
client := NewAICoreClient(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: "https://auth.example.com",
|
||||||
|
APIURL: "https://api.example.com",
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
// Default timeout is 5 minutes
|
||||||
|
if client.http.Timeout != 5*time.Minute {
|
||||||
|
t.Errorf("expected default timeout 5m, got %v", client.http.Timeout)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTimeout should update the timeout
|
||||||
|
client.WithTimeout(10 * time.Minute)
|
||||||
|
if client.http.Timeout != 10*time.Minute {
|
||||||
|
t.Errorf("expected timeout 10m, got %v", client.http.Timeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClient_WithAICore(t *testing.T) {
|
||||||
|
client := NewClient("http://example.com", "key", "model")
|
||||||
|
if client.provider != ProviderOpenAI {
|
||||||
|
t.Errorf("expected default provider openai, got %s", client.provider)
|
||||||
|
}
|
||||||
|
|
||||||
|
client.WithAICore(AICoreConfig{
|
||||||
|
ClientID: "id",
|
||||||
|
ClientSecret: "secret",
|
||||||
|
AuthURL: "https://auth.example.com",
|
||||||
|
APIURL: "https://api.example.com",
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
if client.provider != ProviderAICore {
|
||||||
|
t.Errorf("expected provider aicore, got %s", client.provider)
|
||||||
|
}
|
||||||
|
if client.aicore == nil {
|
||||||
|
t.Error("expected aicore client to be set")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClient_WithTimeout_PropagatestoAICore(t *testing.T) {
|
||||||
|
client := NewClient("http://example.com", "key", "model").
|
||||||
|
WithAICore(AICoreConfig{
|
||||||
|
ClientID: "id",
|
||||||
|
ClientSecret: "secret",
|
||||||
|
AuthURL: "https://auth.example.com",
|
||||||
|
APIURL: "https://api.example.com",
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
// Default should be 5 minutes (inherited from parent client)
|
||||||
|
if client.aicore.http.Timeout != 5*time.Minute {
|
||||||
|
t.Errorf("expected aicore default timeout 5m, got %v", client.aicore.http.Timeout)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTimeout should propagate to AI Core client
|
||||||
|
client.WithTimeout(15 * time.Minute)
|
||||||
|
if client.http.Timeout != 15*time.Minute {
|
||||||
|
t.Errorf("expected parent timeout 15m, got %v", client.http.Timeout)
|
||||||
|
}
|
||||||
|
if client.aicore.http.Timeout != 15*time.Minute {
|
||||||
|
t.Errorf("expected aicore timeout 15m, got %v", client.aicore.http.Timeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestClient_CompleteAICore(t *testing.T) {
|
||||||
|
var baseURL string
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/oauth/token", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"access_token": "test-token",
|
||||||
|
"expires_in": 3600,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/v2/lm/deployments", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"resources": []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"id": "deploy-test",
|
||||||
|
"deploymentUrl": baseURL + "/deployments/test",
|
||||||
|
"status": "RUNNING",
|
||||||
|
"details": map[string]interface{}{
|
||||||
|
"resources": map[string]interface{}{
|
||||||
|
"backend_details": map[string]interface{}{
|
||||||
|
"model": map[string]interface{}{
|
||||||
|
"name": "gpt-5",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/deployments/test/chat/completions", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
json.NewEncoder(w).Encode(ChatResponse{
|
||||||
|
Choices: []struct {
|
||||||
|
Message struct {
|
||||||
|
Content string `json:"content"`
|
||||||
|
} `json:"message"`
|
||||||
|
}{
|
||||||
|
{Message: struct {
|
||||||
|
Content string `json:"content"`
|
||||||
|
}{Content: "AI Core via Client works!"}},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
server := httptest.NewServer(mux)
|
||||||
|
baseURL = server.URL
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient("", "", "gpt-5").WithAICore(AICoreConfig{
|
||||||
|
ClientID: "test-id",
|
||||||
|
ClientSecret: "test-secret",
|
||||||
|
AuthURL: server.URL,
|
||||||
|
APIURL: server.URL,
|
||||||
|
ResourceGroup: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
result, err := client.Complete(context.Background(), []Message{
|
||||||
|
{Role: "user", Content: "Hello"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "AI Core via Client works!") {
|
||||||
|
t.Errorf("unexpected result: %s", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
+34
-3
@@ -1,6 +1,6 @@
|
|||||||
// Package llm provides clients for LLM chat completion APIs.
|
// Package llm provides clients for LLM chat completion APIs.
|
||||||
//
|
//
|
||||||
// Supports OpenAI-compatible (default) and Anthropic Messages API providers.
|
// Supports OpenAI-compatible (default), Anthropic Messages API, and SAP AI Core providers.
|
||||||
package llm
|
package llm
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -22,6 +22,8 @@ const (
|
|||||||
ProviderOpenAI Provider = "openai"
|
ProviderOpenAI Provider = "openai"
|
||||||
// ProviderAnthropic uses the Anthropic Messages API endpoint.
|
// ProviderAnthropic uses the Anthropic Messages API endpoint.
|
||||||
ProviderAnthropic Provider = "anthropic"
|
ProviderAnthropic Provider = "anthropic"
|
||||||
|
// ProviderAICore uses SAP AI Core with OAuth authentication.
|
||||||
|
ProviderAICore Provider = "aicore"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Client calls an LLM chat completion API.
|
// Client calls an LLM chat completion API.
|
||||||
@@ -35,6 +37,7 @@ type Client struct {
|
|||||||
temperature float64
|
temperature float64
|
||||||
provider Provider
|
provider Provider
|
||||||
http *http.Client
|
http *http.Client
|
||||||
|
aicore *AICoreClient // Only set when provider is aicore
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewClient creates a new LLM client. Default provider is OpenAI-compatible.
|
// NewClient creates a new LLM client. Default provider is OpenAI-compatible.
|
||||||
@@ -49,8 +52,12 @@ func NewClient(baseURL, apiKey, model string) *Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithTimeout sets the HTTP request timeout for LLM calls (default 5 minutes).
|
// WithTimeout sets the HTTP request timeout for LLM calls (default 5 minutes).
|
||||||
|
// When using AI Core, this also sets the timeout on the AI Core client.
|
||||||
func (c *Client) WithTimeout(d time.Duration) *Client {
|
func (c *Client) WithTimeout(d time.Duration) *Client {
|
||||||
c.http.Timeout = d
|
c.http.Timeout = d
|
||||||
|
if c.aicore != nil {
|
||||||
|
c.aicore.WithTimeout(d)
|
||||||
|
}
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,12 +67,21 @@ func (c *Client) WithTemperature(t float64) *Client {
|
|||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithProvider sets the API provider format (openai or anthropic).
|
// WithProvider sets the API provider format (openai, anthropic, or aicore).
|
||||||
func (c *Client) WithProvider(p Provider) *Client {
|
func (c *Client) WithProvider(p Provider) *Client {
|
||||||
c.provider = p
|
c.provider = p
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithAICore configures the client to use SAP AI Core for authentication.
|
||||||
|
// This sets the provider to aicore automatically.
|
||||||
|
// The AI Core client inherits the current HTTP timeout from this client.
|
||||||
|
func (c *Client) WithAICore(cfg AICoreConfig) *Client {
|
||||||
|
c.provider = ProviderAICore
|
||||||
|
c.aicore = NewAICoreClient(cfg).WithTimeout(c.http.Timeout)
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
// Message represents a chat message.
|
// Message represents a chat message.
|
||||||
type Message struct {
|
type Message struct {
|
||||||
Role string `json:"role"`
|
Role string `json:"role"`
|
||||||
@@ -82,6 +98,8 @@ func (c *Client) Complete(ctx context.Context, messages []Message) (string, erro
|
|||||||
switch c.provider {
|
switch c.provider {
|
||||||
case ProviderAnthropic:
|
case ProviderAnthropic:
|
||||||
result, err = c.completeAnthropic(ctx, messages)
|
result, err = c.completeAnthropic(ctx, messages)
|
||||||
|
case ProviderAICore:
|
||||||
|
result, err = c.completeAICore(ctx, messages)
|
||||||
default:
|
default:
|
||||||
result, err = c.completeOpenAI(ctx, messages)
|
result, err = c.completeOpenAI(ctx, messages)
|
||||||
}
|
}
|
||||||
@@ -106,6 +124,18 @@ func (c *Client) Complete(ctx context.Context, messages []Message) (string, erro
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// completeAICore routes to AI Core using the appropriate endpoint based on model type.
|
||||||
|
func (c *Client) completeAICore(ctx context.Context, messages []Message) (string, error) {
|
||||||
|
if c.aicore == nil {
|
||||||
|
return "", fmt.Errorf("AI Core client not configured")
|
||||||
|
}
|
||||||
|
|
||||||
|
if IsAnthropicModel(c.model) {
|
||||||
|
return c.aicore.CompleteAnthropic(ctx, c.model, messages, 8192, c.temperature)
|
||||||
|
}
|
||||||
|
return c.aicore.CompleteOpenAI(ctx, c.model, messages, c.temperature)
|
||||||
|
}
|
||||||
|
|
||||||
// isRetryableError returns true for transient errors worth retrying.
|
// isRetryableError returns true for transient errors worth retrying.
|
||||||
func isRetryableError(err error) bool {
|
func isRetryableError(err error) bool {
|
||||||
if err == nil {
|
if err == nil {
|
||||||
@@ -176,7 +206,8 @@ func (c *Client) completeOpenAI(ctx context.Context, messages []Message) (string
|
|||||||
// --- Anthropic Messages API implementation ---
|
// --- Anthropic Messages API implementation ---
|
||||||
|
|
||||||
type anthropicRequest struct {
|
type anthropicRequest struct {
|
||||||
Model string `json:"model"`
|
AnthropicVersion string `json:"anthropic_version,omitempty"`
|
||||||
|
Model string `json:"model,omitempty"`
|
||||||
MaxTokens int `json:"max_tokens"`
|
MaxTokens int `json:"max_tokens"`
|
||||||
System string `json:"system,omitempty"`
|
System string `json:"system,omitempty"`
|
||||||
Messages []anthropicMsg `json:"messages"`
|
Messages []anthropicMsg `json:"messages"`
|
||||||
|
|||||||
@@ -210,7 +210,6 @@ func TestWithTimeout(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func TestComplete_Anthropic_Success(t *testing.T) {
|
func TestComplete_Anthropic_Success(t *testing.T) {
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.URL.Path != "/messages" {
|
if r.URL.Path != "/messages" {
|
||||||
|
|||||||
+32
-17
@@ -7,10 +7,37 @@ import (
|
|||||||
|
|
||||||
// FormatMarkdown formats a ReviewResult into the markdown body for a Gitea review.
|
// FormatMarkdown formats a ReviewResult into the markdown body for a Gitea review.
|
||||||
func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
||||||
|
return FormatMarkdownWithDisplay(result, reviewerName, reviewerName)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GiteaEvent converts the verdict to the Gitea API event string.
|
||||||
|
func GiteaEvent(verdict string) string {
|
||||||
|
switch verdict {
|
||||||
|
case "APPROVE":
|
||||||
|
return "APPROVED"
|
||||||
|
case "REQUEST_CHANGES":
|
||||||
|
return "REQUEST_CHANGES"
|
||||||
|
default:
|
||||||
|
return "COMMENT"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FormatMarkdownWithDisplay formats a ReviewResult with separate display name and sentinel name.
|
||||||
|
// Note: displayName is not HTML-escaped as Gitea sanitizes rendered Markdown.
|
||||||
|
// Persona display names are controlled by repo owners (trusted input).
|
||||||
|
// displayName is used for the header title, sentinelName is used for the cleanup sentinel.
|
||||||
|
// If displayName is empty, sentinelName is used for both.
|
||||||
|
func FormatMarkdownWithDisplay(result *ReviewResult, displayName, sentinelName string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
if reviewerName != "" {
|
// Use display name for header, or fall back to sentinel name
|
||||||
title := strings.ToUpper(reviewerName[:1]) + reviewerName[1:]
|
headerName := displayName
|
||||||
|
if headerName == "" {
|
||||||
|
headerName = sentinelName
|
||||||
|
}
|
||||||
|
|
||||||
|
if headerName != "" {
|
||||||
|
title := CapitalizeFirst(headerName)
|
||||||
sb.WriteString(fmt.Sprintf("# %s Review\n\n", title))
|
sb.WriteString(fmt.Sprintf("# %s Review\n\n", title))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -33,23 +60,11 @@ func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
|||||||
sb.WriteString("## Recommendation\n\n")
|
sb.WriteString("## Recommendation\n\n")
|
||||||
sb.WriteString(fmt.Sprintf("**%s** — %s\n", result.Verdict, result.Recommendation))
|
sb.WriteString(fmt.Sprintf("**%s** — %s\n", result.Verdict, result.Recommendation))
|
||||||
|
|
||||||
if reviewerName != "" {
|
if sentinelName != "" {
|
||||||
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", reviewerName))
|
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", headerName))
|
||||||
// Hidden sentinel for identifying this bot's reviews during cleanup
|
// Hidden sentinel for identifying this bot's reviews during cleanup
|
||||||
sb.WriteString(fmt.Sprintf("\n<!-- review-bot:%s -->\n", reviewerName))
|
sb.WriteString(fmt.Sprintf("\n<!-- review-bot:%s -->\n", sentinelName))
|
||||||
}
|
}
|
||||||
|
|
||||||
return sb.String()
|
return sb.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiteaEvent converts the verdict to the Gitea API event string.
|
|
||||||
func GiteaEvent(verdict string) string {
|
|
||||||
switch verdict {
|
|
||||||
case "APPROVE":
|
|
||||||
return "APPROVED"
|
|
||||||
case "REQUEST_CHANGES":
|
|
||||||
return "REQUEST_CHANGES"
|
|
||||||
default:
|
|
||||||
return "COMMENT"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -159,3 +159,58 @@ func TestFormatMarkdown_RoleTitle(t *testing.T) {
|
|||||||
t.Error("should not contain role title header when reviewer name is empty")
|
t.Error("should not contain role title header when reviewer name is empty")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFormatMarkdownWithDisplay(t *testing.T) {
|
||||||
|
result := &ReviewResult{
|
||||||
|
Verdict: "APPROVE",
|
||||||
|
Summary: "Test summary",
|
||||||
|
Findings: nil,
|
||||||
|
Recommendation: "Test recommendation",
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Run("with display name", func(t *testing.T) {
|
||||||
|
body := FormatMarkdownWithDisplay(result, "Security Specialist", "security")
|
||||||
|
|
||||||
|
// Header should use display name
|
||||||
|
if !strings.Contains(body, "# Security Specialist Review") {
|
||||||
|
t.Error("header should use display name")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sentinel should use sentinel name
|
||||||
|
if !strings.Contains(body, "<!-- review-bot:security -->") {
|
||||||
|
t.Error("sentinel should use sentinel name")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Footer "Review by" should use display name
|
||||||
|
if !strings.Contains(body, "*Review by Security Specialist*") {
|
||||||
|
t.Error("footer should use display name")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("without display name", func(t *testing.T) {
|
||||||
|
body := FormatMarkdownWithDisplay(result, "", "reviewer")
|
||||||
|
|
||||||
|
// Should fall back to sentinel name for header
|
||||||
|
if !strings.Contains(body, "# Reviewer Review") {
|
||||||
|
t.Error("header should fall back to sentinel name")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(body, "<!-- review-bot:reviewer -->") {
|
||||||
|
t.Error("sentinel should use sentinel name")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("empty both names", func(t *testing.T) {
|
||||||
|
body := FormatMarkdownWithDisplay(result, "", "")
|
||||||
|
|
||||||
|
// Should not have header
|
||||||
|
if strings.Contains(body, "# ") && strings.Contains(body, " Review") {
|
||||||
|
t.Error("should not have header when both names empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should not have sentinel
|
||||||
|
if strings.Contains(body, "<!-- review-bot:") {
|
||||||
|
t.Error("should not have sentinel when sentinel name empty")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,367 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"embed"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
|
||||||
|
"github.com/goccy/go-yaml"
|
||||||
|
"github.com/goccy/go-yaml/ast"
|
||||||
|
"github.com/goccy/go-yaml/parser"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:embed personas/*.yaml
|
||||||
|
var embeddedPersonas embed.FS
|
||||||
|
|
||||||
|
// MaxPersonaFileSize is the maximum size for persona files (64 KB).
|
||||||
|
// This prevents denial-of-service via excessively large files.
|
||||||
|
const MaxPersonaFileSize = 64 * 1024
|
||||||
|
|
||||||
|
// MaxYAMLDepth is the maximum nesting depth allowed in YAML persona files.
|
||||||
|
// This prevents stack exhaustion from deeply nested structures.
|
||||||
|
const MaxYAMLDepth = 20
|
||||||
|
|
||||||
|
// MaxYAMLNodes is the maximum number of YAML nodes allowed in persona files.
|
||||||
|
// This prevents DoS via wide-but-shallow structures that bypass depth limits.
|
||||||
|
const MaxYAMLNodes = 1000
|
||||||
|
|
||||||
|
// Persona defines a specialized review role with focused expertise.
|
||||||
|
type Persona struct {
|
||||||
|
Name string `json:"name" yaml:"name"`
|
||||||
|
DisplayName string `json:"display_name" yaml:"display_name"`
|
||||||
|
ModelPref string `json:"model_preference,omitempty" yaml:"model_preference,omitempty"`
|
||||||
|
Identity string `json:"identity" yaml:"identity"`
|
||||||
|
Focus []string `json:"focus" yaml:"focus"`
|
||||||
|
Ignore []string `json:"ignore" yaml:"ignore"`
|
||||||
|
Severity Severity `json:"severity" yaml:"severity"`
|
||||||
|
OutputFormat string `json:"output_format,omitempty" yaml:"output_format,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Severity defines what constitutes each severity level for this persona.
|
||||||
|
// These are prompt guidance for the LLM, not output format changes.
|
||||||
|
type Severity struct {
|
||||||
|
Major string `json:"major" yaml:"major"`
|
||||||
|
Minor string `json:"minor" yaml:"minor"`
|
||||||
|
Nit string `json:"nit" yaml:"nit"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadPersona loads a persona from a JSON or YAML file path.
|
||||||
|
// Format is detected by file extension: .yaml/.yml for YAML, .json or other for JSON.
|
||||||
|
// Files larger than MaxPersonaFileSize are rejected.
|
||||||
|
//
|
||||||
|
// Symlinks are supported: os.Stat follows symlinks, so a symlink pointing to
|
||||||
|
// a regular file will pass the IsRegular() check. Symlinks to non-regular files
|
||||||
|
// (directories, FIFOs, devices) are still rejected.
|
||||||
|
func LoadPersona(path string) (*Persona, error) {
|
||||||
|
// os.Stat follows symlinks, so symlinks to regular files are supported.
|
||||||
|
// The IsRegular() check operates on the target, not the symlink itself.
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("read persona file %s: %w", path, err)
|
||||||
|
}
|
||||||
|
if !info.Mode().IsRegular() {
|
||||||
|
return nil, fmt.Errorf("persona file %s is not a regular file", path)
|
||||||
|
}
|
||||||
|
if info.Size() > MaxPersonaFileSize {
|
||||||
|
return nil, fmt.Errorf("persona file %s exceeds maximum size (%d bytes)", path, MaxPersonaFileSize)
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("read persona file %s: %w", path, err)
|
||||||
|
}
|
||||||
|
// Re-check size after read to defend against TOCTOU races where file
|
||||||
|
// grows between stat and read (e.g., appending process, replaced file).
|
||||||
|
if len(data) > MaxPersonaFileSize {
|
||||||
|
return nil, fmt.Errorf("persona file %s exceeds maximum size (%d bytes)", path, MaxPersonaFileSize)
|
||||||
|
}
|
||||||
|
return parsePersona(data, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadBuiltinPersona loads a built-in persona by name.
|
||||||
|
// Returns an error if the persona doesn't exist.
|
||||||
|
// Built-in personas are stored in YAML format only (see embed directive).
|
||||||
|
func LoadBuiltinPersona(name string) (*Persona, error) {
|
||||||
|
yamlFile := name + ".yaml"
|
||||||
|
data, err := embeddedPersonas.ReadFile("personas/" + yamlFile)
|
||||||
|
if err != nil {
|
||||||
|
available := ListBuiltinPersonas()
|
||||||
|
return nil, fmt.Errorf("unknown built-in persona %q (available: %s)", name, strings.Join(available, ", "))
|
||||||
|
}
|
||||||
|
return parsePersona(data, "builtin:"+yamlFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListBuiltinPersonas returns the names of all built-in personas in sorted order.
|
||||||
|
// Returns an empty slice if the embedded directory cannot be read.
|
||||||
|
func ListBuiltinPersonas() []string {
|
||||||
|
entries, err := embeddedPersonas.ReadDir("personas")
|
||||||
|
if err != nil {
|
||||||
|
return []string{}
|
||||||
|
}
|
||||||
|
seen := make(map[string]bool)
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
name := e.Name()
|
||||||
|
// Strip extension to get persona name
|
||||||
|
var personaName string
|
||||||
|
switch {
|
||||||
|
case strings.HasSuffix(name, ".yaml"):
|
||||||
|
personaName = strings.TrimSuffix(name, ".yaml")
|
||||||
|
case strings.HasSuffix(name, ".yml"):
|
||||||
|
personaName = strings.TrimSuffix(name, ".yml")
|
||||||
|
case strings.HasSuffix(name, ".json"):
|
||||||
|
personaName = strings.TrimSuffix(name, ".json")
|
||||||
|
default:
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[personaName] = true
|
||||||
|
}
|
||||||
|
names := make([]string, 0, len(seen))
|
||||||
|
for name := range seen {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
return names
|
||||||
|
}
|
||||||
|
|
||||||
|
// parsePersona parses persona data from JSON or YAML format.
|
||||||
|
// Format is detected by the source file extension.
|
||||||
|
func parsePersona(data []byte, source string) (*Persona, error) {
|
||||||
|
lowerSource := strings.ToLower(source)
|
||||||
|
isYAML := strings.HasSuffix(lowerSource, ".yaml") || strings.HasSuffix(lowerSource, ".yml")
|
||||||
|
|
||||||
|
var p Persona
|
||||||
|
var err error
|
||||||
|
if isYAML {
|
||||||
|
err = unmarshalYAMLWithDepthLimit(data, &p, MaxYAMLDepth)
|
||||||
|
} else {
|
||||||
|
// Use json.Decoder with DisallowUnknownFields for consistency with
|
||||||
|
// YAML's Strict() - both reject unknown fields to catch typos.
|
||||||
|
dec := json.NewDecoder(bytes.NewReader(data))
|
||||||
|
dec.DisallowUnknownFields()
|
||||||
|
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 {
|
||||||
|
return nil, fmt.Errorf("parse persona %s: %w", source, err)
|
||||||
|
}
|
||||||
|
if err := validatePersona(&p, source); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &p, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// unmarshalYAMLWithDepthLimit unmarshals YAML data with three safety checks:
|
||||||
|
// - Depth limiting: rejects AST trees exceeding maxDepth to prevent stack exhaustion.
|
||||||
|
// - Multi-document rejection: prevents silent data loss from ignored extra documents.
|
||||||
|
// - Strict field checking: rejects unknown YAML keys to catch typos early.
|
||||||
|
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
||||||
|
// First pass: parse into AST to check depth limits, node counts, and
|
||||||
|
// multi-document rejection. This prevents stack exhaustion before we
|
||||||
|
// attempt to decode into structs.
|
||||||
|
file, err := parser.ParseBytes(data, 0)
|
||||||
|
if err != nil {
|
||||||
|
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
|
||||||
|
// could lead to confusing behavior where users think their changes take effect.
|
||||||
|
if len(file.Docs) > 1 {
|
||||||
|
return fmt.Errorf("multi-document YAML is not supported; only single-document files are allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
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 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second pass: decode with strict field checking enabled.
|
||||||
|
// Strict() rejects unknown keys, catching typos like "focuss" or "identiy".
|
||||||
|
//
|
||||||
|
// Safety note: goccy/go-yaml's decoder does not expand YAML aliases
|
||||||
|
// recursively — it resolves them via the pre-built AST, which our first
|
||||||
|
// pass already depth-checked. Alias chains that would exceed depth limits
|
||||||
|
// are caught above; the decoder merely reads the resolved scalar values.
|
||||||
|
dec := yaml.NewDecoder(bytes.NewReader(data), yaml.Strict())
|
||||||
|
return dec.Decode(out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkYAMLDepth recursively checks that YAML AST nodes don't exceed the depth
|
||||||
|
// limit or the total node count limit. It uses two tracking maps:
|
||||||
|
// - validated: maps each node to the maximum depth at which it was previously
|
||||||
|
// checked. If a node is revisited at a deeper depth (e.g., via an alias),
|
||||||
|
// 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 {
|
||||||
|
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.
|
||||||
|
// 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++
|
||||||
|
if *nodeCount > maxNodes {
|
||||||
|
return fmt.Errorf("YAML node count exceeds maximum (%d)", maxNodes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Depth-aware short-circuit: skip re-validation only when the current visit
|
||||||
|
// depth is the same or shallower than the depth at which this node was
|
||||||
|
// previously validated. A shallower (or equal) current depth means the
|
||||||
|
// 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
|
||||||
|
|
||||||
|
// Mark as visiting (on the current recursion path) for cycle detection.
|
||||||
|
visiting[node] = true
|
||||||
|
defer func() { visiting[node] = false }()
|
||||||
|
|
||||||
|
// Walk children based on node type.
|
||||||
|
switch n := node.(type) {
|
||||||
|
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
|
||||||
|
}
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
// 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) {
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
|
||||||
|
func validatePersona(p *Persona, source string) error {
|
||||||
|
if p.Name == "" {
|
||||||
|
return fmt.Errorf("persona %s: name is required", source)
|
||||||
|
}
|
||||||
|
if p.Identity == "" {
|
||||||
|
return fmt.Errorf("persona %s: identity is required", source)
|
||||||
|
}
|
||||||
|
// DisplayName defaults to Name if not set
|
||||||
|
if p.DisplayName == "" {
|
||||||
|
p.DisplayName = p.Name
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CapitalizeFirst capitalizes the first rune of a string in a Unicode-safe way.
|
||||||
|
// Returns the original string if it's empty.
|
||||||
|
func CapitalizeFirst(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
r, size := utf8.DecodeRuneInString(s)
|
||||||
|
if r == utf8.RuneError {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
return strings.ToUpper(string(r)) + s[size:]
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BuildPersonaSystemPrompt constructs a system prompt from a persona definition.
|
||||||
|
// This replaces BuildSystemBase when a persona is provided.
|
||||||
|
func BuildPersonaSystemPrompt(p *Persona) string {
|
||||||
|
var sb strings.Builder
|
||||||
|
|
||||||
|
// Identity section
|
||||||
|
sb.WriteString(p.Identity)
|
||||||
|
sb.WriteString("\n\n")
|
||||||
|
|
||||||
|
// Focus section
|
||||||
|
if len(p.Focus) > 0 {
|
||||||
|
sb.WriteString("## Focus Areas\n\n")
|
||||||
|
sb.WriteString("Concentrate your review on:\n")
|
||||||
|
for _, f := range p.Focus {
|
||||||
|
sb.WriteString(fmt.Sprintf("- %s\n", f))
|
||||||
|
}
|
||||||
|
sb.WriteString("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ignore section
|
||||||
|
if len(p.Ignore) > 0 {
|
||||||
|
sb.WriteString("## Explicitly Out of Scope\n\n")
|
||||||
|
sb.WriteString("Do NOT comment on:\n")
|
||||||
|
for _, i := range p.Ignore {
|
||||||
|
sb.WriteString(fmt.Sprintf("- %s\n", i))
|
||||||
|
}
|
||||||
|
sb.WriteString("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Severity calibration
|
||||||
|
if p.Severity.Major != "" || p.Severity.Minor != "" || p.Severity.Nit != "" {
|
||||||
|
sb.WriteString("## Severity Calibration\n\n")
|
||||||
|
sb.WriteString("Use these severity definitions for YOUR domain:\n")
|
||||||
|
if p.Severity.Major != "" {
|
||||||
|
sb.WriteString(fmt.Sprintf("- **MAJOR**: %s\n", p.Severity.Major))
|
||||||
|
}
|
||||||
|
if p.Severity.Minor != "" {
|
||||||
|
sb.WriteString(fmt.Sprintf("- **MINOR**: %s\n", p.Severity.Minor))
|
||||||
|
}
|
||||||
|
if p.Severity.Nit != "" {
|
||||||
|
sb.WriteString(fmt.Sprintf("- **NIT**: %s\n", p.Severity.Nit))
|
||||||
|
}
|
||||||
|
sb.WriteString("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Output format instructions (shared schema from prompt.go)
|
||||||
|
sb.WriteString("## Review Instructions\n\n")
|
||||||
|
sb.WriteString("CONTEXT:\n")
|
||||||
|
sb.WriteString("- You will receive the full content of modified files for reference, followed by the diff showing what changed.\n")
|
||||||
|
sb.WriteString("- The diff shows ONLY what was added/removed. The full file content provides complete context.\n")
|
||||||
|
sb.WriteString("- Focus your review on the CHANGES (the diff), using the full files for context.\n\n")
|
||||||
|
sb.WriteString("Your task:\n")
|
||||||
|
sb.WriteString("1. Review the diff for issues within YOUR focus areas only.\n")
|
||||||
|
sb.WriteString("2. Consider the CI status — if CI has failed, that is an automatic REQUEST_CHANGES regardless of code quality.\n")
|
||||||
|
sb.WriteString("3. Output your review as structured JSON (and ONLY JSON, no markdown fences or other text).\n\n")
|
||||||
|
sb.WriteString("Output format:\n")
|
||||||
|
sb.WriteString(outputSchemaJSON)
|
||||||
|
sb.WriteString("\n\n")
|
||||||
|
sb.WriteString(verdictRules)
|
||||||
|
sb.WriteString("\n- Only report findings within your focus areas. Ignore everything else.\n")
|
||||||
|
sb.WriteString("- Line numbers should reference the new file line numbers from the diff headers.\n")
|
||||||
|
sb.WriteString("- If the diff has no changes relevant to your focus areas, APPROVE with no findings.\n")
|
||||||
|
|
||||||
|
// Custom output format if provided
|
||||||
|
if p.OutputFormat != "" {
|
||||||
|
sb.WriteString("\n\n## Additional Output Guidelines\n\n")
|
||||||
|
sb.WriteString(p.OutputFormat)
|
||||||
|
}
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildSystemPromptWithPersona constructs the full system prompt, using either
|
||||||
|
// a persona or the default generic prompt. This is a convenience wrapper that
|
||||||
|
// combines BuildPersonaSystemPrompt (or BuildSystemBase) with patterns and conventions.
|
||||||
|
// It is exported for use by callers who want one-shot prompt assembly.
|
||||||
|
func BuildSystemPromptWithPersona(persona *Persona, conventions, patterns string) string {
|
||||||
|
var base string
|
||||||
|
if persona != nil {
|
||||||
|
base = BuildPersonaSystemPrompt(persona)
|
||||||
|
} else {
|
||||||
|
base = BuildSystemBase()
|
||||||
|
}
|
||||||
|
|
||||||
|
var sb strings.Builder
|
||||||
|
sb.WriteString(base)
|
||||||
|
|
||||||
|
if patterns != "" {
|
||||||
|
sb.WriteString(fmt.Sprintf("\n\n## Language Patterns & Idioms\n\nUse the following patterns as review criteria. Code that violates these established patterns is a finding:\n\n%s\n", patterns))
|
||||||
|
}
|
||||||
|
|
||||||
|
if conventions != "" {
|
||||||
|
sb.WriteString(fmt.Sprintf("\n\n## Repository Conventions\n\nThe repository has the following coding conventions that must be respected:\n\n%s\n", conventions))
|
||||||
|
}
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
@@ -0,0 +1,157 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildPersonaSystemPrompt(t *testing.T) {
|
||||||
|
p := &Persona{
|
||||||
|
Name: "security",
|
||||||
|
DisplayName: "Security Specialist",
|
||||||
|
Identity: "You are a security specialist.",
|
||||||
|
Focus: []string{"injection attacks", "auth bypass"},
|
||||||
|
Ignore: []string{"code style", "performance"},
|
||||||
|
Severity: Severity{
|
||||||
|
Major: "exploitable vulnerabilities",
|
||||||
|
Minor: "defense in depth",
|
||||||
|
Nit: "theoretical risks",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := BuildPersonaSystemPrompt(p)
|
||||||
|
|
||||||
|
// Check identity is included
|
||||||
|
if !strings.Contains(prompt, "You are a security specialist.") {
|
||||||
|
t.Error("prompt should contain identity")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check focus areas
|
||||||
|
if !strings.Contains(prompt, "Focus Areas") {
|
||||||
|
t.Error("prompt should contain Focus Areas section")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "injection attacks") {
|
||||||
|
t.Error("prompt should contain focus item")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check ignore section
|
||||||
|
if !strings.Contains(prompt, "Out of Scope") {
|
||||||
|
t.Error("prompt should contain Out of Scope section")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "code style") {
|
||||||
|
t.Error("prompt should contain ignore item")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check severity calibration
|
||||||
|
if !strings.Contains(prompt, "Severity Calibration") {
|
||||||
|
t.Error("prompt should contain Severity Calibration section")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "exploitable vulnerabilities") {
|
||||||
|
t.Error("prompt should contain major severity definition")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check JSON output format is included
|
||||||
|
if !strings.Contains(prompt, `"verdict"`) {
|
||||||
|
t.Error("prompt should contain JSON output format")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "APPROVE") {
|
||||||
|
t.Error("prompt should mention APPROVE verdict")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildPersonaSystemPromptMinimal(t *testing.T) {
|
||||||
|
// Minimal persona with only required fields
|
||||||
|
p := &Persona{
|
||||||
|
Name: "minimal",
|
||||||
|
Identity: "You are a minimal reviewer.",
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := BuildPersonaSystemPrompt(p)
|
||||||
|
|
||||||
|
// Should still work without optional fields
|
||||||
|
if !strings.Contains(prompt, "You are a minimal reviewer.") {
|
||||||
|
t.Error("prompt should contain identity")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should not have empty sections
|
||||||
|
if strings.Contains(prompt, "Focus Areas") && !strings.Contains(prompt, "Concentrate your review on:") {
|
||||||
|
t.Error("should not have Focus Areas header without content")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildSystemPromptWithPersona(t *testing.T) {
|
||||||
|
t.Run("with persona", func(t *testing.T) {
|
||||||
|
p := &Persona{
|
||||||
|
Name: "test",
|
||||||
|
Identity: "Test persona identity.",
|
||||||
|
Focus: []string{"testing"},
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := BuildSystemPromptWithPersona(p, "test conventions", "test patterns")
|
||||||
|
|
||||||
|
if !strings.Contains(prompt, "Test persona identity.") {
|
||||||
|
t.Error("should contain persona identity")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "test conventions") {
|
||||||
|
t.Error("should contain conventions")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "test patterns") {
|
||||||
|
t.Error("should contain patterns")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("without persona", func(t *testing.T) {
|
||||||
|
prompt := BuildSystemPromptWithPersona(nil, "test conventions", "test patterns")
|
||||||
|
|
||||||
|
// Should use default system base
|
||||||
|
if !strings.Contains(prompt, "expert code reviewer") {
|
||||||
|
t.Error("should contain default system base when no persona")
|
||||||
|
}
|
||||||
|
if !strings.Contains(prompt, "test conventions") {
|
||||||
|
t.Error("should contain conventions")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("empty conventions and patterns", func(t *testing.T) {
|
||||||
|
p := &Persona{
|
||||||
|
Name: "test",
|
||||||
|
Identity: "Test identity.",
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := BuildSystemPromptWithPersona(p, "", "")
|
||||||
|
|
||||||
|
if strings.Contains(prompt, "Language Patterns") {
|
||||||
|
t.Error("should not contain patterns section when empty")
|
||||||
|
}
|
||||||
|
if strings.Contains(prompt, "Repository Conventions") {
|
||||||
|
t.Error("should not contain conventions section when empty")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPersonaPromptContainsOutputRules(t *testing.T) {
|
||||||
|
p := &Persona{
|
||||||
|
Name: "test",
|
||||||
|
Identity: "Test.",
|
||||||
|
}
|
||||||
|
|
||||||
|
prompt := BuildPersonaSystemPrompt(p)
|
||||||
|
|
||||||
|
// Must contain the critical output rules
|
||||||
|
requiredStrings := []string{
|
||||||
|
"APPROVE",
|
||||||
|
"REQUEST_CHANGES",
|
||||||
|
"MAJOR",
|
||||||
|
"MINOR",
|
||||||
|
"NIT",
|
||||||
|
"verdict",
|
||||||
|
"findings",
|
||||||
|
"CI",
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, s := range requiredStrings {
|
||||||
|
if !strings.Contains(prompt, s) {
|
||||||
|
t.Errorf("prompt should contain %q", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,37 @@
|
|||||||
|
# Software Architect Persona
|
||||||
|
# Focuses on design quality, patterns, and code organization
|
||||||
|
|
||||||
|
name: architect
|
||||||
|
display_name: Software Architect
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
You are a software architect reviewing code for design quality.
|
||||||
|
|
||||||
|
Your expertise:
|
||||||
|
- Design patterns and anti-patterns
|
||||||
|
- Code organization and module boundaries
|
||||||
|
- API design and contracts
|
||||||
|
- Testability and dependency injection
|
||||||
|
- Consistency with existing architecture
|
||||||
|
- Technical debt identification
|
||||||
|
|
||||||
|
focus:
|
||||||
|
- Design pattern violations or misuse
|
||||||
|
- Module boundary violations (inappropriate coupling)
|
||||||
|
- API design issues (unclear contracts, leaky abstractions)
|
||||||
|
- Testability problems (hidden dependencies, god objects)
|
||||||
|
- Inconsistency with existing codebase patterns
|
||||||
|
- Unnecessary complexity or over-engineering
|
||||||
|
- Missing abstractions or premature abstraction
|
||||||
|
|
||||||
|
ignore:
|
||||||
|
- Security vulnerabilities (security persona handles these)
|
||||||
|
- Performance micro-optimizations
|
||||||
|
- Code style and formatting
|
||||||
|
- Documentation typos
|
||||||
|
- Test implementation details
|
||||||
|
|
||||||
|
severity:
|
||||||
|
major: "Architectural violations that will cause maintenance problems or make the codebase harder to evolve"
|
||||||
|
minor: "Design issues that reduce clarity or testability but don't block progress"
|
||||||
|
nit: "Minor pattern deviations or style preferences"
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
# Documentation Reviewer Persona
|
||||||
|
# Focuses on clarity, documentation quality, and self-documenting code
|
||||||
|
|
||||||
|
name: docs
|
||||||
|
display_name: Documentation Reviewer
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
You are a documentation specialist reviewing code for clarity and documentation quality.
|
||||||
|
|
||||||
|
Your expertise:
|
||||||
|
- API documentation and examples
|
||||||
|
- Code comments and their accuracy
|
||||||
|
- Error message clarity
|
||||||
|
- README and guide quality
|
||||||
|
- Naming clarity and self-documenting code
|
||||||
|
|
||||||
|
focus:
|
||||||
|
- Missing or outdated documentation
|
||||||
|
- Unclear or misleading comments
|
||||||
|
- Poor error messages (cryptic, unhelpful, missing context)
|
||||||
|
- Confusing naming (functions, variables, types)
|
||||||
|
- Missing examples for complex APIs
|
||||||
|
- Inconsistent terminology
|
||||||
|
- Documentation that contradicts the code
|
||||||
|
|
||||||
|
ignore:
|
||||||
|
- Security vulnerabilities
|
||||||
|
- Performance issues
|
||||||
|
- Design patterns
|
||||||
|
- Test coverage
|
||||||
|
- Code style (unless it affects readability)
|
||||||
|
|
||||||
|
severity:
|
||||||
|
major: "Documentation that actively misleads or missing docs for critical functionality"
|
||||||
|
minor: "Unclear documentation or poor error messages that will confuse users"
|
||||||
|
nit: "Minor clarity improvements or typo fixes"
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# Security Specialist Persona
|
||||||
|
# Focuses on vulnerabilities, auth issues, and security best practices
|
||||||
|
|
||||||
|
name: security
|
||||||
|
display_name: Security Specialist
|
||||||
|
|
||||||
|
identity: |
|
||||||
|
You are a security specialist reviewing code for vulnerabilities.
|
||||||
|
|
||||||
|
Your expertise:
|
||||||
|
- OWASP Top 10 vulnerabilities
|
||||||
|
- Injection attacks (SQL, command, path traversal, template)
|
||||||
|
- Authentication and authorization patterns
|
||||||
|
- Secrets management and exposure risks
|
||||||
|
- Race conditions with security implications
|
||||||
|
- Event sourcing attack vectors (replay attacks, event injection)
|
||||||
|
|
||||||
|
focus:
|
||||||
|
- Injection attacks (SQL, command, path traversal, template injection)
|
||||||
|
- Authentication and authorization gaps or bypasses
|
||||||
|
- Secrets exposure (hardcoded credentials, tokens in logs, config leaks)
|
||||||
|
- Input validation failures (unsanitized input, unsafe deserialization)
|
||||||
|
- Race conditions that could be exploited
|
||||||
|
- Cryptographic weaknesses (weak algorithms, improper key handling)
|
||||||
|
- Information disclosure through error messages or logs
|
||||||
|
|
||||||
|
ignore:
|
||||||
|
- Code style and naming conventions
|
||||||
|
- Performance optimizations (unless security-related)
|
||||||
|
- Documentation quality
|
||||||
|
- General code quality or readability
|
||||||
|
- Test coverage
|
||||||
|
|
||||||
|
severity:
|
||||||
|
major: "Exploitable vulnerabilities: auth bypass, injection, data exfiltration, privilege escalation, RCE"
|
||||||
|
minor: "Defense-in-depth issues: missing rate limiting, verbose errors, weak input validation"
|
||||||
|
nit: "Theoretical risks with low exploitability or impact"
|
||||||
+26
-18
@@ -7,6 +7,28 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// outputSchemaJSON is the shared JSON output format specification used by both
|
||||||
|
// the generic reviewer and persona-based reviewers.
|
||||||
|
const outputSchemaJSON = `{
|
||||||
|
"verdict": "APPROVE" or "REQUEST_CHANGES",
|
||||||
|
"summary": "Brief overall assessment (1-3 sentences)",
|
||||||
|
"findings": [
|
||||||
|
{
|
||||||
|
"severity": "MAJOR" or "MINOR" or "NIT",
|
||||||
|
"file": "path/to/file",
|
||||||
|
"line": <line number from the diff>,
|
||||||
|
"finding": "Description of the issue"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"recommendation": "Full recommendation text explaining your verdict"
|
||||||
|
}`
|
||||||
|
|
||||||
|
// verdictRules is the shared verdict determination rules.
|
||||||
|
const verdictRules = `Rules:
|
||||||
|
- If there are any MAJOR findings → verdict must be REQUEST_CHANGES
|
||||||
|
- If there are no MAJOR findings → verdict should be APPROVE
|
||||||
|
- If CI has failed → verdict must be REQUEST_CHANGES with a finding noting the CI failure`
|
||||||
|
|
||||||
// BuildSystemBase returns the core system prompt instructions without
|
// BuildSystemBase returns the core system prompt instructions without
|
||||||
// patterns or conventions. Used by the budget package to separate
|
// patterns or conventions. Used by the budget package to separate
|
||||||
// trimmable from non-trimmable content.
|
// trimmable from non-trimmable content.
|
||||||
@@ -23,24 +45,10 @@ func BuildSystemBase() string {
|
|||||||
sb.WriteString("2. Consider the CI status — if CI has failed, that is an automatic REQUEST_CHANGES regardless of code quality.\n")
|
sb.WriteString("2. Consider the CI status — if CI has failed, that is an automatic REQUEST_CHANGES regardless of code quality.\n")
|
||||||
sb.WriteString("3. Output your review as structured JSON (and ONLY JSON, no markdown fences or other text).\n\n")
|
sb.WriteString("3. Output your review as structured JSON (and ONLY JSON, no markdown fences or other text).\n\n")
|
||||||
sb.WriteString("Output format:\n")
|
sb.WriteString("Output format:\n")
|
||||||
sb.WriteString("{\n")
|
sb.WriteString(outputSchemaJSON)
|
||||||
sb.WriteString(" \"verdict\": \"APPROVE\" or \"REQUEST_CHANGES\",\n")
|
sb.WriteString("\n\n")
|
||||||
sb.WriteString(" \"summary\": \"Brief overall assessment (1-3 sentences)\",\n")
|
sb.WriteString(verdictRules)
|
||||||
sb.WriteString(" \"findings\": [\n")
|
sb.WriteString("\n- Be thorough but fair. Don't nitpick style unless it impacts readability significantly.\n")
|
||||||
sb.WriteString(" {\n")
|
|
||||||
sb.WriteString(" \"severity\": \"MAJOR\" or \"MINOR\" or \"NIT\",\n")
|
|
||||||
sb.WriteString(" \"file\": \"path/to/file\",\n")
|
|
||||||
sb.WriteString(" \"line\": <line number from the diff>,\n")
|
|
||||||
sb.WriteString(" \"finding\": \"Description of the issue\"\n")
|
|
||||||
sb.WriteString(" }\n")
|
|
||||||
sb.WriteString(" ],\n")
|
|
||||||
sb.WriteString(" \"recommendation\": \"Full recommendation text explaining your verdict\"\n")
|
|
||||||
sb.WriteString("}\n\n")
|
|
||||||
sb.WriteString("Rules:\n")
|
|
||||||
sb.WriteString("- If there are any MAJOR findings → verdict must be REQUEST_CHANGES\n")
|
|
||||||
sb.WriteString("- If there are no MAJOR findings → verdict should be APPROVE\n")
|
|
||||||
sb.WriteString("- If CI has failed → verdict must be REQUEST_CHANGES with a finding noting the CI failure\n")
|
|
||||||
sb.WriteString("- Be thorough but fair. Don't nitpick style unless it impacts readability significantly.\n")
|
|
||||||
sb.WriteString("- Line numbers should reference the new file line numbers from the diff headers.\n")
|
sb.WriteString("- Line numbers should reference the new file line numbers from the diff headers.\n")
|
||||||
sb.WriteString("- If the diff is empty or trivial (only formatting/whitespace), APPROVE with no findings.\n")
|
sb.WriteString("- If the diff is empty or trivial (only formatting/whitespace), APPROVE with no findings.\n")
|
||||||
|
|
||||||
|
|||||||
@@ -117,7 +117,6 @@ func TestBuildUserPrompt_WithoutFileContext(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func TestBuildSystemBase(t *testing.T) {
|
func TestBuildSystemBase(t *testing.T) {
|
||||||
result := BuildSystemBase()
|
result := BuildSystemBase()
|
||||||
if result == "" {
|
if result == "" {
|
||||||
|
|||||||
@@ -0,0 +1,150 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RepoPersonaPath is the directory path where repo-specific personas are stored.
|
||||||
|
const RepoPersonaPath = ".review-bot/personas"
|
||||||
|
|
||||||
|
// GiteaClient defines the subset of gitea.Client methods needed for loading repo personas.
|
||||||
|
// This interface allows for easier testing and decouples the review package from gitea.
|
||||||
|
type GiteaClient interface {
|
||||||
|
ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error)
|
||||||
|
GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ContentEntry represents a file or directory entry from the contents API.
|
||||||
|
// This mirrors gitea.ContentEntry to avoid import cycles.
|
||||||
|
type ContentEntry struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
Type string `json:"type"` // "file" or "dir"
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadRepoPersonas fetches personas from a repository's .review-bot/personas/ directory.
|
||||||
|
// Returns an empty map (not nil) if the directory doesn't exist or is empty.
|
||||||
|
// Individual parse failures are logged and skipped; the remaining personas are still returned.
|
||||||
|
// Auth errors and other non-404 errors are propagated.
|
||||||
|
// Files exceeding MaxPersonaFileSize are rejected to prevent resource exhaustion.
|
||||||
|
func LoadRepoPersonas(ctx context.Context, client GiteaClient, owner, repo string) (map[string]*Persona, error) {
|
||||||
|
result := make(map[string]*Persona)
|
||||||
|
|
||||||
|
entries, err := client.ListContents(ctx, owner, repo, RepoPersonaPath)
|
||||||
|
if err != nil {
|
||||||
|
// Check if this is a 404 (directory doesn't exist) - expected case
|
||||||
|
if isNotFoundError(err) {
|
||||||
|
slog.Debug("no repo personas directory found", "repo", owner+"/"+repo)
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
// Other errors (auth, server) should propagate
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(entries) == 0 {
|
||||||
|
slog.Debug("repo personas directory is empty", "repo", owner+"/"+repo)
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, entry := range entries {
|
||||||
|
if entry.Type != "file" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Only process YAML files
|
||||||
|
if !isYAMLFile(entry.Name) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
content, err := client.GetFileContent(ctx, owner, repo, entry.Path)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not fetch repo persona file",
|
||||||
|
"file", entry.Path,
|
||||||
|
"repo", owner+"/"+repo,
|
||||||
|
"error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enforce size limit before parsing to prevent resource exhaustion
|
||||||
|
if len(content) > MaxPersonaFileSize {
|
||||||
|
slog.Warn("repo persona file exceeds maximum size",
|
||||||
|
"file", entry.Path,
|
||||||
|
"repo", owner+"/"+repo,
|
||||||
|
"size", len(content),
|
||||||
|
"max", MaxPersonaFileSize)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
persona, err := ParsePersonaBytes([]byte(content), entry.Path)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not parse repo persona file",
|
||||||
|
"file", entry.Path,
|
||||||
|
"repo", owner+"/"+repo,
|
||||||
|
"error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
result[persona.Name] = persona
|
||||||
|
slog.Debug("loaded repo persona",
|
||||||
|
"name", persona.Name,
|
||||||
|
"file", entry.Path,
|
||||||
|
"repo", owner+"/"+repo)
|
||||||
|
}
|
||||||
|
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MergePersonas combines built-in personas with repo personas.
|
||||||
|
// Repo personas take precedence on name collision.
|
||||||
|
// Returns a new map; inputs are not modified.
|
||||||
|
func MergePersonas(builtin, repo map[string]*Persona) map[string]*Persona {
|
||||||
|
result := make(map[string]*Persona, len(builtin)+len(repo))
|
||||||
|
|
||||||
|
// Copy built-in personas first
|
||||||
|
for name, p := range builtin {
|
||||||
|
result[name] = p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Overlay repo personas (override on collision)
|
||||||
|
for name, p := range repo {
|
||||||
|
if _, exists := result[name]; exists {
|
||||||
|
slog.Debug("repo persona overrides built-in", "name", name)
|
||||||
|
}
|
||||||
|
result[name] = p
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBuiltinPersonasMap returns all built-in personas as a map keyed by name.
|
||||||
|
// Returns an empty map (not nil) if loading fails.
|
||||||
|
func GetBuiltinPersonasMap() map[string]*Persona {
|
||||||
|
result := make(map[string]*Persona)
|
||||||
|
for _, name := range ListBuiltinPersonas() {
|
||||||
|
p, err := LoadBuiltinPersona(name)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not load built-in persona", "name", name, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
result[name] = p
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// isYAMLFile checks if a filename has a YAML extension.
|
||||||
|
func isYAMLFile(name string) bool {
|
||||||
|
lower := strings.ToLower(name)
|
||||||
|
return strings.HasSuffix(lower, ".yaml") || strings.HasSuffix(lower, ".yml")
|
||||||
|
}
|
||||||
|
|
||||||
|
// isNotFoundError checks if an error represents a 404 response.
|
||||||
|
// This uses a specific "HTTP 404" substring match rather than a generic "not found"
|
||||||
|
// match to avoid masking authentication failures or transport errors that might
|
||||||
|
// contain "not found" in their message.
|
||||||
|
func isNotFoundError(err error) bool {
|
||||||
|
if err == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return strings.Contains(err.Error(), "HTTP 404")
|
||||||
|
}
|
||||||
@@ -0,0 +1,443 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParsePersonaBytes(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
data string
|
||||||
|
source string
|
||||||
|
wantName string
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid yaml",
|
||||||
|
data: `name: test
|
||||||
|
identity: test identity
|
||||||
|
focus:
|
||||||
|
- testing
|
||||||
|
`,
|
||||||
|
source: "test.yaml",
|
||||||
|
wantName: "test",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing name",
|
||||||
|
data: "identity: test\n",
|
||||||
|
source: "test.yaml",
|
||||||
|
wantErr: "name is required",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid yaml",
|
||||||
|
data: "not: valid:\n yaml: [broken",
|
||||||
|
source: "test.yaml",
|
||||||
|
wantErr: "parse",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "json format by extension",
|
||||||
|
data: `{"name": "jsontest", "identity": "json identity"}`,
|
||||||
|
source: "test.json",
|
||||||
|
wantName: "jsontest",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
p, err := ParsePersonaBytes([]byte(tt.data), tt.source)
|
||||||
|
if tt.wantErr != "" {
|
||||||
|
if err == nil {
|
||||||
|
t.Fatalf("expected error containing %q, got nil", tt.wantErr)
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), tt.wantErr) {
|
||||||
|
t.Errorf("error = %q, want containing %q", err.Error(), tt.wantErr)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if p.Name != tt.wantName {
|
||||||
|
t.Errorf("Name = %q, want %q", p.Name, tt.wantName)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// mockGiteaClient implements GiteaClient for testing.
|
||||||
|
type mockGiteaClient struct {
|
||||||
|
contents map[string][]ContentEntry // path -> entries
|
||||||
|
files map[string]string // path -> content
|
||||||
|
listErr error
|
||||||
|
fileErr map[string]error // path -> error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockGiteaClient) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
||||||
|
if m.listErr != nil {
|
||||||
|
return nil, m.listErr
|
||||||
|
}
|
||||||
|
entries, ok := m.contents[path]
|
||||||
|
if !ok {
|
||||||
|
return nil, errors.New("list contents .review-bot/personas: HTTP 404: not found")
|
||||||
|
}
|
||||||
|
return entries, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockGiteaClient) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
|
if m.fileErr != nil {
|
||||||
|
if err, ok := m.fileErr[filepath]; ok {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
content, ok := m.files[filepath]
|
||||||
|
if !ok {
|
||||||
|
return "", errors.New("HTTP 404: file not found")
|
||||||
|
}
|
||||||
|
return content, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadRepoPersonas(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
t.Run("directory not found returns empty map", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{} // No contents configured -> 404
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if personas == nil {
|
||||||
|
t.Error("expected empty map, got nil")
|
||||||
|
}
|
||||||
|
if len(personas) != 0 {
|
||||||
|
t.Errorf("expected 0 personas, got %d", len(personas))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("empty directory returns empty map", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(personas) != 0 {
|
||||||
|
t.Errorf("expected 0 personas, got %d", len(personas))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("loads valid personas", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "trading.yaml", Path: ".review-bot/personas/trading.yaml", Type: "file"},
|
||||||
|
{Name: "crypto.yaml", Path: ".review-bot/personas/crypto.yaml", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/trading.yaml": `name: trading
|
||||||
|
display_name: Trading Expert
|
||||||
|
identity: You are a trading expert.
|
||||||
|
focus:
|
||||||
|
- order handling
|
||||||
|
- risk management
|
||||||
|
`,
|
||||||
|
".review-bot/personas/crypto.yaml": `name: crypto
|
||||||
|
display_name: Crypto Expert
|
||||||
|
identity: You are a cryptography expert.
|
||||||
|
focus:
|
||||||
|
- key management
|
||||||
|
- encryption
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(personas) != 2 {
|
||||||
|
t.Fatalf("expected 2 personas, got %d", len(personas))
|
||||||
|
}
|
||||||
|
if personas["trading"] == nil {
|
||||||
|
t.Error("expected trading persona")
|
||||||
|
}
|
||||||
|
if personas["crypto"] == nil {
|
||||||
|
t.Error("expected crypto persona")
|
||||||
|
}
|
||||||
|
if personas["trading"].DisplayName != "Trading Expert" {
|
||||||
|
t.Errorf("trading display name = %q, want %q", personas["trading"].DisplayName, "Trading Expert")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("skips invalid persona files", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "valid.yaml", Path: ".review-bot/personas/valid.yaml", Type: "file"},
|
||||||
|
{Name: "invalid.yaml", Path: ".review-bot/personas/invalid.yaml", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/valid.yaml": `name: valid
|
||||||
|
identity: Valid persona
|
||||||
|
`,
|
||||||
|
".review-bot/personas/invalid.yaml": "not valid yaml: [broken",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
// Should have the valid one, skip the invalid
|
||||||
|
if len(personas) != 1 {
|
||||||
|
t.Fatalf("expected 1 persona (skipped invalid), got %d", len(personas))
|
||||||
|
}
|
||||||
|
if personas["valid"] == nil {
|
||||||
|
t.Error("expected valid persona")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("skips non-yaml files", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "persona.yaml", Path: ".review-bot/personas/persona.yaml", Type: "file"},
|
||||||
|
{Name: "README.md", Path: ".review-bot/personas/README.md", Type: "file"},
|
||||||
|
{Name: "notes.txt", Path: ".review-bot/personas/notes.txt", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/persona.yaml": `name: test
|
||||||
|
identity: Test persona
|
||||||
|
`,
|
||||||
|
".review-bot/personas/README.md": "# Personas\n\nPut your personas here.",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(personas) != 1 {
|
||||||
|
t.Fatalf("expected 1 persona (yaml only), got %d", len(personas))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("skips subdirectories", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "persona.yaml", Path: ".review-bot/personas/persona.yaml", Type: "file"},
|
||||||
|
{Name: "subdir", Path: ".review-bot/personas/subdir", Type: "dir"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/persona.yaml": `name: test
|
||||||
|
identity: Test persona
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(personas) != 1 {
|
||||||
|
t.Fatalf("expected 1 persona (files only), got %d", len(personas))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("propagates auth errors", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
listErr: errors.New("HTTP 401: unauthorized"),
|
||||||
|
}
|
||||||
|
_, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for auth failure")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "401") {
|
||||||
|
t.Errorf("error = %q, want containing '401'", err.Error())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("skips files that fail to fetch", func(t *testing.T) {
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "good.yaml", Path: ".review-bot/personas/good.yaml", Type: "file"},
|
||||||
|
{Name: "bad.yaml", Path: ".review-bot/personas/bad.yaml", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/good.yaml": `name: good
|
||||||
|
identity: Good persona
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
fileErr: map[string]error{
|
||||||
|
".review-bot/personas/bad.yaml": errors.New("HTTP 500: internal server error"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(personas) != 1 {
|
||||||
|
t.Fatalf("expected 1 persona (skipped failed fetch), got %d", len(personas))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("skips oversized files", func(t *testing.T) {
|
||||||
|
// Create a content string that exceeds MaxPersonaFileSize (64KB)
|
||||||
|
oversizedContent := strings.Repeat("a", MaxPersonaFileSize+1)
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]ContentEntry{
|
||||||
|
RepoPersonaPath: {
|
||||||
|
{Name: "normal.yaml", Path: ".review-bot/personas/normal.yaml", Type: "file"},
|
||||||
|
{Name: "huge.yaml", Path: ".review-bot/personas/huge.yaml", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
".review-bot/personas/normal.yaml": `name: normal
|
||||||
|
identity: Normal sized persona
|
||||||
|
`,
|
||||||
|
".review-bot/personas/huge.yaml": oversizedContent,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
personas, err := LoadRepoPersonas(ctx, client, "owner", "repo")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
// Should have the normal one, skip the oversized
|
||||||
|
if len(personas) != 1 {
|
||||||
|
t.Fatalf("expected 1 persona (skipped oversized), got %d", len(personas))
|
||||||
|
}
|
||||||
|
if personas["normal"] == nil {
|
||||||
|
t.Error("expected normal persona")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMergePersonas(t *testing.T) {
|
||||||
|
builtin := map[string]*Persona{
|
||||||
|
"security": {Name: "security", Identity: "Built-in security"},
|
||||||
|
"docs": {Name: "docs", Identity: "Built-in docs"},
|
||||||
|
}
|
||||||
|
repo := map[string]*Persona{
|
||||||
|
"security": {Name: "security", Identity: "Repo security override"},
|
||||||
|
"trading": {Name: "trading", Identity: "Repo trading"},
|
||||||
|
}
|
||||||
|
|
||||||
|
merged := MergePersonas(builtin, repo)
|
||||||
|
|
||||||
|
t.Run("repo overrides builtin on collision", func(t *testing.T) {
|
||||||
|
if merged["security"].Identity != "Repo security override" {
|
||||||
|
t.Errorf("security identity = %q, want repo override", merged["security"].Identity)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("builtin preserved when no collision", func(t *testing.T) {
|
||||||
|
if merged["docs"].Identity != "Built-in docs" {
|
||||||
|
t.Errorf("docs identity = %q, want built-in", merged["docs"].Identity)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("repo-only persona added", func(t *testing.T) {
|
||||||
|
if merged["trading"] == nil {
|
||||||
|
t.Error("expected trading persona from repo")
|
||||||
|
}
|
||||||
|
if merged["trading"].Identity != "Repo trading" {
|
||||||
|
t.Errorf("trading identity = %q, want repo", merged["trading"].Identity)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("original maps not modified", func(t *testing.T) {
|
||||||
|
if builtin["trading"] != nil {
|
||||||
|
t.Error("builtin map was modified")
|
||||||
|
}
|
||||||
|
if len(repo) != 2 {
|
||||||
|
t.Error("repo map was modified")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetBuiltinPersonasMap(t *testing.T) {
|
||||||
|
personas := GetBuiltinPersonasMap()
|
||||||
|
|
||||||
|
if len(personas) == 0 {
|
||||||
|
t.Fatal("expected at least one built-in persona")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify expected personas exist
|
||||||
|
expected := []string{"security", "architect", "docs"}
|
||||||
|
for _, name := range expected {
|
||||||
|
if personas[name] == nil {
|
||||||
|
t.Errorf("expected built-in persona %q", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify personas are valid
|
||||||
|
for name, p := range personas {
|
||||||
|
if p.Name != name {
|
||||||
|
t.Errorf("persona %q has mismatched name %q", name, p.Name)
|
||||||
|
}
|
||||||
|
if p.Identity == "" {
|
||||||
|
t.Errorf("persona %q has empty identity", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsYAMLFile(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"test.yaml", true},
|
||||||
|
{"test.yml", true},
|
||||||
|
{"test.YAML", true},
|
||||||
|
{"test.YML", true},
|
||||||
|
{"test.json", false},
|
||||||
|
{"test.md", false},
|
||||||
|
{"test.txt", false},
|
||||||
|
{"yaml", false},
|
||||||
|
{"yaml.md", false},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if got := isYAMLFile(tt.name); got != tt.want {
|
||||||
|
t.Errorf("isYAMLFile(%q) = %v, want %v", tt.name, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsNotFoundError(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
err error
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{nil, false},
|
||||||
|
{errors.New("HTTP 404: not found"), true},
|
||||||
|
{errors.New("HTTP 404"), true},
|
||||||
|
// Intentionally false: generic "not found" could mask auth/transport errors.
|
||||||
|
// Only explicit HTTP 404 responses should be treated as "directory doesn't exist".
|
||||||
|
{errors.New("something not found"), false},
|
||||||
|
{errors.New("HTTP 401: unauthorized"), false},
|
||||||
|
{errors.New("connection refused"), false},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
name := "nil"
|
||||||
|
if tt.err != nil {
|
||||||
|
name = tt.err.Error()
|
||||||
|
}
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
if got := isNotFoundError(tt.err); got != tt.want {
|
||||||
|
t.Errorf("isNotFoundError(%v) = %v, want %v", tt.err, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
Executable
+127
@@ -0,0 +1,127 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# check-deps.sh - Enforces the strict dependency allowlist from CONVENTIONS.md
|
||||||
|
# Exit 1 if any unapproved import is found.
|
||||||
|
#
|
||||||
|
# Requires: Bash 4+ (for associative arrays), Go toolchain
|
||||||
|
#
|
||||||
|
# The allowlist is parsed from CONVENTIONS.md to maintain a single source of truth.
|
||||||
|
# Enforces Scope column: "test only" packages cannot appear in non-test code.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Check bash version
|
||||||
|
if ((BASH_VERSINFO[0] < 4)); then
|
||||||
|
echo "❌ Bash 4+ required (found ${BASH_VERSION})"
|
||||||
|
echo " On macOS: brew install bash"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
CONVENTIONS_FILE="${1:-CONVENTIONS.md}"
|
||||||
|
|
||||||
|
if [ ! -f "$CONVENTIONS_FILE" ]; then
|
||||||
|
echo "❌ CONVENTIONS.md not found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Parse approved packages from CONVENTIONS.md table using awk (POSIX-compatible)
|
||||||
|
# Format: | `package` | use case | scope |
|
||||||
|
declare -A ALLOWED_PROD=()
|
||||||
|
declare -A ALLOWED_TEST=()
|
||||||
|
|
||||||
|
while IFS= read -r line; do
|
||||||
|
# Use awk to extract package and scope from table row
|
||||||
|
pkg=$(echo "$line" | awk -F'|' '{gsub(/^[[:space:]]*`|`[[:space:]]*$/, "", $2); print $2}')
|
||||||
|
scope=$(echo "$line" | awk -F'|' '{gsub(/^[[:space:]]+|[[:space:]]+$/, "", $4); print tolower($4)}')
|
||||||
|
|
||||||
|
if [ -n "$pkg" ] && [ "$pkg" != "Package" ] && [[ "$pkg" =~ ^[a-zA-Z] ]]; then
|
||||||
|
if [[ "$scope" == *"test"* ]]; then
|
||||||
|
ALLOWED_TEST["$pkg"]=1
|
||||||
|
else
|
||||||
|
ALLOWED_PROD["$pkg"]=1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done < <(grep '| `' "$CONVENTIONS_FILE" 2>/dev/null || true)
|
||||||
|
|
||||||
|
ALL_ALLOWED=("${!ALLOWED_PROD[@]}" "${!ALLOWED_TEST[@]}")
|
||||||
|
|
||||||
|
if [ ${#ALL_ALLOWED[@]} -eq 0 ]; then
|
||||||
|
echo "⚠️ No approved packages found in $CONVENTIONS_FILE"
|
||||||
|
echo " (This is fine if you want stdlib-only)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Helper: check if import matches any package in an associative array (literal prefix, no glob)
|
||||||
|
matches_allowlist() {
|
||||||
|
local import="$1"
|
||||||
|
shift
|
||||||
|
local -n allowlist=$1
|
||||||
|
|
||||||
|
for allowed in "${!allowlist[@]}"; do
|
||||||
|
# Exact match
|
||||||
|
if [ "$import" = "$allowed" ]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
# Literal prefix match for subpackages: must match "pkg/" exactly
|
||||||
|
if [ "${import#"$allowed/"}" != "$import" ]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get direct module dependencies from go.mod
|
||||||
|
DIRECT_IMPORTS=$(go list -m -f '{{if and (not .Indirect) (not .Main)}}{{.Path}}{{end}}' all 2>&1) || {
|
||||||
|
echo "❌ Failed to list dependencies: $DIRECT_IMPORTS"
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
DIRECT_IMPORTS=$(echo "$DIRECT_IMPORTS" | grep -v '^$' || true)
|
||||||
|
|
||||||
|
if [ -z "$DIRECT_IMPORTS" ]; then
|
||||||
|
echo "✅ No external dependencies"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check ALL direct dependencies are in some allowlist
|
||||||
|
VIOLATIONS=""
|
||||||
|
while IFS= read -r import; do
|
||||||
|
[ -z "$import" ] && continue
|
||||||
|
|
||||||
|
if ! matches_allowlist "$import" ALLOWED_PROD && ! matches_allowlist "$import" ALLOWED_TEST; then
|
||||||
|
VIOLATIONS="${VIOLATIONS} - ${import} (not in allowlist)"$'\n'
|
||||||
|
fi
|
||||||
|
done <<< "$DIRECT_IMPORTS"
|
||||||
|
|
||||||
|
if [ -n "$VIOLATIONS" ]; then
|
||||||
|
echo "❌ UNAPPROVED DEPENDENCIES DETECTED"
|
||||||
|
echo ""
|
||||||
|
echo "The following imports are not in the allowlist:"
|
||||||
|
printf "%s" "$VIOLATIONS"
|
||||||
|
echo ""
|
||||||
|
echo "To add a dependency, update CONVENTIONS.md (requires Aaron's approval)"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Enforce Scope: test-only packages must not appear in non-test code
|
||||||
|
# Get imports used by non-test code only (go list -deps without -test excludes test deps)
|
||||||
|
PROD_IMPORTS=$(go list -deps -f '{{if not .Standard}}{{.ImportPath}}{{end}}' ./... 2>/dev/null || true)
|
||||||
|
|
||||||
|
TEST_ONLY_IN_PROD=""
|
||||||
|
for test_pkg in "${!ALLOWED_TEST[@]}"; do
|
||||||
|
# Use word-boundary matching: exact match or followed by /
|
||||||
|
if echo "$PROD_IMPORTS" | grep -qE "^${test_pkg}(/|\$|$)"; then
|
||||||
|
TEST_ONLY_IN_PROD="${TEST_ONLY_IN_PROD} - ${test_pkg} (marked 'test only' but used in production code)"$'\n'
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ -n "$TEST_ONLY_IN_PROD" ]; then
|
||||||
|
echo "❌ TEST-ONLY DEPENDENCIES IN PRODUCTION CODE"
|
||||||
|
echo ""
|
||||||
|
printf "%s" "$TEST_ONLY_IN_PROD"
|
||||||
|
echo ""
|
||||||
|
echo "These packages are marked 'test only' in CONVENTIONS.md"
|
||||||
|
echo "and must only be imported from *_test.go files."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "✅ All dependencies are approved"
|
||||||
|
echo " Direct module deps: $(echo "$DIRECT_IMPORTS" | wc -l | tr -d ' ')"
|
||||||
|
echo " Production allowlist: ${#ALLOWED_PROD[@]}, Test-only allowlist: ${#ALLOWED_TEST[@]}"
|
||||||
Reference in New Issue
Block a user