Compare commits
35 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ec03dc2373 | |||
| 1749d95727 | |||
| 7c83365fc4 | |||
| 6be5e306aa | |||
| cd6cd93bf0 | |||
| c889724dda | |||
| 1ac51669ed | |||
| 2e6f46f28d | |||
| 3fc31c0822 | |||
| 2b611dbd0b | |||
| 3abb611baf | |||
| dd003c66d5 | |||
| 019b815280 | |||
| c27dfd0f08 | |||
| 1b6c37605f | |||
| 036e96d9b7 | |||
| ea74f7e088 | |||
| e6b1840ffc | |||
| 1ca9250e4a | |||
| 1b38e6ad00 | |||
| 5498dccd60 | |||
| ecfbfddc7c | |||
| ac53ecfa5d | |||
| 090ae3848c | |||
| 23da7eedf5 | |||
| 7279cdd216 | |||
| 4c327b61d4 | |||
| 877dbf9999 | |||
| 4a1cb6b47c | |||
| deade3c5a0 | |||
| c54cee134e | |||
| 1dd73bc4df | |||
| 8f564ea4f8 | |||
| 9775cb098c | |||
| 3f06ba2ea6 |
@@ -38,6 +38,8 @@ jobs:
|
|||||||
- name: security
|
- name: security
|
||||||
token_secret: SECURITY_REVIEW_TOKEN
|
token_secret: SECURITY_REVIEW_TOKEN
|
||||||
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
|
||||||
@@ -60,8 +62,8 @@ jobs:
|
|||||||
AICORE_API_URL: ${{ secrets.AICORE_API_URL }}
|
AICORE_API_URL: ${{ secrets.AICORE_API_URL }}
|
||||||
AICORE_RESOURCE_GROUP: ${{ secrets.AICORE_RESOURCE_GROUP }}
|
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,200 @@
|
|||||||
|
# This composite action is designed for Gitea Actions runners.
|
||||||
|
# Gitea Actions supports GitHub Actions syntax including $GITHUB_OUTPUT,
|
||||||
|
# actions/cache, and actions/checkout.
|
||||||
|
# Requirements: python3, sha256sum, curl (all present on ubuntu-* runners).
|
||||||
|
name: 'AI Code Review'
|
||||||
|
description: 'Run AI-powered code review on a pull request using review-bot'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
gitea-url:
|
||||||
|
description: 'Gitea instance URL (defaults to server_url)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
repo:
|
||||||
|
description: 'Repository (owner/name, defaults to current)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
pr-number:
|
||||||
|
description: 'Pull request number (defaults to current PR)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
reviewer-token:
|
||||||
|
description: 'Gitea token for posting the review'
|
||||||
|
required: true
|
||||||
|
reviewer-name:
|
||||||
|
description: 'Display name for the reviewer'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-base-url:
|
||||||
|
description: 'OpenAI-compatible LLM API base URL (not required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-api-key:
|
||||||
|
description: 'LLM API key (not required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
llm-model:
|
||||||
|
description: 'LLM model name'
|
||||||
|
required: true
|
||||||
|
llm-provider:
|
||||||
|
description: 'LLM API provider: openai, anthropic, or aicore (default openai)'
|
||||||
|
required: false
|
||||||
|
default: 'openai'
|
||||||
|
aicore-client-id:
|
||||||
|
description: 'SAP AI Core client ID (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-client-secret:
|
||||||
|
description: 'SAP AI Core client secret (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-auth-url:
|
||||||
|
description: 'SAP AI Core authentication URL (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-api-url:
|
||||||
|
description: 'SAP AI Core API URL (required for aicore provider)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
aicore-resource-group:
|
||||||
|
description: 'SAP AI Core resource group (default: default)'
|
||||||
|
required: false
|
||||||
|
default: 'default'
|
||||||
|
conventions-file:
|
||||||
|
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
patterns-repo:
|
||||||
|
description: 'Comma-separated repos with language patterns (e.g. rodin/elixir-patterns,rodin/phoenix-conventions)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
patterns-files:
|
||||||
|
description: 'Comma-separated file paths or directories to fetch from patterns repos'
|
||||||
|
required: false
|
||||||
|
default: 'README.md'
|
||||||
|
temperature:
|
||||||
|
description: 'LLM temperature (0 = server default)'
|
||||||
|
required: false
|
||||||
|
default: '0'
|
||||||
|
timeout:
|
||||||
|
description: 'LLM request timeout in seconds (default 300)'
|
||||||
|
required: false
|
||||||
|
default: '300'
|
||||||
|
version:
|
||||||
|
description: 'review-bot version to install (e.g. v0.1.0, defaults to latest)'
|
||||||
|
required: false
|
||||||
|
default: 'latest'
|
||||||
|
dry-run:
|
||||||
|
description: 'Print review to stdout instead of posting'
|
||||||
|
required: false
|
||||||
|
default: 'false'
|
||||||
|
update-existing:
|
||||||
|
description: 'Delete previous review from same bot after posting new one. Accepts: true/1/yes or false/0/no (default true)'
|
||||||
|
required: false
|
||||||
|
default: 'true'
|
||||||
|
system-prompt-file:
|
||||||
|
description: 'Local file with additional system prompt instructions (e.g. security review focus)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
persona:
|
||||||
|
description: 'Built-in persona name (security, architect, docs)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
persona-file:
|
||||||
|
description: 'Path to custom persona JSON file'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: 'composite'
|
||||||
|
steps:
|
||||||
|
- name: Determine version
|
||||||
|
id: version
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
|
if [ "${{ inputs.version }}" = "latest" ]; then
|
||||||
|
VERSION=$(curl -sSf "${GITEA_URL}/api/v1/repos/${REPO}/releases?limit=1" \
|
||||||
|
| python3 -c "import sys, json; releases = json.load(sys.stdin); print(releases[0]['tag_name'] if releases else '')")
|
||||||
|
if [ -z "$VERSION" ]; then
|
||||||
|
echo "Failed to determine latest version" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
VERSION="${{ inputs.version }}"
|
||||||
|
fi
|
||||||
|
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Cache review-bot binary
|
||||||
|
id: cache
|
||||||
|
uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: ${{ runner.temp }}/review-bot
|
||||||
|
key: review-bot-linux-amd64-${{ steps.version.outputs.version }}
|
||||||
|
|
||||||
|
- name: Install review-bot
|
||||||
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
GITEA_URL="${{ inputs.gitea-url || github.server_url }}"
|
||||||
|
REPO="${{ inputs.repo || 'rodin/review-bot' }}"
|
||||||
|
VERSION="${{ steps.version.outputs.version }}"
|
||||||
|
BINARY="review-bot-linux-amd64"
|
||||||
|
|
||||||
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/${BINARY}" \
|
||||||
|
-o "${{ runner.temp }}/review-bot"
|
||||||
|
curl -sSfL "${GITEA_URL}/${REPO}/releases/download/${VERSION}/checksums.txt" \
|
||||||
|
-o "${{ runner.temp }}/checksums.txt"
|
||||||
|
|
||||||
|
# Verify SHA-256 checksum
|
||||||
|
cd "${{ runner.temp }}"
|
||||||
|
EXPECTED=$(grep "${BINARY}" checksums.txt | awk '{print $1}')
|
||||||
|
ACTUAL=$(sha256sum review-bot | awk '{print $1}')
|
||||||
|
|
||||||
|
if [ -z "$EXPECTED" ]; then
|
||||||
|
echo "Error: no checksum found for ${BINARY}" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ "$EXPECTED" != "$ACTUAL" ]; then
|
||||||
|
echo "Error: checksum mismatch!" >&2
|
||||||
|
echo " Expected: $EXPECTED" >&2
|
||||||
|
echo " Actual: $ACTUAL" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
chmod +x "${{ runner.temp }}/review-bot"
|
||||||
|
echo "Installed review-bot ${VERSION} (checksum verified)"
|
||||||
|
|
||||||
|
- name: Run review
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
GITHUB_SERVER_URL: ${{ inputs.gitea-url || github.server_url }}
|
||||||
|
GITHUB_REPOSITORY: ${{ inputs.repo || github.repository }}
|
||||||
|
PR_NUMBER: ${{ inputs.pr-number || github.event.pull_request.number }}
|
||||||
|
REVIEWER_TOKEN: ${{ inputs.reviewer-token }}
|
||||||
|
REVIEWER_NAME: ${{ inputs.reviewer-name }}
|
||||||
|
LLM_BASE_URL: ${{ inputs.llm-base-url }}
|
||||||
|
LLM_API_KEY: ${{ inputs.llm-api-key }}
|
||||||
|
LLM_MODEL: ${{ inputs.llm-model }}
|
||||||
|
CONVENTIONS_FILE: ${{ inputs.conventions-file }}
|
||||||
|
PATTERNS_REPO: ${{ inputs.patterns-repo }}
|
||||||
|
PATTERNS_FILES: ${{ inputs.patterns-files }}
|
||||||
|
LLM_TEMPERATURE: ${{ inputs.temperature }}
|
||||||
|
LLM_TIMEOUT: ${{ inputs.timeout }}
|
||||||
|
LLM_PROVIDER: ${{ inputs.llm-provider }}
|
||||||
|
UPDATE_EXISTING: ${{ inputs.update-existing }}
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ inputs.system-prompt-file }}
|
||||||
|
PERSONA: ${{ inputs.persona }}
|
||||||
|
PERSONA_FILE: ${{ inputs.persona-file }}
|
||||||
|
AICORE_CLIENT_ID: ${{ inputs.aicore-client-id }}
|
||||||
|
AICORE_CLIENT_SECRET: ${{ inputs.aicore-client-secret }}
|
||||||
|
AICORE_AUTH_URL: ${{ inputs.aicore-auth-url }}
|
||||||
|
AICORE_API_URL: ${{ inputs.aicore-api-url }}
|
||||||
|
AICORE_RESOURCE_GROUP: ${{ inputs.aicore-resource-group }}
|
||||||
|
run: |
|
||||||
|
ARGS=""
|
||||||
|
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
||||||
|
ARGS="--dry-run"
|
||||||
|
fi
|
||||||
|
${{ runner.temp }}/review-bot $ARGS
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
- run: go test ./...
|
||||||
|
- run: go vet ./...
|
||||||
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
|
|
||||||
|
# Self-review using native SAP AI Core provider
|
||||||
|
# Models must match SAP AI Core deployments
|
||||||
|
# Available models: gpt-5, anthropic--claude-4.6-sonnet, anthropic--claude-4.6-opus
|
||||||
|
# Removed gpt-4.1, gpt-5-mini, gpt-4.1-mini - not deployed on AI Core
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
if: github.event_name == 'pull_request'
|
||||||
|
needs: test
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: sonnet
|
||||||
|
token_secret: SONNET_REVIEW_TOKEN
|
||||||
|
model: anthropic--claude-4.6-sonnet
|
||||||
|
- name: gpt
|
||||||
|
token_secret: GPT_REVIEW_TOKEN
|
||||||
|
model: gpt-5
|
||||||
|
- name: security
|
||||||
|
token_secret: SECURITY_REVIEW_TOKEN
|
||||||
|
model: gpt-5
|
||||||
|
patterns_repo: rodin/security-patterns
|
||||||
|
patterns_files: "."
|
||||||
|
system_prompt_file: SECURITY_REVIEW.md
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
- run: go build -o review-bot ./cmd/review-bot
|
||||||
|
- name: Run ${{ matrix.name }} review
|
||||||
|
env:
|
||||||
|
GITHUB_SERVER_URL: ${{ github.server_url }}
|
||||||
|
GITHUB_REPOSITORY: ${{ github.repository }}
|
||||||
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
||||||
|
REVIEWER_NAME: ${{ matrix.name }}
|
||||||
|
LLM_PROVIDER: aicore
|
||||||
|
LLM_MODEL: ${{ matrix.model }}
|
||||||
|
AICORE_CLIENT_ID: ${{ secrets.AICORE_CLIENT_ID }}
|
||||||
|
AICORE_CLIENT_SECRET: ${{ secrets.AICORE_CLIENT_SECRET }}
|
||||||
|
AICORE_AUTH_URL: ${{ secrets.AICORE_AUTH_URL }}
|
||||||
|
AICORE_API_URL: ${{ secrets.AICORE_API_URL }}
|
||||||
|
AICORE_RESOURCE_GROUP: ${{ secrets.AICORE_RESOURCE_GROUP }}
|
||||||
|
CONVENTIONS_FILE: "CONVENTIONS.md"
|
||||||
|
PATTERNS_REPO: ${{ matrix.patterns_repo || 'rodin/go-patterns' }}
|
||||||
|
PATTERNS_FILES: ${{ matrix.patterns_files || 'README.md,patterns/' }}
|
||||||
|
LLM_TIMEOUT: "600"
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ matrix.system_prompt_file }}
|
||||||
|
run: ./review-bot
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
name: PR Ready Gate
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
clear-labels:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
# Always run - curl commands are safe if labels don't exist
|
||||||
|
steps:
|
||||||
|
- name: Remove ready and self-reviewed labels, reassign to author
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.RODIN_TOKEN }}
|
||||||
|
run: |
|
||||||
|
PR_NUMBER=${{ github.event.pull_request.number }}
|
||||||
|
AUTHOR=${{ github.event.pull_request.user.login }}
|
||||||
|
READY_LABEL_ID=38
|
||||||
|
SELF_REVIEWED_LABEL_ID=37
|
||||||
|
|
||||||
|
# Remove ready label if present
|
||||||
|
curl -sS -X DELETE \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/issues/${PR_NUMBER}/labels/${READY_LABEL_ID}" || true
|
||||||
|
|
||||||
|
# Remove self-reviewed label if present
|
||||||
|
curl -sS -X DELETE \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/issues/${PR_NUMBER}/labels/${SELF_REVIEWED_LABEL_ID}" || true
|
||||||
|
|
||||||
|
# Reassign to author
|
||||||
|
curl -sS -X PATCH \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d "{\"assignees\": [\"${AUTHOR}\"]}" \
|
||||||
|
"https://gitea.weiker.me/api/v1/repos/${{ github.repository }}/pulls/${PR_NUMBER}"
|
||||||
|
|
||||||
|
echo "Cleared ready/self-reviewed labels and reassigned PR #${PR_NUMBER} to ${AUTHOR}"
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: '1.26'
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
go vet ./...
|
||||||
|
go test ./...
|
||||||
|
|
||||||
|
- name: Build binaries
|
||||||
|
run: |
|
||||||
|
VERSION=${GITHUB_REF_NAME}
|
||||||
|
mkdir -p dist
|
||||||
|
|
||||||
|
GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-linux-amd64 ./cmd/review-bot
|
||||||
|
GOOS=linux GOARCH=arm64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-linux-arm64 ./cmd/review-bot
|
||||||
|
GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-darwin-amd64 ./cmd/review-bot
|
||||||
|
GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w -X main.version=${VERSION}" -o dist/review-bot-darwin-arm64 ./cmd/review-bot
|
||||||
|
|
||||||
|
cd dist && sha256sum * > checksums.txt
|
||||||
|
|
||||||
|
- name: Create release and upload assets
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||||
|
run: |
|
||||||
|
VERSION=${GITHUB_REF_NAME}
|
||||||
|
GITEA_URL="${{ github.server_url }}"
|
||||||
|
REPO="${{ github.repository }}"
|
||||||
|
|
||||||
|
# Create release (or find existing one for this tag)
|
||||||
|
HTTP_CODE=$(curl -s -o /tmp/release_response.json -w "%{http_code}" -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases" \
|
||||||
|
-d "{\"tag_name\": \"${VERSION}\", \"name\": \"${VERSION}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}")
|
||||||
|
|
||||||
|
if [ "$HTTP_CODE" = "409" ]; then
|
||||||
|
echo "Release for ${VERSION} already exists, fetching existing..."
|
||||||
|
curl -sSf -o /tmp/release_response.json \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/tags/${VERSION}"
|
||||||
|
elif [ "$HTTP_CODE" != "201" ]; then
|
||||||
|
echo "Failed to create release (HTTP ${HTTP_CODE})" >&2
|
||||||
|
cat /tmp/release_response.json >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Parse release ID (python3 available on ubuntu-24.04 runners)
|
||||||
|
RELEASE_ID=$(python3 -c "import json; print(json.load(open('/tmp/release_response.json'))['id'])")
|
||||||
|
|
||||||
|
if [ -z "$RELEASE_ID" ]; then
|
||||||
|
echo "Failed to parse release ID" >&2
|
||||||
|
cat /tmp/release_response.json >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Release ID: ${RELEASE_ID}"
|
||||||
|
|
||||||
|
# Upload each asset (idempotent: delete existing asset with same name first)
|
||||||
|
for file in dist/*; do
|
||||||
|
filename=$(basename "$file")
|
||||||
|
echo "Uploading ${filename}..."
|
||||||
|
|
||||||
|
# Check if asset already exists and delete it
|
||||||
|
EXISTING_ID=$(export ASSET_NAME="${filename}"; curl -sS \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets" \
|
||||||
|
| python3 -c "import json,sys,os; name=os.environ['ASSET_NAME']; assets=json.load(sys.stdin); print(next((str(a['id']) for a in assets if a['name']==name),''))" 2>/dev/null)
|
||||||
|
|
||||||
|
if [ -n "$EXISTING_ID" ]; then
|
||||||
|
echo " Asset ${filename} already exists (id=${EXISTING_ID}), deleting..."
|
||||||
|
curl -sSf -X DELETE \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets/${EXISTING_ID}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
curl -sSf -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/octet-stream" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets?name=$(printf '%s' "${filename}" | jq -sRr @uri)" \
|
||||||
|
--data-binary "@${file}"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "Release ${VERSION} created with assets"
|
||||||
@@ -329,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
|
||||||
|
|
||||||
@@ -459,41 +460,6 @@ YAML is the recommended format for personas because it supports:
|
|||||||
|
|
||||||
JSON is also supported for backwards compatibility—just use `.json` extension.
|
JSON is also supported for backwards compatibility—just use `.json` extension.
|
||||||
|
|
||||||
### Repository Personas (Auto-Discovery)
|
|
||||||
|
|
||||||
Repositories can ship their own personas in `.review-bot/personas/`. When you specify `--persona <name>`, review-bot will:
|
|
||||||
|
|
||||||
1. **Try to load from the target repo** — Checks `.review-bot/personas/<name>.yaml` (or `.yml`)
|
|
||||||
2. **Fall back to built-in** — If not found in repo, uses the built-in persona
|
|
||||||
|
|
||||||
This lets each repo define domain-specific personas without modifying CI config:
|
|
||||||
|
|
||||||
```
|
|
||||||
my-trading-repo/
|
|
||||||
├── .review-bot/
|
|
||||||
│ └── personas/
|
|
||||||
│ ├── trading.yaml # Custom trading persona
|
|
||||||
│ └── regulatory.yaml # Compliance-focused reviews
|
|
||||||
├── lib/
|
|
||||||
└── ...
|
|
||||||
```
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# CI config (no persona-file needed)
|
|
||||||
- uses: rodin/review-bot/.gitea/actions/review@v1
|
|
||||||
with:
|
|
||||||
reviewer-name: trading
|
|
||||||
persona: trading # Will find .review-bot/personas/trading.yaml
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
**Priority order:**
|
|
||||||
1. Repo's `.review-bot/personas/<name>.yaml`
|
|
||||||
2. Built-in persona with matching name
|
|
||||||
3. Error if neither exists
|
|
||||||
|
|
||||||
This allows repos to override built-in personas (e.g., a custom `security` persona that adds project-specific rules) while keeping the simple `persona: security` syntax in CI.
|
|
||||||
|
|
||||||
|
|
||||||
### Persona vs system-prompt-file
|
### Persona vs system-prompt-file
|
||||||
|
|
||||||
|
|||||||
+47
-30
@@ -15,6 +15,7 @@ import (
|
|||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
"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"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
)
|
)
|
||||||
|
|
||||||
var version = "dev"
|
var version = "dev"
|
||||||
@@ -54,8 +55,8 @@ func main() {
|
|||||||
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")
|
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", envOrDefault("GITHUB_SERVER_URL", "")), "Gitea instance URL")
|
||||||
repo := flag.String("repo", envOrDefault("GITEA_REPO", ""), "Repository (owner/name)")
|
repo := flag.String("repo", envOrDefault("GITEA_REPO", envOrDefault("GITHUB_REPOSITORY", "")), "Repository (owner/name)")
|
||||||
prNum := flag.String("pr", envOrDefault("PR_NUMBER", ""), "Pull request number")
|
prNum := flag.String("pr", envOrDefault("PR_NUMBER", ""), "Pull request number")
|
||||||
reviewerName := flag.String("reviewer-name", envOrDefault("REVIEWER_NAME", ""), "Reviewer display name")
|
reviewerName := flag.String("reviewer-name", envOrDefault("REVIEWER_NAME", ""), "Reviewer display name")
|
||||||
reviewerToken := flag.String("reviewer-token", envOrDefault("REVIEWER_TOKEN", ""), "Gitea token for posting review")
|
reviewerToken := flag.String("reviewer-token", envOrDefault("REVIEWER_TOKEN", ""), "Gitea token for posting review")
|
||||||
@@ -115,9 +116,7 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Persona loading is deferred until after giteaClient is initialized,
|
// NOTE: Persona loading deferred until after Gitea client init to support repo personas
|
||||||
// so we can try loading from the target repo first.
|
|
||||||
var persona *review.Persona
|
|
||||||
|
|
||||||
// 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 {
|
||||||
@@ -175,23 +174,22 @@ func main() {
|
|||||||
ctx, cancel := context.WithTimeout(context.Background(), overallTimeout)
|
ctx, cancel := context.WithTimeout(context.Background(), overallTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
// Load persona: try remote repo first, then fall back to built-in
|
// Load persona if specified (after Gitea client init to support repo personas)
|
||||||
|
var persona *review.Persona
|
||||||
if *personaName != "" {
|
if *personaName != "" {
|
||||||
// Try loading from target repo's .review-bot/personas/ directory
|
// Try loading from repo first, then fall back to built-in
|
||||||
fetcher := &giteaFetcher{client: giteaClient}
|
repoPersonas, err := review.LoadRepoPersonas(ctx, newGiteaClientAdapter(giteaClient), owner, repoName)
|
||||||
remotePersonas, err := review.LoadRemotePersonas(ctx, fetcher, owner, repoName)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not load remote personas", "repo", fmt.Sprintf("%s/%s", owner, repoName), "error", err)
|
slog.Warn("could not load repo personas", "repo", owner+"/"+repoName, "error", err)
|
||||||
// Assign empty map so the lookup below doesn't panic
|
// Continue with built-in personas only.
|
||||||
remotePersonas = map[string]*review.Persona{}
|
// 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 {
|
||||||
if p, ok := remotePersonas[*personaName]; ok {
|
|
||||||
persona = p
|
persona = p
|
||||||
slog.Info("loaded persona from target repo", "persona", persona.Name, "display", persona.DisplayName)
|
slog.Info("loaded repo persona", "persona", persona.Name, "display", persona.DisplayName, "repo", owner+"/"+repoName)
|
||||||
} else {
|
} else {
|
||||||
// Fall back to built-in persona
|
// Fall back to built-in
|
||||||
var err error
|
|
||||||
persona, err = review.LoadBuiltinPersona(*personaName)
|
persona, err = review.LoadBuiltinPersona(*personaName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Error("failed to load persona", "persona", *personaName, "error", err)
|
slog.Error("failed to load persona", "persona", *personaName, "error", err)
|
||||||
@@ -205,12 +203,11 @@ func main() {
|
|||||||
slog.Error("invalid persona-file path", "error", err)
|
slog.Error("invalid persona-file path", "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
loadedPersona, loadErr := review.LoadPersona(resolvedPath)
|
persona, err = review.LoadPersona(resolvedPath)
|
||||||
if loadErr != nil {
|
if err != nil {
|
||||||
slog.Error("failed to load persona file", "file", *personaFile, "error", loadErr)
|
slog.Error("failed to load persona file", "file", *personaFile, "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
persona = loadedPersona
|
|
||||||
slog.Info("loaded persona from file", "file", *personaFile, "persona", persona.Name)
|
slog.Info("loaded persona from file", "file", *personaFile, "persona", persona.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -548,6 +545,9 @@ func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patt
|
|||||||
}
|
}
|
||||||
owner, repo := parts[0], parts[1]
|
owner, repo := parts[0], parts[1]
|
||||||
|
|
||||||
|
var repoLoadedFiles []string
|
||||||
|
var repoSkippedFiles []string
|
||||||
|
|
||||||
for _, path := range paths {
|
for _, path := range paths {
|
||||||
path = strings.TrimSpace(path)
|
path = strings.TrimSpace(path)
|
||||||
if path == "" {
|
if path == "" {
|
||||||
@@ -563,11 +563,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()
|
||||||
}
|
}
|
||||||
@@ -802,20 +813,23 @@ func shouldSkipStaleReview(evaluatedSHA, currentSHA string) bool {
|
|||||||
return evaluatedSHA != currentSHA
|
return evaluatedSHA != currentSHA
|
||||||
}
|
}
|
||||||
|
|
||||||
// giteaFetcher adapts gitea.Client to review.PersonaFetcher interface.
|
// giteaClientAdapter adapts gitea.Client to vcs.FileReader interface.
|
||||||
type giteaFetcher struct {
|
type giteaClientAdapter struct {
|
||||||
client *gitea.Client
|
client *gitea.Client
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *giteaFetcher) ListContents(ctx context.Context, owner, repo, path string) ([]review.ContentEntry, error) {
|
func newGiteaClientAdapter(c *gitea.Client) *giteaClientAdapter {
|
||||||
entries, err := f.client.ListContents(ctx, owner, repo, path)
|
return &giteaClientAdapter{client: c}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *giteaClientAdapter) ListContents(ctx context.Context, owner, repo, path string) ([]vcs.ContentEntry, error) {
|
||||||
|
entries, err := a.client.ListContents(ctx, owner, repo, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
// Convert gitea.ContentEntry to review.ContentEntry
|
result := make([]vcs.ContentEntry, len(entries))
|
||||||
result := make([]review.ContentEntry, len(entries))
|
|
||||||
for i, e := range entries {
|
for i, e := range entries {
|
||||||
result[i] = review.ContentEntry{
|
result[i] = vcs.ContentEntry{
|
||||||
Name: e.Name,
|
Name: e.Name,
|
||||||
Path: e.Path,
|
Path: e.Path,
|
||||||
Type: e.Type,
|
Type: e.Type,
|
||||||
@@ -824,6 +838,9 @@ func (f *giteaFetcher) ListContents(ctx context.Context, owner, repo, path strin
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *giteaFetcher) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
func (a *giteaClientAdapter) GetFileContent(ctx context.Context, owner, repo, filePath, ref string) (string, error) {
|
||||||
return f.client.GetFileContent(ctx, owner, repo, filepath)
|
if ref != "" {
|
||||||
|
return a.client.GetFileContentRef(ctx, owner, repo, filePath, ref)
|
||||||
|
}
|
||||||
|
return a.client.GetFileContent(ctx, owner, repo, filePath)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,268 @@
|
|||||||
|
# GitHub Support for review-bot
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
AI code reviews on GitHub PRs using SAP AI Core as the LLM provider.
|
||||||
|
|
||||||
|
## Non-Goals
|
||||||
|
|
||||||
|
- Auto-detection of platform (explicit `--provider` flag is fine)
|
||||||
|
- Unifying into one abstraction layer for its own sake
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
1. **Same features on both platforms** — anything review-bot does on Gitea should work on GitHub
|
||||||
|
2. **Testable** — small interfaces, dependency injection, no global state
|
||||||
|
3. **Interface from working code** — extract from gitea/, don't invent in vacuum
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 1: Feature Inventory
|
||||||
|
|
||||||
|
What does review-bot actually do?
|
||||||
|
|
||||||
|
### Core Review Flow
|
||||||
|
|
||||||
|
| Feature | Description |
|
||||||
|
|---------|-------------|
|
||||||
|
| Get PR metadata | Title, body, head SHA, base ref |
|
||||||
|
| Get PR diff | Unified diff format |
|
||||||
|
| Get PR files | List of changed files with status |
|
||||||
|
| Get file content | Raw file at ref |
|
||||||
|
| List directory | Enumerate files in path |
|
||||||
|
| Post review | Body + inline comments + verdict |
|
||||||
|
|
||||||
|
### Review Management
|
||||||
|
|
||||||
|
| Feature | Description |
|
||||||
|
|---------|-------------|
|
||||||
|
| List reviews | Get existing reviews on PR |
|
||||||
|
| Delete review | Remove old review before re-posting |
|
||||||
|
| Get authenticated user | Who am I? |
|
||||||
|
|
||||||
|
### Platform-Specific (not in shared interface)
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub |
|
||||||
|
|---------|-------|--------|
|
||||||
|
| Resolve comment | Yes | No equivalent |
|
||||||
|
| Timeline API | Yes | No equivalent |
|
||||||
|
|
||||||
|
These stay on gitea.Client directly. Callers that need them type-assert.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 2: GitHub API Mapping
|
||||||
|
|
||||||
|
| Feature | Gitea API | GitHub API |
|
||||||
|
|---------|-----------|------------|
|
||||||
|
| Get PR | `GET /api/v1/repos/.../pulls/{n}` | `GET /repos/.../pulls/{n}` |
|
||||||
|
| Get diff | `.diff` suffix | `Accept: application/vnd.github.diff` header |
|
||||||
|
| Get files | `GET .../pulls/{n}/files` | Same |
|
||||||
|
| Get file content | `GET .../raw/{path}?ref=` | `GET .../contents/{path}?ref=` + base64 decode |
|
||||||
|
| List directory | `GET .../contents/{path}` | Same |
|
||||||
|
| Post review | `POST .../pulls/{n}/reviews` | Same (adapter handles comment schema) |
|
||||||
|
| List reviews | `GET .../pulls/{n}/reviews` | Same |
|
||||||
|
| Delete review | `DELETE .../pulls/{n}/reviews/{id}` | Same |
|
||||||
|
| Get user | `GET /api/v1/user` | `GET /user` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 3: Interface Design
|
||||||
|
|
||||||
|
**Principle:** Extract from working gitea/ code. The interface is discovered, not invented.
|
||||||
|
|
||||||
|
### Small, role-based interfaces
|
||||||
|
|
||||||
|
```go
|
||||||
|
// vcs/interfaces.go
|
||||||
|
|
||||||
|
type PRReader interface {
|
||||||
|
GetPullRequest(ctx context.Context, owner, repo string, number int) (*PullRequest, error)
|
||||||
|
GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error)
|
||||||
|
GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]ChangedFile, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type FileReader interface {
|
||||||
|
GetFileContent(ctx context.Context, owner, repo, path, ref string) (string, error)
|
||||||
|
ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type Reviewer interface {
|
||||||
|
PostReview(ctx context.Context, owner, repo string, number int, req ReviewRequest) (*Review, error)
|
||||||
|
ListReviews(ctx context.Context, owner, repo string, number int) ([]Review, error)
|
||||||
|
DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error
|
||||||
|
}
|
||||||
|
|
||||||
|
type Identity interface {
|
||||||
|
GetAuthenticatedUser(ctx context.Context) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Client combines all for callers that need everything
|
||||||
|
type Client interface {
|
||||||
|
PRReader
|
||||||
|
FileReader
|
||||||
|
Reviewer
|
||||||
|
Identity
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Types
|
||||||
|
|
||||||
|
Use what gitea/ already has. Move to vcs/types.go or re-export.
|
||||||
|
|
||||||
|
```go
|
||||||
|
type PullRequest struct { ... } // from gitea.PullRequest
|
||||||
|
type ChangedFile struct { ... } // from gitea.ChangedFile
|
||||||
|
type ContentEntry struct { ... } // from gitea.ContentEntry
|
||||||
|
type Review struct { ... } // from gitea.Review
|
||||||
|
type ReviewRequest struct { ... } // new, for PostReview input
|
||||||
|
type ReviewComment struct { ... } // from gitea.ReviewComment
|
||||||
|
```
|
||||||
|
|
||||||
|
### Adapter responsibilities
|
||||||
|
|
||||||
|
Each adapter (gitea, github) handles:
|
||||||
|
- API URL construction
|
||||||
|
- Auth header format (`token` vs `Bearer`)
|
||||||
|
- Request/response mapping
|
||||||
|
- Comment schema translation (line numbers, commit IDs, etc.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 4: Test Plan
|
||||||
|
|
||||||
|
### Unit Tests (mock HTTP)
|
||||||
|
|
||||||
|
```
|
||||||
|
github/
|
||||||
|
pr_test.go # TestGetPullRequest, TestGetDiff, TestGetFiles
|
||||||
|
files_test.go # TestGetFileContent, TestListContents
|
||||||
|
review_test.go # TestPostReview, TestListReviews, TestDeleteReview
|
||||||
|
identity_test.go # TestGetAuthenticatedUser
|
||||||
|
```
|
||||||
|
|
||||||
|
Per method: happy path, 404, 401, 429, malformed response.
|
||||||
|
|
||||||
|
### Integration Tests
|
||||||
|
|
||||||
|
Against github.com/aweiker/ai-core-review-bot:
|
||||||
|
- Fetch real PR
|
||||||
|
- Fetch real file
|
||||||
|
- Post + delete review (clean up)
|
||||||
|
|
||||||
|
### End-to-End
|
||||||
|
|
||||||
|
Open PR on test repo, run full review-bot, verify review appears.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 5: Implementation Phases
|
||||||
|
|
||||||
|
### Phase 1: Extract interfaces from gitea/
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- Create `vcs/interfaces.go` with interfaces extracted from gitea/client.go signatures
|
||||||
|
- Create `vcs/types.go` — move or alias types from gitea/
|
||||||
|
- Verify gitea.Client satisfies vcs.Client (compile-time check)
|
||||||
|
|
||||||
|
**Exit criteria:** `var _ vcs.Client = (*gitea.Client)(nil)` compiles.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 2: Gitea adapter (if needed)
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- If gitea.Client method signatures don't match exactly, create wrapper
|
||||||
|
- Keep gitea/ working exactly as before
|
||||||
|
|
||||||
|
**Exit criteria:** Existing tests pass. No behavior change.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 3: GitHub client — PRReader
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- `github/client.go` — struct, constructor, HTTP helpers
|
||||||
|
- `github/pr.go` — GetPullRequest, GetPullRequestDiff, GetPullRequestFiles
|
||||||
|
- Unit tests
|
||||||
|
|
||||||
|
**Exit criteria:** `go test ./github/...` passes for PR methods.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 4: GitHub client — FileReader
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- `github/files.go` — GetFileContent, ListContents
|
||||||
|
- Unit tests
|
||||||
|
|
||||||
|
**Exit criteria:** Unit tests pass.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 5: GitHub client — Reviewer + Identity
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- `github/review.go` — PostReview, ListReviews, DeleteReview
|
||||||
|
- `github/identity.go` — GetAuthenticatedUser
|
||||||
|
- Unit tests
|
||||||
|
|
||||||
|
**Exit criteria:** Unit tests pass.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 6: Integration tests
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- `integration/github_test.go`
|
||||||
|
- Test against real GitHub
|
||||||
|
|
||||||
|
**Exit criteria:** All integration tests pass.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 7: Wire into cmd/review-bot
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- Add `--provider github|gitea` flag (default: gitea for backward compat)
|
||||||
|
- Select client based on flag
|
||||||
|
- Update to use vcs interfaces where it makes sense
|
||||||
|
|
||||||
|
**Exit criteria:**
|
||||||
|
- `./review-bot --provider github ...` works
|
||||||
|
- `./review-bot --provider gitea ...` works (same as before)
|
||||||
|
- Existing Gitea workflows unchanged
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 8: GitHub Actions workflow + releases
|
||||||
|
|
||||||
|
**Work:**
|
||||||
|
- `.github/workflows/ci.yml` — test on PR
|
||||||
|
- `.github/workflows/release.yml` — publish binary to GitHub releases
|
||||||
|
- `.github/actions/review/action.yml` — composite action
|
||||||
|
- Action downloads binary from github.com/aweiker/ai-core-review-bot releases
|
||||||
|
|
||||||
|
**Exit criteria:**
|
||||||
|
- CI runs on github.com/aweiker/ai-core-review-bot
|
||||||
|
- Release creates downloadable binary
|
||||||
|
- Review action posts review successfully
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Part 6: Decisions
|
||||||
|
|
||||||
|
| Question | Decision |
|
||||||
|
|----------|----------|
|
||||||
|
| Auth token | Workflow `GITHUB_TOKEN` (automatic) |
|
||||||
|
| Binary distribution | GitHub releases on aweiker/ai-core-review-bot |
|
||||||
|
| Comment schema | Adapter's job — translate ReviewComment to platform format |
|
||||||
|
| Default provider | `gitea` for backward compatibility |
|
||||||
|
| Shared types | vcs/types.go (extracted from gitea/) |
|
||||||
|
| Platform-specific features | Stay on concrete client, not interface |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
8 phases. Start by extracting interfaces from working gitea/ code, not inventing them. GitHub implements the same interfaces. Each phase has clear exit criteria.
|
||||||
+227
-17
@@ -11,9 +11,11 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -39,12 +41,26 @@ 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
|
||||||
|
}
|
||||||
|
|
||||||
// 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
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewClient creates a new Gitea API client.
|
// NewClient creates a new Gitea API client.
|
||||||
@@ -56,6 +72,12 @@ func NewClient(baseURL, token string) *Client {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetHTTPClient sets the underlying HTTP client used for requests.
|
||||||
|
// This is intended for testing to inject mock transports.
|
||||||
|
func (c *Client) SetHTTPClient(hc *http.Client) {
|
||||||
|
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"`
|
||||||
@@ -210,24 +232,185 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
return &review, nil
|
return &review, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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 from a URL for safe logging.
|
||||||
|
// This prevents accidental exposure of sensitive data that future callers
|
||||||
|
// might pass via query strings.
|
||||||
|
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.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()
|
||||||
|
}
|
||||||
|
|
||||||
|
// doGet 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).
|
||||||
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, nil)
|
const maxAttempts = 3
|
||||||
if err != nil {
|
// backoff[i] is the delay before attempt i+1 (i.e., after attempt i fails).
|
||||||
return nil, err
|
// 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}
|
||||||
}
|
}
|
||||||
req.Header.Set("Authorization", "token "+c.token)
|
|
||||||
|
|
||||||
resp, err := c.http.Do(req)
|
// maxErrorBodyBytes limits how much of an error response body we read
|
||||||
if err != nil {
|
// to protect against malicious servers sending unbounded data.
|
||||||
return nil, err
|
const maxErrorBodyBytes = 64 * 1024 // 64 KB
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
var lastErr error
|
||||||
body, _ := io.ReadAll(resp.Body)
|
for attempt := 0; attempt < maxAttempts; attempt++ {
|
||||||
return nil, &APIError{StatusCode: resp.StatusCode, Body: string(body)}
|
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)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "token "+c.token)
|
||||||
|
|
||||||
|
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 {
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
resp.Body.Close()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return body, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error path: limit how much we read from potentially malicious server
|
||||||
|
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 io.ReadAll(resp.Body)
|
|
||||||
|
return nil, lastErr
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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 +434,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,7 +453,16 @@ 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 {
|
||||||
return nil, fmt.Errorf("parse contents JSON: %w", err)
|
// 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)
|
||||||
|
}
|
||||||
|
// 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
|
||||||
}
|
}
|
||||||
@@ -317,9 +515,9 @@ func (c *Client) GetAllFilesInPath(ctx context.Context, owner, repo, path string
|
|||||||
|
|
||||||
// Review represents a pull request review from the Gitea API.
|
// Review represents a pull request review from the Gitea API.
|
||||||
type Review struct {
|
type Review struct {
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
User struct {
|
User struct {
|
||||||
Login string `json:"login"`
|
Login string `json:"login"`
|
||||||
} `json:"user"`
|
} `json:"user"`
|
||||||
State string `json:"state"`
|
State string `json:"state"`
|
||||||
@@ -633,3 +831,15 @@ func (c *Client) ResolveComment(ctx context.Context, owner, repo string, comment
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DismissReview dismisses a review on a pull request.
|
||||||
|
// This is a stub for the vcs.Reviewer interface; full implementation is Phase 2.
|
||||||
|
func (c *Client) DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, message string) error {
|
||||||
|
return fmt.Errorf("dismiss review %d on %s/%s#%d: %w", reviewID, owner, repo, number, errors.ErrUnsupported)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileContentAtRef fetches a file at a specific ref from a repo.
|
||||||
|
// This delegates to GetFileContentRef for the Gitea implementation.
|
||||||
|
func (c *Client) GetFileContentAtRef(ctx context.Context, owner, repo, path, ref string) (string, error) {
|
||||||
|
return c.GetFileContentRef(ctx, owner, repo, path, ref)
|
||||||
|
}
|
||||||
|
|||||||
+406
-5
@@ -6,10 +6,14 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestGetPullRequest(t *testing.T) {
|
func TestGetPullRequest(t *testing.T) {
|
||||||
@@ -276,11 +280,64 @@ func TestListContents(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestListContents_DotPath(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// "." should be normalized to empty path, which hits the root contents endpoint
|
||||||
|
if r.URL.Path != "/api/v1/repos/owner/repo/contents" {
|
||||||
|
t.Errorf("expected root contents path, got: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
fmt.Fprintf(w, `[{"name":"README.md","path":"README.md","type":"file"}]`)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
entries, err := client.ListContents(context.Background(), "owner", "repo", ".")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(entries) != 1 {
|
||||||
|
t.Fatalf("expected 1 entry, got %d", len(entries))
|
||||||
|
}
|
||||||
|
if entries[0].Name != "README.md" {
|
||||||
|
t.Errorf("expected README.md, got %s", entries[0].Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListContents_FilePath(t *testing.T) {
|
||||||
|
// Gitea returns a single object (not an array) when path is a file
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path != "/api/v1/repos/owner/repo/contents/README.md" {
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
// Single object, not an array
|
||||||
|
fmt.Fprintf(w, `{"name":"README.md","path":"README.md","type":"file"}`)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
entries, err := client.ListContents(context.Background(), "owner", "repo", "README.md")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(entries) != 1 {
|
||||||
|
t.Fatalf("expected 1 entry, got %d", len(entries))
|
||||||
|
}
|
||||||
|
if entries[0].Name != "README.md" {
|
||||||
|
t.Errorf("expected README.md, got %s", entries[0].Name)
|
||||||
|
}
|
||||||
|
if entries[0].Type != "file" {
|
||||||
|
t.Errorf("expected type file, got %s", entries[0].Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestGetAllFilesInPath_File(t *testing.T) {
|
func TestGetAllFilesInPath_File(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 == "/api/v1/repos/owner/repo/contents/README.md" {
|
if r.URL.Path == "/api/v1/repos/owner/repo/contents/README.md" {
|
||||||
// Gitea returns 404 for contents API on files (it's not a dir)
|
// Gitea returns a single object (not array) when path is a file
|
||||||
http.NotFound(w, r)
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
fmt.Fprintf(w, `{"name":"README.md","path":"README.md","type":"file"}`)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if r.URL.Path == "/api/v1/repos/owner/repo/raw/README.md" {
|
if r.URL.Path == "/api/v1/repos/owner/repo/raw/README.md" {
|
||||||
@@ -584,9 +641,9 @@ func TestGetAllFilesInPath_403Propagates(t *testing.T) {
|
|||||||
|
|
||||||
func TestIsNotFound(t *testing.T) {
|
func TestIsNotFound(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
err error
|
err error
|
||||||
want bool
|
want bool
|
||||||
}{
|
}{
|
||||||
{"nil error", nil, false},
|
{"nil error", nil, false},
|
||||||
{"non-API error", fmt.Errorf("network timeout"), false},
|
{"non-API error", fmt.Errorf("network timeout"), false},
|
||||||
@@ -743,3 +800,347 @@ func TestResolveComment_Error(t *testing.T) {
|
|||||||
t.Fatal("expected error for 404 response")
|
t.Fatal("expected error for 404 response")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestIsServerError(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
err error
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"nil error", nil, false},
|
||||||
|
{"non-API error", fmt.Errorf("network timeout"), false},
|
||||||
|
{"404 APIError", &APIError{StatusCode: 404, Body: "not found"}, false},
|
||||||
|
{"500 APIError", &APIError{StatusCode: 500, Body: "server error"}, true},
|
||||||
|
{"502 APIError", &APIError{StatusCode: 502, Body: "bad gateway"}, true},
|
||||||
|
{"503 APIError", &APIError{StatusCode: 503, Body: "unavailable"}, true},
|
||||||
|
{"599 APIError", &APIError{StatusCode: 599, Body: "edge case"}, true},
|
||||||
|
{"600 not server error", &APIError{StatusCode: 600, Body: "edge"}, false},
|
||||||
|
{"400 not server error", &APIError{StatusCode: 400, Body: "bad request"}, false},
|
||||||
|
{"wrapped 500", fmt.Errorf("fetch: %w", &APIError{StatusCode: 500, Body: "err"}), true},
|
||||||
|
{"wrapped 404", fmt.Errorf("fetch: %w", &APIError{StatusCode: 404, Body: "err"}), false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := IsServerError(tt.err)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("IsServerError(%v) = %v, want %v", tt.err, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDoGet_RetriesOn500(t *testing.T) {
|
||||||
|
attempts := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
attempts++
|
||||||
|
if attempts < 3 {
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
w.Write([]byte(`{"message":"transient error"}`))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.Write([]byte(`{"data":"success"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
// Use short backoff for fast tests
|
||||||
|
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
||||||
|
|
||||||
|
body, err := client.doGet(context.Background(), server.URL+"/test")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expected success after retry, got error: %v", err)
|
||||||
|
}
|
||||||
|
if string(body) != `{"data":"success"}` {
|
||||||
|
t.Errorf("body = %q, want %q", string(body), `{"data":"success"}`)
|
||||||
|
}
|
||||||
|
if attempts != 3 {
|
||||||
|
t.Errorf("attempts = %d, want 3", attempts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDoGet_FailsAfterMaxRetries(t *testing.T) {
|
||||||
|
attempts := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
attempts++
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
w.Write([]byte(`{"message":"persistent error"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
// Use short backoff for fast tests
|
||||||
|
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
||||||
|
|
||||||
|
_, err := client.doGet(context.Background(), server.URL+"/test")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error after max retries")
|
||||||
|
}
|
||||||
|
var apiErr *APIError
|
||||||
|
if !errors.As(err, &apiErr) {
|
||||||
|
t.Fatalf("expected APIError, got: %v", err)
|
||||||
|
}
|
||||||
|
if apiErr.StatusCode != http.StatusInternalServerError {
|
||||||
|
t.Errorf("status = %d, want 500", apiErr.StatusCode)
|
||||||
|
}
|
||||||
|
if attempts != 3 {
|
||||||
|
t.Errorf("attempts = %d, want 3 (max retries)", attempts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDoGet_NoRetryOn4xx(t *testing.T) {
|
||||||
|
attempts := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
attempts++
|
||||||
|
w.WriteHeader(http.StatusForbidden)
|
||||||
|
w.Write([]byte(`{"message":"forbidden"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
_, err := client.doGet(context.Background(), server.URL+"/test")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 403")
|
||||||
|
}
|
||||||
|
var apiErr *APIError
|
||||||
|
if !errors.As(err, &apiErr) {
|
||||||
|
t.Fatalf("expected APIError, got: %v", err)
|
||||||
|
}
|
||||||
|
if apiErr.StatusCode != http.StatusForbidden {
|
||||||
|
t.Errorf("status = %d, want 403", apiErr.StatusCode)
|
||||||
|
}
|
||||||
|
if attempts != 1 {
|
||||||
|
t.Errorf("attempts = %d, want 1 (no retry on 4xx)", attempts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDoGet_RespectsContextCancellation(t *testing.T) {
|
||||||
|
attempts := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
attempts++
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
w.Write([]byte(`{"message":"error"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
// Use longer backoff to give us time to cancel during the wait
|
||||||
|
client.RetryBackoff = []time.Duration{100 * time.Millisecond, 100 * time.Millisecond}
|
||||||
|
|
||||||
|
// Cancel after first attempt returns and retry begins
|
||||||
|
go func() {
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
cancel()
|
||||||
|
}()
|
||||||
|
|
||||||
|
_, err := client.doGet(ctx, server.URL+"/test")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error on context cancellation")
|
||||||
|
}
|
||||||
|
// Should have made 1 attempt, then context cancelled during backoff
|
||||||
|
if attempts != 1 {
|
||||||
|
t.Errorf("attempts = %d, expected 1 before context cancel during backoff", attempts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// mockTransport is a test helper that returns errors for the first N calls,
|
||||||
|
// then delegates to a real server.
|
||||||
|
type mockTransport struct {
|
||||||
|
failCount int32 // number of failures remaining (atomic)
|
||||||
|
failErr error // error to return on failure
|
||||||
|
realServer *httptest.Server
|
||||||
|
attemptsMade atomic.Int32 // tracks total attempts
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
|
m.attemptsMade.Add(1)
|
||||||
|
remaining := atomic.AddInt32(&m.failCount, -1)
|
||||||
|
if remaining >= 0 {
|
||||||
|
// Still have failures to return
|
||||||
|
return nil, m.failErr
|
||||||
|
}
|
||||||
|
// Redirect to real server
|
||||||
|
req.URL.Host = m.realServer.Listener.Addr().String()
|
||||||
|
req.URL.Scheme = "http"
|
||||||
|
return http.DefaultTransport.RoundTrip(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDoGet_RetriesOnTemporaryNetError(t *testing.T) {
|
||||||
|
// Real server that will handle successful requests
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
w.Write([]byte(`{"status":"ok"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
// Mock transport: fail twice with ECONNREFUSED, then succeed
|
||||||
|
mt := &mockTransport{
|
||||||
|
failCount: 2,
|
||||||
|
failErr: &net.OpError{Op: "dial", Net: "tcp", Err: syscall.ECONNREFUSED},
|
||||||
|
realServer: server,
|
||||||
|
}
|
||||||
|
|
||||||
|
client := NewClient("http://fake-host/", "test-token")
|
||||||
|
client.SetHTTPClient(&http.Client{Transport: mt})
|
||||||
|
client.RetryBackoff = []time.Duration{1 * time.Millisecond, 1 * time.Millisecond}
|
||||||
|
|
||||||
|
body, err := client.doGet(context.Background(), "http://fake-host/test")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("expected success after retries, got error: %v", err)
|
||||||
|
}
|
||||||
|
if string(body) != `{"status":"ok"}` {
|
||||||
|
t.Errorf("body = %q, want %q", string(body), `{"status":"ok"}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should have made exactly 3 attempts: 2 failures + 1 success
|
||||||
|
if got := mt.attemptsMade.Load(); got != 3 {
|
||||||
|
t.Errorf("attempts = %d, want 3 (2 failures + 1 success)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsTemporaryNetError(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
err error
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"nil error", nil, false},
|
||||||
|
{"plain error", fmt.Errorf("some error"), false},
|
||||||
|
// OpError with retriable syscall errors
|
||||||
|
{"OpError ECONNREFUSED", &net.OpError{Op: "dial", Err: syscall.ECONNREFUSED}, true},
|
||||||
|
{"OpError ECONNRESET", &net.OpError{Op: "read", Err: syscall.ECONNRESET}, true},
|
||||||
|
{"OpError ENETUNREACH", &net.OpError{Op: "dial", Err: syscall.ENETUNREACH}, true},
|
||||||
|
{"OpError EHOSTUNREACH", &net.OpError{Op: "dial", Err: syscall.EHOSTUNREACH}, true},
|
||||||
|
{"OpError ETIMEDOUT", &net.OpError{Op: "dial", Err: syscall.ETIMEDOUT}, true},
|
||||||
|
// OpError with permanent syscall errors — should NOT retry
|
||||||
|
{"OpError EACCES", &net.OpError{Op: "dial", Err: syscall.EACCES}, false},
|
||||||
|
{"OpError EPERM", &net.OpError{Op: "dial", Err: syscall.EPERM}, false},
|
||||||
|
// OpError with unknown inner error — conservative retry
|
||||||
|
{"OpError unknown inner", &net.OpError{Op: "dial", Err: fmt.Errorf("unknown")}, true},
|
||||||
|
// DNS errors
|
||||||
|
{"DNS timeout", &net.DNSError{IsTimeout: true}, true},
|
||||||
|
{"DNS no such host", &net.DNSError{IsTimeout: false, Name: "bad.host"}, false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := isTemporaryNetError(tt.err)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("isTemporaryNetError(%v) = %v, want %v", tt.err, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsRetriableSyscallError(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
err error
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"nil", nil, false},
|
||||||
|
{"ECONNREFUSED", syscall.ECONNREFUSED, true},
|
||||||
|
{"ECONNRESET", syscall.ECONNRESET, true},
|
||||||
|
{"ENETUNREACH", syscall.ENETUNREACH, true},
|
||||||
|
{"EHOSTUNREACH", syscall.EHOSTUNREACH, true},
|
||||||
|
{"ETIMEDOUT", syscall.ETIMEDOUT, true},
|
||||||
|
{"EACCES (permanent)", syscall.EACCES, false},
|
||||||
|
{"EPERM (permanent)", syscall.EPERM, false},
|
||||||
|
{"ENOENT (permanent)", syscall.ENOENT, false},
|
||||||
|
{"unknown error", fmt.Errorf("something"), true}, // conservative retry
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := isRetriableSyscallError(tt.err)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("isRetriableSyscallError(%v) = %v, want %v", tt.err, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRedactURL(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "no query params",
|
||||||
|
input: "https://gitea.example.com/api/v1/repos/owner/repo/pulls/1",
|
||||||
|
want: "https://gitea.example.com/api/v1/repos/owner/repo/pulls/1",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "with query params - redacts",
|
||||||
|
input: "https://gitea.example.com/api/v1/repos/owner/repo/raw/file?ref=main",
|
||||||
|
want: "https://gitea.example.com/api/v1/repos/owner/repo/raw/file?[redacted]",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "multiple query params",
|
||||||
|
input: "https://example.com/path?token=secret&page=1",
|
||||||
|
want: "https://example.com/path?[redacted]",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid URL",
|
||||||
|
input: "://invalid",
|
||||||
|
want: "[invalid URL]",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "empty string",
|
||||||
|
input: "",
|
||||||
|
want: "",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := redactURL(tt.input)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("redactURL(%q) = %q, want %q", tt.input, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSanitizeErrorForLog(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
err error
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "nil error",
|
||||||
|
err: nil,
|
||||||
|
want: "<nil>",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "APIError omits body",
|
||||||
|
err: &APIError{StatusCode: 500, Body: "internal error: database connection failed"},
|
||||||
|
want: "HTTP 500",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "APIError with large body still only shows status",
|
||||||
|
err: &APIError{StatusCode: 502, Body: strings.Repeat("x", 1000)},
|
||||||
|
want: "HTTP 502",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non-API error preserved",
|
||||||
|
err: fmt.Errorf("connection refused"),
|
||||||
|
want: "connection refused",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "wrapped APIError",
|
||||||
|
err: fmt.Errorf("request failed: %w", &APIError{StatusCode: 503, Body: "service unavailable"}),
|
||||||
|
want: "HTTP 503",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := sanitizeErrorForLog(tt.err)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("sanitizeErrorForLog() = %q, want %q", got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
//go:build phase2
|
||||||
|
|
||||||
|
package gitea_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compile-time interface conformance assertions.
|
||||||
|
// These will verify gitea.Client satisfies vcs interfaces once the Phase 2
|
||||||
|
// adapter bridges the method signature gaps:
|
||||||
|
//
|
||||||
|
// - PRReader: GetPullRequest returns *gitea.PullRequest (needs *vcs.PullRequest)
|
||||||
|
// - PRReader: GetPullRequestFiles returns []gitea.ChangedFile (needs []vcs.ChangedFile)
|
||||||
|
// - FileReader: GetFileContent lacks ref parameter
|
||||||
|
// - Reviewer: PostReview uses (event, body, comments) instead of vcs.ReviewRequest
|
||||||
|
//
|
||||||
|
// Remove the phase2 build tag once the adapter is complete.
|
||||||
|
var (
|
||||||
|
_ vcs.PRReader = (*gitea.Client)(nil)
|
||||||
|
_ vcs.FileReader = (*gitea.Client)(nil)
|
||||||
|
_ vcs.Reviewer = (*gitea.Client)(nil)
|
||||||
|
_ vcs.Identity = (*gitea.Client)(nil)
|
||||||
|
)
|
||||||
+5
-27
@@ -2,7 +2,6 @@ package review
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"regexp"
|
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -23,29 +22,10 @@ func GiteaEvent(verdict string) string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// markdownSpecialChars matches characters that have special meaning in Markdown.
|
|
||||||
// We escape these to prevent untrusted input from breaking formatting.
|
|
||||||
// Uses a quoted string since raw strings can't contain backticks.
|
|
||||||
var markdownSpecialChars = regexp.MustCompile("([\\\\*_`\\[\\]()#<>|~])")
|
|
||||||
|
|
||||||
// sanitizeMarkdownText escapes special Markdown characters in untrusted text.
|
|
||||||
// This prevents markdown injection attacks where a malicious display name could
|
|
||||||
// break formatting, inject links, or create unexpected rendering.
|
|
||||||
func sanitizeMarkdownText(s string) string {
|
|
||||||
// First, remove any control characters and null bytes
|
|
||||||
cleaned := strings.Map(func(r rune) rune {
|
|
||||||
if r < 32 && r != '\t' && r != '\n' {
|
|
||||||
return -1 // drop the character
|
|
||||||
}
|
|
||||||
return r
|
|
||||||
}, s)
|
|
||||||
// Escape special Markdown characters by prepending backslash
|
|
||||||
return markdownSpecialChars.ReplaceAllString(cleaned, `\$1`)
|
|
||||||
}
|
|
||||||
|
|
||||||
// FormatMarkdownWithDisplay formats a ReviewResult with separate display name and sentinel name.
|
// FormatMarkdownWithDisplay formats a ReviewResult with separate display name and sentinel name.
|
||||||
// displayName is sanitized to prevent Markdown injection from untrusted remote persona metadata.
|
// Note: displayName is not HTML-escaped as Gitea sanitizes rendered Markdown.
|
||||||
// sentinelName is used for the cleanup sentinel comment (machine-readable, not rendered).
|
// 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.
|
// If displayName is empty, sentinelName is used for both.
|
||||||
func FormatMarkdownWithDisplay(result *ReviewResult, displayName, sentinelName string) string {
|
func FormatMarkdownWithDisplay(result *ReviewResult, displayName, sentinelName string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
@@ -57,8 +37,7 @@ func FormatMarkdownWithDisplay(result *ReviewResult, displayName, sentinelName s
|
|||||||
}
|
}
|
||||||
|
|
||||||
if headerName != "" {
|
if headerName != "" {
|
||||||
// Sanitize the header name to prevent Markdown injection
|
title := CapitalizeFirst(headerName)
|
||||||
title := CapitalizeFirst(sanitizeMarkdownText(headerName))
|
|
||||||
sb.WriteString(fmt.Sprintf("# %s Review\n\n", title))
|
sb.WriteString(fmt.Sprintf("# %s Review\n\n", title))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -82,8 +61,7 @@ func FormatMarkdownWithDisplay(result *ReviewResult, displayName, sentinelName s
|
|||||||
sb.WriteString(fmt.Sprintf("**%s** — %s\n", result.Verdict, result.Recommendation))
|
sb.WriteString(fmt.Sprintf("**%s** — %s\n", result.Verdict, result.Recommendation))
|
||||||
|
|
||||||
if sentinelName != "" {
|
if sentinelName != "" {
|
||||||
// Sanitize headerName for the footer as well
|
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", headerName))
|
||||||
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", sanitizeMarkdownText(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", sentinelName))
|
sb.WriteString(fmt.Sprintf("\n<!-- review-bot:%s -->\n", sentinelName))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -214,71 +214,3 @@ func TestFormatMarkdownWithDisplay(t *testing.T) {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSanitizeMarkdownText(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
input string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "plain text unchanged",
|
|
||||||
input: "Security Specialist",
|
|
||||||
want: "Security Specialist",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes asterisks",
|
|
||||||
input: "**bold** attack",
|
|
||||||
want: `\*\*bold\*\* attack`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes brackets for links",
|
|
||||||
input: "[click me](http://evil.com)",
|
|
||||||
want: `\[click me\]\(http://evil.com\)`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes backticks",
|
|
||||||
input: "`code` injection",
|
|
||||||
want: "\\`code\\` injection",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes angle brackets",
|
|
||||||
input: "<script>alert(1)</script>",
|
|
||||||
want: `\<script\>alert\(1\)\</script\>`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes hash for headers",
|
|
||||||
input: "# Fake Header",
|
|
||||||
want: `\# Fake Header`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes pipe for tables",
|
|
||||||
input: "col1 | col2",
|
|
||||||
want: `col1 \| col2`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "removes control characters",
|
|
||||||
input: "hello\x00world\x1f",
|
|
||||||
want: "helloworld",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "preserves tabs and newlines",
|
|
||||||
input: "line1\n\tindented",
|
|
||||||
want: "line1\n\tindented",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escapes tilde for strikethrough",
|
|
||||||
input: "~~strikethrough~~",
|
|
||||||
want: `\~\~strikethrough\~\~`,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
got := sanitizeMarkdownText(tt.input)
|
|
||||||
if got != tt.want {
|
|
||||||
t.Errorf("sanitizeMarkdownText(%q) = %q, want %q", tt.input, got, tt.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -224,6 +224,13 @@ func checkYAMLDepth(node *yaml.Node, depth, maxDepth, maxNodes int, seen map[*ya
|
|||||||
return nil
|
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.
|
||||||
|
func ParsePersonaBytes(data []byte, source string) (*Persona, error) {
|
||||||
|
return parsePersona(data, source)
|
||||||
|
}
|
||||||
|
|
||||||
func validatePersona(p *Persona, source string) error {
|
func validatePersona(p *Persona, source string) error {
|
||||||
if p.Name == "" {
|
if p.Name == "" {
|
||||||
return fmt.Errorf("persona %s: name is required", source)
|
return fmt.Errorf("persona %s: name is required", source)
|
||||||
|
|||||||
@@ -1,171 +0,0 @@
|
|||||||
package review
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// PersonaFetcher abstracts fetching files from a remote repository.
|
|
||||||
// This allows persona loading to work with any Git host API.
|
|
||||||
type PersonaFetcher interface {
|
|
||||||
// ListContents returns file/directory entries at a path.
|
|
||||||
// Returns an error if the path doesn't exist or isn't accessible.
|
|
||||||
ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error)
|
|
||||||
|
|
||||||
// GetFileContent returns the raw content of a file from the default branch.
|
|
||||||
GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContentEntry represents a file or directory entry.
|
|
||||||
type ContentEntry struct {
|
|
||||||
Name string // filename or directory name
|
|
||||||
Path string // full path from repo root
|
|
||||||
Type string // "file" or "dir"
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultPersonasPath is the conventional location for repo-specific personas.
|
|
||||||
const DefaultPersonasPath = ".review-bot/personas"
|
|
||||||
|
|
||||||
// LoadRemotePersonas fetches personas from a remote repository's .review-bot/personas/ directory.
|
|
||||||
// Returns a map of persona name to Persona. If the directory doesn't exist or is empty,
|
|
||||||
// returns an empty map with no error (graceful fallback to built-in personas).
|
|
||||||
//
|
|
||||||
// Files larger than MaxPersonaFileSize are logged and skipped.
|
|
||||||
// Invalid YAML files are logged and skipped (partial success model).
|
|
||||||
// Only .yaml and .yml files are processed; other files are ignored.
|
|
||||||
func LoadRemotePersonas(ctx context.Context, fetcher PersonaFetcher, owner, repo string) (map[string]*Persona, error) {
|
|
||||||
return LoadRemotePersonasFromPath(ctx, fetcher, owner, repo, DefaultPersonasPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadRemotePersonasFromPath loads personas from a custom path in a remote repository.
|
|
||||||
// It behaves the same as LoadRemotePersonas but allows specifying a path other than
|
|
||||||
// the default .review-bot/personas directory.
|
|
||||||
func LoadRemotePersonasFromPath(ctx context.Context, fetcher PersonaFetcher, owner, repo, path string) (map[string]*Persona, error) {
|
|
||||||
entries, err := fetcher.ListContents(ctx, owner, repo, path)
|
|
||||||
if err != nil {
|
|
||||||
// 404 is expected when repo doesn't have personas — return empty, not error
|
|
||||||
if isNotFoundError(err) {
|
|
||||||
slog.Debug("no remote personas directory found", "repo", fmt.Sprintf("%s/%s", owner, repo), "path", path)
|
|
||||||
return map[string]*Persona{}, nil
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("list remote personas: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cap the number of files to process to prevent resource exhaustion
|
|
||||||
// from repos with thousands of small files.
|
|
||||||
const maxPersonaFiles = 50
|
|
||||||
|
|
||||||
result := make(map[string]*Persona)
|
|
||||||
processed := 0
|
|
||||||
for _, entry := range entries {
|
|
||||||
if processed >= maxPersonaFiles {
|
|
||||||
slog.Warn("persona file limit reached", "limit", maxPersonaFiles, "repo", fmt.Sprintf("%s/%s", owner, repo))
|
|
||||||
break
|
|
||||||
}
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
return nil, ctx.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Skip directories and non-YAML files
|
|
||||||
if entry.Type != "file" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !isYAMLFile(entry.Name) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
content, err := fetcher.GetFileContent(ctx, owner, repo, entry.Path)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not fetch remote persona file", "file", entry.Path, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check size before parsing (defense in depth)
|
|
||||||
if len(content) > MaxPersonaFileSize {
|
|
||||||
slog.Warn("remote persona file exceeds size limit", "file", entry.Path, "size", len(content), "limit", MaxPersonaFileSize)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// YAML parsing uses parsePersona which has defenses against YAML DoS attacks:
|
|
||||||
// - MaxPersonaFileSize (above) caps raw input size before any parsing
|
|
||||||
// - maxPersonaFiles (above) limits the number of files processed per repo
|
|
||||||
// - unmarshalYAMLWithDepthLimit enforces MaxYAMLDepth to prevent stack exhaustion
|
|
||||||
// - checkYAMLDepth tracks node counts (MaxYAMLNodes) against "billion laughs" expansion
|
|
||||||
// - Alias cycles are detected and capped by seen-node tracking
|
|
||||||
// See persona.go for the implementation details.
|
|
||||||
persona, err := parsePersona([]byte(content), entry.Path)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not parse remote persona file", "file", entry.Path, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
result[persona.Name] = persona
|
|
||||||
processed++
|
|
||||||
slog.Debug("loaded remote persona", "name", persona.Name, "file", entry.Path)
|
|
||||||
}
|
|
||||||
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// MergePersonas combines remote and built-in personas.
|
|
||||||
// Remote personas take precedence on name collision.
|
|
||||||
// Returns the merged map and a list of persona names in sorted order.
|
|
||||||
func MergePersonas(remote, builtin map[string]*Persona) (map[string]*Persona, []string) {
|
|
||||||
merged := make(map[string]*Persona)
|
|
||||||
|
|
||||||
// Add built-in first
|
|
||||||
for name, p := range builtin {
|
|
||||||
merged[name] = p
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remote overrides built-in on collision
|
|
||||||
for name, p := range remote {
|
|
||||||
if _, exists := merged[name]; exists {
|
|
||||||
slog.Debug("remote persona overrides built-in", "name", name)
|
|
||||||
}
|
|
||||||
merged[name] = p
|
|
||||||
}
|
|
||||||
|
|
||||||
// Collect sorted names
|
|
||||||
names := make([]string, 0, len(merged))
|
|
||||||
for name := range merged {
|
|
||||||
names = append(names, name)
|
|
||||||
}
|
|
||||||
sort.Strings(names)
|
|
||||||
|
|
||||||
return merged, names
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadAllBuiltinPersonas loads all built-in personas into a map.
|
|
||||||
func LoadAllBuiltinPersonas() 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 returns true if the 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 indicates a 404 response.
|
|
||||||
// This is a simple string check to avoid importing the gitea package
|
|
||||||
// (which would create a circular dependency).
|
|
||||||
func isNotFoundError(err error) bool {
|
|
||||||
if err == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
errStr := err.Error()
|
|
||||||
return strings.Contains(errStr, "HTTP 404")
|
|
||||||
}
|
|
||||||
@@ -1,394 +0,0 @@
|
|||||||
package review
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// mockFetcher implements PersonaFetcher for testing.
|
|
||||||
type mockFetcher struct {
|
|
||||||
contents map[string][]ContentEntry // path -> entries
|
|
||||||
files map[string]string // path -> content
|
|
||||||
listErr error // error to return from ListContents
|
|
||||||
getFileErr map[string]error // path -> error for GetFileContent
|
|
||||||
listNotFound bool // return 404-style error
|
|
||||||
}
|
|
||||||
|
|
||||||
func newMockFetcher() *mockFetcher {
|
|
||||||
return &mockFetcher{
|
|
||||||
contents: make(map[string][]ContentEntry),
|
|
||||||
files: make(map[string]string),
|
|
||||||
getFileErr: make(map[string]error),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *mockFetcher) ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error) {
|
|
||||||
if m.listNotFound {
|
|
||||||
return nil, errors.New("HTTP 404: not found")
|
|
||||||
}
|
|
||||||
if m.listErr != nil {
|
|
||||||
return nil, m.listErr
|
|
||||||
}
|
|
||||||
entries, ok := m.contents[path]
|
|
||||||
if !ok {
|
|
||||||
return nil, errors.New("HTTP 404: not found")
|
|
||||||
}
|
|
||||||
return entries, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *mockFetcher) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
|
||||||
if err, ok := m.getFileErr[filepath]; ok {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
content, ok := m.files[filepath]
|
|
||||||
if !ok {
|
|
||||||
return "", errors.New("HTTP 404: file not found")
|
|
||||||
}
|
|
||||||
return content, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_NoDirectory(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.listNotFound = true
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error for missing directory, got: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 0 {
|
|
||||||
t.Errorf("expected empty map, got %d personas", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_EmptyDirectory(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{}
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 0 {
|
|
||||||
t.Errorf("expected empty map, got %d personas", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SinglePersona(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "trading.yaml", Path: ".review-bot/personas/trading.yaml", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/trading.yaml"] = `
|
|
||||||
name: trading
|
|
||||||
display_name: Trading Expert
|
|
||||||
identity: You are a trading systems expert.
|
|
||||||
focus:
|
|
||||||
- order execution
|
|
||||||
- market data
|
|
||||||
`
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona, got %d", len(result))
|
|
||||||
}
|
|
||||||
if result["trading"] == nil {
|
|
||||||
t.Fatal("expected 'trading' persona")
|
|
||||||
}
|
|
||||||
if result["trading"].DisplayName != "Trading Expert" {
|
|
||||||
t.Errorf("expected display name 'Trading Expert', got %q", result["trading"].DisplayName)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_MultiplePersonas(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "one.yaml", Path: ".review-bot/personas/one.yaml", Type: "file"},
|
|
||||||
{Name: "two.yml", Path: ".review-bot/personas/two.yml", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/one.yaml"] = `
|
|
||||||
name: one
|
|
||||||
identity: First persona.
|
|
||||||
`
|
|
||||||
fetcher.files[".review-bot/personas/two.yml"] = `
|
|
||||||
name: two
|
|
||||||
identity: Second persona.
|
|
||||||
`
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 2 {
|
|
||||||
t.Fatalf("expected 2 personas, got %d", len(result))
|
|
||||||
}
|
|
||||||
if result["one"] == nil || result["two"] == nil {
|
|
||||||
t.Error("expected both personas to be loaded")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SkipsNonYAML(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "valid.yaml", Path: ".review-bot/personas/valid.yaml", Type: "file"},
|
|
||||||
{Name: "readme.md", Path: ".review-bot/personas/readme.md", Type: "file"},
|
|
||||||
{Name: "config.json", Path: ".review-bot/personas/config.json", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/valid.yaml"] = `
|
|
||||||
name: valid
|
|
||||||
identity: Valid persona.
|
|
||||||
`
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona (skipping non-YAML), got %d", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SkipsDirectories(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "valid.yaml", Path: ".review-bot/personas/valid.yaml", Type: "file"},
|
|
||||||
{Name: "subdir", Path: ".review-bot/personas/subdir", Type: "dir"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/valid.yaml"] = `
|
|
||||||
name: valid
|
|
||||||
identity: Valid persona.
|
|
||||||
`
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona (skipping dir), got %d", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SkipsInvalidYAML(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "valid.yaml", Path: ".review-bot/personas/valid.yaml", Type: "file"},
|
|
||||||
{Name: "invalid.yaml", Path: ".review-bot/personas/invalid.yaml", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/valid.yaml"] = `
|
|
||||||
name: valid
|
|
||||||
identity: Valid persona.
|
|
||||||
`
|
|
||||||
fetcher.files[".review-bot/personas/invalid.yaml"] = `
|
|
||||||
this is not valid yaml: [unclosed bracket
|
|
||||||
`
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona (skipping invalid), got %d", len(result))
|
|
||||||
}
|
|
||||||
if result["valid"] == nil {
|
|
||||||
t.Error("expected valid persona to be loaded")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SkipsOversizedFiles(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "huge.yaml", Path: ".review-bot/personas/huge.yaml", Type: "file"},
|
|
||||||
}
|
|
||||||
// Create content larger than MaxPersonaFileSize (64KB)
|
|
||||||
fetcher.files[".review-bot/personas/huge.yaml"] = `
|
|
||||||
name: huge
|
|
||||||
identity: ` + string(make([]byte, MaxPersonaFileSize+1000))
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 0 {
|
|
||||||
t.Errorf("expected 0 personas (oversized file skipped), got %d", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_SkipsFetchErrors(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "valid.yaml", Path: ".review-bot/personas/valid.yaml", Type: "file"},
|
|
||||||
{Name: "error.yaml", Path: ".review-bot/personas/error.yaml", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/valid.yaml"] = `
|
|
||||||
name: valid
|
|
||||||
identity: Valid persona.
|
|
||||||
`
|
|
||||||
fetcher.getFileErr[".review-bot/personas/error.yaml"] = errors.New("network error")
|
|
||||||
|
|
||||||
result, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if len(result) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona (skipping error), got %d", len(result))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_ListContentsError(t *testing.T) {
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.listErr = errors.New("server error")
|
|
||||||
|
|
||||||
_, err := LoadRemotePersonas(context.Background(), fetcher, "owner", "repo")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for list contents failure")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadRemotePersonas_ContextCancellation(t *testing.T) {
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel() // Cancel immediately
|
|
||||||
|
|
||||||
fetcher := newMockFetcher()
|
|
||||||
fetcher.contents[DefaultPersonasPath] = []ContentEntry{
|
|
||||||
{Name: "one.yaml", Path: ".review-bot/personas/one.yaml", Type: "file"},
|
|
||||||
}
|
|
||||||
fetcher.files[".review-bot/personas/one.yaml"] = `
|
|
||||||
name: one
|
|
||||||
identity: One.
|
|
||||||
`
|
|
||||||
|
|
||||||
_, err := LoadRemotePersonas(ctx, fetcher, "owner", "repo")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected context cancellation error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMergePersonas_NoOverlap(t *testing.T) {
|
|
||||||
remote := map[string]*Persona{
|
|
||||||
"trading": {Name: "trading", Identity: "Trading expert."},
|
|
||||||
}
|
|
||||||
builtin := map[string]*Persona{
|
|
||||||
"security": {Name: "security", Identity: "Security expert."},
|
|
||||||
}
|
|
||||||
|
|
||||||
merged, names := MergePersonas(remote, builtin)
|
|
||||||
|
|
||||||
if len(merged) != 2 {
|
|
||||||
t.Fatalf("expected 2 personas, got %d", len(merged))
|
|
||||||
}
|
|
||||||
if len(names) != 2 {
|
|
||||||
t.Fatalf("expected 2 names, got %d", len(names))
|
|
||||||
}
|
|
||||||
// Names should be sorted
|
|
||||||
if names[0] != "security" || names[1] != "trading" {
|
|
||||||
t.Errorf("expected sorted names [security, trading], got %v", names)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMergePersonas_RemoteOverridesBuiltin(t *testing.T) {
|
|
||||||
remote := map[string]*Persona{
|
|
||||||
"security": {Name: "security", Identity: "Custom security expert."},
|
|
||||||
}
|
|
||||||
builtin := map[string]*Persona{
|
|
||||||
"security": {Name: "security", Identity: "Default security expert."},
|
|
||||||
}
|
|
||||||
|
|
||||||
merged, _ := MergePersonas(remote, builtin)
|
|
||||||
|
|
||||||
if merged["security"].Identity != "Custom security expert." {
|
|
||||||
t.Errorf("expected remote to override builtin, got identity: %q", merged["security"].Identity)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMergePersonas_EmptyRemote(t *testing.T) {
|
|
||||||
remote := map[string]*Persona{}
|
|
||||||
builtin := map[string]*Persona{
|
|
||||||
"security": {Name: "security", Identity: "Security."},
|
|
||||||
}
|
|
||||||
|
|
||||||
merged, names := MergePersonas(remote, builtin)
|
|
||||||
|
|
||||||
if len(merged) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona, got %d", len(merged))
|
|
||||||
}
|
|
||||||
if names[0] != "security" {
|
|
||||||
t.Errorf("expected 'security', got %q", names[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMergePersonas_EmptyBuiltin(t *testing.T) {
|
|
||||||
remote := map[string]*Persona{
|
|
||||||
"trading": {Name: "trading", Identity: "Trading."},
|
|
||||||
}
|
|
||||||
builtin := map[string]*Persona{}
|
|
||||||
|
|
||||||
merged, names := MergePersonas(remote, builtin)
|
|
||||||
|
|
||||||
if len(merged) != 1 {
|
|
||||||
t.Fatalf("expected 1 persona, got %d", len(merged))
|
|
||||||
}
|
|
||||||
if names[0] != "trading" {
|
|
||||||
t.Errorf("expected 'trading', got %q", names[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadAllBuiltinPersonas(t *testing.T) {
|
|
||||||
personas := LoadAllBuiltinPersonas()
|
|
||||||
|
|
||||||
// Should load at least the known built-in personas
|
|
||||||
expected := []string{"architect", "docs", "security"}
|
|
||||||
for _, name := range expected {
|
|
||||||
if personas[name] == nil {
|
|
||||||
t.Errorf("expected built-in persona %q to be loaded", name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsYAMLFile(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
expected bool
|
|
||||||
}{
|
|
||||||
{"test.yaml", true},
|
|
||||||
{"test.yml", true},
|
|
||||||
{"test.YAML", true},
|
|
||||||
{"test.YML", true},
|
|
||||||
{"test.json", false},
|
|
||||||
{"test.md", false},
|
|
||||||
{"yaml", false},
|
|
||||||
{"", false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := isYAMLFile(tc.name); got != tc.expected {
|
|
||||||
t.Errorf("isYAMLFile(%q) = %v, want %v", tc.name, got, tc.expected)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsNotFoundError(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
err error
|
|
||||||
expected bool
|
|
||||||
}{
|
|
||||||
{"nil error", nil, false},
|
|
||||||
{"HTTP 404", errors.New("HTTP 404: not found"), true},
|
|
||||||
{"not found text", errors.New("path not found"), false},
|
|
||||||
{"server error", errors.New("server error"), false},
|
|
||||||
{"HTTP 500", errors.New("HTTP 500: internal error"), false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := isNotFoundError(tc.err); got != tc.expected {
|
|
||||||
t.Errorf("isNotFoundError(%v) = %v, want %v", tc.err, got, tc.expected)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RepoPersonaPath is the directory path where repo-specific personas are stored.
|
||||||
|
const RepoPersonaPath = ".review-bot/personas"
|
||||||
|
|
||||||
|
// 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 vcs.FileReader, 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,412 @@
|
|||||||
|
package review
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParsePersonaBytes(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
data string
|
||||||
|
source string
|
||||||
|
wantName string
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid yaml",
|
||||||
|
data: "name: test\nidentity: test identity\nfocus:\n - testing\n",
|
||||||
|
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 vcs.FileReader for testing.
|
||||||
|
type mockGiteaClient struct {
|
||||||
|
contents map[string][]vcs.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) ([]vcs.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, ref 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][]vcs.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][]vcs.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\ndisplay_name: Trading Expert\nidentity: You are a trading expert.\nfocus:\n - order handling\n - risk management\n",
|
||||||
|
".review-bot/personas/crypto.yaml": "name: crypto\ndisplay_name: Crypto Expert\nidentity: You are a cryptography expert.\nfocus:\n - key management\n - encryption\n",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
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][]vcs.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\nidentity: Valid persona\n",
|
||||||
|
".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)
|
||||||
|
}
|
||||||
|
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][]vcs.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\nidentity: Test persona\n",
|
||||||
|
".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][]vcs.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\nidentity: Test persona\n",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
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][]vcs.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\nidentity: Good persona\n",
|
||||||
|
},
|
||||||
|
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) {
|
||||||
|
oversizedContent := strings.Repeat("a", MaxPersonaFileSize+1)
|
||||||
|
client := &mockGiteaClient{
|
||||||
|
contents: map[string][]vcs.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\nidentity: Normal sized persona\n",
|
||||||
|
".review-bot/personas/huge.yaml": oversizedContent,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
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 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")
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := []string{"security", "architect", "docs"}
|
||||||
|
for _, name := range expected {
|
||||||
|
if personas[name] == nil {
|
||||||
|
t.Errorf("expected built-in persona %q", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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},
|
||||||
|
{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)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
//go:build phase2
|
||||||
|
|
||||||
|
package vcs_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compile-time assertion: documents the gap between gitea.Client and vcs.Client.
|
||||||
|
// Guarded by the "phase2" build tag — enable once the Gitea adapter bridges these gaps:
|
||||||
|
//
|
||||||
|
// 1. PostReview signature mismatch:
|
||||||
|
// gitea.Client: PostReview(ctx, owner, repo, number, event, body string, comments []gitea.ReviewComment)
|
||||||
|
// vcs.Reviewer: PostReview(ctx, owner, repo, number, req vcs.ReviewRequest)
|
||||||
|
//
|
||||||
|
// 2. GetFileContent signature mismatch:
|
||||||
|
// gitea.Client: GetFileContent(ctx, owner, repo, filepath string) [no ref; uses default branch]
|
||||||
|
// vcs.FileReader: GetFileContent(ctx, owner, repo, path, ref string)
|
||||||
|
// (gitea.Client has GetFileContentRef for the ref variant)
|
||||||
|
//
|
||||||
|
// 3. ReviewComment type mismatch:
|
||||||
|
// gitea.ReviewComment uses NewPosition int64 (Gitea line-number convention)
|
||||||
|
// vcs.ReviewComment uses Position int (GitHub diff-position convention)
|
||||||
|
//
|
||||||
|
// The Gitea adapter (Phase 2) will wrap gitea.Client to bridge these gaps.
|
||||||
|
var _ vcs.Client = (*gitea.Client)(nil)
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
// Package vcs defines the shared VCS client interface and supporting types.
|
||||||
|
// Platform adapters (gitea, github) implement these interfaces so the core
|
||||||
|
// review logic can work with any VCS platform without platform-specific code.
|
||||||
|
package vcs
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// PRReader can fetch pull request metadata, diffs, and changed files.
|
||||||
|
type PRReader interface {
|
||||||
|
GetPullRequest(ctx context.Context, owner, repo string, number int) (*PullRequest, error)
|
||||||
|
GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error)
|
||||||
|
GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]ChangedFile, error)
|
||||||
|
GetFileContentAtRef(ctx context.Context, owner, repo, path, ref string) (string, error)
|
||||||
|
GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]CommitStatus, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FileReader can fetch file contents and list directory entries.
|
||||||
|
type FileReader interface {
|
||||||
|
GetFileContent(ctx context.Context, owner, repo, path, ref string) (string, error)
|
||||||
|
ListContents(ctx context.Context, owner, repo, path string) ([]ContentEntry, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reviewer can post, list, and delete pull request reviews.
|
||||||
|
type Reviewer interface {
|
||||||
|
PostReview(ctx context.Context, owner, repo string, number int, req ReviewRequest) (*Review, error)
|
||||||
|
ListReviews(ctx context.Context, owner, repo string, number int) ([]Review, error)
|
||||||
|
DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error
|
||||||
|
DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, message string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Identity can report who the authenticated user is.
|
||||||
|
type Identity interface {
|
||||||
|
GetAuthenticatedUser(ctx context.Context) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Client is the full VCS interface: PR reads, file reads, review management, and identity.
|
||||||
|
// Platform adapters (gitea, github) implement this interface.
|
||||||
|
type Client interface {
|
||||||
|
PRReader
|
||||||
|
FileReader
|
||||||
|
Reviewer
|
||||||
|
Identity
|
||||||
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
package vcs
|
||||||
|
|
||||||
|
// ReviewEvent is the event type for a pull request review action.
|
||||||
|
// Adapters must translate these action constants to/from platform-native values.
|
||||||
|
// For example, Gitea uses "APPROVED" as both action and state, while GitHub
|
||||||
|
// uses "APPROVE" for the action and returns "approved" as the state.
|
||||||
|
type ReviewEvent string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ReviewEventApprove approves the pull request.
|
||||||
|
ReviewEventApprove ReviewEvent = "APPROVE"
|
||||||
|
// ReviewEventRequestChanges requests changes to the pull request.
|
||||||
|
ReviewEventRequestChanges ReviewEvent = "REQUEST_CHANGES"
|
||||||
|
// ReviewEventComment posts a review comment without approval or rejection.
|
||||||
|
ReviewEventComment ReviewEvent = "COMMENT"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BaseRef identifies the target branch of a pull request.
|
||||||
|
type BaseRef struct {
|
||||||
|
Ref string `json:"ref"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// HeadRef identifies the source branch and latest commit of a pull request.
|
||||||
|
type HeadRef struct {
|
||||||
|
SHA string `json:"sha"`
|
||||||
|
Ref string `json:"ref"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserInfo identifies a user by login name.
|
||||||
|
type UserInfo struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PullRequest holds relevant PR metadata.
|
||||||
|
type PullRequest struct {
|
||||||
|
Number int `json:"number"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
Head HeadRef `json:"head"`
|
||||||
|
Base BaseRef `json:"base"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChangedFile represents a file modified in a PR.
|
||||||
|
type ChangedFile struct {
|
||||||
|
Filename string `json:"filename"`
|
||||||
|
Status string `json:"status"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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"
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommitStatus represents a single CI status entry for a commit.
|
||||||
|
type CommitStatus struct {
|
||||||
|
Status string `json:"status"`
|
||||||
|
Context string `json:"context"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
TargetURL string `json:"target_url"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review represents a pull request review.
|
||||||
|
type Review struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
User UserInfo `json:"user"`
|
||||||
|
State string `json:"state"`
|
||||||
|
Stale bool `json:"stale"`
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReviewComment represents an inline comment in a review.
|
||||||
|
// All adapters use GitHub diff-position convention:
|
||||||
|
// - Position is a 1-indexed offset from the @@ hunk line in the unified diff.
|
||||||
|
// - CommitID identifies the commit the comment is anchored to.
|
||||||
|
// It is optional; omit (empty string) for review-level comments that are
|
||||||
|
// not attached to a specific commit.
|
||||||
|
//
|
||||||
|
// Adapters are responsible for translating to/from platform-native formats
|
||||||
|
// (e.g. Gitea uses line numbers; GitHub uses diff positions natively).
|
||||||
|
type ReviewComment struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Position int `json:"position"` // diff-position: 1-indexed offset from @@ hunk line
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReviewRequest is the payload for posting a review.
|
||||||
|
type ReviewRequest struct {
|
||||||
|
// Body is the top-level review comment.
|
||||||
|
Body string `json:"body"`
|
||||||
|
// Event is the review action (approve, request changes, or comment).
|
||||||
|
Event ReviewEvent `json:"event"`
|
||||||
|
Comments []ReviewComment `json:"comments,omitempty"`
|
||||||
|
}
|
||||||
+193
@@ -0,0 +1,193 @@
|
|||||||
|
package vcs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// maxFilesInPath is the maximum number of files GetAllFilesInPath will fetch.
|
||||||
|
// Prevents unbounded resource consumption on very large directory trees.
|
||||||
|
maxFilesInPath = 10000
|
||||||
|
|
||||||
|
// maxTotalBytesInPath is the maximum total bytes GetAllFilesInPath will accumulate.
|
||||||
|
// Prevents memory exhaustion when fetching large repositories.
|
||||||
|
maxTotalBytesInPath = 100 * 1024 * 1024 // 100 MB
|
||||||
|
)
|
||||||
|
|
||||||
|
// GetAllFilesInPath recursively fetches all file contents under a path using the
|
||||||
|
// provided FileReader. Returns a map of filepath -> content for all files found.
|
||||||
|
// If the path points to an empty directory, returns an empty map.
|
||||||
|
//
|
||||||
|
// This function uses fail-fast error handling: any error from ListContents or
|
||||||
|
// GetFileContent aborts the entire traversal and returns the error immediately.
|
||||||
|
// This differs from gitea.Client.GetAllFilesInPath, which logs errors and continues.
|
||||||
|
// The fail-fast contract ensures callers can trust that a nil error means all files
|
||||||
|
// were successfully fetched.
|
||||||
|
//
|
||||||
|
// Resource limits: the traversal is bounded by maxFilesInPath (file count) and
|
||||||
|
// maxTotalBytesInPath (total accumulated bytes). The context is checked before each
|
||||||
|
// recursive call and file fetch to respect cancellation.
|
||||||
|
func GetAllFilesInPath(ctx context.Context, client FileReader, owner, repo, path string) (map[string]string, error) {
|
||||||
|
results := make(map[string]string)
|
||||||
|
totalBytes := 0
|
||||||
|
|
||||||
|
var walk func(string) error
|
||||||
|
walk = func(dir string) error {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return fmt.Errorf("context canceled during traversal: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
entries, err := client.ListContents(ctx, owner, repo, dir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("list contents %q: %w", dir, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, entry := range entries {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return fmt.Errorf("context canceled during traversal: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch entry.Type {
|
||||||
|
case "file":
|
||||||
|
if len(results) >= maxFilesInPath {
|
||||||
|
return fmt.Errorf("exceeded max file count (%d) in path %q", maxFilesInPath, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
content, err := client.GetFileContent(ctx, owner, repo, entry.Path, "")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("get file %q: %w", entry.Path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
totalBytes += len(content)
|
||||||
|
if totalBytes > maxTotalBytesInPath {
|
||||||
|
return fmt.Errorf("exceeded max total bytes (%d) in path %q", maxTotalBytesInPath, path)
|
||||||
|
}
|
||||||
|
|
||||||
|
results[entry.Path] = content
|
||||||
|
case "dir":
|
||||||
|
if err := walk(entry.Path); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := walk(path); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return results, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildLineToPositionMap parses a unified diff and returns a map of
|
||||||
|
// filename -> (new line number -> diff position). The diff position is a
|
||||||
|
// 1-indexed offset from the @@ hunk header line for each file.
|
||||||
|
// Only lines that appear in the new file (context lines and additions) are mapped.
|
||||||
|
// Deletion-only lines are not included.
|
||||||
|
func BuildLineToPositionMap(diff string) map[string]map[int]int {
|
||||||
|
result := make(map[string]map[int]int)
|
||||||
|
|
||||||
|
lines := strings.Split(diff, "\n")
|
||||||
|
var currentFile string
|
||||||
|
var position int
|
||||||
|
var newLine int
|
||||||
|
|
||||||
|
for _, line := range lines {
|
||||||
|
// Detect new file in diff
|
||||||
|
if strings.HasPrefix(line, "+++ b/") {
|
||||||
|
currentFile = strings.TrimPrefix(line, "+++ b/")
|
||||||
|
position = 0
|
||||||
|
newLine = 0
|
||||||
|
if result[currentFile] == nil {
|
||||||
|
result[currentFile] = make(map[int]int)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip --- lines (old file header)
|
||||||
|
if strings.HasPrefix(line, "--- ") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip diff --git lines
|
||||||
|
if strings.HasPrefix(line, "diff --git") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip index lines
|
||||||
|
if strings.HasPrefix(line, "index ") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse hunk headers
|
||||||
|
if strings.HasPrefix(line, "@@") {
|
||||||
|
position++
|
||||||
|
// Extract new file start line from @@ -a,b +c,d @@
|
||||||
|
newLine = parseHunkNewStart(line)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// We need a current file to map lines
|
||||||
|
if currentFile == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip "\ No newline at end of file" markers — these are git diff
|
||||||
|
// metadata and not part of the file content.
|
||||||
|
if strings.HasPrefix(line, `\`) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process diff content lines
|
||||||
|
if strings.HasPrefix(line, "+") {
|
||||||
|
position++
|
||||||
|
result[currentFile][newLine] = position
|
||||||
|
newLine++
|
||||||
|
} else if strings.HasPrefix(line, "-") {
|
||||||
|
position++
|
||||||
|
// Deletion lines don't map to new line numbers
|
||||||
|
} else if strings.HasPrefix(line, " ") {
|
||||||
|
// Context line (space-prefixed).
|
||||||
|
// Only map if position > 0, which means we've seen a hunk header.
|
||||||
|
// Lines before the first hunk header (position == 0) are not part
|
||||||
|
// of any diff hunk and should be skipped.
|
||||||
|
if position > 0 {
|
||||||
|
position++
|
||||||
|
result[currentFile][newLine] = position
|
||||||
|
newLine++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseHunkNewStart extracts the new-file starting line number from a hunk header.
|
||||||
|
// Format: @@ -old_start[,old_count] +new_start[,new_count] @@
|
||||||
|
func parseHunkNewStart(hunkLine string) int {
|
||||||
|
// Find the +N part
|
||||||
|
plusIdx := strings.Index(hunkLine, "+")
|
||||||
|
if plusIdx < 0 {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
rest := hunkLine[plusIdx+1:]
|
||||||
|
|
||||||
|
// Find the end of the number (first non-digit after +)
|
||||||
|
endIdx := 0
|
||||||
|
for endIdx < len(rest) && rest[endIdx] >= '0' && rest[endIdx] <= '9' {
|
||||||
|
endIdx++
|
||||||
|
}
|
||||||
|
|
||||||
|
if endIdx == 0 {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
n, err := strconv.Atoi(rest[:endIdx])
|
||||||
|
if err != nil {
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
@@ -0,0 +1,331 @@
|
|||||||
|
package vcs_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// mockFileReader implements vcs.FileReader for testing.
|
||||||
|
type mockFileReader struct {
|
||||||
|
contents map[string][]vcs.ContentEntry // path -> entries
|
||||||
|
files map[string]string // path -> content
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockFileReader) GetFileContent(ctx context.Context, owner, repo, path, ref string) (string, error) {
|
||||||
|
content, ok := m.files[path]
|
||||||
|
if !ok {
|
||||||
|
return "", fmt.Errorf("HTTP 404: file not found: %s", path)
|
||||||
|
}
|
||||||
|
return content, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockFileReader) ListContents(ctx context.Context, owner, repo, path string) ([]vcs.ContentEntry, error) {
|
||||||
|
entries, ok := m.contents[path]
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("HTTP 404: path not found: %s", path)
|
||||||
|
}
|
||||||
|
return entries, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetAllFilesInPath(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
t.Run("empty directory", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(result) != 0 {
|
||||||
|
t.Errorf("expected empty map, got %d entries", len(result))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("flat directory", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {
|
||||||
|
{Name: "main.go", Path: "src/main.go", Type: "file"},
|
||||||
|
{Name: "util.go", Path: "src/util.go", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
"src/main.go": "package main",
|
||||||
|
"src/util.go": "package main\n// util",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(result) != 2 {
|
||||||
|
t.Fatalf("expected 2 files, got %d", len(result))
|
||||||
|
}
|
||||||
|
if result["src/main.go"] != "package main" {
|
||||||
|
t.Errorf("main.go content = %q", result["src/main.go"])
|
||||||
|
}
|
||||||
|
if result["src/util.go"] != "package main\n// util" {
|
||||||
|
t.Errorf("util.go content = %q", result["src/util.go"])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("nested directories", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {
|
||||||
|
{Name: "main.go", Path: "src/main.go", Type: "file"},
|
||||||
|
{Name: "pkg", Path: "src/pkg", Type: "dir"},
|
||||||
|
},
|
||||||
|
"src/pkg": {
|
||||||
|
{Name: "lib.go", Path: "src/pkg/lib.go", Type: "file"},
|
||||||
|
{Name: "sub", Path: "src/pkg/sub", Type: "dir"},
|
||||||
|
},
|
||||||
|
"src/pkg/sub": {
|
||||||
|
{Name: "deep.go", Path: "src/pkg/sub/deep.go", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
"src/main.go": "package main",
|
||||||
|
"src/pkg/lib.go": "package pkg",
|
||||||
|
"src/pkg/sub/deep.go": "package sub",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(result) != 3 {
|
||||||
|
t.Fatalf("expected 3 files, got %d", len(result))
|
||||||
|
}
|
||||||
|
if result["src/main.go"] != "package main" {
|
||||||
|
t.Errorf("main.go content = %q", result["src/main.go"])
|
||||||
|
}
|
||||||
|
if result["src/pkg/lib.go"] != "package pkg" {
|
||||||
|
t.Errorf("lib.go content = %q", result["src/pkg/lib.go"])
|
||||||
|
}
|
||||||
|
if result["src/pkg/sub/deep.go"] != "package sub" {
|
||||||
|
t.Errorf("deep.go content = %q", result["src/pkg/sub/deep.go"])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("mixed files and dirs", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"root": {
|
||||||
|
{Name: "README.md", Path: "root/README.md", Type: "file"},
|
||||||
|
{Name: "docs", Path: "root/docs", Type: "dir"},
|
||||||
|
{Name: "config.yaml", Path: "root/config.yaml", Type: "file"},
|
||||||
|
},
|
||||||
|
"root/docs": {
|
||||||
|
{Name: "guide.md", Path: "root/docs/guide.md", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
"root/README.md": "# Hello",
|
||||||
|
"root/config.yaml": "key: value",
|
||||||
|
"root/docs/guide.md": "## Guide",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "root")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(result) != 3 {
|
||||||
|
t.Fatalf("expected 3 files, got %d", len(result))
|
||||||
|
}
|
||||||
|
if result["root/README.md"] != "# Hello" {
|
||||||
|
t.Errorf("README content = %q", result["root/README.md"])
|
||||||
|
}
|
||||||
|
if result["root/docs/guide.md"] != "## Guide" {
|
||||||
|
t.Errorf("guide content = %q", result["root/docs/guide.md"])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildLineToPositionMap(t *testing.T) {
|
||||||
|
t.Run("single hunk", func(t *testing.T) {
|
||||||
|
diff := "diff --git a/file.go b/file.go\nindex abc..def 100644\n--- a/file.go\n+++ b/file.go\n@@ -1,3 +1,4 @@\n package main\n \n+// new comment\n func main() {}\n"
|
||||||
|
result := vcs.BuildLineToPositionMap(diff)
|
||||||
|
fileMap, ok := result["file.go"]
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected file.go in result")
|
||||||
|
}
|
||||||
|
// Hunk header @@ is position 1
|
||||||
|
// Line 1: " package main" -> position 2
|
||||||
|
if fileMap[1] != 2 {
|
||||||
|
t.Errorf("line 1 position = %d, want 2", fileMap[1])
|
||||||
|
}
|
||||||
|
// Line 2: " " (context) -> position 3
|
||||||
|
if fileMap[2] != 3 {
|
||||||
|
t.Errorf("line 2 position = %d, want 3", fileMap[2])
|
||||||
|
}
|
||||||
|
// Line 3: "+// new comment" -> position 4
|
||||||
|
if fileMap[3] != 4 {
|
||||||
|
t.Errorf("line 3 position = %d, want 4", fileMap[3])
|
||||||
|
}
|
||||||
|
// Line 4: " func main() {}" -> position 5
|
||||||
|
if fileMap[4] != 5 {
|
||||||
|
t.Errorf("line 4 position = %d, want 5", fileMap[4])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("multi hunk", func(t *testing.T) {
|
||||||
|
diff := "diff --git a/file.go b/file.go\n--- a/file.go\n+++ b/file.go\n@@ -1,3 +1,3 @@\n package main\n \n-// old\n+// new\n@@ -10,3 +10,4 @@\n func foo() {\n+\t// added\n \treturn\n }\n"
|
||||||
|
result := vcs.BuildLineToPositionMap(diff)
|
||||||
|
fileMap, ok := result["file.go"]
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected file.go in result")
|
||||||
|
}
|
||||||
|
// First hunk: @@ is position 1
|
||||||
|
// Line 1: " package main" -> position 2
|
||||||
|
if fileMap[1] != 2 {
|
||||||
|
t.Errorf("line 1 position = %d, want 2", fileMap[1])
|
||||||
|
}
|
||||||
|
// Line 3: "+// new" -> position 5 (after " ", "-// old" at pos 3,4)
|
||||||
|
if fileMap[3] != 5 {
|
||||||
|
t.Errorf("line 3 position = %d, want 5", fileMap[3])
|
||||||
|
}
|
||||||
|
// Second hunk: @@ is position 6
|
||||||
|
// Line 10: " func foo() {" -> position 7
|
||||||
|
if fileMap[10] != 7 {
|
||||||
|
t.Errorf("line 10 position = %d, want 7", fileMap[10])
|
||||||
|
}
|
||||||
|
// Line 11: "+\t// added" -> position 8
|
||||||
|
if fileMap[11] != 8 {
|
||||||
|
t.Errorf("line 11 position = %d, want 8", fileMap[11])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("deletion lines not in map", func(t *testing.T) {
|
||||||
|
diff := "diff --git a/file.go b/file.go\n--- a/file.go\n+++ b/file.go\n@@ -1,4 +1,3 @@\n package main\n \n-// deleted line\n func main() {}\n"
|
||||||
|
result := vcs.BuildLineToPositionMap(diff)
|
||||||
|
fileMap, ok := result["file.go"]
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected file.go in result")
|
||||||
|
}
|
||||||
|
// Line 1: " package main" -> position 2
|
||||||
|
if fileMap[1] != 2 {
|
||||||
|
t.Errorf("line 1 position = %d, want 2", fileMap[1])
|
||||||
|
}
|
||||||
|
// Line 3 in new file: " func main() {}" -> position 5 (after deletion at pos 4)
|
||||||
|
if fileMap[3] != 5 {
|
||||||
|
t.Errorf("line 3 position = %d, want 5", fileMap[3])
|
||||||
|
}
|
||||||
|
// Should only have 3 entries (lines 1, 2, 3 of new file)
|
||||||
|
if len(fileMap) != 3 {
|
||||||
|
t.Errorf("expected 3 mapped lines, got %d: %v", len(fileMap), fileMap)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("multiple files", func(t *testing.T) {
|
||||||
|
diff := "diff --git a/a.go b/a.go\n--- a/a.go\n+++ b/a.go\n@@ -1,2 +1,3 @@\n package a\n \n+// file a\ndiff --git a/b.go b/b.go\n--- a/b.go\n+++ b/b.go\n@@ -1,2 +1,3 @@\n package b\n \n+// file b\n"
|
||||||
|
result := vcs.BuildLineToPositionMap(diff)
|
||||||
|
if len(result) != 2 {
|
||||||
|
t.Fatalf("expected 2 files, got %d", len(result))
|
||||||
|
}
|
||||||
|
aMap, ok := result["a.go"]
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected a.go in result")
|
||||||
|
}
|
||||||
|
bMap, ok := result["b.go"]
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected b.go in result")
|
||||||
|
}
|
||||||
|
// a.go line 3: "+// file a" -> position 4
|
||||||
|
if aMap[3] != 4 {
|
||||||
|
t.Errorf("a.go line 3 position = %d, want 4", aMap[3])
|
||||||
|
}
|
||||||
|
// b.go line 3: "+// file b" -> position 4
|
||||||
|
if bMap[3] != 4 {
|
||||||
|
t.Errorf("b.go line 3 position = %d, want 4", bMap[3])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetAllFilesInPath_ErrorPropagation(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
t.Run("ListContents error propagates", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
// "src" not in map, so ListContents will fail
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "list contents") {
|
||||||
|
t.Errorf("expected error about list contents, got: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("GetFileContent error propagates", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {
|
||||||
|
{Name: "main.go", Path: "src/main.go", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
// "src/main.go" not in files map, so GetFileContent will fail
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "get file") {
|
||||||
|
t.Errorf("expected error about get file, got: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("nested ListContents error propagates", func(t *testing.T) {
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {
|
||||||
|
{Name: "pkg", Path: "src/pkg", Type: "dir"},
|
||||||
|
},
|
||||||
|
// "src/pkg" not in map, so recursive ListContents will fail
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "list contents") {
|
||||||
|
t.Errorf("expected error about list contents, got: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("canceled context propagates", func(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel() // Cancel immediately
|
||||||
|
|
||||||
|
client := &mockFileReader{
|
||||||
|
contents: map[string][]vcs.ContentEntry{
|
||||||
|
"src": {
|
||||||
|
{Name: "main.go", Path: "src/main.go", Type: "file"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
files: map[string]string{
|
||||||
|
"src/main.go": "package main",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := vcs.GetAllFilesInPath(ctx, client, "owner", "repo", "src")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error from canceled context, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "context canceled") {
|
||||||
|
t.Errorf("expected context cancellation error, got: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user