Compare commits
25 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 55391c66d8 | |||
| 2287a8238c | |||
| 436e6a8824 | |||
| 687005d982 | |||
| 6a3c813279 | |||
| b8af8306a6 | |||
| 69e0a459c3 | |||
| 41c670b44b | |||
| 0d417e068e | |||
| aee903caa2 | |||
| 75190d53ed | |||
| 8b8462bdc8 | |||
| 565a077b01 | |||
| dab7871cb4 | |||
| 2adb23b3d9 | |||
| d9cacf6f62 | |||
| 14a0c2a946 | |||
| 67d835909f | |||
| ef3e6d5e87 | |||
| aade891129 | |||
| 7b42de67ca | |||
| dd2661fe14 | |||
| 98a4772f30 | |||
| fc23b6ebe9 | |||
| b02ade4f23 |
@@ -34,6 +34,10 @@ inputs:
|
|||||||
llm-model:
|
llm-model:
|
||||||
description: 'LLM model name'
|
description: 'LLM model name'
|
||||||
required: true
|
required: true
|
||||||
|
llm-provider:
|
||||||
|
description: 'LLM API provider: openai or anthropic (default openai)'
|
||||||
|
required: false
|
||||||
|
default: 'openai'
|
||||||
conventions-file:
|
conventions-file:
|
||||||
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
description: 'Path to conventions file in the repo (e.g. CLAUDE.md)'
|
||||||
required: false
|
required: false
|
||||||
@@ -62,6 +66,14 @@ inputs:
|
|||||||
description: 'Print review to stdout instead of posting'
|
description: 'Print review to stdout instead of posting'
|
||||||
required: false
|
required: false
|
||||||
default: '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: ''
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'composite'
|
using: 'composite'
|
||||||
@@ -140,6 +152,9 @@ runs:
|
|||||||
PATTERNS_FILES: ${{ inputs.patterns-files }}
|
PATTERNS_FILES: ${{ inputs.patterns-files }}
|
||||||
LLM_TEMPERATURE: ${{ inputs.temperature }}
|
LLM_TEMPERATURE: ${{ inputs.temperature }}
|
||||||
LLM_TIMEOUT: ${{ inputs.timeout }}
|
LLM_TIMEOUT: ${{ inputs.timeout }}
|
||||||
|
LLM_PROVIDER: ${{ inputs.llm-provider }}
|
||||||
|
UPDATE_EXISTING: ${{ inputs.update-existing }}
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ inputs.system-prompt-file }}
|
||||||
run: |
|
run: |
|
||||||
ARGS=""
|
ARGS=""
|
||||||
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
if [ "${{ inputs.dry-run }}" = "true" ]; then
|
||||||
|
|||||||
@@ -31,7 +31,11 @@ jobs:
|
|||||||
model: gpt-5
|
model: gpt-5
|
||||||
- name: gpt
|
- name: gpt
|
||||||
token_secret: GPT_REVIEW_TOKEN
|
token_secret: GPT_REVIEW_TOKEN
|
||||||
model: gpt-5-mini
|
model: gpt-4.1
|
||||||
|
- name: security
|
||||||
|
token_secret: SONNET_REVIEW_TOKEN
|
||||||
|
model: gpt-5
|
||||||
|
system_prompt_file: SECURITY_REVIEW.md
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
@@ -44,10 +48,13 @@ jobs:
|
|||||||
GITEA_REPO: ${{ github.repository }}
|
GITEA_REPO: ${{ github.repository }}
|
||||||
PR_NUMBER: ${{ github.event.pull_request.number }}
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||||
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
REVIEWER_TOKEN: ${{ secrets[matrix.token_secret] }}
|
||||||
|
REVIEWER_NAME: ${{ matrix.name }}
|
||||||
LLM_BASE_URL: ${{ secrets.LLM_BASE_URL }}
|
LLM_BASE_URL: ${{ secrets.LLM_BASE_URL }}
|
||||||
LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
|
LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
|
||||||
LLM_MODEL: ${{ matrix.model }}
|
LLM_MODEL: ${{ matrix.model }}
|
||||||
CONVENTIONS_FILE: "CONVENTIONS.md"
|
CONVENTIONS_FILE: "CONVENTIONS.md"
|
||||||
PATTERNS_REPO: "rodin/go-patterns"
|
PATTERNS_REPO: "rodin/go-patterns"
|
||||||
PATTERNS_FILES: "README.md,docs/"
|
PATTERNS_FILES: "README.md,patterns/"
|
||||||
|
LLM_TIMEOUT: "600"
|
||||||
|
SYSTEM_PROMPT_FILE: ${{ matrix.system_prompt_file }}
|
||||||
run: ./review-bot
|
run: ./review-bot
|
||||||
|
|||||||
@@ -16,7 +16,9 @@ jobs:
|
|||||||
go-version: '1.26'
|
go-version: '1.26'
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: go test ./...
|
run: |
|
||||||
|
go vet ./...
|
||||||
|
go test ./...
|
||||||
|
|
||||||
- name: Build binaries
|
- name: Build binaries
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -1,17 +1,242 @@
|
|||||||
# review-bot
|
# review-bot
|
||||||
|
|
||||||
Automated code review bot for Gitea. Fetches a pull request diff, sends it to an LLM for analysis, and posts a structured review back to the PR.
|
AI-powered code review bot for Gitea pull requests. Fetches diff + context, sends to an LLM, and posts a structured review (APPROVE / REQUEST_CHANGES) back to the PR.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Fetches PR metadata, diff, and CI status from Gitea API
|
- **Multi-provider**: OpenAI-compatible and Anthropic Messages API
|
||||||
- Sends context-rich prompts to any OpenAI-compatible LLM
|
- **Context-aware**: Fetches full file content, conventions, language patterns, CI status
|
||||||
- Parses structured JSON review responses
|
- **Smart budget**: Automatically trims context to fit model token limits
|
||||||
- Posts formatted reviews (APPROVE / REQUEST_CHANGES) back to Gitea
|
- **Idempotent reviews**: Posts new review, then cleans up stale ones (one review per bot)
|
||||||
- Supports custom coding conventions via repo files
|
- **Custom prompts**: Load additional instructions from a file (e.g. security-focused review)
|
||||||
- Zero external dependencies — Go stdlib only
|
- **Zero dependencies**: Go stdlib only
|
||||||
|
|
||||||
## Usage
|
## Quick Start: Composite Action
|
||||||
|
|
||||||
|
The easiest way to use review-bot in your Gitea CI:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# .gitea/workflows/review.yml
|
||||||
|
name: Review
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: code-review
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: gpt-4.1
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it. Every PR gets an automated review.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Single reviewer with conventions
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: reviewer
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: gpt-4.1
|
||||||
|
conventions-file: CONVENTIONS.md
|
||||||
|
timeout: '600'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Two reviewers with different models (diversity of opinion)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: gpt
|
||||||
|
model: gpt-4.1
|
||||||
|
token_secret: GPT_REVIEW_TOKEN
|
||||||
|
- name: claude
|
||||||
|
model: claude-sonnet-4-20250514
|
||||||
|
token_secret: CLAUDE_REVIEW_TOKEN
|
||||||
|
provider: anthropic
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets[matrix.token_secret] }}
|
||||||
|
reviewer-name: ${{ matrix.name }}
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: ${{ matrix.model }}
|
||||||
|
llm-provider: ${{ matrix.provider }}
|
||||||
|
conventions-file: CONVENTIONS.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Each reviewer posts independently and only cleans up its own stale reviews.
|
||||||
|
|
||||||
|
### Multiple review types from a single bot account
|
||||||
|
|
||||||
|
Use the same Gitea token but different `reviewer-name` values to run specialized reviews without needing multiple bot accounts:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
review:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: code-quality
|
||||||
|
model: gpt-4.1
|
||||||
|
- name: security
|
||||||
|
model: gpt-4.1
|
||||||
|
system_prompt_file: .review/SECURITY.md
|
||||||
|
- name: performance
|
||||||
|
model: gpt-4.1
|
||||||
|
system_prompt_file: .review/PERFORMANCE.md
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: ${{ matrix.name }}
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: ${{ matrix.model }}
|
||||||
|
system-prompt-file: ${{ matrix.system_prompt_file }}
|
||||||
|
```
|
||||||
|
|
||||||
|
The sentinel `<!-- review-bot:security -->` ensures the security review only replaces previous security reviews, never the code-quality or performance reviews.
|
||||||
|
|
||||||
|
### With language patterns from another repo
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: reviewer
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: gpt-4.1
|
||||||
|
conventions-file: CLAUDE.md
|
||||||
|
patterns-repo: rodin/go-patterns,rodin/kubernetes-conventions
|
||||||
|
patterns-files: "README.md,patterns/"
|
||||||
|
```
|
||||||
|
|
||||||
|
Pattern repos are fetched at review time. The reviewer uses them as criteria for idiomatic code.
|
||||||
|
|
||||||
|
### Dry run (test without posting)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: test
|
||||||
|
llm-base-url: ${{ secrets.LLM_BASE_URL }}
|
||||||
|
llm-api-key: ${{ secrets.LLM_API_KEY }}
|
||||||
|
llm-model: gpt-4.1
|
||||||
|
dry-run: 'true'
|
||||||
|
```
|
||||||
|
|
||||||
|
Prints the review to CI logs without posting to the PR. Useful for testing prompt changes.
|
||||||
|
|
||||||
|
### Using Anthropic directly
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: https://gitea.weiker.me/rodin/review-bot/.gitea/actions/review@v0.1.0
|
||||||
|
with:
|
||||||
|
reviewer-token: ${{ secrets.REVIEW_TOKEN }}
|
||||||
|
reviewer-name: claude
|
||||||
|
llm-base-url: https://api.anthropic.com
|
||||||
|
llm-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
llm-model: claude-sonnet-4-20250514
|
||||||
|
llm-provider: anthropic
|
||||||
|
```
|
||||||
|
|
||||||
|
## Action Inputs
|
||||||
|
|
||||||
|
| Input | Required | Default | Description |
|
||||||
|
|-------|----------|---------|-------------|
|
||||||
|
| `reviewer-token` | Yes | — | Gitea token for posting reviews (needs `write:issue`, `write:repository`) |
|
||||||
|
| `reviewer-name` | No | `""` | Logical identity for this reviewer. Used as sentinel for idempotent cleanup. Set this when running multiple review bots on the same PR. |
|
||||||
|
| `llm-base-url` | Yes | — | LLM API base URL |
|
||||||
|
| `llm-api-key` | Yes | — | LLM API key |
|
||||||
|
| `llm-model` | Yes | — | Model name |
|
||||||
|
| `llm-provider` | No | `openai` | API provider: `openai` or `anthropic` |
|
||||||
|
| `conventions-file` | No | `""` | Path to coding conventions file in the repo |
|
||||||
|
| `patterns-repo` | No | `""` | Comma-separated repos with language patterns (e.g. `rodin/go-patterns`) |
|
||||||
|
| `patterns-files` | No | `README.md` | Files/directories to fetch from pattern repos |
|
||||||
|
| `system-prompt-file` | No | `""` | Local file with additional system prompt instructions |
|
||||||
|
| `temperature` | No | `0` | LLM temperature (0 = server default) |
|
||||||
|
| `timeout` | No | `300` | LLM request timeout in seconds |
|
||||||
|
| `dry-run` | No | `false` | Print review to stdout instead of posting |
|
||||||
|
| `update-existing` | No | `true` | Delete previous review from same bot before posting. Accepts: true/1/yes or false/0/no |
|
||||||
|
| `version` | No | `latest` | review-bot version to install |
|
||||||
|
|
||||||
|
## How Review Cleanup Works
|
||||||
|
|
||||||
|
When `reviewer-name` is set, the bot embeds a hidden sentinel in each review:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!-- review-bot:code-review -->
|
||||||
|
```
|
||||||
|
|
||||||
|
On the next run, it finds and deletes any review containing its own sentinel (except the one it just posted). This means:
|
||||||
|
|
||||||
|
- **One review per bot per PR** — no clutter from repeated pushes
|
||||||
|
- **Multiple bots coexist** — each only cleans up its own reviews
|
||||||
|
- **Same token, different roles** — a single bot account can post "code-review" and "security" reviews without conflict
|
||||||
|
- **No extra permissions** — identity comes from the sentinel, not the API
|
||||||
|
|
||||||
|
If `reviewer-name` is empty, cleanup is skipped (reviews stack like before).
|
||||||
|
|
||||||
|
### Shared Token: Worst-Wins Behavior
|
||||||
|
|
||||||
|
When multiple review types share the same Gitea bot account (e.g. code-quality and security), Gitea determines the user's approval state from their **most recent review**. This creates a race condition: if security finds issues (REQUEST_CHANGES) but code-quality finishes last (APPROVE), the PR appears approved.
|
||||||
|
|
||||||
|
review-bot handles this automatically with **worst-wins reconciliation**: before posting, each job checks whether any sibling review from the same user already has REQUEST_CHANGES. If so and this job would post APPROVE, it posts as REQUEST_CHANGES instead — maintaining the block. This ensures the PR stays blocked until all checks pass, regardless of execution order.
|
||||||
|
|
||||||
|
**If you need independent approval/block per review type**, use separate Gitea bot accounts with their own tokens.
|
||||||
|
|
||||||
|
## Custom Review Prompts
|
||||||
|
|
||||||
|
Use `system-prompt-file` to specialize the review focus. The file contents are appended to the base system prompt as "Additional Review Instructions."
|
||||||
|
|
||||||
|
Example `SECURITY_REVIEW.md`:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
You are performing a security-focused code review.
|
||||||
|
|
||||||
|
Focus areas:
|
||||||
|
- Injection attacks (SQL, command, path traversal, template)
|
||||||
|
- Authentication/Authorization (missing checks, privilege escalation)
|
||||||
|
- Secrets exposure (hardcoded credentials, tokens in logs)
|
||||||
|
- Input validation (unsanitized input, unsafe deserialization)
|
||||||
|
- Race conditions (TOCTOU, unsynchronized shared state)
|
||||||
|
|
||||||
|
Rules:
|
||||||
|
- Only report findings with security implications
|
||||||
|
- Ignore style, naming, and general code quality
|
||||||
|
- MAJOR = exploitable vulnerability, MINOR = hardening opportunity, NIT = theoretical risk
|
||||||
|
- If no security-relevant changes exist, APPROVE with empty findings
|
||||||
|
```
|
||||||
|
|
||||||
|
## CLI Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
review-bot \
|
review-bot \
|
||||||
@@ -19,71 +244,74 @@ review-bot \
|
|||||||
--repo owner/name \
|
--repo owner/name \
|
||||||
--pr 42 \
|
--pr 42 \
|
||||||
--reviewer-token "$GITEA_TOKEN" \
|
--reviewer-token "$GITEA_TOKEN" \
|
||||||
|
--reviewer-name "code-review" \
|
||||||
--llm-base-url https://api.openai.com/v1 \
|
--llm-base-url https://api.openai.com/v1 \
|
||||||
--llm-api-key "$OPENAI_API_KEY" \
|
--llm-api-key "$OPENAI_API_KEY" \
|
||||||
--llm-model gpt-4 \
|
--llm-model gpt-4.1 \
|
||||||
--reviewer-name "Sonnet" \
|
--conventions-file CONVENTIONS.md
|
||||||
--conventions-file CONVENTIONS.md \
|
|
||||||
--dry-run
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Environment Variables
|
## Environment Variables
|
||||||
|
|
||||||
All flags can be set via environment variables:
|
All flags have environment variable equivalents:
|
||||||
|
|
||||||
| Flag | Env Var | Required | Description |
|
| Flag | Env Var |
|
||||||
|------|---------|----------|-------------|
|
|------|---------|
|
||||||
| `--gitea-url` | `GITEA_URL` | Yes | Gitea instance base URL |
|
| `--gitea-url` | `GITEA_URL` |
|
||||||
| `--repo` | `GITEA_REPO` | Yes | Repository in `owner/name` format |
|
| `--repo` | `GITEA_REPO` |
|
||||||
| `--pr` | `PR_NUMBER` | Yes | Pull request number |
|
| `--pr` | `PR_NUMBER` |
|
||||||
| `--reviewer-token` | `REVIEWER_TOKEN` | Yes | Gitea API token for posting reviews |
|
| `--reviewer-token` | `REVIEWER_TOKEN` |
|
||||||
| `--llm-base-url` | `LLM_BASE_URL` | Yes | OpenAI-compatible API base URL |
|
| `--reviewer-name` | `REVIEWER_NAME` |
|
||||||
| `--llm-api-key` | `LLM_API_KEY` | Yes | LLM API key |
|
| `--llm-base-url` | `LLM_BASE_URL` |
|
||||||
| `--llm-model` | `LLM_MODEL` | Yes | Model identifier |
|
| `--llm-api-key` | `LLM_API_KEY` |
|
||||||
| `--reviewer-name` | `REVIEWER_NAME` | No | Display name in review footer |
|
| `--llm-model` | `LLM_MODEL` |
|
||||||
| `--conventions-file` | `CONVENTIONS_FILE` | No | Path to conventions file in repo |
|
| `--llm-provider` | `LLM_PROVIDER` |
|
||||||
| `--dry-run` | — | No | Print review to stdout instead of posting |
|
| `--conventions-file` | `CONVENTIONS_FILE` |
|
||||||
|
| `--patterns-repo` | `PATTERNS_REPO` |
|
||||||
|
| `--patterns-files` | `PATTERNS_FILES` |
|
||||||
|
| `--system-prompt-file` | `SYSTEM_PROMPT_FILE` |
|
||||||
|
| `--llm-temperature` | `LLM_TEMPERATURE` |
|
||||||
|
| `--llm-timeout` | `LLM_TIMEOUT` |
|
||||||
|
| `--update-existing` | `UPDATE_EXISTING` |
|
||||||
|
|
||||||
## Adding to a Gitea Repository
|
## Setup
|
||||||
|
|
||||||
1. Build the binary or use the CI workflow approach (build in CI).
|
1. **Create a Gitea bot account** (e.g. `review-bot`)
|
||||||
|
2. **Generate a token** with scopes: `write:issue`, `write:repository`
|
||||||
|
3. **Add secrets** to your Gitea repo (Settings → Actions → Secrets):
|
||||||
|
- `REVIEW_TOKEN` — the bot's Gitea token
|
||||||
|
- `LLM_BASE_URL` — your LLM endpoint
|
||||||
|
- `LLM_API_KEY` — your LLM key
|
||||||
|
4. **Add the workflow** (see Quick Start above)
|
||||||
|
|
||||||
2. Add secrets to your Gitea repo (Settings → Actions → Secrets):
|
### Token Scopes Required
|
||||||
- `SONNET_REVIEW_TOKEN` — Gitea token for the Sonnet reviewer account
|
|
||||||
- `GPT_REVIEW_TOKEN` — Gitea token for the GPT reviewer account
|
|
||||||
- `LLM_BASE_URL` — Your LLM API endpoint
|
|
||||||
- `LLM_API_KEY` — Your LLM API key
|
|
||||||
|
|
||||||
3. Copy `.gitea/workflows/ci.yml` to your repo (or adapt it).
|
| Scope | Purpose |
|
||||||
|
|-------|---------|
|
||||||
|
| `write:issue` | Post and delete reviews |
|
||||||
|
| `write:repository` | Read PR diffs, file content, commit statuses |
|
||||||
|
|
||||||
4. On every PR, the bot will:
|
No `read:user` scope needed — the bot identifies itself from the review response.
|
||||||
- Run tests and vet
|
|
||||||
- Build review-bot
|
|
||||||
- Post reviews from each configured LLM reviewer
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run tests
|
go test ./... # Unit tests
|
||||||
go test ./...
|
go vet ./... # Static analysis
|
||||||
|
|
||||||
# Run vet
|
|
||||||
go vet ./...
|
|
||||||
|
|
||||||
# Build
|
|
||||||
go build -o review-bot ./cmd/review-bot
|
go build -o review-bot ./cmd/review-bot
|
||||||
|
|
||||||
# Integration tests (requires env vars)
|
# Integration tests (requires env vars set)
|
||||||
go test -tags=integration ./...
|
go test -tags=integration ./...
|
||||||
```
|
```
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
```
|
```
|
||||||
cmd/review-bot/ CLI entrypoint
|
cmd/review-bot/ CLI entrypoint + orchestration
|
||||||
gitea/ Gitea API client
|
gitea/ Gitea API client (reviews, PRs, files)
|
||||||
llm/ OpenAI-compatible LLM client
|
llm/ Multi-provider LLM client (OpenAI + Anthropic)
|
||||||
review/ Prompt building, response parsing, formatting
|
review/ Prompt building, response parsing, formatting
|
||||||
|
budget/ Token estimation + context trimming
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
You are performing a security-focused code review. Your primary concern is identifying vulnerabilities, not general code quality.
|
||||||
|
|
||||||
|
Focus areas:
|
||||||
|
- **Injection attacks**: SQL injection, command injection, path traversal, template injection
|
||||||
|
- **Authentication/Authorization**: Missing auth checks, privilege escalation, IDOR
|
||||||
|
- **Secrets exposure**: Hardcoded credentials, API keys in code, tokens in logs
|
||||||
|
- **Input validation**: Untrusted input used without sanitization, unsafe deserialization
|
||||||
|
- **Cryptography**: Weak algorithms, predictable randomness, improper key management
|
||||||
|
- **Error handling**: Information leakage in error messages, stack traces exposed
|
||||||
|
- **Dependencies**: Known vulnerable patterns, unsafe use of external libraries
|
||||||
|
- **Race conditions**: TOCTOU bugs, unsynchronized shared state
|
||||||
|
- **Resource exhaustion**: Unbounded allocations, missing timeouts, denial-of-service vectors
|
||||||
|
|
||||||
|
Rules for this review:
|
||||||
|
- Only report findings with actual security implications. Ignore style, naming, and general code quality.
|
||||||
|
- Severity mapping: MAJOR = exploitable vulnerability or data exposure. MINOR = defense-in-depth improvement or hardening opportunity. NIT = theoretical concern with low practical risk.
|
||||||
|
- If the code has no security-relevant changes, APPROVE with an empty findings list.
|
||||||
|
- Do not duplicate findings that a standard code review would catch (logic bugs, missing error checks) unless they have a security dimension.
|
||||||
@@ -0,0 +1,226 @@
|
|||||||
|
// Package budget manages LLM context window budgeting for review-bot.
|
||||||
|
//
|
||||||
|
// It estimates token usage and progressively trims context content to fit
|
||||||
|
// within model-specific limits. The trimming order (least important first):
|
||||||
|
// patterns → conventions → file context → diff truncation.
|
||||||
|
package budget
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// modelLimit pairs a model name prefix with its context window size.
|
||||||
|
type modelLimit struct {
|
||||||
|
prefix string
|
||||||
|
limit int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Known model context limits (in tokens), ordered longest-prefix-first
|
||||||
|
// for deterministic matching.
|
||||||
|
var modelLimits = []modelLimit{
|
||||||
|
{"claude-haiku-3.5-20241022", 200_000},
|
||||||
|
{"claude-sonnet-4-20250514", 200_000},
|
||||||
|
{"claude-opus-4-20250514", 200_000},
|
||||||
|
{"gpt-4.1-mini", 128_000},
|
||||||
|
{"gpt-5-mini", 200_000},
|
||||||
|
{"gpt-4.1", 128_000},
|
||||||
|
{"gpt-5", 200_000},
|
||||||
|
}
|
||||||
|
|
||||||
|
const defaultLimit = 128_000
|
||||||
|
|
||||||
|
// reserveTokens is headroom for the response generation.
|
||||||
|
const reserveTokens = 4_000
|
||||||
|
|
||||||
|
const diffTruncMarker = "\n\n... [diff truncated due to context limit] ..."
|
||||||
|
const diffTooLargeMarker = "... [diff too large for context window — review manually] ..."
|
||||||
|
const userMetaTruncMarker = "\n... [description truncated] ..."
|
||||||
|
|
||||||
|
// EstimateTokens estimates the number of tokens in a string.
|
||||||
|
// Uses the rough heuristic of ~4 bytes per token, which is
|
||||||
|
// conservative for English text and code.
|
||||||
|
func EstimateTokens(s string) int {
|
||||||
|
return len(s) / 4
|
||||||
|
}
|
||||||
|
|
||||||
|
// LimitForModel returns the context window size for the given model.
|
||||||
|
// Uses longest-prefix-first matching for deterministic results.
|
||||||
|
func LimitForModel(model string) int {
|
||||||
|
for _, ml := range modelLimits {
|
||||||
|
if model == ml.prefix || strings.HasPrefix(model, ml.prefix) {
|
||||||
|
return ml.limit
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return defaultLimit
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sections holds the prompt content sections in trim priority order.
|
||||||
|
// When the total exceeds the budget, sections are trimmed from least
|
||||||
|
// important (Patterns) to most important (Diff).
|
||||||
|
type Sections struct {
|
||||||
|
SystemBase string // Core instructions (never trimmed)
|
||||||
|
Patterns string // Language patterns (trimmed first)
|
||||||
|
Conventions string // Repo conventions (trimmed second)
|
||||||
|
FileContext string // Full file content (trimmed third)
|
||||||
|
Diff string // The actual diff (trimmed last, only truncated)
|
||||||
|
UserMeta string // PR title, description, CI status (truncated only if base exceeds budget)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result holds the trimmed content and metadata about what was dropped.
|
||||||
|
type Result struct {
|
||||||
|
SystemPrompt string
|
||||||
|
UserPrompt string
|
||||||
|
Trimmed []string // Human-readable descriptions of what was trimmed
|
||||||
|
EstTokens int // Estimated total tokens after trimming
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fit trims sections to fit within the model's context limit.
|
||||||
|
// Returns the assembled prompts and a list of what was trimmed.
|
||||||
|
func Fit(model string, sections Sections) Result {
|
||||||
|
limit := LimitForModel(model) - reserveTokens
|
||||||
|
|
||||||
|
baseTokens := EstimateTokens(sections.SystemBase) + EstimateTokens(sections.UserMeta)
|
||||||
|
available := limit - baseTokens
|
||||||
|
if available < 0 {
|
||||||
|
// Base content alone exceeds budget. Truncate UserMeta (keep first ~1000 tokens).
|
||||||
|
if len(sections.UserMeta) > 4000 {
|
||||||
|
sections.UserMeta = truncateUTF8(sections.UserMeta, 4000) + userMetaTruncMarker
|
||||||
|
baseTokens = EstimateTokens(sections.SystemBase) + EstimateTokens(sections.UserMeta)
|
||||||
|
available = limit - baseTokens
|
||||||
|
}
|
||||||
|
if available < 0 {
|
||||||
|
available = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trimmable sections in priority order (first = dropped first)
|
||||||
|
type entry struct {
|
||||||
|
name string
|
||||||
|
content *string
|
||||||
|
}
|
||||||
|
entries := []entry{
|
||||||
|
{"patterns", §ions.Patterns},
|
||||||
|
{"conventions", §ions.Conventions},
|
||||||
|
{"file context", §ions.FileContext},
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if everything fits
|
||||||
|
totalTrimmable := EstimateTokens(sections.Diff)
|
||||||
|
for _, e := range entries {
|
||||||
|
totalTrimmable += EstimateTokens(*e.content)
|
||||||
|
}
|
||||||
|
|
||||||
|
var trimmed []string
|
||||||
|
if totalTrimmable > available {
|
||||||
|
// Trim from least important
|
||||||
|
for i := range entries {
|
||||||
|
tokens := EstimateTokens(*entries[i].content)
|
||||||
|
if tokens == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
trimmed = append(trimmed, fmt.Sprintf("%s (~%dK tokens)", entries[i].name, tokens/1000))
|
||||||
|
*entries[i].content = ""
|
||||||
|
|
||||||
|
// Recalculate
|
||||||
|
totalTrimmable = EstimateTokens(sections.Diff)
|
||||||
|
for _, e := range entries {
|
||||||
|
totalTrimmable += EstimateTokens(*e.content)
|
||||||
|
}
|
||||||
|
if totalTrimmable <= available {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// If still too large, truncate the diff
|
||||||
|
if totalTrimmable > available {
|
||||||
|
diffBudget := available
|
||||||
|
for _, e := range entries {
|
||||||
|
diffBudget -= EstimateTokens(*e.content)
|
||||||
|
}
|
||||||
|
if diffBudget < 0 {
|
||||||
|
diffBudget = 0
|
||||||
|
}
|
||||||
|
// Reserve space for truncation marker
|
||||||
|
markerBudget := EstimateTokens(diffTruncMarker)
|
||||||
|
effectiveBudget := diffBudget - markerBudget
|
||||||
|
if effectiveBudget < 0 {
|
||||||
|
effectiveBudget = 0
|
||||||
|
}
|
||||||
|
maxChars := effectiveBudget * 4
|
||||||
|
if maxChars < len(sections.Diff) {
|
||||||
|
removed := EstimateTokens(sections.Diff) - diffBudget
|
||||||
|
trimmed = append(trimmed, fmt.Sprintf("diff truncated (~%dK tokens removed)", removed/1000))
|
||||||
|
if maxChars > 0 {
|
||||||
|
if diffBudget >= markerBudget {
|
||||||
|
sections.Diff = truncateUTF8(sections.Diff, maxChars) + diffTruncMarker
|
||||||
|
} else {
|
||||||
|
sections.Diff = truncateUTF8(sections.Diff, maxChars)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
sections.Diff = diffTooLargeMarker
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
finalTokens := baseTokens
|
||||||
|
for _, e := range entries {
|
||||||
|
finalTokens += EstimateTokens(*e.content)
|
||||||
|
}
|
||||||
|
finalTokens += EstimateTokens(sections.Diff)
|
||||||
|
|
||||||
|
return buildResult(sections, trimmed, finalTokens)
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildResult(s Sections, trimmed []string, estTokens int) Result {
|
||||||
|
var sys strings.Builder
|
||||||
|
sys.WriteString(s.SystemBase)
|
||||||
|
if s.Patterns != "" {
|
||||||
|
sys.WriteString("\n\n## Language Patterns & Idioms\n\nUse the following patterns as review criteria. Code that violates these established patterns is a finding:\n\n")
|
||||||
|
sys.WriteString(s.Patterns)
|
||||||
|
}
|
||||||
|
if s.Conventions != "" {
|
||||||
|
sys.WriteString("\n\n## Repository Conventions\n\nThe repository has the following coding conventions that must be respected:\n\n")
|
||||||
|
sys.WriteString(s.Conventions)
|
||||||
|
}
|
||||||
|
|
||||||
|
var usr strings.Builder
|
||||||
|
usr.WriteString(s.UserMeta)
|
||||||
|
if s.FileContext != "" {
|
||||||
|
usr.WriteString("\n### Full File Context (modified files)\n\n")
|
||||||
|
usr.WriteString(s.FileContext)
|
||||||
|
usr.WriteString("\n")
|
||||||
|
}
|
||||||
|
if s.Diff != "" {
|
||||||
|
usr.WriteString("\n### Diff (changes to review)\n\n```diff\n")
|
||||||
|
usr.WriteString(s.Diff)
|
||||||
|
usr.WriteString("\n```\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(trimmed) > 0 {
|
||||||
|
usr.WriteString("\n⚠️ Note: Context was trimmed to fit model limits. Dropped: ")
|
||||||
|
usr.WriteString(strings.Join(trimmed, ", "))
|
||||||
|
usr.WriteString("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
return Result{
|
||||||
|
SystemPrompt: sys.String(),
|
||||||
|
UserPrompt: usr.String(),
|
||||||
|
Trimmed: trimmed,
|
||||||
|
EstTokens: estTokens,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// truncateUTF8 truncates s to at most maxBytes without splitting multi-byte
|
||||||
|
// UTF-8 characters. Returns a valid UTF-8 string of at most maxBytes bytes.
|
||||||
|
func truncateUTF8(s string, maxBytes int) string {
|
||||||
|
if len(s) <= maxBytes {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
for maxBytes > 0 && !utf8.RuneStart(s[maxBytes]) {
|
||||||
|
maxBytes--
|
||||||
|
}
|
||||||
|
return s[:maxBytes]
|
||||||
|
}
|
||||||
@@ -0,0 +1,203 @@
|
|||||||
|
package budget
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEstimateTokens(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
input string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{"", 0},
|
||||||
|
{"abcd", 1},
|
||||||
|
{"12345678", 2},
|
||||||
|
{strings.Repeat("x", 400), 100},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
got := EstimateTokens(tt.input)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("EstimateTokens(%d chars) = %d, want %d", len(tt.input), got, tt.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLimitForModel(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
model string
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{"gpt-4.1", 128_000},
|
||||||
|
{"gpt-5", 200_000},
|
||||||
|
{"gpt-5-mini", 200_000},
|
||||||
|
{"unknown-model", defaultLimit},
|
||||||
|
{"gpt-4.1-2026-01-01", 128_000}, // prefix match
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
got := LimitForModel(tt.model)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("LimitForModel(%q) = %d, want %d", tt.model, got, tt.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_AllFits(t *testing.T) {
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "system instructions",
|
||||||
|
Patterns: "some patterns",
|
||||||
|
Conventions: "some conventions",
|
||||||
|
FileContext: "file content",
|
||||||
|
Diff: "diff content",
|
||||||
|
UserMeta: "PR: title\n",
|
||||||
|
}
|
||||||
|
result := Fit("gpt-5", s)
|
||||||
|
|
||||||
|
if len(result.Trimmed) != 0 {
|
||||||
|
t.Errorf("expected no trimming, got %v", result.Trimmed)
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.SystemPrompt, "some patterns") {
|
||||||
|
t.Error("expected patterns in system prompt")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.SystemPrompt, "some conventions") {
|
||||||
|
t.Error("expected conventions in system prompt")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.UserPrompt, "file content") {
|
||||||
|
t.Error("expected file context in user prompt")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_TrimsPatterns(t *testing.T) {
|
||||||
|
// Create content that exceeds 128K token budget for gpt-4.1
|
||||||
|
// Budget ≈ 128K - 4K reserve = 124K tokens = ~496K chars
|
||||||
|
// Fill patterns with enough to push over
|
||||||
|
bigPatterns := strings.Repeat("x", 500_000) // ~125K tokens
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "base",
|
||||||
|
Patterns: bigPatterns,
|
||||||
|
Conventions: "conventions",
|
||||||
|
FileContext: "files",
|
||||||
|
Diff: "diff",
|
||||||
|
UserMeta: "meta",
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
if len(result.Trimmed) == 0 {
|
||||||
|
t.Fatal("expected trimming")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.Trimmed[0], "patterns") {
|
||||||
|
t.Errorf("expected patterns to be trimmed first, got %v", result.Trimmed)
|
||||||
|
}
|
||||||
|
if strings.Contains(result.SystemPrompt, bigPatterns[:100]) {
|
||||||
|
t.Error("expected patterns to be removed from output")
|
||||||
|
}
|
||||||
|
// Conventions should survive
|
||||||
|
if !strings.Contains(result.SystemPrompt, "conventions") {
|
||||||
|
t.Error("expected conventions to survive after patterns trimmed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_TrimsConventions(t *testing.T) {
|
||||||
|
// Patterns + conventions + diff all exceed budget even after patterns removed
|
||||||
|
big := strings.Repeat("y", 520_000) // ~130K tokens each (exceeds 124K budget even alone)
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "base",
|
||||||
|
Patterns: big,
|
||||||
|
Conventions: big,
|
||||||
|
FileContext: "files",
|
||||||
|
Diff: "diff",
|
||||||
|
UserMeta: "meta",
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
if len(result.Trimmed) < 2 {
|
||||||
|
t.Fatalf("expected at least 2 trimmed, got %v", result.Trimmed)
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.Trimmed[0], "patterns") {
|
||||||
|
t.Errorf("expected patterns trimmed first, got %s", result.Trimmed[0])
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.Trimmed[1], "conventions") {
|
||||||
|
t.Errorf("expected conventions trimmed second, got %s", result.Trimmed[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_TruncatesDiff(t *testing.T) {
|
||||||
|
// Only diff is huge, no patterns/conventions
|
||||||
|
hugeDiff := strings.Repeat("z", 600_000) // ~150K tokens > 128K limit
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "base",
|
||||||
|
Diff: hugeDiff,
|
||||||
|
UserMeta: "meta",
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
if len(result.Trimmed) == 0 {
|
||||||
|
t.Fatal("expected diff truncation")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.Trimmed[len(result.Trimmed)-1], "diff truncated") {
|
||||||
|
t.Errorf("expected diff truncation note, got %v", result.Trimmed)
|
||||||
|
}
|
||||||
|
if !strings.Contains(result.UserPrompt, "[diff truncated due to context limit]") {
|
||||||
|
t.Error("expected truncation marker in user prompt")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_PreservesNoteInOutput(t *testing.T) {
|
||||||
|
big := strings.Repeat("w", 500_000)
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "base",
|
||||||
|
Patterns: big,
|
||||||
|
Diff: "small diff",
|
||||||
|
UserMeta: "meta",
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
if !strings.Contains(result.UserPrompt, "⚠️ Note: Context was trimmed") {
|
||||||
|
t.Error("expected trimming note in user prompt")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
func TestFit_HugeUserMeta(t *testing.T) {
|
||||||
|
// UserMeta so large that base alone exceeds limit
|
||||||
|
// Use a unique marker past the truncation point
|
||||||
|
hugeDesc := strings.Repeat("d", 5000) + "UNIQUE_MARKER_PAST_TRUNCATION" + strings.Repeat("d", 595_000)
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: "base",
|
||||||
|
Diff: "small diff",
|
||||||
|
UserMeta: hugeDesc,
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
limit := LimitForModel("gpt-4.1") - reserveTokens
|
||||||
|
if result.EstTokens > limit {
|
||||||
|
t.Errorf("EstTokens %d exceeds limit %d", result.EstTokens, limit)
|
||||||
|
}
|
||||||
|
// Content past truncation point should not be present
|
||||||
|
if strings.Contains(result.UserPrompt, "UNIQUE_MARKER_PAST_TRUNCATION") {
|
||||||
|
t.Error("expected UserMeta to be truncated but found content past truncation point")
|
||||||
|
}
|
||||||
|
// Truncation marker should be present
|
||||||
|
if !strings.Contains(result.UserPrompt, "[description truncated]") {
|
||||||
|
t.Error("expected truncation marker in output")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFit_NeverExceedsLimit(t *testing.T) {
|
||||||
|
// All sections huge — verify final tokens never exceed limit
|
||||||
|
big := strings.Repeat("a", 200_000)
|
||||||
|
s := Sections{
|
||||||
|
SystemBase: strings.Repeat("s", 8000),
|
||||||
|
Patterns: big,
|
||||||
|
Conventions: big,
|
||||||
|
FileContext: big,
|
||||||
|
Diff: big,
|
||||||
|
UserMeta: strings.Repeat("m", 8000),
|
||||||
|
}
|
||||||
|
result := Fit("gpt-4.1", s)
|
||||||
|
|
||||||
|
limit := LimitForModel("gpt-4.1") - reserveTokens
|
||||||
|
if result.EstTokens > limit {
|
||||||
|
t.Errorf("EstTokens %d exceeds limit %d (trimmed: %v)", result.EstTokens, limit, result.Trimmed)
|
||||||
|
}
|
||||||
|
}
|
||||||
+153
-10
@@ -6,10 +6,12 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/budget"
|
||||||
"gitea.weiker.me/rodin/review-bot/gitea"
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
"gitea.weiker.me/rodin/review-bot/llm"
|
"gitea.weiker.me/rodin/review-bot/llm"
|
||||||
"gitea.weiker.me/rodin/review-bot/review"
|
"gitea.weiker.me/rodin/review-bot/review"
|
||||||
@@ -18,6 +20,7 @@ import (
|
|||||||
var version = "dev"
|
var version = "dev"
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
versionFlag := flag.Bool("version", false, "Print version and exit")
|
||||||
// CLI flags
|
// CLI flags
|
||||||
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", ""), "Gitea instance URL")
|
giteaURL := flag.String("gitea-url", envOrDefault("GITEA_URL", ""), "Gitea instance URL")
|
||||||
repo := flag.String("repo", envOrDefault("GITEA_REPO", ""), "Repository (owner/name)")
|
repo := flag.String("repo", envOrDefault("GITEA_REPO", ""), "Repository (owner/name)")
|
||||||
@@ -28,14 +31,24 @@ func main() {
|
|||||||
llmAPIKey := flag.String("llm-api-key", envOrDefault("LLM_API_KEY", ""), "LLM API key")
|
llmAPIKey := flag.String("llm-api-key", envOrDefault("LLM_API_KEY", ""), "LLM API key")
|
||||||
llmModel := flag.String("llm-model", envOrDefault("LLM_MODEL", ""), "LLM model name")
|
llmModel := flag.String("llm-model", envOrDefault("LLM_MODEL", ""), "LLM model name")
|
||||||
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
||||||
|
systemPromptFile := flag.String("system-prompt-file", envOrDefault("SYSTEM_PROMPT_FILE", ""), "Local file with additional system prompt instructions")
|
||||||
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
||||||
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", "README.md"), "Comma-separated file paths to fetch from patterns repo")
|
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", "README.md"), "Comma-separated file paths to fetch from patterns repo")
|
||||||
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
||||||
|
updateExisting := flag.Bool("update-existing", envOrDefaultBool("UPDATE_EXISTING", true), "Delete previous review from same bot before posting (default true)")
|
||||||
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
||||||
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
||||||
|
llmProvider := flag.String("llm-provider", envOrDefault("LLM_PROVIDER", "openai"), "LLM API provider: openai or anthropic")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
|
if *versionFlag {
|
||||||
|
fmt.Printf("review-bot %s\n", version)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Printf("review-bot %s", version)
|
||||||
|
|
||||||
// Validate required fields
|
// Validate required fields
|
||||||
if *giteaURL == "" || *repo == "" || *prNum == "" || *reviewerToken == "" ||
|
if *giteaURL == "" || *repo == "" || *prNum == "" || *reviewerToken == "" ||
|
||||||
*llmBaseURL == "" || *llmAPIKey == "" || *llmModel == "" {
|
*llmBaseURL == "" || *llmAPIKey == "" || *llmModel == "" {
|
||||||
@@ -44,6 +57,11 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate reviewer-name: only safe characters allowed in sentinel
|
||||||
|
if err := validateReviewerName(*reviewerName); err != nil {
|
||||||
|
log.Fatalf("%v", err)
|
||||||
|
}
|
||||||
|
|
||||||
// Parse repo owner/name
|
// Parse repo owner/name
|
||||||
parts := strings.SplitN(*repo, "/", 2)
|
parts := strings.SplitN(*repo, "/", 2)
|
||||||
if len(parts) != 2 {
|
if len(parts) != 2 {
|
||||||
@@ -66,6 +84,12 @@ func main() {
|
|||||||
if *llmTemp > 0 {
|
if *llmTemp > 0 {
|
||||||
llmClient.WithTemperature(*llmTemp)
|
llmClient.WithTemperature(*llmTemp)
|
||||||
}
|
}
|
||||||
|
switch llm.Provider(*llmProvider) {
|
||||||
|
case llm.ProviderOpenAI, llm.ProviderAnthropic:
|
||||||
|
llmClient.WithProvider(llm.Provider(*llmProvider))
|
||||||
|
default:
|
||||||
|
log.Fatalf("Invalid --llm-provider %q, must be openai or anthropic", *llmProvider)
|
||||||
|
}
|
||||||
if *llmTimeout > 0 {
|
if *llmTimeout > 0 {
|
||||||
llmClient.WithTimeout(time.Duration(*llmTimeout) * time.Second)
|
llmClient.WithTimeout(time.Duration(*llmTimeout) * time.Second)
|
||||||
}
|
}
|
||||||
@@ -133,15 +157,62 @@ func main() {
|
|||||||
log.Printf("Loaded patterns from %s (%d bytes)", *patternsRepo, len(patterns))
|
log.Printf("Loaded patterns from %s (%d bytes)", *patternsRepo, len(patterns))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Step 7: Build prompts
|
// Step 6b: Load additional system prompt if specified
|
||||||
systemPrompt := review.BuildSystemPrompt(conventions, patterns)
|
additionalPrompt := ""
|
||||||
userPrompt := review.BuildUserPrompt(pr.Title, pr.Body, diff, fileContext, ciPassed, ciDetails)
|
if *systemPromptFile != "" {
|
||||||
|
workspace := os.Getenv("GITHUB_WORKSPACE")
|
||||||
|
if workspace == "" {
|
||||||
|
workspace, _ = os.Getwd()
|
||||||
|
}
|
||||||
|
absWorkspace, err := filepath.Abs(workspace)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("Failed to resolve workspace path: %v", err)
|
||||||
|
}
|
||||||
|
promptPath := filepath.Join(absWorkspace, *systemPromptFile)
|
||||||
|
promptPath = filepath.Clean(promptPath)
|
||||||
|
if !strings.HasPrefix(promptPath, absWorkspace+string(filepath.Separator)) && promptPath != absWorkspace {
|
||||||
|
log.Fatalf("system-prompt-file resolves outside workspace (got %q, workspace %q)", promptPath, absWorkspace)
|
||||||
|
}
|
||||||
|
// Resolve symlinks and re-validate to prevent symlink traversal
|
||||||
|
resolvedPath, err := filepath.EvalSymlinks(promptPath)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("Failed to resolve system prompt file %q: %v", promptPath, err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(resolvedPath, absWorkspace+string(filepath.Separator)) && resolvedPath != absWorkspace {
|
||||||
|
log.Fatalf("system-prompt-file symlink resolves outside workspace (got %q, workspace %q)", resolvedPath, absWorkspace)
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(resolvedPath)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("Failed to read system prompt file %q: %v", promptPath, err)
|
||||||
|
}
|
||||||
|
additionalPrompt = string(data)
|
||||||
|
log.Printf("Loaded system prompt file: %s (%d bytes)", *systemPromptFile, len(additionalPrompt))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 7: Budget-aware prompt assembly
|
||||||
|
systemBase := review.BuildSystemBase()
|
||||||
|
if additionalPrompt != "" {
|
||||||
|
systemBase += "\n\n## Additional Review Instructions\n\n" + additionalPrompt
|
||||||
|
}
|
||||||
|
sections := budget.Sections{
|
||||||
|
SystemBase: systemBase,
|
||||||
|
Patterns: patterns,
|
||||||
|
Conventions: conventions,
|
||||||
|
FileContext: fileContext,
|
||||||
|
Diff: diff,
|
||||||
|
UserMeta: review.BuildUserMeta(pr.Title, pr.Body, ciPassed, ciDetails),
|
||||||
|
}
|
||||||
|
budgetResult := budget.Fit(*llmModel, sections)
|
||||||
|
log.Printf("Token estimate: ~%dK (limit: %dK)", budgetResult.EstTokens/1000, budget.LimitForModel(*llmModel)/1000)
|
||||||
|
if len(budgetResult.Trimmed) > 0 {
|
||||||
|
log.Printf("Context trimmed: %v", budgetResult.Trimmed)
|
||||||
|
}
|
||||||
|
|
||||||
// Step 8: Call LLM
|
// Step 8: Call LLM
|
||||||
log.Printf("Sending to LLM (%s)...", *llmModel)
|
log.Printf("Sending to LLM (%s)...", *llmModel)
|
||||||
messages := []llm.Message{
|
messages := []llm.Message{
|
||||||
{Role: "system", Content: systemPrompt},
|
{Role: "system", Content: budgetResult.SystemPrompt},
|
||||||
{Role: "user", Content: userPrompt},
|
{Role: "user", Content: budgetResult.UserPrompt},
|
||||||
}
|
}
|
||||||
|
|
||||||
response, err := llmClient.Complete(ctx, messages)
|
response, err := llmClient.Complete(ctx, messages)
|
||||||
@@ -168,11 +239,49 @@ func main() {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
sentinel := fmt.Sprintf("<!-- review-bot:%s -->", *reviewerName)
|
||||||
|
|
||||||
log.Printf("Posting review (event=%s)...", event)
|
log.Printf("Posting review (event=%s)...", event)
|
||||||
if err := giteaClient.PostReview(ctx, owner, repoName, prNumber, event, reviewBody); err != nil {
|
posted, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, event, reviewBody)
|
||||||
|
if err != nil {
|
||||||
log.Fatalf("Failed to post review: %v", err)
|
log.Fatalf("Failed to post review: %v", err)
|
||||||
}
|
}
|
||||||
log.Printf("Review posted successfully!")
|
log.Printf("Review posted (id=%d, user=%s)", posted.ID, posted.User.Login)
|
||||||
|
|
||||||
|
// Delete stale reviews from this bot using sentinel matching
|
||||||
|
if *updateExisting && *reviewerName != "" {
|
||||||
|
reviews, err := giteaClient.ListReviews(ctx, owner, repoName, prNumber)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("Warning: could not list existing reviews: %v", err)
|
||||||
|
} else {
|
||||||
|
for _, r := range reviews {
|
||||||
|
if r.ID != posted.ID && r.User.Login == posted.User.Login && strings.Contains(r.Body, sentinel) {
|
||||||
|
if err := giteaClient.DeleteReview(ctx, owner, repoName, prNumber, r.ID); err != nil {
|
||||||
|
log.Printf("Warning: could not delete old review %d: %v", r.ID, err)
|
||||||
|
} else {
|
||||||
|
log.Printf("Deleted stale review %d", r.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Worst-wins: if we posted APPROVE but a sibling review from the
|
||||||
|
// same user (same token, different role) has REQUEST_CHANGES,
|
||||||
|
// delete ours and re-post as REQUEST_CHANGES to maintain the block.
|
||||||
|
if event == "APPROVED" && shouldEscalate(reviews, posted.ID, posted.User.Login, sentinel) {
|
||||||
|
log.Printf("Sibling review has REQUEST_CHANGES; escalating")
|
||||||
|
if err := giteaClient.DeleteReview(ctx, owner, repoName, prNumber, posted.ID); err != nil {
|
||||||
|
log.Printf("Warning: could not delete review for escalation: %v", err)
|
||||||
|
} else {
|
||||||
|
_, err := giteaClient.PostReview(ctx, owner, repoName, prNumber, "REQUEST_CHANGES", reviewBody)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("Warning: could not re-post as REQUEST_CHANGES: %v", err)
|
||||||
|
} else {
|
||||||
|
log.Printf("Review escalated to REQUEST_CHANGES")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// fetchFileContext fetches the full content of modified files from the PR branch.
|
// fetchFileContext fetches the full content of modified files from the PR branch.
|
||||||
@@ -235,12 +344,12 @@ func fetchPatterns(ctx context.Context, client *gitea.Client, patternsRepo, patt
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
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) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
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))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -306,3 +415,37 @@ func envOrDefaultInt(key string, defaultVal int) int {
|
|||||||
}
|
}
|
||||||
return defaultVal
|
return defaultVal
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func envOrDefaultBool(key string, defaultVal bool) bool {
|
||||||
|
v := strings.TrimSpace(strings.ToLower(os.Getenv(key)))
|
||||||
|
if v == "" {
|
||||||
|
return defaultVal
|
||||||
|
}
|
||||||
|
return v == "true" || v == "1" || v == "yes"
|
||||||
|
}
|
||||||
|
|
||||||
|
// validateReviewerName checks that the name contains only safe characters
|
||||||
|
// for embedding in an HTML comment sentinel ([a-zA-Z0-9_-]).
|
||||||
|
func validateReviewerName(name string) error {
|
||||||
|
if name == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for _, ch := range name {
|
||||||
|
if !((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') || (ch >= '0' && ch <= '9') || ch == '-' || ch == '_') {
|
||||||
|
return fmt.Errorf("reviewer-name must contain only [a-zA-Z0-9_-] (got %q)", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// shouldEscalate checks if the current APPROVED review should be escalated
|
||||||
|
// to REQUEST_CHANGES because a sibling bot review (same user, different role)
|
||||||
|
// already has REQUEST_CHANGES.
|
||||||
|
func shouldEscalate(reviews []gitea.Review, postedID int64, postedLogin, ownSentinel string) bool {
|
||||||
|
for _, r := range reviews {
|
||||||
|
if r.ID != postedID && !r.Stale && r.User.Login == postedLogin && r.State == "REQUEST_CHANGES" && strings.Contains(r.Body, "<!-- review-bot:") && !strings.Contains(r.Body, ownSentinel) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,150 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/gitea"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestValidateReviewerName(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{"valid simple", "sonnet", false},
|
||||||
|
{"valid with dash", "code-review", false},
|
||||||
|
{"valid with underscore", "my_bot", false},
|
||||||
|
{"valid alphanumeric", "bot123", false},
|
||||||
|
{"valid uppercase", "MyBot", false},
|
||||||
|
{"empty is valid", "", false},
|
||||||
|
{"invalid html close", "foo-->", true},
|
||||||
|
{"invalid space", "my bot", true},
|
||||||
|
{"invalid dot", "my.bot", true},
|
||||||
|
{"invalid slash", "my/bot", true},
|
||||||
|
{"invalid angle", "bot<script>", true},
|
||||||
|
{"invalid colon", "bot:name", true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
err := validateReviewerName(tc.input)
|
||||||
|
if tc.wantErr && err == nil {
|
||||||
|
t.Errorf("expected error for %q, got nil", tc.input)
|
||||||
|
}
|
||||||
|
if !tc.wantErr && err != nil {
|
||||||
|
t.Errorf("expected no error for %q, got %v", tc.input, err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeReview(id int64, login, state string, stale bool, body string) gitea.Review {
|
||||||
|
r := gitea.Review{
|
||||||
|
ID: id,
|
||||||
|
Body: body,
|
||||||
|
State: state,
|
||||||
|
Stale: stale,
|
||||||
|
}
|
||||||
|
r.User.Login = login
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestShouldEscalate(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
reviews []gitea.Review
|
||||||
|
postedID int64
|
||||||
|
postedLogin string
|
||||||
|
ownSentinel string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "no reviews",
|
||||||
|
reviews: nil,
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "sibling same user has REQUEST_CHANGES",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "bot", "REQUEST_CHANGES", false, "bad\n<!-- review-bot:security -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "sibling different user has REQUEST_CHANGES (should NOT escalate)",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "other-bot", "REQUEST_CHANGES", false, "bad\n<!-- review-bot:gpt -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "same user REQUEST_CHANGES but stale (should NOT escalate)",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "bot", "REQUEST_CHANGES", true, "old\n<!-- review-bot:security -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "same user same sentinel (own stale review, should NOT escalate)",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "bot", "REQUEST_CHANGES", false, "old\n<!-- review-bot:sonnet -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "same user APPROVED sibling (should NOT escalate)",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "bot", "APPROVED", false, "good\n<!-- review-bot:security -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "human REQUEST_CHANGES no sentinel (should NOT escalate)",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(101, "bot", "REQUEST_CHANGES", false, "please fix this"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "skip own posted ID",
|
||||||
|
reviews: []gitea.Review{
|
||||||
|
makeReview(100, "bot", "REQUEST_CHANGES", false, "x\n<!-- review-bot:security -->"),
|
||||||
|
},
|
||||||
|
postedID: 100,
|
||||||
|
postedLogin: "bot",
|
||||||
|
ownSentinel: "<!-- review-bot:sonnet -->",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
got := shouldEscalate(tc.reviews, tc.postedID, tc.postedLogin, tc.ownSentinel)
|
||||||
|
if got != tc.want {
|
||||||
|
t.Errorf("shouldEscalate() = %v, want %v", got, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+124
-25
@@ -1,3 +1,6 @@
|
|||||||
|
// Package gitea provides a client for the Gitea API.
|
||||||
|
// It supports pull request operations, file content retrieval,
|
||||||
|
// and review submission.
|
||||||
package gitea
|
package gitea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -8,6 +11,7 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"log"
|
"log"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
@@ -55,8 +59,8 @@ type ChangedFile struct {
|
|||||||
|
|
||||||
// GetPullRequest fetches PR metadata.
|
// GetPullRequest fetches PR metadata.
|
||||||
func (c *Client) GetPullRequest(ctx context.Context, owner, repo string, number int) (*PullRequest, error) {
|
func (c *Client) GetPullRequest(ctx context.Context, owner, repo string, number int) (*PullRequest, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d", c.baseURL, owner, repo, number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d", c.baseURL, owner, repo, number)
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("fetch PR: %w", err)
|
return nil, fmt.Errorf("fetch PR: %w", err)
|
||||||
}
|
}
|
||||||
@@ -69,8 +73,8 @@ func (c *Client) GetPullRequest(ctx context.Context, owner, repo string, number
|
|||||||
|
|
||||||
// GetPullRequestDiff fetches the unified diff for a PR.
|
// GetPullRequestDiff fetches the unified diff for a PR.
|
||||||
func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, number int) (string, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d.diff", c.baseURL, owner, repo, number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d.diff", c.baseURL, owner, repo, number)
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetch diff: %w", err)
|
return "", fmt.Errorf("fetch diff: %w", err)
|
||||||
}
|
}
|
||||||
@@ -79,8 +83,8 @@ func (c *Client) GetPullRequestDiff(ctx context.Context, owner, repo string, num
|
|||||||
|
|
||||||
// GetPullRequestFiles fetches the list of files changed in a PR.
|
// GetPullRequestFiles fetches the list of files changed in a PR.
|
||||||
func (c *Client) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]ChangedFile, error) {
|
func (c *Client) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]ChangedFile, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/files", c.baseURL, owner, repo, number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/files", c.baseURL, owner, repo, number)
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("fetch PR files: %w", err)
|
return nil, fmt.Errorf("fetch PR files: %w", err)
|
||||||
}
|
}
|
||||||
@@ -93,8 +97,8 @@ func (c *Client) GetPullRequestFiles(ctx context.Context, owner, repo string, nu
|
|||||||
|
|
||||||
// GetCommitStatuses fetches CI statuses for a commit SHA.
|
// GetCommitStatuses fetches CI statuses for a commit SHA.
|
||||||
func (c *Client) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]CommitStatus, error) {
|
func (c *Client) GetCommitStatuses(ctx context.Context, owner, repo, sha string) ([]CommitStatus, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/commits/%s/statuses", c.baseURL, owner, repo, sha)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/commits/%s/statuses", c.baseURL, owner, repo, sha)
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("fetch commit statuses: %w", err)
|
return nil, fmt.Errorf("fetch commit statuses: %w", err)
|
||||||
}
|
}
|
||||||
@@ -107,8 +111,8 @@ func (c *Client) GetCommitStatuses(ctx context.Context, owner, repo, sha string)
|
|||||||
|
|
||||||
// GetFileContent fetches a file from the default branch of a repo.
|
// GetFileContent fetches a file from the default branch of a repo.
|
||||||
func (c *Client) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
func (c *Client) GetFileContent(ctx context.Context, owner, repo, filepath string) (string, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/raw/%s", c.baseURL, owner, repo, filepath)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/raw/%s", c.baseURL, owner, repo, escapePath(filepath))
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetch file %s: %w", filepath, err)
|
return "", fmt.Errorf("fetch file %s: %w", filepath, err)
|
||||||
}
|
}
|
||||||
@@ -117,18 +121,18 @@ func (c *Client) GetFileContent(ctx context.Context, owner, repo, filepath strin
|
|||||||
|
|
||||||
// GetFileContentRef fetches a file from a specific ref (branch/tag/sha) in a repo.
|
// GetFileContentRef fetches a file from a specific ref (branch/tag/sha) in a repo.
|
||||||
func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
func (c *Client) GetFileContentRef(ctx context.Context, owner, repo, filepath, ref string) (string, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/raw/%s?ref=%s", c.baseURL, owner, repo, filepath, ref)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/raw/%s?ref=%s", c.baseURL, owner, repo, escapePath(filepath), url.QueryEscape(ref))
|
||||||
body, err := c.doGet(ctx, url)
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("fetch file %s@%s: %w", filepath, ref, err)
|
return "", fmt.Errorf("fetch file %s@%s: %w", filepath, ref, err)
|
||||||
}
|
}
|
||||||
return string(body), nil
|
return string(body), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PostReview submits a review to a PR.
|
// PostReview submits a review to a PR and returns the created review.
|
||||||
// event should be "APPROVED" or "REQUEST_CHANGES".
|
// event should be "APPROVED" or "REQUEST_CHANGES".
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body string) error {
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, event, body string) (*Review, error) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, owner, repo, number)
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews", c.baseURL, owner, repo, number)
|
||||||
|
|
||||||
payload := struct {
|
payload := struct {
|
||||||
Body string `json:"body"`
|
Body string `json:"body"`
|
||||||
@@ -140,31 +144,40 @@ func (c *Client) PostReview(ctx context.Context, owner, repo string, number int,
|
|||||||
|
|
||||||
data, err := json.Marshal(payload)
|
data, err := json.Marshal(payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("marshal review payload: %w", err)
|
return nil, fmt.Errorf("marshal review payload: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, "POST", url, bytes.NewReader(data))
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqURL, bytes.NewReader(data))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("create review request: %w", err)
|
return nil, fmt.Errorf("create review request: %w", err)
|
||||||
}
|
}
|
||||||
req.Header.Set("Authorization", "token "+c.token)
|
req.Header.Set("Authorization", "token "+c.token)
|
||||||
req.Header.Set("Content-Type", "application/json")
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
resp, err := c.http.Do(req)
|
resp, err := c.http.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("post review: %w", err)
|
return nil, fmt.Errorf("post review: %w", err)
|
||||||
}
|
}
|
||||||
defer resp.Body.Close()
|
defer resp.Body.Close()
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
respBody, _ := io.ReadAll(resp.Body)
|
respBody, _ := io.ReadAll(resp.Body)
|
||||||
return fmt.Errorf("post review failed (status %d): %s", resp.StatusCode, string(respBody))
|
return nil, fmt.Errorf("post review failed (status %d): %s", resp.StatusCode, string(respBody))
|
||||||
}
|
}
|
||||||
return nil
|
|
||||||
|
respBody, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("read review response: %w", err)
|
||||||
|
}
|
||||||
|
var review Review
|
||||||
|
if err := json.Unmarshal(respBody, &review); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse review response: %w", err)
|
||||||
|
}
|
||||||
|
return &review, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) doGet(ctx context.Context, url string) ([]byte, error) {
|
func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
||||||
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -183,6 +196,18 @@ func (c *Client) doGet(ctx context.Context, url string) ([]byte, error) {
|
|||||||
return io.ReadAll(resp.Body)
|
return io.ReadAll(resp.Body)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// escapePath escapes each segment of a relative file path for use in URLs.
|
||||||
|
// Slashes are preserved as path separators; other special characters are escaped.
|
||||||
|
// Input should be a relative path (no leading slash). Already-encoded segments
|
||||||
|
// will be double-encoded, which is the desired behavior for user-provided paths.
|
||||||
|
func escapePath(p string) string {
|
||||||
|
parts := strings.Split(p, "/")
|
||||||
|
for i, part := range parts {
|
||||||
|
parts[i] = url.PathEscape(part)
|
||||||
|
}
|
||||||
|
return strings.Join(parts, "/")
|
||||||
|
}
|
||||||
|
|
||||||
// ContentEntry represents a file or directory entry from the contents API.
|
// ContentEntry represents a file or directory entry from the contents API.
|
||||||
type ContentEntry struct {
|
type ContentEntry struct {
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
@@ -191,9 +216,15 @@ 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.
|
||||||
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) {
|
||||||
url := fmt.Sprintf("%s/api/v1/repos/%s/%s/contents/%s", c.baseURL, owner, repo, path)
|
var reqURL string
|
||||||
body, err := c.doGet(ctx, url)
|
if path == "" {
|
||||||
|
reqURL = fmt.Sprintf("%s/api/v1/repos/%s/%s/contents", c.baseURL, owner, repo)
|
||||||
|
} else {
|
||||||
|
reqURL = fmt.Sprintf("%s/api/v1/repos/%s/%s/contents/%s", c.baseURL, owner, repo, escapePath(path))
|
||||||
|
}
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("list contents %s: %w", path, err)
|
return nil, fmt.Errorf("list contents %s: %w", path, err)
|
||||||
}
|
}
|
||||||
@@ -244,3 +275,71 @@ func (c *Client) GetAllFilesInPath(ctx context.Context, owner, repo, path string
|
|||||||
}
|
}
|
||||||
return results, nil
|
return results, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Review represents a pull request review from the Gitea API.
|
||||||
|
type Review struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
User struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
} `json:"user"`
|
||||||
|
State string `json:"state"`
|
||||||
|
Stale bool `json:"stale"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListReviews returns all reviews on a pull request.
|
||||||
|
// Paginates through all pages to ensure no reviews are missed.
|
||||||
|
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]Review, error) {
|
||||||
|
const pageSize = 50
|
||||||
|
var all []Review
|
||||||
|
for page := 1; ; page++ {
|
||||||
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews?limit=%d&page=%d",
|
||||||
|
c.baseURL,
|
||||||
|
url.PathEscape(owner),
|
||||||
|
url.PathEscape(repo),
|
||||||
|
number,
|
||||||
|
pageSize,
|
||||||
|
page)
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("list reviews (page %d): %w", page, err)
|
||||||
|
}
|
||||||
|
var batch []Review
|
||||||
|
if err := json.Unmarshal(body, &batch); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse reviews (page %d): %w", page, err)
|
||||||
|
}
|
||||||
|
all = append(all, batch...)
|
||||||
|
if len(batch) < pageSize {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return all, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteReview deletes a review by ID. The token must belong to the review author.
|
||||||
|
func (c *Client) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
||||||
|
reqURL := fmt.Sprintf("%s/api/v1/repos/%s/%s/pulls/%d/reviews/%d",
|
||||||
|
c.baseURL,
|
||||||
|
url.PathEscape(owner),
|
||||||
|
url.PathEscape(repo),
|
||||||
|
number,
|
||||||
|
reviewID)
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, reqURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("create delete request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "token "+c.token)
|
||||||
|
|
||||||
|
resp, err := c.http.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("delete review: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
|
respBody, _ := io.ReadAll(resp.Body)
|
||||||
|
return fmt.Errorf("delete review failed (status %d): %s", resp.StatusCode, string(respBody))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|||||||
+135
-3
@@ -123,15 +123,21 @@ func TestPostReview(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
w.Write([]byte(`{}`))
|
w.Write([]byte(`{"id":100,"user":{"login":"review-bot"},"state":"APPROVED","stale":false}`))
|
||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM")
|
review, err := client.PostReview(context.Background(), "owner", "repo", 3, "APPROVED", "LGTM")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error: %v", err)
|
t.Fatalf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
|
if review.ID != 100 {
|
||||||
|
t.Errorf("expected review ID 100, got %d", review.ID)
|
||||||
|
}
|
||||||
|
if review.User.Login != "review-bot" {
|
||||||
|
t.Errorf("expected user login %q, got %q", "review-bot", review.User.Login)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetPullRequest_Non200(t *testing.T) {
|
func TestGetPullRequest_Non200(t *testing.T) {
|
||||||
@@ -169,7 +175,7 @@ func TestPostReview_Non200(t *testing.T) {
|
|||||||
defer server.Close()
|
defer server.Close()
|
||||||
|
|
||||||
client := NewClient(server.URL, "test-token")
|
client := NewClient(server.URL, "test-token")
|
||||||
err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test")
|
_, err := client.PostReview(context.Background(), "owner", "repo", 1, "APPROVED", "test")
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("expected error for 403, got nil")
|
t.Fatal("expected error for 403, got nil")
|
||||||
}
|
}
|
||||||
@@ -294,3 +300,129 @@ func TestGetAllFilesInPath_File(t *testing.T) {
|
|||||||
t.Errorf("unexpected content: %q", files["README.md"])
|
t.Errorf("unexpected content: %q", files["README.md"])
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestEscapePath(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"simple", "src/main.go", "src/main.go"},
|
||||||
|
{"spaces", "my dir/my file.go", "my%20dir/my%20file.go"},
|
||||||
|
{"special chars", "path/file#1.txt", "path/file%231.txt"},
|
||||||
|
{"empty", "", ""},
|
||||||
|
{"single segment", "README.md", "README.md"},
|
||||||
|
{"nested deep", "a/b/c/d.md", "a/b/c/d.md"},
|
||||||
|
{"already encoded", "path/file%20name.go", "path/file%2520name.go"},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := escapePath(tt.input)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("escapePath(%q) = %q, want %q", tt.input, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews(t *testing.T) {
|
||||||
|
pageCount := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path != "/api/v1/repos/owner/repo/pulls/5/reviews" {
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
if r.URL.Query().Get("limit") != "50" {
|
||||||
|
t.Errorf("expected limit=50, got %s", r.URL.Query().Get("limit"))
|
||||||
|
}
|
||||||
|
pageCount++
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
// Return 2 results (less than page size) to signal end
|
||||||
|
w.Write([]byte(`[{"id":10,"user":{"login":"bot-a"},"state":"APPROVED","stale":false},{"id":11,"user":{"login":"bot-b"},"state":"REQUEST_CHANGES","stale":true}]`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 2 {
|
||||||
|
t.Fatalf("expected 2 reviews, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
if reviews[0].User.Login != "bot-a" {
|
||||||
|
t.Errorf("expected bot-a, got %s", reviews[0].User.Login)
|
||||||
|
}
|
||||||
|
if pageCount != 1 {
|
||||||
|
t.Errorf("expected 1 page fetch (results < page size), got %d", pageCount)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_Pagination(t *testing.T) {
|
||||||
|
pageCount := 0
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
pageCount++
|
||||||
|
page := r.URL.Query().Get("page")
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
if page == "1" {
|
||||||
|
// Return exactly 50 items to trigger next page fetch
|
||||||
|
items := "["
|
||||||
|
for i := 0; i < 50; i++ {
|
||||||
|
if i > 0 {
|
||||||
|
items += ","
|
||||||
|
}
|
||||||
|
items += fmt.Sprintf(`{"id":%d,"user":{"login":"bot"},"state":"APPROVED","stale":false}`, i+1)
|
||||||
|
}
|
||||||
|
items += "]"
|
||||||
|
w.Write([]byte(items))
|
||||||
|
} else {
|
||||||
|
// Page 2: return fewer than 50 to signal end
|
||||||
|
w.Write([]byte(`[{"id":51,"user":{"login":"bot"},"state":"APPROVED","stale":false}]`))
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
reviews, err := client.ListReviews(context.Background(), "owner", "repo", 5)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 51 {
|
||||||
|
t.Fatalf("expected 51 reviews across 2 pages, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
if pageCount != 2 {
|
||||||
|
t.Errorf("expected 2 page fetches, got %d", pageCount)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeleteReview(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path != "/api/v1/repos/owner/repo/pulls/5/reviews/10" {
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
if r.Method != "DELETE" {
|
||||||
|
t.Errorf("expected DELETE, got %s", r.Method)
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeleteReview_Forbidden(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusForbidden)
|
||||||
|
w.Write([]byte(`{"message":"forbidden"}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-token")
|
||||||
|
err := client.DeleteReview(context.Background(), "owner", "repo", 5, 10)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 403, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+148
-25
@@ -1,3 +1,6 @@
|
|||||||
|
// Package llm provides clients for LLM chat completion APIs.
|
||||||
|
//
|
||||||
|
// Supports OpenAI-compatible (default) and Anthropic Messages API providers.
|
||||||
package llm
|
package llm
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -11,24 +14,37 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Client calls an OpenAI-compatible chat completion API.
|
// Provider identifies which API format to use.
|
||||||
|
type Provider string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ProviderOpenAI uses the OpenAI-compatible chat/completions endpoint.
|
||||||
|
ProviderOpenAI Provider = "openai"
|
||||||
|
// ProviderAnthropic uses the Anthropic Messages API endpoint.
|
||||||
|
ProviderAnthropic Provider = "anthropic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Client calls an LLM chat completion API.
|
||||||
// A Client is safe for concurrent use by multiple goroutines after construction.
|
// A Client is safe for concurrent use by multiple goroutines after construction.
|
||||||
// WithTimeout and WithTemperature must be called during setup, before concurrent use.
|
// WithTimeout, WithTemperature, and WithProvider must be called during setup,
|
||||||
|
// before concurrent use.
|
||||||
type Client struct {
|
type Client struct {
|
||||||
baseURL string
|
baseURL string
|
||||||
apiKey string
|
apiKey string
|
||||||
model string
|
model string
|
||||||
temperature float64
|
temperature float64
|
||||||
|
provider Provider
|
||||||
http *http.Client
|
http *http.Client
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewClient creates a new LLM client.
|
// NewClient creates a new LLM client. Default provider is OpenAI-compatible.
|
||||||
func NewClient(baseURL, apiKey, model string) *Client {
|
func NewClient(baseURL, apiKey, model string) *Client {
|
||||||
return &Client{
|
return &Client{
|
||||||
baseURL: strings.TrimRight(baseURL, "/"),
|
baseURL: strings.TrimRight(baseURL, "/"),
|
||||||
apiKey: apiKey,
|
apiKey: apiKey,
|
||||||
model: model,
|
model: model,
|
||||||
http: &http.Client{Timeout: 5 * time.Minute},
|
provider: ProviderOpenAI,
|
||||||
|
http: &http.Client{Timeout: 5 * time.Minute},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -44,20 +60,39 @@ func (c *Client) WithTemperature(t float64) *Client {
|
|||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithProvider sets the API provider format (openai or anthropic).
|
||||||
|
func (c *Client) WithProvider(p Provider) *Client {
|
||||||
|
c.provider = p
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
// Message represents a chat message.
|
// Message represents a chat message.
|
||||||
type Message struct {
|
type Message struct {
|
||||||
Role string `json:"role"`
|
Role string `json:"role"`
|
||||||
Content string `json:"content"`
|
Content string `json:"content"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChatRequest is the request payload.
|
// Complete sends a chat completion request and returns the assistant's response content.
|
||||||
|
// The first message with role "system" is treated as the system prompt.
|
||||||
|
func (c *Client) Complete(ctx context.Context, messages []Message) (string, error) {
|
||||||
|
switch c.provider {
|
||||||
|
case ProviderAnthropic:
|
||||||
|
return c.completeAnthropic(ctx, messages)
|
||||||
|
default:
|
||||||
|
return c.completeOpenAI(ctx, messages)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- OpenAI-compatible implementation ---
|
||||||
|
|
||||||
|
// ChatRequest is the OpenAI request payload.
|
||||||
type ChatRequest struct {
|
type ChatRequest struct {
|
||||||
Model string `json:"model"`
|
Model string `json:"model"`
|
||||||
Messages []Message `json:"messages"`
|
Messages []Message `json:"messages"`
|
||||||
Temperature float64 `json:"temperature,omitempty"`
|
Temperature float64 `json:"temperature,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChatResponse is the response from the API.
|
// ChatResponse is the OpenAI response.
|
||||||
type ChatResponse struct {
|
type ChatResponse struct {
|
||||||
Choices []struct {
|
Choices []struct {
|
||||||
Message struct {
|
Message struct {
|
||||||
@@ -66,8 +101,7 @@ type ChatResponse struct {
|
|||||||
} `json:"choices"`
|
} `json:"choices"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Complete sends a chat completion request and returns the assistant's response content.
|
func (c *Client) completeOpenAI(ctx context.Context, messages []Message) (string, error) {
|
||||||
func (c *Client) Complete(ctx context.Context, messages []Message) (string, error) {
|
|
||||||
reqBody := ChatRequest{
|
reqBody := ChatRequest{
|
||||||
Model: c.model,
|
Model: c.model,
|
||||||
Temperature: c.temperature,
|
Temperature: c.temperature,
|
||||||
@@ -80,37 +114,126 @@ func (c *Client) Complete(ctx context.Context, messages []Message) (string, erro
|
|||||||
}
|
}
|
||||||
|
|
||||||
url := c.baseURL + "/chat/completions"
|
url := c.baseURL + "/chat/completions"
|
||||||
req, err := http.NewRequestWithContext(ctx, "POST", url, bytes.NewReader(data))
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(data))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("create request: %w", err)
|
return "", fmt.Errorf("create request: %w", err)
|
||||||
}
|
}
|
||||||
req.Header.Set("Authorization", "Bearer "+c.apiKey)
|
req.Header.Set("Authorization", "Bearer "+c.apiKey)
|
||||||
req.Header.Set("Content-Type", "application/json")
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
return c.doRequest(req, func(body []byte) (string, error) {
|
||||||
|
var resp ChatResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse response: %w", err)
|
||||||
|
}
|
||||||
|
if len(resp.Choices) == 0 {
|
||||||
|
return "", fmt.Errorf("no choices in LLM response")
|
||||||
|
}
|
||||||
|
return resp.Choices[0].Message.Content, nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Anthropic Messages API implementation ---
|
||||||
|
|
||||||
|
type anthropicRequest struct {
|
||||||
|
Model string `json:"model"`
|
||||||
|
MaxTokens int `json:"max_tokens"`
|
||||||
|
System string `json:"system,omitempty"`
|
||||||
|
Messages []anthropicMsg `json:"messages"`
|
||||||
|
Temperature float64 `json:"temperature,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type anthropicMsg struct {
|
||||||
|
Role string `json:"role"`
|
||||||
|
Content string `json:"content"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type anthropicResponse struct {
|
||||||
|
Content []struct {
|
||||||
|
Type string `json:"type"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
} `json:"content"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) completeAnthropic(ctx context.Context, messages []Message) (string, error) {
|
||||||
|
// Extract system message (first message with role "system")
|
||||||
|
var system string
|
||||||
|
var userMessages []anthropicMsg
|
||||||
|
for _, m := range messages {
|
||||||
|
if m.Role == "system" {
|
||||||
|
system = m.Content
|
||||||
|
} else {
|
||||||
|
userMessages = append(userMessages, anthropicMsg{
|
||||||
|
Role: m.Role,
|
||||||
|
Content: m.Content,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
reqBody := anthropicRequest{
|
||||||
|
Model: c.model,
|
||||||
|
MaxTokens: 8192,
|
||||||
|
System: system,
|
||||||
|
Messages: userMessages,
|
||||||
|
}
|
||||||
|
if c.temperature > 0 {
|
||||||
|
reqBody.Temperature = c.temperature
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(reqBody)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("marshal request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
url := c.baseURL + "/messages"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(data))
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("create request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("x-api-key", c.apiKey)
|
||||||
|
req.Header.Set("anthropic-version", "2023-06-01")
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
return c.doRequest(req, func(body []byte) (string, error) {
|
||||||
|
var resp anthropicResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse response: %w", err)
|
||||||
|
}
|
||||||
|
if len(resp.Content) == 0 {
|
||||||
|
return "", fmt.Errorf("no content in Anthropic response")
|
||||||
|
}
|
||||||
|
// Concatenate all text blocks
|
||||||
|
var sb strings.Builder
|
||||||
|
for _, block := range resp.Content {
|
||||||
|
if block.Type == "text" {
|
||||||
|
sb.WriteString(block.Text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result := sb.String()
|
||||||
|
if result == "" {
|
||||||
|
return "", fmt.Errorf("no text content in Anthropic response")
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Shared HTTP execution ---
|
||||||
|
|
||||||
|
func (c *Client) doRequest(req *http.Request, parse func([]byte) (string, error)) (string, error) {
|
||||||
resp, err := c.http.Do(req)
|
resp, err := c.http.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("LLM request: %w", err)
|
return "", fmt.Errorf("LLM request: %w", err)
|
||||||
}
|
}
|
||||||
defer resp.Body.Close()
|
defer resp.Body.Close()
|
||||||
|
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
|
||||||
body, _ := io.ReadAll(resp.Body)
|
|
||||||
return "", fmt.Errorf("LLM API error (status %d): %s", resp.StatusCode, string(body))
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := io.ReadAll(resp.Body)
|
body, err := io.ReadAll(resp.Body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("read response: %w", err)
|
return "", fmt.Errorf("read response: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var chatResp ChatResponse
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
if err := json.Unmarshal(body, &chatResp); err != nil {
|
return "", fmt.Errorf("LLM API error (status %d): %s", resp.StatusCode, string(body))
|
||||||
return "", fmt.Errorf("parse response: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(chatResp.Choices) == 0 {
|
return parse(body)
|
||||||
return "", fmt.Errorf("no choices in LLM response")
|
|
||||||
}
|
|
||||||
|
|
||||||
return chatResp.Choices[0].Message.Content, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -208,3 +208,90 @@ func TestWithTimeout(t *testing.T) {
|
|||||||
t.Error("expected timeout error with 50ms timeout and 200ms server delay")
|
t.Error("expected timeout error with 50ms timeout and 200ms server delay")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
func TestComplete_Anthropic_Success(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path != "/messages" {
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
if r.Header.Get("x-api-key") != "test-key" {
|
||||||
|
t.Errorf("expected x-api-key header, got %q", r.Header.Get("x-api-key"))
|
||||||
|
}
|
||||||
|
if r.Header.Get("anthropic-version") != "2023-06-01" {
|
||||||
|
t.Errorf("expected anthropic-version header, got %q", r.Header.Get("anthropic-version"))
|
||||||
|
}
|
||||||
|
|
||||||
|
var req map[string]interface{}
|
||||||
|
json.NewDecoder(r.Body).Decode(&req)
|
||||||
|
|
||||||
|
if req["system"] != "You are helpful" {
|
||||||
|
t.Errorf("expected system prompt, got %v", req["system"])
|
||||||
|
}
|
||||||
|
msgs := req["messages"].([]interface{})
|
||||||
|
if len(msgs) != 1 {
|
||||||
|
t.Errorf("expected 1 user message, got %d", len(msgs))
|
||||||
|
}
|
||||||
|
if req["max_tokens"] != float64(8192) {
|
||||||
|
t.Errorf("expected max_tokens 8192, got %v", req["max_tokens"])
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.Write([]byte(`{"content":[{"type":"text","text":"Hello from Claude!"}]}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-key", "claude-sonnet").WithProvider(ProviderAnthropic)
|
||||||
|
got, err := client.Complete(context.Background(), []Message{
|
||||||
|
{Role: "system", Content: "You are helpful"},
|
||||||
|
{Role: "user", Content: "Hi"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if got != "Hello from Claude!" {
|
||||||
|
t.Errorf("expected %q, got %q", "Hello from Claude!", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComplete_Anthropic_NoContent(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.Write([]byte(`{"content":[]}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-key", "claude-sonnet").WithProvider(ProviderAnthropic)
|
||||||
|
_, err := client.Complete(context.Background(), []Message{{Role: "user", Content: "Hi"}})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for empty content, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestComplete_Anthropic_APIError(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
w.Write([]byte(`{"error":{"message":"invalid request"}}`))
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := NewClient(server.URL, "test-key", "claude-sonnet").WithProvider(ProviderAnthropic)
|
||||||
|
_, err := client.Complete(context.Background(), []Message{{Role: "user", Content: "Hi"}})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 400, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithProvider(t *testing.T) {
|
||||||
|
client := NewClient("http://example.com", "key", "model")
|
||||||
|
if client.provider != ProviderOpenAI {
|
||||||
|
t.Errorf("expected default provider openai, got %s", client.provider)
|
||||||
|
}
|
||||||
|
result := client.WithProvider(ProviderAnthropic)
|
||||||
|
if result != client {
|
||||||
|
t.Error("WithProvider should return the same client for chaining")
|
||||||
|
}
|
||||||
|
if client.provider != ProviderAnthropic {
|
||||||
|
t.Errorf("expected provider anthropic, got %s", client.provider)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -9,6 +9,11 @@ import (
|
|||||||
func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
|
if reviewerName != "" {
|
||||||
|
title := strings.ToUpper(reviewerName[:1]) + reviewerName[1:]
|
||||||
|
sb.WriteString(fmt.Sprintf("# %s Review\n\n", title))
|
||||||
|
}
|
||||||
|
|
||||||
sb.WriteString("## Summary\n\n")
|
sb.WriteString("## Summary\n\n")
|
||||||
sb.WriteString(result.Summary)
|
sb.WriteString(result.Summary)
|
||||||
sb.WriteString("\n\n")
|
sb.WriteString("\n\n")
|
||||||
@@ -30,6 +35,8 @@ func FormatMarkdown(result *ReviewResult, reviewerName string) string {
|
|||||||
|
|
||||||
if reviewerName != "" {
|
if reviewerName != "" {
|
||||||
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", reviewerName))
|
sb.WriteString(fmt.Sprintf("\n---\n*Review by %s*\n", reviewerName))
|
||||||
|
// Hidden sentinel for identifying this bot's reviews during cleanup
|
||||||
|
sb.WriteString(fmt.Sprintf("\n<!-- review-bot:%s -->\n", reviewerName))
|
||||||
}
|
}
|
||||||
|
|
||||||
return sb.String()
|
return sb.String()
|
||||||
|
|||||||
@@ -116,3 +116,46 @@ func TestGiteaEvent(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFormatMarkdown_Sentinel(t *testing.T) {
|
||||||
|
result := &ReviewResult{
|
||||||
|
Verdict: "APPROVE",
|
||||||
|
Summary: "All good.",
|
||||||
|
Recommendation: "Merge it.",
|
||||||
|
}
|
||||||
|
output := FormatMarkdown(result, "security")
|
||||||
|
if !strings.Contains(output, "<!-- review-bot:security -->") {
|
||||||
|
t.Error("expected sentinel comment in output")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty reviewer name should NOT have sentinel
|
||||||
|
output2 := FormatMarkdown(result, "")
|
||||||
|
if strings.Contains(output2, "<!-- review-bot") {
|
||||||
|
t.Error("should not contain sentinel when reviewer name is empty")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFormatMarkdown_RoleTitle(t *testing.T) {
|
||||||
|
result := &ReviewResult{
|
||||||
|
Verdict: "APPROVE",
|
||||||
|
Summary: "All good.",
|
||||||
|
Recommendation: "Merge it.",
|
||||||
|
}
|
||||||
|
|
||||||
|
// With reviewer name: should have title header
|
||||||
|
output := FormatMarkdown(result, "security")
|
||||||
|
if !strings.Contains(output, "# Security Review\n") {
|
||||||
|
t.Error("expected '# Security Review' header when reviewer name is set")
|
||||||
|
}
|
||||||
|
|
||||||
|
output2 := FormatMarkdown(result, "gpt")
|
||||||
|
if !strings.Contains(output2, "# Gpt Review\n") {
|
||||||
|
t.Error("expected '# Gpt Review' header")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without reviewer name: no title header
|
||||||
|
output3 := FormatMarkdown(result, "")
|
||||||
|
if strings.Contains(output3, "# ") && strings.Contains(output3, " Review\n") {
|
||||||
|
t.Error("should not contain role title header when reviewer name is empty")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+28
-4
@@ -1,3 +1,5 @@
|
|||||||
|
// Package review builds prompts for AI code review and parses LLM responses
|
||||||
|
// into structured review results.
|
||||||
package review
|
package review
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -5,8 +7,10 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
// BuildSystemPrompt constructs the system prompt for the LLM reviewer.
|
// BuildSystemBase returns the core system prompt instructions without
|
||||||
func BuildSystemPrompt(conventions, patterns string) string {
|
// patterns or conventions. Used by the budget package to separate
|
||||||
|
// trimmable from non-trimmable content.
|
||||||
|
func BuildSystemBase() string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
sb.WriteString("You are an expert code reviewer. Review the provided pull request diff carefully.\n\n")
|
sb.WriteString("You are an expert code reviewer. Review the provided pull request diff carefully.\n\n")
|
||||||
@@ -40,6 +44,15 @@ func BuildSystemPrompt(conventions, patterns string) string {
|
|||||||
sb.WriteString("- Line numbers should reference the new file line numbers from the diff headers.\n")
|
sb.WriteString("- Line numbers should reference the new file line numbers from the diff headers.\n")
|
||||||
sb.WriteString("- If the diff is empty or trivial (only formatting/whitespace), APPROVE with no findings.\n")
|
sb.WriteString("- If the diff is empty or trivial (only formatting/whitespace), APPROVE with no findings.\n")
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildSystemPrompt constructs the full system prompt with patterns and conventions.
|
||||||
|
// Deprecated: Use BuildSystemBase with budget.Fit for context-aware assembly.
|
||||||
|
func BuildSystemPrompt(conventions, patterns string) string {
|
||||||
|
var sb strings.Builder
|
||||||
|
sb.WriteString(BuildSystemBase())
|
||||||
|
|
||||||
if patterns != "" {
|
if patterns != "" {
|
||||||
sb.WriteString(fmt.Sprintf("\n\n## Language Patterns & Idioms\n\nUse the following patterns as review criteria. Code that violates these established patterns is a finding:\n\n%s\n", patterns))
|
sb.WriteString(fmt.Sprintf("\n\n## Language Patterns & Idioms\n\nUse the following patterns as review criteria. Code that violates these established patterns is a finding:\n\n%s\n", patterns))
|
||||||
}
|
}
|
||||||
@@ -51,8 +64,9 @@ func BuildSystemPrompt(conventions, patterns string) string {
|
|||||||
return sb.String()
|
return sb.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
// BuildUserPrompt constructs the user message with PR context.
|
// BuildUserMeta returns the PR metadata header (title, description, CI status)
|
||||||
func BuildUserPrompt(title, description, diff, fileContext string, ciPassed bool, ciDetails string) string {
|
// without the diff or file context. Used by the budget package.
|
||||||
|
func BuildUserMeta(title, description string, ciPassed bool, ciDetails string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
sb.WriteString(fmt.Sprintf("## Pull Request: %s\n\n", title))
|
sb.WriteString(fmt.Sprintf("## Pull Request: %s\n\n", title))
|
||||||
@@ -71,6 +85,16 @@ func BuildUserPrompt(title, description, diff, fileContext string, ciPassed bool
|
|||||||
sb.WriteString(fmt.Sprintf("CI Details: %s\n", ciDetails))
|
sb.WriteString(fmt.Sprintf("CI Details: %s\n", ciDetails))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildUserPrompt constructs the user message with PR context.
|
||||||
|
// Deprecated: Use BuildUserMeta with budget.Fit for context-aware assembly.
|
||||||
|
func BuildUserPrompt(title, description, diff, fileContext string, ciPassed bool, ciDetails string) string {
|
||||||
|
var sb strings.Builder
|
||||||
|
|
||||||
|
sb.WriteString(BuildUserMeta(title, description, ciPassed, ciDetails))
|
||||||
|
|
||||||
if fileContext != "" {
|
if fileContext != "" {
|
||||||
sb.WriteString("\n### Full File Context (modified files)\n\n")
|
sb.WriteString("\n### Full File Context (modified files)\n\n")
|
||||||
sb.WriteString(fileContext)
|
sb.WriteString(fileContext)
|
||||||
|
|||||||
@@ -116,3 +116,43 @@ func TestBuildUserPrompt_WithoutFileContext(t *testing.T) {
|
|||||||
t.Error("should not include file context section when empty")
|
t.Error("should not include file context section when empty")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
func TestBuildSystemBase(t *testing.T) {
|
||||||
|
result := BuildSystemBase()
|
||||||
|
if result == "" {
|
||||||
|
t.Fatal("BuildSystemBase returned empty string")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "expert code reviewer") {
|
||||||
|
t.Error("expected reviewer role in system base")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "REQUEST_CHANGES") {
|
||||||
|
t.Error("expected verdict format in system base")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "JSON") {
|
||||||
|
t.Error("expected JSON output instruction in system base")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildUserMeta(t *testing.T) {
|
||||||
|
result := BuildUserMeta("Fix bug", "Some description", true, "all checks passed")
|
||||||
|
if !strings.Contains(result, "Fix bug") {
|
||||||
|
t.Error("expected title in user meta")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "Some description") {
|
||||||
|
t.Error("expected description in user meta")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "PASSED") {
|
||||||
|
t.Error("expected CI PASSED status")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildUserMeta_CIFailed(t *testing.T) {
|
||||||
|
result := BuildUserMeta("Title", "", false, "test job failed")
|
||||||
|
if !strings.Contains(result, "FAILED") {
|
||||||
|
t.Error("expected CI FAILED status")
|
||||||
|
}
|
||||||
|
if strings.Contains(result, "Description") {
|
||||||
|
t.Error("expected no description section when empty")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user