Compare commits
59 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 91fba770d9 | |||
| 5252143a33 | |||
| ac6d34f5bd | |||
| 34f7393892 | |||
| bdc109901d | |||
| 271ea7f5fe | |||
| e70b54f238 | |||
| c5bc807d2c | |||
| e8664714c4 | |||
| d40902771e | |||
| a30ee7df6e | |||
| a89dce1c52 | |||
| 4c189d18a2 | |||
| 28e63a2338 | |||
| c4af35cd78 | |||
| 02920b685b | |||
| 4881a21ecb | |||
| 4e8c676515 | |||
| 027bad2f7c | |||
| cd8a1becb3 | |||
| 9dd5e8dbac | |||
| 8b256360bf | |||
| 293296b50c | |||
| eba97321ad | |||
| be3f696a70 | |||
| 65ba8af244 | |||
| 02bdd701a5 | |||
| 23dc781908 | |||
| 1960d987ed | |||
| dca260f582 | |||
| 921599542d | |||
| 71bb33b6fd | |||
| 55366b3431 | |||
| 3cd5ae594e | |||
| eaccc96073 | |||
| 289b400bfd | |||
| d0b7f09772 | |||
| 377da8ca3a | |||
| 61819ac3e3 | |||
| 3d1260d3b2 | |||
| 0e7e12a99c | |||
| 1862dc999d | |||
| d8270262d6 | |||
| b2eea502d0 | |||
| 0ec5093aeb | |||
| 8a0eed298a | |||
| 8e4c1cc32e | |||
| ec03dc2373 | |||
| 1749d95727 | |||
| 7c83365fc4 | |||
| 6be5e306aa | |||
| cd6cd93bf0 | |||
| c889724dda | |||
| 1ac51669ed | |||
| 2e6f46f28d | |||
| 3fc31c0822 | |||
| 2b611dbd0b | |||
| 3abb611baf | |||
| dd003c66d5 |
+1
-1
@@ -9,7 +9,7 @@
|
|||||||
|
|
||||||
| Package | Use Case | Scope |
|
| Package | Use Case | Scope |
|
||||||
|---------|----------|-------|
|
|---------|----------|-------|
|
||||||
| `github.com/goccy/go-yaml` | YAML parsing and AST inspection (subpkgs: `ast`, `parser`) | production |
|
| `gopkg.in/yaml.v3` | YAML parsing (persona files, config) | production |
|
||||||
| `github.com/google/go-cmp` | Test comparisons (`cmp.Diff`) | test only |
|
| `github.com/google/go-cmp` | Test comparisons (`cmp.Diff`) | test only |
|
||||||
|
|
||||||
**Any import not in this table or the Go standard library is forbidden.**
|
**Any import not in this table or the Go standard library is forbidden.**
|
||||||
|
|||||||
+32
-163
@@ -2,7 +2,6 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
@@ -71,7 +70,7 @@ func main() {
|
|||||||
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
conventionsFile := flag.String("conventions-file", envOrDefault("CONVENTIONS_FILE", ""), "Conventions file path in repo (e.g. CLAUDE.md)")
|
||||||
systemPromptFile := flag.String("system-prompt-file", envOrDefault("SYSTEM_PROMPT_FILE", ""), "Local file with additional system prompt instructions")
|
systemPromptFile := flag.String("system-prompt-file", envOrDefault("SYSTEM_PROMPT_FILE", ""), "Local file with additional system prompt instructions")
|
||||||
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
patternsRepo := flag.String("patterns-repo", envOrDefault("PATTERNS_REPO", ""), "Repo with language patterns (e.g. rodin/elixir-patterns)")
|
||||||
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", ""), "Comma-separated file paths to fetch from patterns repo (empty = all files)")
|
patternsFiles := flag.String("patterns-files", envOrDefault("PATTERNS_FILES", "README.md"), "Comma-separated file paths to fetch from patterns repo")
|
||||||
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
dryRun := flag.Bool("dry-run", false, "Print review to stdout instead of posting")
|
||||||
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
llmTemp := flag.Float64("llm-temperature", envOrDefaultFloat("LLM_TEMPERATURE", 0), "LLM temperature (0 = server default)")
|
||||||
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
llmTimeout := flag.Int("llm-timeout", envOrDefaultInt("LLM_TIMEOUT", 300), "LLM request timeout in seconds (default 300)")
|
||||||
@@ -85,16 +84,9 @@ func main() {
|
|||||||
aicoreAPIURL := flag.String("aicore-api-url", envOrDefault("AICORE_API_URL", ""), "SAP AI Core API URL (for provider=aicore)")
|
aicoreAPIURL := flag.String("aicore-api-url", envOrDefault("AICORE_API_URL", ""), "SAP AI Core API URL (for provider=aicore)")
|
||||||
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
aicoreResourceGroup := flag.String("aicore-resource-group", envOrDefault("AICORE_RESOURCE_GROUP", "default"), "SAP AI Core resource group (for provider=aicore)")
|
||||||
|
|
||||||
// Register --gitea-url as a backward-compatible alias for --vcs-url.
|
// Backward-compatible alias: --gitea-url shares vcsURL's pointer (last flag wins).
|
||||||
// StringVar shares the *string pointer with vcsURL, so whichever flag is
|
// Must use *vcsURL as default: StringVar sets *p=value at registration, so empty
|
||||||
// set last by flag.Parse wins — both point to the same underlying value.
|
// string would overwrite the env-resolved value from the --vcs-url declaration.
|
||||||
// NOTE: If a user passes both --vcs-url and --gitea-url, the last one on
|
|
||||||
// the command line takes effect (standard flag package behavior). This is
|
|
||||||
// acceptable since --gitea-url is deprecated and both serve the same purpose.
|
|
||||||
//
|
|
||||||
// ORDERING: This must remain AFTER vcsURL's flag.String declaration and BEFORE
|
|
||||||
// flag.Parse(). The *vcsURL dereference captures the env-var-resolved default
|
|
||||||
// at registration time; moving flag.Parse() above this line would break it.
|
|
||||||
flag.StringVar(vcsURL, "gitea-url", *vcsURL, "Deprecated: use --vcs-url instead")
|
flag.StringVar(vcsURL, "gitea-url", *vcsURL, "Deprecated: use --vcs-url instead")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
@@ -110,10 +102,8 @@ func main() {
|
|||||||
slog.Info("review-bot starting", "version", version)
|
slog.Info("review-bot starting", "version", version)
|
||||||
|
|
||||||
// Validate VCS provider
|
// Validate VCS provider
|
||||||
switch *provider {
|
vcsProvider := vcs.VCSProvider(*provider)
|
||||||
case "gitea", "github":
|
if !vcsProvider.Valid() {
|
||||||
// valid
|
|
||||||
default:
|
|
||||||
fmt.Fprintf(os.Stderr, "Error: invalid --provider %q (valid: gitea, github)\n", *provider)
|
fmt.Fprintf(os.Stderr, "Error: invalid --provider %q (valid: gitea, github)\n", *provider)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
@@ -126,7 +116,7 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
// --vcs-url is required only for gitea provider
|
// --vcs-url is required only for gitea provider
|
||||||
if *provider == "gitea" && *vcsURL == "" {
|
if vcsProvider == vcs.ProviderGitea && *vcsURL == "" {
|
||||||
fmt.Fprintf(os.Stderr, "Error: --vcs-url (or --gitea-url) is required for provider=gitea\n")
|
fmt.Fprintf(os.Stderr, "Error: --vcs-url (or --gitea-url) is required for provider=gitea\n")
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
@@ -169,21 +159,16 @@ func main() {
|
|||||||
|
|
||||||
// Initialize VCS client
|
// Initialize VCS client
|
||||||
var client vcs.Client
|
var client vcs.Client
|
||||||
switch *provider {
|
switch vcsProvider {
|
||||||
case "gitea":
|
case vcs.ProviderGitea:
|
||||||
giteaClient := gitea.NewClient(*vcsURL, *reviewerToken)
|
giteaClient := gitea.NewClient(*vcsURL, *reviewerToken)
|
||||||
client = gitea.NewAdapter(giteaClient)
|
client = gitea.NewAdapter(giteaClient)
|
||||||
case "github":
|
case vcs.ProviderGitHub:
|
||||||
ghBaseURL := *baseURL
|
client = github.NewClient(*reviewerToken, *baseURL)
|
||||||
if ghBaseURL == "" {
|
|
||||||
ghBaseURL = "https://api.github.com"
|
|
||||||
}
|
|
||||||
client = github.NewClient(*reviewerToken, ghBaseURL)
|
|
||||||
default:
|
default:
|
||||||
fmt.Fprintf(os.Stderr, "Error: unhandled provider %q\n", *provider)
|
panic("unreachable: provider validation should have caught " + vcsProvider.String())
|
||||||
os.Exit(1)
|
|
||||||
}
|
}
|
||||||
slog.Info("VCS client initialized", "provider", *provider)
|
slog.Info("VCS client initialized", "provider", vcsProvider)
|
||||||
|
|
||||||
// Initialize LLM client
|
// Initialize LLM client
|
||||||
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
llmClient := llm.NewClient(*llmBaseURL, *llmAPIKey, *llmModel)
|
||||||
@@ -432,7 +417,7 @@ func main() {
|
|||||||
currentSHA = currentPR.Head.SHA
|
currentSHA = currentPR.Head.SHA
|
||||||
}
|
}
|
||||||
if shouldSkipStaleReview(evaluatedSHA, currentSHA) {
|
if shouldSkipStaleReview(evaluatedSHA, currentSHA) {
|
||||||
slog.Warn("HEAD moved during review — skipping stale review",
|
slog.Warn("HEAD moved during review -- skipping stale review",
|
||||||
"evaluated", evaluatedSHA,
|
"evaluated", evaluatedSHA,
|
||||||
"current", currentSHA,
|
"current", currentSHA,
|
||||||
"pr", prNumber)
|
"pr", prNumber)
|
||||||
@@ -480,12 +465,12 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Self-request as reviewer (Gitea-specific; ensures we appear in required-reviewer checks)
|
// Self-request as reviewer (Gitea-specific; ensures we appear in required-reviewer checks)
|
||||||
if giteaAdapter, ok := client.(*gitea.Adapter); ok {
|
if selfReq, ok := client.(vcs.ReviewerSelfRequester); ok {
|
||||||
authUser, err := client.GetAuthenticatedUser(ctx)
|
authUser, err := client.GetAuthenticatedUser(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not determine authenticated user for reviewer self-request", "error", err)
|
slog.Warn("could not determine authenticated user for reviewer self-request", "error", err)
|
||||||
} else if authUser != "" {
|
} else if authUser != "" {
|
||||||
if err := giteaAdapter.Underlying().RequestReviewer(ctx, owner, repoName, prNumber, authUser); err != nil {
|
if err := selfReq.RequestReviewerSelf(ctx, owner, repoName, prNumber, authUser); err != nil {
|
||||||
slog.Warn("could not self-request as reviewer", "user", authUser, "error", err)
|
slog.Warn("could not self-request as reviewer", "user", authUser, "error", err)
|
||||||
} else {
|
} else {
|
||||||
slog.Debug("self-requested as reviewer", "user", authUser, "pr", prNumber)
|
slog.Debug("self-requested as reviewer", "user", authUser, "pr", prNumber)
|
||||||
@@ -509,11 +494,15 @@ func main() {
|
|||||||
}
|
}
|
||||||
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
slog.Info("review posted", "review_id", posted.ID, "user", posted.User.Login, "pr", prNumber)
|
||||||
|
|
||||||
// Supersede all old reviews
|
// Supersede all old reviews via optional interface
|
||||||
if len(oldReviews) > 0 {
|
if len(oldReviews) > 0 {
|
||||||
if err := supersedeOldReviews(ctx, client, *provider, *vcsURL, owner, repoName, prNumber, oldReviews, posted.ID, sentinel); err != nil {
|
if superseder, ok := client.(vcs.ReviewSuperseder); ok {
|
||||||
slog.Error("failed to supersede old reviews", "error", err)
|
if err := superseder.SupersedeReviews(ctx, owner, repoName, prNumber, oldReviews, posted.ID, *vcsURL, sentinel); err != nil {
|
||||||
os.Exit(1)
|
slog.Error("failed to supersede old reviews", "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
slog.Error("provider does not support review superseding", "provider", vcsProvider)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -530,84 +519,6 @@ func verdictToEvent(verdict string) vcs.ReviewEvent {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// supersedeOldReviews marks prior reviews as superseded so only the latest review is visible.
|
|
||||||
// For GitHub: dismisses old reviews (vcsURL is unused in this path).
|
|
||||||
// For Gitea: edits the review body with a link to the new review and resolves inline comments.
|
|
||||||
//
|
|
||||||
// The vcsURL parameter is only used in the Gitea path to construct review permalink URLs;
|
|
||||||
// it is accepted unconditionally to keep the function signature uniform across providers.
|
|
||||||
func supersedeOldReviews(ctx context.Context, client vcs.Client, provider, vcsURL, owner, repoName string, prNumber int, oldReviews []vcs.Review, newReviewID int64, sentinel string) error {
|
|
||||||
switch provider {
|
|
||||||
case "github":
|
|
||||||
// Best-effort dismissal: attempt all reviews, join any errors.
|
|
||||||
var errs []error
|
|
||||||
for _, old := range oldReviews {
|
|
||||||
if err := client.DismissReview(ctx, owner, repoName, prNumber, old.ID, "Superseded by new review"); err != nil {
|
|
||||||
slog.Warn("failed to dismiss review", "id", old.ID, "error", err)
|
|
||||||
errs = append(errs, fmt.Errorf("dismiss review %d: %w", old.ID, err))
|
|
||||||
} else {
|
|
||||||
slog.Info("dismissed old review", "review_id", old.ID, "new_review_id", newReviewID, "pr", prNumber)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return errors.Join(errs...)
|
|
||||||
case "gitea":
|
|
||||||
// Continue to Gitea-specific logic below the switch.
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("supersedeOldReviews: unsupported provider %q", provider)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The type assertion below is guaranteed to succeed: the caller's provider switch
|
|
||||||
// ensures we only reach this point when provider == "gitea", and the gitea provider
|
|
||||||
// always constructs a *gitea.Adapter. The !ok branch guards against future refactors
|
|
||||||
// (e.g. wrapping the adapter in a decorator) that would silently break this path.
|
|
||||||
giteaAdapter, ok := client.(*gitea.Adapter)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("expected gitea.Adapter for gitea provider, got %T", client)
|
|
||||||
}
|
|
||||||
underlying := giteaAdapter.Underlying()
|
|
||||||
|
|
||||||
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d", strings.TrimRight(vcsURL, "/"), owner, repoName, prNumber, newReviewID)
|
|
||||||
for _, oldReview := range oldReviews {
|
|
||||||
cid, err := underlying.GetTimelineReviewCommentIDForReview(ctx, owner, repoName, prNumber, oldReview.ID)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
|
||||||
if err := underlying.EditComment(ctx, owner, repoName, cid, supersededBody); err != nil {
|
|
||||||
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "comment_id", cid, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
slog.Info("marked old review as superseded", "review_id", oldReview.ID, "new_review_id", newReviewID, "pr", prNumber)
|
|
||||||
|
|
||||||
// Resolve old review's inline comments
|
|
||||||
oldComments, err := underlying.ListReviewComments(ctx, owner, repoName, prNumber, oldReview.ID)
|
|
||||||
if err != nil {
|
|
||||||
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
resolved, failed := 0, 0
|
|
||||||
for _, c := range oldComments {
|
|
||||||
if c.ID == 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if err := underlying.ResolveComment(ctx, owner, repoName, c.ID); err != nil {
|
|
||||||
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
|
||||||
failed++
|
|
||||||
} else {
|
|
||||||
resolved++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if resolved > 0 {
|
|
||||||
slog.Info("resolved old inline comments", "review_id", oldReview.ID, "count", resolved, "pr", prNumber)
|
|
||||||
}
|
|
||||||
if failed > 0 {
|
|
||||||
slog.Warn("some inline comments could not be resolved", "review_id", oldReview.ID, "failed", failed, "pr", prNumber)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchFileContext fetches the full content of modified files from the PR branch.
|
// fetchFileContext fetches the full content of modified files from the PR branch.
|
||||||
func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref string, files []vcs.ChangedFile) string {
|
func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref string, files []vcs.ChangedFile) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
@@ -635,25 +546,12 @@ func fetchFileContext(ctx context.Context, client vcs.PRReader, owner, repo, ref
|
|||||||
// patternsRepo is comma-separated list of owner/name repos.
|
// patternsRepo is comma-separated list of owner/name repos.
|
||||||
// patternsFiles is comma-separated list of file paths or directories.
|
// patternsFiles is comma-separated list of file paths or directories.
|
||||||
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
// If a path ends with / or is a directory, all files within it are fetched recursively.
|
||||||
// If patternsFiles is empty, all files from the repo root are fetched.
|
// Empty entries in patternsFiles are skipped (no implicit repo-root fetch).
|
||||||
func fetchPatterns(ctx context.Context, client vcs.FileReader, patternsRepo, patternsFiles string) string {
|
func fetchPatterns(ctx context.Context, client vcs.FileReader, patternsRepo, patternsFiles string) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
|
|
||||||
repos := strings.Split(patternsRepo, ",")
|
repos := strings.Split(patternsRepo, ",")
|
||||||
|
paths := strings.Split(patternsFiles, ",")
|
||||||
// Build the list of paths to fetch
|
|
||||||
var paths []string
|
|
||||||
if patternsFiles == "" {
|
|
||||||
// Empty patternsFiles means "fetch all files from repo root"
|
|
||||||
paths = []string{""}
|
|
||||||
} else {
|
|
||||||
for _, p := range strings.Split(patternsFiles, ",") {
|
|
||||||
p = strings.TrimSpace(p)
|
|
||||||
if p != "" {
|
|
||||||
paths = append(paths, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, repoRef := range repos {
|
for _, repoRef := range repos {
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
@@ -674,6 +572,11 @@ func fetchPatterns(ctx context.Context, client vcs.FileReader, patternsRepo, pat
|
|||||||
var repoSkippedFiles []string
|
var repoSkippedFiles []string
|
||||||
|
|
||||||
for _, path := range paths {
|
for _, path := range paths {
|
||||||
|
path = strings.TrimSpace(path)
|
||||||
|
if path == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
files, err := vcs.GetAllFilesInPath(ctx, client, owner, repo, path)
|
files, err := vcs.GetAllFilesInPath(ctx, client, owner, repo, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("could not fetch patterns", "path", path, "repo", repoRef, "error", err)
|
slog.Warn("could not fetch patterns", "path", path, "repo", repoRef, "error", err)
|
||||||
@@ -768,14 +671,6 @@ 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
|
// validateReviewerName checks that the name contains only safe characters
|
||||||
// for embedding in an HTML comment sentinel ([a-zA-Z0-9_-]).
|
// for embedding in an HTML comment sentinel ([a-zA-Z0-9_-]).
|
||||||
func validateReviewerName(name string) error {
|
func validateReviewerName(name string) error {
|
||||||
@@ -827,31 +722,6 @@ func validateWorkspacePath(path, pathName string) (string, error) {
|
|||||||
return resolvedPath, nil
|
return resolvedPath, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
|
||||||
// with collapsed original content and the commit it was evaluated against.
|
|
||||||
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
|
||||||
shortSHA := commitSHA
|
|
||||||
if len(shortSHA) > 8 {
|
|
||||||
shortSHA = shortSHA[:8]
|
|
||||||
}
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("~~Original review~~\n\n")
|
|
||||||
sb.WriteString("**Superseded** \u2014 [see current review](")
|
|
||||||
sb.WriteString(newReviewURL)
|
|
||||||
sb.WriteString(") for up-to-date findings.\n\n")
|
|
||||||
if shortSHA != "" {
|
|
||||||
sb.WriteString("<details><summary>Previous findings (commit ")
|
|
||||||
sb.WriteString(shortSHA)
|
|
||||||
sb.WriteString(")</summary>\n\n")
|
|
||||||
} else {
|
|
||||||
sb.WriteString("<details><summary>Previous findings</summary>\n\n")
|
|
||||||
}
|
|
||||||
sb.WriteString(originalBody)
|
|
||||||
sb.WriteString("\n\n</details>\n\n")
|
|
||||||
sb.WriteString(sentinel)
|
|
||||||
return sb.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// hasSharedToken detects if another review-bot role posted under the same
|
// hasSharedToken detects if another review-bot role posted under the same
|
||||||
// VCS user. This indicates misconfiguration where two roles share a token
|
// VCS user. This indicates misconfiguration where two roles share a token
|
||||||
// instead of having separate accounts. Returns true if shared token
|
// instead of having separate accounts. Returns true if shared token
|
||||||
@@ -869,7 +739,7 @@ func hasSharedToken(reviews []vcs.Review, ownSentinel string) bool {
|
|||||||
}
|
}
|
||||||
for _, r := range reviews {
|
for _, r := range reviews {
|
||||||
if r.User.Login == ownLogin && strings.Contains(r.Body, "<!-- review-bot:") && !strings.Contains(r.Body, ownSentinel) {
|
if r.User.Login == ownLogin && strings.Contains(r.Body, "<!-- review-bot:") && !strings.Contains(r.Body, ownSentinel) {
|
||||||
slog.Warn("shared token detected — another review-bot role is using the same VCS user",
|
slog.Warn("shared token detected -- another review-bot role is using the same VCS user",
|
||||||
"sibling_role", extractSentinelName(r.Body), "user", ownLogin)
|
"sibling_role", extractSentinelName(r.Body), "user", ownLogin)
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
@@ -907,7 +777,6 @@ func extractSentinelName(body string) string {
|
|||||||
return name
|
return name
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// findAllOwnReviews returns all non-superseded reviews matching the sentinel.
|
// findAllOwnReviews returns all non-superseded reviews matching the sentinel.
|
||||||
func findAllOwnReviews(reviews []vcs.Review, sentinel string) []vcs.Review {
|
func findAllOwnReviews(reviews []vcs.Review, sentinel string) []vcs.Review {
|
||||||
var result []vcs.Review
|
var result []vcs.Review
|
||||||
|
|||||||
+2
-138
@@ -162,55 +162,6 @@ func makeReview(id int64, login, state string, stale bool, body string) vcs.Revi
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBuildSupersededBody(t *testing.T) {
|
|
||||||
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
|
||||||
sentinel := "<!-- review-bot:sonnet -->"
|
|
||||||
newURL := "https://gitea.example.com/owner/repo/pulls/1#pullrequestreview-99"
|
|
||||||
|
|
||||||
result := buildSupersededBody(original, "abcdef1234567890", newURL, sentinel)
|
|
||||||
|
|
||||||
// Should contain the struck-through banner
|
|
||||||
if !strings.Contains(result, "~~Original review~~") {
|
|
||||||
t.Error("missing struck-through banner")
|
|
||||||
}
|
|
||||||
// Should contain superseded notice with link
|
|
||||||
if !strings.Contains(result, "**Superseded**") {
|
|
||||||
t.Error("missing superseded notice")
|
|
||||||
}
|
|
||||||
if !strings.Contains(result, "[see current review]("+newURL+")") {
|
|
||||||
t.Error("missing link to new review")
|
|
||||||
}
|
|
||||||
// Should contain collapsed original
|
|
||||||
if !strings.Contains(result, "<details>") {
|
|
||||||
t.Error("missing details/collapse")
|
|
||||||
}
|
|
||||||
// Should contain short commit SHA
|
|
||||||
if !strings.Contains(result, "abcdef12") {
|
|
||||||
t.Error("missing short SHA")
|
|
||||||
}
|
|
||||||
// Should NOT contain full SHA
|
|
||||||
if strings.Contains(result, "abcdef1234567890") {
|
|
||||||
t.Error("should truncate SHA to 8 chars")
|
|
||||||
}
|
|
||||||
// Should contain the original body inside details
|
|
||||||
if !strings.Contains(result, original) {
|
|
||||||
t.Error("original body not preserved in collapsed section")
|
|
||||||
}
|
|
||||||
// Should end with sentinel
|
|
||||||
if !strings.Contains(result, sentinel) {
|
|
||||||
t.Error("missing sentinel")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBuildSupersededBodyShortSHA(t *testing.T) {
|
|
||||||
// Short SHA should pass through without panic
|
|
||||||
result := buildSupersededBody("body", "abc", "https://example.com/review", "<!-- review-bot:x -->")
|
|
||||||
if !strings.Contains(result, "abc") {
|
|
||||||
t.Error("short SHA not preserved")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
func TestHasSharedToken(t *testing.T) {
|
func TestHasSharedToken(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -416,52 +367,6 @@ func TestIsPatternFile(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestBuildPatternPaths verifies the path-building logic for fetchPatterns.
|
|
||||||
// Empty patternsFiles means "fetch all from root" (represented as [""]).
|
|
||||||
func TestBuildPatternPaths(t *testing.T) {
|
|
||||||
buildPaths := func(patternsFiles string) []string {
|
|
||||||
if patternsFiles == "" {
|
|
||||||
return []string{""}
|
|
||||||
}
|
|
||||||
var paths []string
|
|
||||||
for _, p := range strings.Split(patternsFiles, ",") {
|
|
||||||
p = strings.TrimSpace(p)
|
|
||||||
if p != "" {
|
|
||||||
paths = append(paths, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return paths
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
input string
|
|
||||||
want []string
|
|
||||||
}{
|
|
||||||
{"empty fetches root", "", []string{""}},
|
|
||||||
{"single file", "README.md", []string{"README.md"}},
|
|
||||||
{"multiple files", "README.md,PATTERNS.md", []string{"README.md", "PATTERNS.md"}},
|
|
||||||
{"trims whitespace", " foo.md , bar.md ", []string{"foo.md", "bar.md"}},
|
|
||||||
{"skips empty between commas", "foo.md,,bar.md", []string{"foo.md", "bar.md"}},
|
|
||||||
{"directory path", "patterns/", []string{"patterns/"}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
got := buildPaths(tc.input)
|
|
||||||
if len(got) != len(tc.want) {
|
|
||||||
t.Errorf("buildPaths(%q) = %v, want %v", tc.input, got, tc.want)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for i := range got {
|
|
||||||
if got[i] != tc.want[i] {
|
|
||||||
t.Errorf("buildPaths(%q)[%d] = %q, want %q", tc.input, i, got[i], tc.want[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluateCIStatus(t *testing.T) {
|
func TestEvaluateCIStatus(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -643,47 +548,6 @@ func TestEnvOrDefaultInt(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestEnvOrDefaultBool(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
envVal string
|
|
||||||
setEnv bool
|
|
||||||
defaultVal bool
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{"unset returns default true", "", false, true, true},
|
|
||||||
{"unset returns default false", "", false, false, false},
|
|
||||||
{"true", "true", true, false, true},
|
|
||||||
{"TRUE", "TRUE", true, false, true},
|
|
||||||
{"True", "True", true, false, true},
|
|
||||||
{"1", "1", true, false, true},
|
|
||||||
{"yes", "yes", true, false, true},
|
|
||||||
{"YES", "YES", true, false, true},
|
|
||||||
{"false", "false", true, true, false},
|
|
||||||
{"0", "0", true, true, false},
|
|
||||||
{"no", "no", true, true, false},
|
|
||||||
{"random string", "random", true, true, false},
|
|
||||||
{"empty string returns default", "", true, true, true},
|
|
||||||
{"whitespace true", " true ", true, false, true},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
envKey := "TEST_ENV_BOOL_" + strings.ReplaceAll(tc.name, " ", "_")
|
|
||||||
if tc.setEnv {
|
|
||||||
os.Setenv(envKey, tc.envVal)
|
|
||||||
defer os.Unsetenv(envKey)
|
|
||||||
} else {
|
|
||||||
os.Unsetenv(envKey)
|
|
||||||
}
|
|
||||||
got := envOrDefaultBool(envKey, tc.defaultVal)
|
|
||||||
if got != tc.want {
|
|
||||||
t.Errorf("envOrDefaultBool(%q, %v) = %v, want %v", tc.envVal, tc.defaultVal, got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestExtractSentinelName_EdgeCases(t *testing.T) {
|
func TestExtractSentinelName_EdgeCases(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
body string
|
body string
|
||||||
@@ -692,8 +556,8 @@ func TestExtractSentinelName_EdgeCases(t *testing.T) {
|
|||||||
{"<!-- review-bot:sonnet --> rest", "sonnet"},
|
{"<!-- review-bot:sonnet --> rest", "sonnet"},
|
||||||
{"<!-- review-bot:gpt-review --> rest", "gpt-review"},
|
{"<!-- review-bot:gpt-review --> rest", "gpt-review"},
|
||||||
{"no sentinel here", "unknown"},
|
{"no sentinel here", "unknown"},
|
||||||
{"<!-- review-bot:", "unknown"}, // prefix but no suffix
|
{"<!-- review-bot:", "unknown"}, // prefix but no suffix
|
||||||
{"prefix <!-- review-bot:abc --> end", "abc"}, // embedded in text
|
{"prefix <!-- review-bot:abc --> end", "abc"}, // embedded in text
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range tests {
|
for _, tc := range tests {
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ JSON is awkward for persona files that contain multi-line text (identity, severi
|
|||||||
- Backwards compatibility: existing JSON personas must continue to work
|
- Backwards compatibility: existing JSON personas must continue to work
|
||||||
- Security: protect against DoS via deeply nested YAML (AIKIDO-2024-10486)
|
- Security: protect against DoS via deeply nested YAML (AIKIDO-2024-10486)
|
||||||
- Consistency: use `.yaml` extension (not `.yml`)
|
- Consistency: use `.yaml` extension (not `.yml`)
|
||||||
- Library: use `github.com/goccy/go-yaml` v1.16.0+ (approved in CONVENTIONS.md); we implement custom AST-based depth/node-count checks for precise alias-aware validation
|
- Library: use `gopkg.in/yaml.v3` (approved in CONVENTIONS.md) with explicit depth limiting
|
||||||
|
|
||||||
## Proposed Approach
|
## Proposed Approach
|
||||||
|
|
||||||
@@ -33,16 +33,37 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
|
|
||||||
### YAML Parsing with Depth Protection
|
### YAML Parsing with Depth Protection
|
||||||
|
|
||||||
We implement a custom AST-based depth/node-count walk (`checkYAMLDepth` in
|
```go
|
||||||
`review/persona.go`) rather than relying on library decoder options. Key design
|
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
||||||
decisions:
|
var node yaml.Node
|
||||||
|
dec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
|
if err := dec.Decode(&node); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkYAMLDepth(&node, 0, maxDepth); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return node.Decode(out)
|
||||||
|
}
|
||||||
|
|
||||||
- **Library:** `github.com/goccy/go-yaml` with `ast.Node`-based traversal
|
func checkYAMLDepth(node *yaml.Node, depth, maxDepth int) error {
|
||||||
- **Dual-map tracking:** `validated` (depth-aware short-circuit) + `visiting` (cycle detection)
|
if depth > maxDepth {
|
||||||
- **Node-count limit:** Conservative overcounting bounds total validation work
|
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
||||||
- **Alias-aware depth:** Aliases increment depth and are re-checked when encountered at greater depths
|
}
|
||||||
|
// Handle alias nodes by following the Alias pointer
|
||||||
|
if node.Kind == yaml.AliasNode && node.Alias != nil {
|
||||||
|
return checkYAMLDepth(node.Alias, depth, maxDepth)
|
||||||
|
}
|
||||||
|
for _, child := range node.Content {
|
||||||
|
if err := checkYAMLDepth(child, depth+1, maxDepth); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
See `review/persona.go:checkYAMLDepth` for the authoritative implementation.
|
The `gopkg.in/yaml.v3` library does not have built-in depth protection, so we implement explicit depth checking by first decoding into a `yaml.Node`, walking the tree to verify depth (including alias resolution), then decoding into the target struct.
|
||||||
|
|
||||||
## State/Data Model
|
## State/Data Model
|
||||||
|
|
||||||
@@ -53,7 +74,7 @@ No new state. Same `Persona` struct, just different parsing.
|
|||||||
| Error | Handling |
|
| Error | Handling |
|
||||||
|-------|----------|
|
|-------|----------|
|
||||||
| Invalid YAML syntax | Return parse error with source file |
|
| Invalid YAML syntax | Return parse error with source file |
|
||||||
| Deeply nested YAML | Custom AST walk (`checkYAMLDepth`) rejects before decode |
|
| Deeply nested YAML | Library rejects (v1.16.0+ fix) |
|
||||||
| Unknown extension | Fall back to JSON parsing |
|
| Unknown extension | Fall back to JSON parsing |
|
||||||
| Missing required fields | Validation rejects after parse |
|
| Missing required fields | Validation rejects after parse |
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ package gitea
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/vcs"
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
)
|
)
|
||||||
@@ -16,6 +18,7 @@ type Adapter struct {
|
|||||||
|
|
||||||
// Compile-time interface conformance assertion.
|
// Compile-time interface conformance assertion.
|
||||||
var _ vcs.Client = (*Adapter)(nil)
|
var _ vcs.Client = (*Adapter)(nil)
|
||||||
|
var _ vcs.ReviewerSelfRequester = (*Adapter)(nil)
|
||||||
|
|
||||||
// NewAdapter creates a new Adapter wrapping the given gitea Client.
|
// NewAdapter creates a new Adapter wrapping the given gitea Client.
|
||||||
func NewAdapter(client *Client) *Adapter {
|
func NewAdapter(client *Client) *Adapter {
|
||||||
@@ -230,3 +233,84 @@ func (a *Adapter) DismissReview(ctx context.Context, owner, repo string, number
|
|||||||
func (a *Adapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
func (a *Adapter) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
return a.client.GetAuthenticatedUser(ctx)
|
return a.client.GetAuthenticatedUser(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RequestReviewerSelf adds the given user as a requested reviewer on a pull request.
|
||||||
|
// This implements vcs.ReviewerSelfRequester for the Gitea adapter.
|
||||||
|
func (a *Adapter) RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error {
|
||||||
|
return a.client.RequestReviewer(ctx, owner, repo, number, user)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compile-time interface conformance assertion for ReviewSuperseder.
|
||||||
|
var _ vcs.ReviewSuperseder = (*Adapter)(nil)
|
||||||
|
|
||||||
|
// SupersedeReviews marks prior reviews as superseded by editing their body with a
|
||||||
|
// link to the new review and resolving their inline comments. This is Gitea-specific
|
||||||
|
// behavior that has no GitHub equivalent (GitHub uses DismissReview instead).
|
||||||
|
//
|
||||||
|
// baseURL is the Gitea instance URL used to construct review permalink URLs.
|
||||||
|
// sentinel is the HTML comment sentinel that identifies reviews belonging to this reviewer.
|
||||||
|
func (a *Adapter) SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []vcs.Review, newReviewID int64, baseURL, sentinel string) error {
|
||||||
|
// Validate baseURL scheme before embedding in Markdown link (defense-in-depth).
|
||||||
|
if !strings.HasPrefix(baseURL, "http://") && !strings.HasPrefix(baseURL, "https://") {
|
||||||
|
return fmt.Errorf("SupersedeReviews: baseURL must have http or https scheme, got %q", baseURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
underlying := a.client
|
||||||
|
|
||||||
|
newReviewURL := fmt.Sprintf("%s/%s/%s/pulls/%d#pullrequestreview-%d",
|
||||||
|
strings.TrimRight(baseURL, "/"), owner, repo, prNumber, newReviewID)
|
||||||
|
|
||||||
|
for _, oldReview := range oldReviews {
|
||||||
|
cid, err := underlying.GetTimelineReviewCommentIDForReview(ctx, owner, repo, prNumber, oldReview.ID)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not find comment ID for old review", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
supersededBody := buildSupersededBody(oldReview.Body, oldReview.CommitID, newReviewURL, sentinel)
|
||||||
|
if err := underlying.EditComment(ctx, owner, repo, cid, supersededBody); err != nil {
|
||||||
|
slog.Warn("could not mark old review as superseded", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve old review's inline comments
|
||||||
|
oldComments, err := underlying.ListReviewComments(ctx, owner, repo, prNumber, oldReview.ID)
|
||||||
|
if err != nil {
|
||||||
|
slog.Warn("could not list old review comments for resolution", "review_id", oldReview.ID, "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, c := range oldComments {
|
||||||
|
if c.ID == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := underlying.ResolveComment(ctx, owner, repo, c.ID); err != nil {
|
||||||
|
slog.Debug("could not resolve inline comment", "comment_id", c.ID, "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildSupersededBody creates the body for a superseded review: struck-through banner
|
||||||
|
// with collapsed original content and the commit it was evaluated against.
|
||||||
|
func buildSupersededBody(originalBody, commitSHA, newReviewURL, sentinel string) string {
|
||||||
|
shortSHA := commitSHA
|
||||||
|
if len(shortSHA) > 8 {
|
||||||
|
shortSHA = shortSHA[:8]
|
||||||
|
}
|
||||||
|
var sb strings.Builder
|
||||||
|
sb.WriteString("~~Original review~~\n\n")
|
||||||
|
sb.WriteString("**Superseded** \u2014 [see current review](")
|
||||||
|
sb.WriteString(newReviewURL)
|
||||||
|
sb.WriteString(") for up-to-date findings.\n\n")
|
||||||
|
if shortSHA != "" {
|
||||||
|
sb.WriteString("<details><summary>Previous findings (commit ")
|
||||||
|
sb.WriteString(shortSHA)
|
||||||
|
sb.WriteString(")</summary>\n\n")
|
||||||
|
} else {
|
||||||
|
sb.WriteString("<details><summary>Previous findings</summary>\n\n")
|
||||||
|
}
|
||||||
|
sb.WriteString(originalBody)
|
||||||
|
sb.WriteString("\n\n</details>\n\n")
|
||||||
|
sb.WriteString(sentinel)
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|||||||
@@ -386,3 +386,25 @@ func TestAdapter_GetFileContent_RefRouting(t *testing.T) {
|
|||||||
t.Errorf("GetFileContent(ref=\"abc123\") = %q, want %q", got, "content-at-ref")
|
t.Errorf("GetFileContent(ref=\"abc123\") = %q, want %q", got, "content-at-ref")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAdapter_RequestReviewerSelf(t *testing.T) {
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
t.Errorf("expected POST, got %s", r.Method)
|
||||||
|
}
|
||||||
|
expected := "/api/v1/repos/owner/repo/pulls/5/requested_reviewers"
|
||||||
|
if r.URL.Path != expected {
|
||||||
|
t.Errorf("path = %q, want %q", r.URL.Path, expected)
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
}))
|
||||||
|
defer server.Close()
|
||||||
|
|
||||||
|
client := gitea.NewClient(server.URL, "token")
|
||||||
|
adapter := gitea.NewAdapter(client)
|
||||||
|
|
||||||
|
err := adapter.RequestReviewerSelf(context.Background(), "owner", "repo", 5, "bot-user")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("RequestReviewerSelf() error = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+11
-4
@@ -11,6 +11,7 @@ import (
|
|||||||
type PositionMap struct {
|
type PositionMap struct {
|
||||||
// files maps filename → (position → new-file line number).
|
// files maps filename → (position → new-file line number).
|
||||||
// Deletion lines are mapped to -1 (no new-file line).
|
// Deletion lines are mapped to -1 (no new-file line).
|
||||||
|
// Hunk-header lines are mapped to 0 (no new-file line).
|
||||||
files map[string]map[int]int
|
files map[string]map[int]int
|
||||||
// maxPositions caches the highest position number per file,
|
// maxPositions caches the highest position number per file,
|
||||||
// tracked during construction to avoid O(n) scans at translate time.
|
// tracked during construction to avoid O(n) scans at translate time.
|
||||||
@@ -19,8 +20,8 @@ type PositionMap struct {
|
|||||||
|
|
||||||
// Translate converts a GitHub diff-position to a new-file line number for a given file.
|
// Translate converts a GitHub diff-position to a new-file line number for a given file.
|
||||||
// Returns an error if the file is not in the diff or the position is out of range.
|
// Returns an error if the file is not in the diff or the position is out of range.
|
||||||
// If the position targets a deletion line, it maps to the nearest non-deletion line below;
|
// If the position targets a deletion or hunk-header line, it maps to the nearest
|
||||||
// if no such line exists, returns an error.
|
// context/addition line below; if no such line exists, returns an error.
|
||||||
func (pm *PositionMap) Translate(file string, position int) (int, error) {
|
func (pm *PositionMap) Translate(file string, position int) (int, error) {
|
||||||
if pm == nil || pm.files == nil {
|
if pm == nil || pm.files == nil {
|
||||||
return 0, fmt.Errorf("empty position map")
|
return 0, fmt.Errorf("empty position map")
|
||||||
@@ -41,14 +42,18 @@ func (pm *PositionMap) Translate(file string, position int) (int, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// lineNum == -1 means this position is a deletion line.
|
// lineNum == -1 means this position is a deletion line.
|
||||||
// Map to the nearest non-deletion line below.
|
// lineNum == 0 means this position is a hunk-header line.
|
||||||
if lineNum == -1 {
|
// Both map to the nearest context/addition line below.
|
||||||
|
if lineNum <= 0 {
|
||||||
maxPos := pm.maxPosition(file)
|
maxPos := pm.maxPosition(file)
|
||||||
for p := position + 1; p <= maxPos; p++ {
|
for p := position + 1; p <= maxPos; p++ {
|
||||||
if ln, exists := fileMap[p]; exists && ln > 0 {
|
if ln, exists := fileMap[p]; exists && ln > 0 {
|
||||||
return ln, nil
|
return ln, nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if lineNum == 0 {
|
||||||
|
return 0, fmt.Errorf("position %d targets a hunk-header line with no subsequent new-file line in %q", position, file)
|
||||||
|
}
|
||||||
return 0, fmt.Errorf("position %d targets a deletion line with no subsequent new-file line in %q", position, file)
|
return 0, fmt.Errorf("position %d targets a deletion line with no subsequent new-file line in %q", position, file)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,6 +75,7 @@ func (pm *PositionMap) maxPosition(file string) int {
|
|||||||
// - A new @@ hunk within the same file continues incrementing (does not reset)
|
// - A new @@ hunk within the same file continues incrementing (does not reset)
|
||||||
// - Position maps to the new file line number for additions and context lines
|
// - Position maps to the new file line number for additions and context lines
|
||||||
// - Deletion lines have a position but no new-file line number (stored as -1)
|
// - Deletion lines have a position but no new-file line number (stored as -1)
|
||||||
|
// - Hunk-header lines have a position but no new-file line number (stored as 0)
|
||||||
func BuildPositionToLineMap(diff string) *PositionMap {
|
func BuildPositionToLineMap(diff string) *PositionMap {
|
||||||
pm := &PositionMap{
|
pm := &PositionMap{
|
||||||
files: make(map[string]map[int]int),
|
files: make(map[string]map[int]int),
|
||||||
@@ -126,6 +132,7 @@ func BuildPositionToLineMap(diff string) *PositionMap {
|
|||||||
// Parse hunk headers
|
// Parse hunk headers
|
||||||
if strings.HasPrefix(line, "@@") && currentFile != "" {
|
if strings.HasPrefix(line, "@@") && currentFile != "" {
|
||||||
position++
|
position++
|
||||||
|
pm.files[currentFile][position] = 0 // sentinel: hunk-header has no new-file line
|
||||||
pm.maxPositions[currentFile] = position
|
pm.maxPositions[currentFile] = position
|
||||||
newLine = parseHunkStart(line)
|
newLine = parseHunkStart(line)
|
||||||
continue
|
continue
|
||||||
|
|||||||
@@ -272,3 +272,112 @@ diff --git a/b.go b/b.go
|
|||||||
t.Errorf("Translate(b.go, 3) = %d, want 2", got)
|
t.Errorf("Translate(b.go, 3) = %d, want 2", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTranslate_HunkHeaderPosition_SingleHunk(t *testing.T) {
|
||||||
|
// Position 1 is the @@ hunk-header line.
|
||||||
|
// It should resolve to the first context/addition line below (new line 16).
|
||||||
|
diff := `diff --git a/file.go b/file.go
|
||||||
|
index abc..def 100644
|
||||||
|
--- a/file.go
|
||||||
|
+++ b/file.go
|
||||||
|
@@ -16,4 +16,5 @@ func example() {
|
||||||
|
context line
|
||||||
|
-deleted line
|
||||||
|
+added line
|
||||||
|
context after
|
||||||
|
`
|
||||||
|
pm := BuildPositionToLineMap(diff)
|
||||||
|
|
||||||
|
got, err := pm.Translate("file.go", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Translate(file.go, 1): unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if got != 16 {
|
||||||
|
t.Errorf("Translate(file.go, 1) = %d, want 16 (first context/addition line in hunk)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTranslate_HunkHeaderPosition_MultiHunk(t *testing.T) {
|
||||||
|
// First hunk: @@ is pos 1, then " line1" (pos 2), "-old" (pos 3), "+new" (pos 4)
|
||||||
|
// Second hunk: @@ is pos 5, then " func foo() {" (pos 6), "+// added" (pos 7), etc.
|
||||||
|
// Translating position 5 (second @@) should resolve to new line 10.
|
||||||
|
diff := `diff --git a/file.go b/file.go
|
||||||
|
--- a/file.go
|
||||||
|
+++ b/file.go
|
||||||
|
@@ -1,3 +1,3 @@ package main
|
||||||
|
line1
|
||||||
|
-old
|
||||||
|
+new
|
||||||
|
@@ -10,3 +10,4 @@ func foo() {
|
||||||
|
func foo() {
|
||||||
|
+ // added
|
||||||
|
return
|
||||||
|
}
|
||||||
|
`
|
||||||
|
pm := BuildPositionToLineMap(diff)
|
||||||
|
|
||||||
|
// Position 5 is the second @@ hunk-header — should resolve to new line 10
|
||||||
|
got, err := pm.Translate("file.go", 5)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Translate(file.go, 5): unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if got != 10 {
|
||||||
|
t.Errorf("Translate(file.go, 5) = %d, want 10 (first context/addition line in second hunk)", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Also verify first hunk header at position 1 resolves to new line 1
|
||||||
|
got, err = pm.Translate("file.go", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Translate(file.go, 1): unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if got != 1 {
|
||||||
|
t.Errorf("Translate(file.go, 1) = %d, want 1 (first context/addition line in first hunk)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTranslate_HunkHeaderPosition_NewFile(t *testing.T) {
|
||||||
|
// New file: @@ -0,0 +1,3 @@ is position 1.
|
||||||
|
// Should resolve to new line 1 (the first addition).
|
||||||
|
diff := `diff --git a/new.go b/new.go
|
||||||
|
new file mode 100644
|
||||||
|
--- /dev/null
|
||||||
|
+++ b/new.go
|
||||||
|
@@ -0,0 +1,3 @@
|
||||||
|
+package main
|
||||||
|
+
|
||||||
|
+func init() {}
|
||||||
|
`
|
||||||
|
pm := BuildPositionToLineMap(diff)
|
||||||
|
|
||||||
|
got, err := pm.Translate("new.go", 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Translate(new.go, 1): unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if got != 1 {
|
||||||
|
t.Errorf("Translate(new.go, 1) = %d, want 1 (first addition line)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTranslate_HunkHeaderAtEnd(t *testing.T) {
|
||||||
|
// A hunk-header at the last position with no subsequent new-file line should error.
|
||||||
|
// This is the hunk-header equivalent of TestBuildPositionToLineMap_DeletionAtEnd.
|
||||||
|
diff := `diff --git a/file.go b/file.go
|
||||||
|
--- a/file.go
|
||||||
|
+++ b/file.go
|
||||||
|
@@ -1,2 +1,2 @@ package main
|
||||||
|
line1
|
||||||
|
-old
|
||||||
|
+new
|
||||||
|
@@ -10,2 +10,1 @@ func foo() {
|
||||||
|
-removed
|
||||||
|
`
|
||||||
|
pm := BuildPositionToLineMap(diff)
|
||||||
|
|
||||||
|
// Position 5 is the second @@ hunk-header; the only line after it (pos 6) is a
|
||||||
|
// deletion (lineNum == -1), so there's no positive new-file line to resolve to.
|
||||||
|
// The hunk-header lookup should fail.
|
||||||
|
_, err := pm.Translate("file.go", 5)
|
||||||
|
if err == nil {
|
||||||
|
t.Error("expected error for hunk-header at end with no subsequent new-file line")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package gitea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildSupersededBody(t *testing.T) {
|
||||||
|
original := "# Review\n\nLooks good.\n\n<!-- review-bot:sonnet -->"
|
||||||
|
sentinel := "<!-- review-bot:sonnet -->"
|
||||||
|
newURL := "https://gitea.example.com/owner/repo/pulls/1#pullrequestreview-99"
|
||||||
|
|
||||||
|
result := buildSupersededBody(original, "abcdef1234567890", newURL, sentinel)
|
||||||
|
|
||||||
|
// Should contain the struck-through banner
|
||||||
|
if !strings.Contains(result, "~~Original review~~") {
|
||||||
|
t.Error("missing struck-through banner")
|
||||||
|
}
|
||||||
|
// Should contain superseded notice with link
|
||||||
|
if !strings.Contains(result, "**Superseded**") {
|
||||||
|
t.Error("missing superseded notice")
|
||||||
|
}
|
||||||
|
if !strings.Contains(result, "[see current review]("+newURL+")") {
|
||||||
|
t.Error("missing link to new review")
|
||||||
|
}
|
||||||
|
// Should contain collapsed original
|
||||||
|
if !strings.Contains(result, "<details>") {
|
||||||
|
t.Error("missing details/collapse")
|
||||||
|
}
|
||||||
|
// Should contain short commit SHA
|
||||||
|
if !strings.Contains(result, "abcdef12") {
|
||||||
|
t.Error("missing short SHA")
|
||||||
|
}
|
||||||
|
// Should NOT contain full SHA in summary (it's truncated to 8)
|
||||||
|
if strings.Contains(result, "abcdef1234567890") {
|
||||||
|
t.Error("should truncate SHA to 8 chars")
|
||||||
|
}
|
||||||
|
// Should contain the original body inside details
|
||||||
|
if !strings.Contains(result, original) {
|
||||||
|
t.Error("original body not preserved in collapsed section")
|
||||||
|
}
|
||||||
|
// Should end with sentinel
|
||||||
|
if !strings.Contains(result, sentinel) {
|
||||||
|
t.Error("missing sentinel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildSupersededBodyShortSHA(t *testing.T) {
|
||||||
|
// Short SHA should pass through without panic
|
||||||
|
result := buildSupersededBody("body", "abc", "https://example.com/review", "<!-- review-bot:x -->")
|
||||||
|
if !strings.Contains(result, "abc") {
|
||||||
|
t.Error("short SHA not preserved")
|
||||||
|
}
|
||||||
|
}
|
||||||
+56
-45
@@ -194,12 +194,25 @@ func (c *Client) SetRetryBackoff(d []time.Duration) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// doWithRetry performs an HTTP request with retry on 429 rate limit responses.
|
// requestOptions holds per-request configuration for doRequestCore.
|
||||||
// It delegates request construction to buildReq, which is called on each attempt
|
type requestOptions struct {
|
||||||
// to produce a fresh *http.Request (allowing body re-reads for POST/PUT).
|
// bodyFn returns a fresh io.Reader for the request body on each attempt.
|
||||||
// It respects the Retry-After header when present (capped at maxRetryAfter).
|
// Must be non-nil for any request that carries a body (POST, PUT, PATCH,
|
||||||
// Transport errors (network failures, context cancellation) are not retried.
|
// or DELETE when a body is required by the API).
|
||||||
func (c *Client) doWithRetry(ctx context.Context, reqURL string, buildReq func() (*http.Request, error)) ([]byte, error) {
|
// Returning a fresh reader on each call allows retries to re-send the body.
|
||||||
|
bodyFn func() io.Reader
|
||||||
|
|
||||||
|
// accept overrides the default Accept header. Empty means "application/vnd.github+json".
|
||||||
|
accept string
|
||||||
|
|
||||||
|
// extraHeaders are additional headers to set on each request attempt.
|
||||||
|
extraHeaders map[string]string
|
||||||
|
}
|
||||||
|
|
||||||
|
// doRequestCore is the shared implementation for all HTTP requests with retry
|
||||||
|
// on 429 rate limit responses. It respects the Retry-After header when present
|
||||||
|
// (capped at maxRetryAfter). Transport errors are not retried.
|
||||||
|
func (c *Client) doRequestCore(ctx context.Context, method, reqURL string, opts requestOptions) ([]byte, error) {
|
||||||
const maxRetryAfter = 120 * time.Second
|
const maxRetryAfter = 120 * time.Second
|
||||||
|
|
||||||
// maxErrorBodyBytes limits how much of an error response body is stored.
|
// maxErrorBodyBytes limits how much of an error response body is stored.
|
||||||
@@ -250,10 +263,29 @@ func (c *Client) doWithRetry(ctx context.Context, reqURL string, buildReq func()
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
req, err := buildReq()
|
var body io.Reader
|
||||||
|
if opts.bodyFn != nil {
|
||||||
|
body = opts.bodyFn()
|
||||||
|
}
|
||||||
|
req, err := http.NewRequestWithContext(ctx, method, reqURL, body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("create request: %w", err)
|
return nil, fmt.Errorf("create request: %w", err)
|
||||||
}
|
}
|
||||||
|
if c.token != "" {
|
||||||
|
// Bearer is the OAuth2 standard and is accepted by GitHub for both
|
||||||
|
// classic PATs and fine-grained tokens. The alternative "token" scheme
|
||||||
|
// is GitHub-specific and offers no additional compatibility.
|
||||||
|
req.Header.Set("Authorization", "Bearer "+c.token)
|
||||||
|
}
|
||||||
|
req.Header.Set("User-Agent", userAgent)
|
||||||
|
if opts.accept != "" {
|
||||||
|
req.Header.Set("Accept", opts.accept)
|
||||||
|
} else {
|
||||||
|
req.Header.Set("Accept", "application/vnd.github+json")
|
||||||
|
}
|
||||||
|
for k, v := range opts.extraHeaders {
|
||||||
|
req.Header.Set(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
resp, err := c.httpClient.Do(req)
|
resp, err := c.httpClient.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -264,9 +296,9 @@ func (c *Client) doWithRetry(ctx context.Context, reqURL string, buildReq func()
|
|||||||
respStatus := resp.StatusCode
|
respStatus := resp.StatusCode
|
||||||
retryAfterHeader := resp.Header.Get("Retry-After")
|
retryAfterHeader := resp.Header.Get("Retry-After")
|
||||||
|
|
||||||
body, done, handleErr := c.handleResponse(resp, maxResponseBytes, maxErrorBodyBytes)
|
respBody, done, handleErr := c.handleResponse(resp, maxResponseBytes, maxErrorBodyBytes)
|
||||||
if done {
|
if done {
|
||||||
return body, handleErr
|
return respBody, handleErr
|
||||||
}
|
}
|
||||||
lastErr = handleErr
|
lastErr = handleErr
|
||||||
|
|
||||||
@@ -310,26 +342,7 @@ func (c *Client) doWithRetry(ctx context.Context, reqURL string, buildReq func()
|
|||||||
// It respects the Retry-After header when present (capped at maxRetryAfter).
|
// It respects the Retry-After header when present (capped at maxRetryAfter).
|
||||||
// Transport errors (network failures, context cancellation) are not retried.
|
// Transport errors (network failures, context cancellation) are not retried.
|
||||||
func (c *Client) doRequest(ctx context.Context, method, reqURL string, accept string) ([]byte, error) {
|
func (c *Client) doRequest(ctx context.Context, method, reqURL string, accept string) ([]byte, error) {
|
||||||
buildReq := func() (*http.Request, error) {
|
return c.doRequestCore(ctx, method, reqURL, requestOptions{accept: accept})
|
||||||
req, err := http.NewRequestWithContext(ctx, method, reqURL, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if c.token != "" {
|
|
||||||
// Bearer is the OAuth2 standard and is accepted by GitHub for both
|
|
||||||
// classic PATs and fine-grained tokens. The alternative "token" scheme
|
|
||||||
// is GitHub-specific and offers no additional compatibility.
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
}
|
|
||||||
req.Header.Set("User-Agent", userAgent)
|
|
||||||
if accept != "" {
|
|
||||||
req.Header.Set("Accept", accept)
|
|
||||||
} else {
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
}
|
|
||||||
return req, nil
|
|
||||||
}
|
|
||||||
return c.doWithRetry(ctx, reqURL, buildReq)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleResponse reads and closes the response body, returning the result.
|
// handleResponse reads and closes the response body, returning the result.
|
||||||
@@ -361,8 +374,20 @@ func (c *Client) doGet(ctx context.Context, reqURL string) ([]byte, error) {
|
|||||||
return c.doRequest(ctx, http.MethodGet, reqURL, "")
|
return c.doRequest(ctx, http.MethodGet, reqURL, "")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// doRequestWithBody is like doRequest but sends a request body.
|
||||||
|
// It accepts the raw body bytes and sets Content-Type to application/json.
|
||||||
|
// Retry semantics match doRequest (retries on 429 with Retry-After support).
|
||||||
|
func (c *Client) doRequestWithBody(ctx context.Context, method, reqURL string, reqBody []byte) ([]byte, error) {
|
||||||
|
var opts requestOptions
|
||||||
|
if reqBody != nil {
|
||||||
|
opts.bodyFn = func() io.Reader { return bytes.NewReader(reqBody) }
|
||||||
|
opts.extraHeaders = map[string]string{"Content-Type": "application/json"}
|
||||||
|
}
|
||||||
|
return c.doRequestCore(ctx, method, reqURL, opts)
|
||||||
|
}
|
||||||
|
|
||||||
// doJSONRequest performs an HTTP request with a JSON body and returns the response body.
|
// doJSONRequest performs an HTTP request with a JSON body and returns the response body.
|
||||||
// It delegates retry/backoff/429 handling to doWithRetry.
|
// It delegates retry/backoff/429 handling to doRequestWithBody.
|
||||||
// This is a general-purpose helper used by any method that needs to send JSON payloads
|
// This is a general-purpose helper used by any method that needs to send JSON payloads
|
||||||
// (e.g. PostReview, DismissReview).
|
// (e.g. PostReview, DismissReview).
|
||||||
func (c *Client) doJSONRequest(ctx context.Context, method, reqURL string, payload any) ([]byte, error) {
|
func (c *Client) doJSONRequest(ctx context.Context, method, reqURL string, payload any) ([]byte, error) {
|
||||||
@@ -370,19 +395,5 @@ func (c *Client) doJSONRequest(ctx context.Context, method, reqURL string, paylo
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("marshal request body: %w", err)
|
return nil, fmt.Errorf("marshal request body: %w", err)
|
||||||
}
|
}
|
||||||
|
return c.doRequestWithBody(ctx, method, reqURL, jsonBody)
|
||||||
buildReq := func() (*http.Request, error) {
|
|
||||||
req, err := http.NewRequestWithContext(ctx, method, reqURL, bytes.NewReader(jsonBody))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if c.token != "" {
|
|
||||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
|
||||||
}
|
|
||||||
req.Header.Set("User-Agent", userAgent)
|
|
||||||
req.Header.Set("Accept", "application/vnd.github+json")
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
return req, nil
|
|
||||||
}
|
|
||||||
return c.doWithRetry(ctx, reqURL, buildReq)
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -568,7 +568,6 @@ func TestSetHTTPClient_NilRestoresDefault(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
func TestSetRetryBackoff_RejectsInvalidLength(t *testing.T) {
|
func TestSetRetryBackoff_RejectsInvalidLength(t *testing.T) {
|
||||||
c := NewClient("token", "https://api.github.com")
|
c := NewClient("token", "https://api.github.com")
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,10 @@ import (
|
|||||||
"gitea.weiker.me/rodin/review-bot/vcs"
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Compile-time interface conformance assertions.
|
// Compile-time interface conformance assertion.
|
||||||
// These verify github.Client satisfies vcs.Client (the full interface).
|
// This verifies github.Client satisfies the full vcs.Client interface
|
||||||
|
// (PRReader, FileReader, Reviewer, Identity).
|
||||||
var _ vcs.Client = (*github.Client)(nil)
|
var _ vcs.Client = (*github.Client)(nil)
|
||||||
|
|
||||||
|
// Verify github.Client implements ReviewSuperseder.
|
||||||
|
var _ vcs.ReviewSuperseder = (*github.Client)(nil)
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
package github
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// newTestClient creates a *Client backed by an httptest.Server running the
|
||||||
|
// given handler. The server is automatically closed when the test finishes.
|
||||||
|
// Shared across test files in package github.
|
||||||
|
func newTestClient(t *testing.T, handler http.HandlerFunc) *Client {
|
||||||
|
t.Helper()
|
||||||
|
srv := httptest.NewServer(handler)
|
||||||
|
t.Cleanup(srv.Close)
|
||||||
|
c := NewClient("test-token", srv.URL, AllowInsecureHTTP())
|
||||||
|
c.SetHTTPClient(srv.Client())
|
||||||
|
if err := c.SetRetryBackoff([]time.Duration{1 * time.Millisecond, 1 * time.Millisecond}); err != nil {
|
||||||
|
t.Fatalf("SetRetryBackoff: %v", err)
|
||||||
|
}
|
||||||
|
return c
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
package github
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// userResponse is the GitHub API response for the authenticated user.
|
||||||
|
type userResponse struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAuthenticatedUser returns the login of the currently authenticated user.
|
||||||
|
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
||||||
|
reqURL := fmt.Sprintf("%s/user", c.baseURL)
|
||||||
|
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("get authenticated user: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var resp userResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return "", fmt.Errorf("parse user response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return resp.Login, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package github
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGetAuthenticatedUser_HappyPath(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "GET" {
|
||||||
|
t.Errorf("expected GET, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.URL.Path != "/user" {
|
||||||
|
t.Errorf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
if r.Header.Get("Authorization") != "Bearer test-token" {
|
||||||
|
t.Errorf("unexpected auth header: %s", r.Header.Get("Authorization"))
|
||||||
|
}
|
||||||
|
json.NewEncoder(w).Encode(map[string]string{"login": "review-bot"})
|
||||||
|
})
|
||||||
|
|
||||||
|
login, err := c.GetAuthenticatedUser(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if login != "review-bot" {
|
||||||
|
t.Errorf("expected login 'review-bot', got %q", login)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetAuthenticatedUser_401(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(401)
|
||||||
|
w.Write([]byte(`{"message":"Bad credentials"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.GetAuthenticatedUser(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 401")
|
||||||
|
}
|
||||||
|
if !IsUnauthorized(err) {
|
||||||
|
t.Errorf("expected IsUnauthorized=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,225 @@
|
|||||||
|
package github
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrCannotDeleteSubmittedReview is returned when DeleteReview is called on
|
||||||
|
// a review that has already been submitted (APPROVED, REQUEST_CHANGES, COMMENT).
|
||||||
|
// GitHub only allows deletion of PENDING reviews. Callers that need to replace
|
||||||
|
// a submitted review should use DismissReview instead.
|
||||||
|
var ErrCannotDeleteSubmittedReview = errors.New("cannot delete submitted review: use DismissReview instead")
|
||||||
|
|
||||||
|
// ErrConflictingCommitIDs is returned when PostReview receives comments with
|
||||||
|
// differing non-empty CommitIDs. The GitHub API accepts only a single commit_id
|
||||||
|
// per review submission; callers must ensure all comments target the same commit.
|
||||||
|
var ErrConflictingCommitIDs = errors.New("comments contain conflicting commit IDs: all must target the same commit")
|
||||||
|
|
||||||
|
// postReviewRequest is the GitHub API request body for creating a review.
|
||||||
|
type postReviewRequest struct {
|
||||||
|
CommitID string `json:"commit_id,omitempty"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
Comments []reviewCommentEntry `json:"comments,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// reviewCommentEntry is a single inline comment in a review creation request.
|
||||||
|
type reviewCommentEntry struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Position int `json:"position"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// reviewResponse is the GitHub API response for a review.
|
||||||
|
type reviewResponse struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Body string `json:"body"`
|
||||||
|
State string `json:"state"`
|
||||||
|
CommitID string `json:"commit_id"`
|
||||||
|
User struct {
|
||||||
|
Login string `json:"login"`
|
||||||
|
} `json:"user"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// dismissReviewRequest is the GitHub API request body for dismissing a review.
|
||||||
|
type dismissReviewRequest struct {
|
||||||
|
Message string `json:"message"`
|
||||||
|
Event string `json:"event"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// translateGitHubReviewState translates a GitHub API review state to the
|
||||||
|
// canonical vcs.Review.State value.
|
||||||
|
func translateGitHubReviewState(state string) string {
|
||||||
|
switch state {
|
||||||
|
case "CHANGES_REQUESTED":
|
||||||
|
return "REQUEST_CHANGES"
|
||||||
|
case "COMMENTED":
|
||||||
|
return "COMMENT"
|
||||||
|
default:
|
||||||
|
// States like APPROVED, DISMISSED, and PENDING pass through unchanged
|
||||||
|
// as they already match the canonical vcs representation. PENDING appears
|
||||||
|
// on draft reviews that have not yet been submitted via the GitHub UI or API.
|
||||||
|
return state
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostReview submits a review on a pull request.
|
||||||
|
//
|
||||||
|
// The vcs.ReviewEvent constants (ReviewEventApprove, ReviewEventRequestChanges,
|
||||||
|
// ReviewEventComment) have string values that match GitHub's wire-format event
|
||||||
|
// strings (APPROVE, REQUEST_CHANGES, COMMENT), so Event is cast directly to
|
||||||
|
// string without translation.
|
||||||
|
//
|
||||||
|
// ReviewComment.Position maps directly to the GitHub API position field.
|
||||||
|
// When req.Comments is empty, the payload omits the comments field entirely
|
||||||
|
// (via the omitempty tag on postReviewRequest.Comments).
|
||||||
|
//
|
||||||
|
// The GitHub API accepts a single commit_id per review submission. PostReview
|
||||||
|
// extracts it from the first comment with a non-empty CommitID. If any subsequent
|
||||||
|
// comment specifies a different CommitID, PostReview returns ErrConflictingCommitIDs.
|
||||||
|
// Comments with an empty CommitID are allowed and inherit the review-level value.
|
||||||
|
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, req vcs.ReviewRequest) (*vcs.Review, error) {
|
||||||
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
||||||
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
|
|
||||||
|
payload := postReviewRequest{
|
||||||
|
Body: req.Body,
|
||||||
|
Event: string(req.Event),
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build the payload in one pass. The GitHub API accepts a single commit_id
|
||||||
|
// per review; we extract it from the first comment that supplies one and
|
||||||
|
// reject the request if any other comment disagrees.
|
||||||
|
for _, comment := range req.Comments {
|
||||||
|
if comment.CommitID != "" {
|
||||||
|
if payload.CommitID == "" {
|
||||||
|
payload.CommitID = comment.CommitID
|
||||||
|
} else if payload.CommitID != comment.CommitID {
|
||||||
|
return nil, ErrConflictingCommitIDs
|
||||||
|
}
|
||||||
|
}
|
||||||
|
payload.Comments = append(payload.Comments, reviewCommentEntry{
|
||||||
|
Path: comment.Path,
|
||||||
|
Position: comment.Position,
|
||||||
|
Body: comment.Body,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(payload)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("marshal review request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := c.doRequestWithBody(ctx, http.MethodPost, reqURL, data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("post review: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var resp reviewResponse
|
||||||
|
if err := json.Unmarshal(body, &resp); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse review response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &vcs.Review{
|
||||||
|
ID: resp.ID,
|
||||||
|
Body: resp.Body,
|
||||||
|
User: vcs.UserInfo{Login: resp.User.Login},
|
||||||
|
State: translateGitHubReviewState(resp.State),
|
||||||
|
CommitID: resp.CommitID,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListReviews retrieves all reviews for a pull request.
|
||||||
|
// GitHub review states are translated to canonical vcs values.
|
||||||
|
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcs.Review, error) {
|
||||||
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
||||||
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
||||||
|
|
||||||
|
body, err := c.doGet(ctx, reqURL)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("list reviews: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var responses []reviewResponse
|
||||||
|
if err := json.Unmarshal(body, &responses); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse reviews response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reviews := make([]vcs.Review, len(responses))
|
||||||
|
for i, r := range responses {
|
||||||
|
reviews[i] = vcs.Review{
|
||||||
|
ID: r.ID,
|
||||||
|
Body: r.Body,
|
||||||
|
User: vcs.UserInfo{Login: r.User.Login},
|
||||||
|
State: translateGitHubReviewState(r.State),
|
||||||
|
CommitID: r.CommitID,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return reviews, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteReview deletes a pull request review.
|
||||||
|
// Only PENDING reviews can be deleted; attempting to delete a submitted review
|
||||||
|
// (APPROVED, CHANGES_REQUESTED, or COMMENTED per GitHub API naming) returns
|
||||||
|
// ErrCannotDeleteSubmittedReview.
|
||||||
|
func (c *Client) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
||||||
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d",
|
||||||
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, reviewID)
|
||||||
|
|
||||||
|
// nil body: the GitHub DELETE endpoint for reviews requires no request body.
|
||||||
|
_, err := c.doRequestWithBody(ctx, http.MethodDelete, reqURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
var apiErr *APIError
|
||||||
|
if errors.As(err, &apiErr) && apiErr.StatusCode == 422 {
|
||||||
|
return fmt.Errorf("delete review: %w", ErrCannotDeleteSubmittedReview)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("delete review: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DismissReview dismisses a submitted review on a pull request.
|
||||||
|
// This is the correct way to "remove" a submitted review (APPROVED, REQUEST_CHANGES).
|
||||||
|
// GitHub does not allow deleting submitted reviews — they must be dismissed.
|
||||||
|
func (c *Client) DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, message string) error {
|
||||||
|
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d/dismissals",
|
||||||
|
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, reviewID)
|
||||||
|
|
||||||
|
payload := dismissReviewRequest{
|
||||||
|
Message: message,
|
||||||
|
// Event is required by the GitHub API for dismissal requests, even though
|
||||||
|
// "DISMISS" is the only valid value for this endpoint.
|
||||||
|
Event: "DISMISS",
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(payload)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("marshal dismiss request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = c.doRequestWithBody(ctx, http.MethodPut, reqURL, data)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("dismiss review: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SupersedeReviews marks prior reviews as superseded by dismissing them.
|
||||||
|
// This implements vcs.ReviewSuperseder for the GitHub adapter.
|
||||||
|
// The baseURL and sentinel parameters are unused for GitHub (dismissal is the mechanism).
|
||||||
|
func (c *Client) SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []vcs.Review, newReviewID int64, _, _ string) error {
|
||||||
|
var errs []error
|
||||||
|
for _, old := range oldReviews {
|
||||||
|
if err := c.DismissReview(ctx, owner, repo, prNumber, old.ID, "Superseded by new review"); err != nil {
|
||||||
|
errs = append(errs, fmt.Errorf("dismiss review %d: %w", old.ID, err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return errors.Join(errs...)
|
||||||
|
}
|
||||||
@@ -0,0 +1,391 @@
|
|||||||
|
package github
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.weiker.me/rodin/review-bot/vcs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// --- PostReview tests ---
|
||||||
|
|
||||||
|
func TestPostReview_HappyPath(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "POST" {
|
||||||
|
t.Fatalf("expected POST, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.URL.Path != "/repos/owner/repo/pulls/5/reviews" {
|
||||||
|
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
if r.Header.Get("Content-Type") != "application/json" {
|
||||||
|
t.Errorf("expected Content-Type application/json, got %q", r.Header.Get("Content-Type"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify request body
|
||||||
|
body, _ := io.ReadAll(r.Body)
|
||||||
|
var req postReviewRequest
|
||||||
|
if err := json.Unmarshal(body, &req); err != nil {
|
||||||
|
t.Fatalf("unmarshal request: %v", err)
|
||||||
|
}
|
||||||
|
if req.Event != "APPROVE" {
|
||||||
|
t.Errorf("expected event APPROVE, got %q", req.Event)
|
||||||
|
}
|
||||||
|
if req.Body != "LGTM" {
|
||||||
|
t.Errorf("expected body 'LGTM', got %q", req.Body)
|
||||||
|
}
|
||||||
|
if req.CommitID != "abc123" {
|
||||||
|
t.Errorf("expected commit_id 'abc123', got %q", req.CommitID)
|
||||||
|
}
|
||||||
|
if len(req.Comments) != 1 {
|
||||||
|
t.Fatalf("expected 1 comment, got %d", len(req.Comments))
|
||||||
|
}
|
||||||
|
if req.Comments[0].Path != "main.go" {
|
||||||
|
t.Errorf("expected comment path 'main.go', got %q", req.Comments[0].Path)
|
||||||
|
}
|
||||||
|
if req.Comments[0].Position != 4 {
|
||||||
|
t.Errorf("expected comment position 4, got %d", req.Comments[0].Position)
|
||||||
|
}
|
||||||
|
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"id": 100,
|
||||||
|
"body": "LGTM",
|
||||||
|
"state": "APPROVED",
|
||||||
|
"commit_id": "abc123",
|
||||||
|
"user": map[string]string{"login": "reviewer"},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
review, err := c.PostReview(context.Background(), "owner", "repo", 5, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
Comments: []vcs.ReviewComment{
|
||||||
|
{Path: "main.go", Position: 4, CommitID: "abc123", Body: "nit: rename"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if review.ID != 100 {
|
||||||
|
t.Errorf("expected ID 100, got %d", review.ID)
|
||||||
|
}
|
||||||
|
if review.Body != "LGTM" {
|
||||||
|
t.Errorf("expected body 'LGTM', got %q", review.Body)
|
||||||
|
}
|
||||||
|
if review.State != "APPROVED" {
|
||||||
|
t.Errorf("expected state 'APPROVED', got %q", review.State)
|
||||||
|
}
|
||||||
|
if review.User.Login != "reviewer" {
|
||||||
|
t.Errorf("expected user 'reviewer', got %q", review.User.Login)
|
||||||
|
}
|
||||||
|
if review.CommitID != "abc123" {
|
||||||
|
t.Errorf("expected commit_id 'abc123', got %q", review.CommitID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_401(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(401)
|
||||||
|
w.Write([]byte(`{"message":"Bad credentials"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 5, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 401")
|
||||||
|
}
|
||||||
|
if !IsUnauthorized(err) {
|
||||||
|
t.Errorf("expected IsUnauthorized=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_422(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(422)
|
||||||
|
w.Write([]byte(`{"message":"Unprocessable Entity"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 5, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 422")
|
||||||
|
}
|
||||||
|
// 422 should surface as a wrapped APIError
|
||||||
|
var apiErr *APIError
|
||||||
|
if !errors.As(err, &apiErr) {
|
||||||
|
t.Fatalf("expected *APIError, got %T: %v", err, err)
|
||||||
|
}
|
||||||
|
if apiErr.StatusCode != 422 {
|
||||||
|
t.Errorf("expected status 422, got %d", apiErr.StatusCode)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_MalformedResponse(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Write([]byte(`not json`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 5, vcs.ReviewRequest{
|
||||||
|
Body: "LGTM",
|
||||||
|
Event: vcs.ReviewEventApprove,
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for malformed response")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "parse review response") {
|
||||||
|
t.Errorf("expected parse error, got: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- ListReviews tests ---
|
||||||
|
|
||||||
|
func TestListReviews_HappyPath(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "GET" {
|
||||||
|
t.Fatalf("expected GET, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.URL.Path != "/repos/owner/repo/pulls/3/reviews" {
|
||||||
|
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
json.NewEncoder(w).Encode([]map[string]interface{}{
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"body": "Approved",
|
||||||
|
"state": "APPROVED",
|
||||||
|
"commit_id": "sha1",
|
||||||
|
"user": map[string]string{"login": "user1"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 2,
|
||||||
|
"body": "Needs work",
|
||||||
|
"state": "CHANGES_REQUESTED",
|
||||||
|
"commit_id": "sha2",
|
||||||
|
"user": map[string]string{"login": "user2"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 3,
|
||||||
|
"body": "Comment only",
|
||||||
|
"state": "COMMENTED",
|
||||||
|
"commit_id": "sha3",
|
||||||
|
"user": map[string]string{"login": "user3"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 4,
|
||||||
|
"body": "Old review",
|
||||||
|
"state": "DISMISSED",
|
||||||
|
"commit_id": "sha4",
|
||||||
|
"user": map[string]string{"login": "user4"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
reviews, err := c.ListReviews(context.Background(), "owner", "repo", 3)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if len(reviews) != 4 {
|
||||||
|
t.Fatalf("expected 4 reviews, got %d", len(reviews))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check state translation
|
||||||
|
expected := []struct {
|
||||||
|
id int64
|
||||||
|
state string
|
||||||
|
}{
|
||||||
|
{1, "APPROVED"},
|
||||||
|
{2, "REQUEST_CHANGES"},
|
||||||
|
{3, "COMMENT"},
|
||||||
|
{4, "DISMISSED"},
|
||||||
|
}
|
||||||
|
for i, e := range expected {
|
||||||
|
if reviews[i].ID != e.id {
|
||||||
|
t.Errorf("review[%d]: expected ID %d, got %d", i, e.id, reviews[i].ID)
|
||||||
|
}
|
||||||
|
if reviews[i].State != e.state {
|
||||||
|
t.Errorf("review[%d]: expected state %q, got %q", i, e.state, reviews[i].State)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_404(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(404)
|
||||||
|
w.Write([]byte(`{"message":"Not Found"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.ListReviews(context.Background(), "owner", "repo", 999)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 404")
|
||||||
|
}
|
||||||
|
if !IsNotFound(err) {
|
||||||
|
t.Errorf("expected IsNotFound=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestListReviews_401(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(401)
|
||||||
|
w.Write([]byte(`{"message":"Bad credentials"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.ListReviews(context.Background(), "owner", "repo", 3)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 401")
|
||||||
|
}
|
||||||
|
if !IsUnauthorized(err) {
|
||||||
|
t.Errorf("expected IsUnauthorized=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- DeleteReview tests ---
|
||||||
|
|
||||||
|
func TestDeleteReview_HappyPath(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "DELETE" {
|
||||||
|
t.Fatalf("expected DELETE, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.URL.Path != "/repos/owner/repo/pulls/5/reviews/42" {
|
||||||
|
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
w.WriteHeader(204)
|
||||||
|
})
|
||||||
|
|
||||||
|
err := c.DeleteReview(context.Background(), "owner", "repo", 5, 42)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeleteReview_422_SubmittedReview(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(422)
|
||||||
|
w.Write([]byte(`{"message":"Can not delete a non pending review"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
err := c.DeleteReview(context.Background(), "owner", "repo", 5, 42)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 422")
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrCannotDeleteSubmittedReview) {
|
||||||
|
t.Errorf("expected ErrCannotDeleteSubmittedReview, got: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- DismissReview tests ---
|
||||||
|
|
||||||
|
func TestDismissReview_HappyPath(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != "PUT" {
|
||||||
|
t.Fatalf("expected PUT, got %s", r.Method)
|
||||||
|
}
|
||||||
|
if r.URL.Path != "/repos/owner/repo/pulls/5/reviews/10/dismissals" {
|
||||||
|
t.Fatalf("unexpected path: %s", r.URL.Path)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, _ := io.ReadAll(r.Body)
|
||||||
|
var req dismissReviewRequest
|
||||||
|
if err := json.Unmarshal(body, &req); err != nil {
|
||||||
|
t.Fatalf("unmarshal request: %v", err)
|
||||||
|
}
|
||||||
|
if req.Message != "Superseded by new review" {
|
||||||
|
t.Errorf("expected message 'Superseded by new review', got %q", req.Message)
|
||||||
|
}
|
||||||
|
if req.Event != "DISMISS" {
|
||||||
|
t.Errorf("expected event 'DISMISS', got %q", req.Event)
|
||||||
|
}
|
||||||
|
|
||||||
|
json.NewEncoder(w).Encode(map[string]interface{}{
|
||||||
|
"id": 10,
|
||||||
|
"state": "DISMISSED",
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
err := c.DismissReview(context.Background(), "owner", "repo", 5, 10, "Superseded by new review")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDismissReview_404(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(404)
|
||||||
|
w.Write([]byte(`{"message":"Not Found"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
err := c.DismissReview(context.Background(), "owner", "repo", 5, 999, "dismiss")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 404")
|
||||||
|
}
|
||||||
|
if !IsNotFound(err) {
|
||||||
|
t.Errorf("expected IsNotFound=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDismissReview_401(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(401)
|
||||||
|
w.Write([]byte(`{"message":"Bad credentials"}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
err := c.DismissReview(context.Background(), "owner", "repo", 5, 10, "dismiss")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for 401")
|
||||||
|
}
|
||||||
|
if !IsUnauthorized(err) {
|
||||||
|
t.Errorf("expected IsUnauthorized=true, got error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- State translation tests ---
|
||||||
|
|
||||||
|
func TestTranslateGitHubReviewState(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"approved passes through", "APPROVED", "APPROVED"},
|
||||||
|
{"changes_requested maps to REQUEST_CHANGES", "CHANGES_REQUESTED", "REQUEST_CHANGES"},
|
||||||
|
{"commented maps to COMMENT", "COMMENTED", "COMMENT"},
|
||||||
|
{"dismissed passes through", "DISMISSED", "DISMISSED"},
|
||||||
|
{"unknown state passes through", "UNKNOWN_STATE", "UNKNOWN_STATE"},
|
||||||
|
{"empty string passes through", "", ""},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got := translateGitHubReviewState(tt.input)
|
||||||
|
if got != tt.want {
|
||||||
|
t.Errorf("translateGitHubReviewState(%q) = %q, want %q", tt.input, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPostReview_ConflictingCommitIDs(t *testing.T) {
|
||||||
|
c := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
t.Fatal("request should not be sent when commit IDs conflict")
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := c.PostReview(context.Background(), "owner", "repo", 5, vcs.ReviewRequest{
|
||||||
|
Body: "Review",
|
||||||
|
Event: vcs.ReviewEventComment,
|
||||||
|
Comments: []vcs.ReviewComment{
|
||||||
|
{Path: "a.go", Position: 1, CommitID: "sha-1", Body: "first"},
|
||||||
|
{Path: "b.go", Position: 2, CommitID: "sha-2", Body: "second"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for conflicting commit IDs")
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrConflictingCommitIDs) {
|
||||||
|
t.Errorf("expected ErrConflictingCommitIDs, got: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,198 +0,0 @@
|
|||||||
package github
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
|
|
||||||
"gitea.weiker.me/rodin/review-bot/vcs"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// reviewsPerPage is the number of reviews to fetch per API page.
|
|
||||||
reviewsPerPage = 100
|
|
||||||
// maxReviewPages is the maximum number of pages to paginate through
|
|
||||||
// when listing reviews. Acts as a safeguard against infinite pagination.
|
|
||||||
maxReviewPages = 100
|
|
||||||
)
|
|
||||||
|
|
||||||
// reviewResponse is the GitHub API response for a pull request review.
|
|
||||||
type reviewResponse struct {
|
|
||||||
ID int64 `json:"id"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
User struct {
|
|
||||||
Login string `json:"login"`
|
|
||||||
} `json:"user"`
|
|
||||||
State string `json:"state"`
|
|
||||||
CommitID string `json:"commit_id"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// reviewCreateRequest is the GitHub API request body for creating a pull request review.
|
|
||||||
type reviewCreateRequest struct {
|
|
||||||
Body string `json:"body"`
|
|
||||||
Event string `json:"event"`
|
|
||||||
Comments []reviewCommentCreate `json:"comments,omitempty"`
|
|
||||||
CommitID string `json:"commit_id,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// reviewCommentCreate is a single inline comment in a review creation request.
|
|
||||||
type reviewCommentCreate struct {
|
|
||||||
Path string `json:"path"`
|
|
||||||
Position int `json:"position"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// dismissReviewRequest is the GitHub API request body for dismissing a review.
|
|
||||||
type dismissReviewRequest struct {
|
|
||||||
Message string `json:"message"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// userResponse is the GitHub API response for the authenticated user.
|
|
||||||
type userResponse struct {
|
|
||||||
Login string `json:"login"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// translateReviewEvent converts a vcs.ReviewEvent to the GitHub API event string.
|
|
||||||
func translateReviewEvent(event vcs.ReviewEvent) string {
|
|
||||||
switch event {
|
|
||||||
case vcs.ReviewEventApprove:
|
|
||||||
return "APPROVE"
|
|
||||||
case vcs.ReviewEventRequestChanges:
|
|
||||||
return "REQUEST_CHANGES"
|
|
||||||
default:
|
|
||||||
return "COMMENT"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// PostReview creates a new review on a pull request.
|
|
||||||
func (c *Client) PostReview(ctx context.Context, owner, repo string, number int, req vcs.ReviewRequest) (*vcs.Review, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number)
|
|
||||||
|
|
||||||
payload := reviewCreateRequest{
|
|
||||||
Body: req.Body,
|
|
||||||
Event: translateReviewEvent(req.Event),
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, comment := range req.Comments {
|
|
||||||
rc := reviewCommentCreate{
|
|
||||||
Path: comment.Path,
|
|
||||||
Position: comment.Position,
|
|
||||||
Body: comment.Body,
|
|
||||||
}
|
|
||||||
payload.Comments = append(payload.Comments, rc)
|
|
||||||
// Use CommitID from the first comment that has one.
|
|
||||||
// All comments in a single review are expected to reference the same commit.
|
|
||||||
if payload.CommitID == "" && comment.CommitID != "" {
|
|
||||||
payload.CommitID = comment.CommitID
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := c.doJSONRequest(ctx, http.MethodPost, reqURL, payload)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("post review: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var resp reviewResponse
|
|
||||||
if err := json.Unmarshal(body, &resp); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse review response: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return &vcs.Review{
|
|
||||||
ID: resp.ID,
|
|
||||||
Body: resp.Body,
|
|
||||||
User: vcs.UserInfo{Login: resp.User.Login},
|
|
||||||
State: resp.State,
|
|
||||||
CommitID: resp.CommitID,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListReviews lists all reviews on a pull request.
|
|
||||||
func (c *Client) ListReviews(ctx context.Context, owner, repo string, number int) ([]vcs.Review, error) {
|
|
||||||
var allReviews []vcs.Review
|
|
||||||
|
|
||||||
for page := 1; page <= maxReviewPages; page++ {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews?per_page=%d&page=%d",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, reviewsPerPage, page)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("list reviews page %d: %w", page, err)
|
|
||||||
}
|
|
||||||
var reviews []reviewResponse
|
|
||||||
if err := json.Unmarshal(body, &reviews); err != nil {
|
|
||||||
return nil, fmt.Errorf("parse reviews JSON: %w", err)
|
|
||||||
}
|
|
||||||
if len(reviews) == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
for _, r := range reviews {
|
|
||||||
allReviews = append(allReviews, vcs.Review{
|
|
||||||
ID: r.ID,
|
|
||||||
Body: r.Body,
|
|
||||||
User: vcs.UserInfo{Login: r.User.Login},
|
|
||||||
State: r.State,
|
|
||||||
CommitID: r.CommitID,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
if len(reviews) < reviewsPerPage {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
// NOTE: This warning only fires when the final page was full (the short-page
|
|
||||||
// break above did not trigger), meaning additional reviews likely exist beyond
|
|
||||||
// our page limit. The loop naturally exits after this iteration since page
|
|
||||||
// increments past maxReviewPages.
|
|
||||||
if page == maxReviewPages {
|
|
||||||
slog.Warn("ListReviews hit page limit; results may be truncated",
|
|
||||||
"owner", owner, "repo", repo, "pr", number,
|
|
||||||
"maxPages", maxReviewPages, "reviewsFetched", len(allReviews))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return allReviews, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeleteReview permanently deletes a review from a pull request.
|
|
||||||
// Use DismissReview instead when the review should remain visible but marked as dismissed
|
|
||||||
// (e.g., superseding an outdated review while preserving history).
|
|
||||||
func (c *Client) DeleteReview(ctx context.Context, owner, repo string, number int, reviewID int64) error {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, reviewID)
|
|
||||||
_, err := c.doRequest(ctx, http.MethodDelete, reqURL, "")
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("delete review: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DismissReview dismisses a review on a pull request with a message.
|
|
||||||
func (c *Client) DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, message string) error {
|
|
||||||
reqURL := fmt.Sprintf("%s/repos/%s/%s/pulls/%d/reviews/%d/dismissals",
|
|
||||||
c.baseURL, url.PathEscape(owner), url.PathEscape(repo), number, reviewID)
|
|
||||||
|
|
||||||
payload := dismissReviewRequest{
|
|
||||||
Message: message,
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := c.doJSONRequest(ctx, http.MethodPut, reqURL, payload)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("dismiss review: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAuthenticatedUser returns the login name of the authenticated user.
|
|
||||||
func (c *Client) GetAuthenticatedUser(ctx context.Context) (string, error) {
|
|
||||||
reqURL := fmt.Sprintf("%s/user", c.baseURL)
|
|
||||||
body, err := c.doGet(ctx, reqURL)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("get authenticated user: %w", err)
|
|
||||||
}
|
|
||||||
var resp userResponse
|
|
||||||
if err := json.Unmarshal(body, &resp); err != nil {
|
|
||||||
return "", fmt.Errorf("parse user response: %w", err)
|
|
||||||
}
|
|
||||||
return resp.Login, nil
|
|
||||||
}
|
|
||||||
@@ -2,4 +2,4 @@ module gitea.weiker.me/rodin/review-bot
|
|||||||
|
|
||||||
go 1.26.2
|
go 1.26.2
|
||||||
|
|
||||||
require github.com/goccy/go-yaml v1.19.2
|
require gopkg.in/yaml.v3 v3.0.1
|
||||||
|
|||||||
@@ -1,2 +1,4 @@
|
|||||||
github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
|||||||
+38
-146
@@ -5,15 +5,12 @@ import (
|
|||||||
"embed"
|
"embed"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"os"
|
"os"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
|
|
||||||
"github.com/goccy/go-yaml"
|
"gopkg.in/yaml.v3"
|
||||||
"github.com/goccy/go-yaml/ast"
|
|
||||||
"github.com/goccy/go-yaml/parser"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
//go:embed personas/*.yaml
|
//go:embed personas/*.yaml
|
||||||
@@ -121,7 +118,9 @@ func ListBuiltinPersonas() []string {
|
|||||||
default:
|
default:
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
seen[personaName] = true
|
if !seen[personaName] {
|
||||||
|
seen[personaName] = true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
names := make([]string, 0, len(seen))
|
names := make([]string, 0, len(seen))
|
||||||
for name := range seen {
|
for name := range seen {
|
||||||
@@ -143,19 +142,10 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
err = unmarshalYAMLWithDepthLimit(data, &p, MaxYAMLDepth)
|
err = unmarshalYAMLWithDepthLimit(data, &p, MaxYAMLDepth)
|
||||||
} else {
|
} else {
|
||||||
// Use json.Decoder with DisallowUnknownFields for consistency with
|
// Use json.Decoder with DisallowUnknownFields for consistency with
|
||||||
// YAML's Strict() - both reject unknown fields to catch typos.
|
// YAML's KnownFields(true) - both reject unknown fields to catch typos.
|
||||||
dec := json.NewDecoder(bytes.NewReader(data))
|
dec := json.NewDecoder(bytes.NewReader(data))
|
||||||
dec.DisallowUnknownFields()
|
dec.DisallowUnknownFields()
|
||||||
err = dec.Decode(&p)
|
err = dec.Decode(&p)
|
||||||
if err == nil {
|
|
||||||
// Reject trailing content after the first valid JSON object.
|
|
||||||
// Without this check, input like `{"name":"x"}garbage` would
|
|
||||||
// silently succeed because Decoder stops after one object.
|
|
||||||
var dummy json.RawMessage
|
|
||||||
if err2 := dec.Decode(&dummy); err2 != io.EOF {
|
|
||||||
err = fmt.Errorf("unexpected trailing content after JSON object")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("parse persona %s: %w", source, err)
|
return nil, fmt.Errorf("parse persona %s: %w", source, err)
|
||||||
@@ -166,164 +156,70 @@ func parsePersona(data []byte, source string) (*Persona, error) {
|
|||||||
return &p, nil
|
return &p, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// unmarshalYAMLWithDepthLimit unmarshals YAML data with three safety checks:
|
// unmarshalYAMLWithDepthLimit unmarshals YAML data with explicit depth limiting
|
||||||
// - Depth limiting: rejects AST trees exceeding maxDepth to prevent stack exhaustion.
|
// and strict field checking. This protects against stack exhaustion from deeply
|
||||||
// - Multi-document rejection: prevents silent data loss from ignored extra documents.
|
// nested structures and catches typos in field names.
|
||||||
// - Strict field checking: rejects unknown YAML keys to catch typos early.
|
// Multi-document YAML files are rejected to prevent silent data loss.
|
||||||
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
func unmarshalYAMLWithDepthLimit(data []byte, out any, maxDepth int) error {
|
||||||
// First pass: parse into AST to check depth limits, node counts, and
|
// First pass: decode into a yaml.Node to check depth limits and node counts.
|
||||||
// multi-document rejection. This prevents stack exhaustion before we
|
// This prevents stack exhaustion before we attempt to decode into structs.
|
||||||
// attempt to decode into structs.
|
var node yaml.Node
|
||||||
file, err := parser.ParseBytes(data, 0)
|
dec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
if err != nil {
|
if err := dec.Decode(&node); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reject empty YAML input (whitespace-only, comment-only, or truly empty files).
|
|
||||||
// The parser returns a single doc with nil body for these cases.
|
|
||||||
if len(file.Docs) == 0 || file.Docs[0].Body == nil {
|
|
||||||
return fmt.Errorf("empty YAML document")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reject multi-document YAML files - silently ignoring additional documents
|
// Reject multi-document YAML files - silently ignoring additional documents
|
||||||
// could lead to confusing behavior where users think their changes take effect.
|
// could lead to confusing behavior where users think their changes take effect.
|
||||||
if len(file.Docs) > 1 {
|
var extra yaml.Node
|
||||||
|
if dec.Decode(&extra) == nil {
|
||||||
return fmt.Errorf("multi-document YAML is not supported; only single-document files are allowed")
|
return fmt.Errorf("multi-document YAML is not supported; only single-document files are allowed")
|
||||||
}
|
}
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
if err := checkYAMLDepth(file.Docs[0].Body, 0, maxDepth, MaxYAMLNodes, make(map[ast.Node]int), make(map[ast.Node]bool), &nodeCount); err != nil {
|
if err := checkYAMLDepth(&node, 0, maxDepth, MaxYAMLNodes, make(map[*yaml.Node]struct{}), &nodeCount); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Second pass: decode with strict field checking enabled.
|
// Second pass: decode with strict field checking enabled.
|
||||||
// Strict() rejects unknown keys, catching typos like "focuss" or "identiy".
|
// KnownFields(true) rejects unknown keys, catching typos like "focuss" or "identiy".
|
||||||
//
|
// We must re-decode from the original data because yaml.Node.Decode() doesn't
|
||||||
// Safety note: goccy/go-yaml's decoder does not expand YAML aliases
|
// support the KnownFields option.
|
||||||
// recursively — it resolves them via the pre-built AST, which our first
|
strictDec := yaml.NewDecoder(bytes.NewReader(data))
|
||||||
// pass already depth-checked. Alias chains that would exceed depth limits
|
strictDec.KnownFields(true)
|
||||||
// are caught above; the decoder merely reads the resolved scalar values.
|
return strictDec.Decode(out)
|
||||||
dec := yaml.NewDecoder(bytes.NewReader(data), yaml.Strict())
|
|
||||||
return dec.Decode(out)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// checkYAMLDepth recursively checks that YAML AST nodes don't exceed the depth
|
// checkYAMLDepth recursively checks that YAML nodes don't exceed the depth limit
|
||||||
// limit or the total node count limit. It uses two tracking maps:
|
// or the total node count limit. It also detects alias cycles to prevent infinite
|
||||||
// - validated: maps each node to the maximum depth at which it was previously
|
// recursion from crafted YAML with self-referential aliases.
|
||||||
// checked. If a node is revisited at a deeper depth (e.g., via an alias),
|
func checkYAMLDepth(node *yaml.Node, depth, maxDepth, maxNodes int, seen map[*yaml.Node]struct{}, nodeCount *int) error {
|
||||||
// we re-check it to ensure the combined effective depth doesn't exceed limits.
|
|
||||||
// - visiting: per-path recursion stack for true cycle detection. A node on the
|
|
||||||
// current path is a cycle (alias loop); we return nil to avoid infinite recursion.
|
|
||||||
//
|
|
||||||
// This design prevents the alias depth bypass where an anchored subtree validated
|
|
||||||
// at a shallow depth could be referenced via alias at a greater depth, effectively
|
|
||||||
// exceeding MaxYAMLDepth.
|
|
||||||
func checkYAMLDepth(node ast.Node, depth, maxDepth, maxNodes int, validated map[ast.Node]int, visiting map[ast.Node]bool, nodeCount *int) error {
|
|
||||||
if node == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if depth > maxDepth {
|
if depth > maxDepth {
|
||||||
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
return fmt.Errorf("YAML nesting depth exceeds maximum (%d)", maxDepth)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cycle detection: if we're currently visiting this node on the current
|
|
||||||
// recursion path, it's a cycle (e.g., alias pointing to an ancestor).
|
|
||||||
// Return nil to break the cycle without error — cycles are a structural
|
|
||||||
// property, not a depth violation.
|
|
||||||
if visiting[node] {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Track total nodes visited as defense-in-depth against wide-but-shallow attacks.
|
// Track total nodes visited as defense-in-depth against wide-but-shallow attacks.
|
||||||
// Placed after cycle detection but before the depth-aware short-circuit. This means
|
|
||||||
// nodes revisited at shallower depths (via aliases) are counted each time they are
|
|
||||||
// encountered — intentional conservative overcounting. This bounds the total work
|
|
||||||
// performed during validation rather than tracking unique nodes, which is the safer
|
|
||||||
// security posture for untrusted YAML input.
|
|
||||||
*nodeCount++
|
*nodeCount++
|
||||||
if *nodeCount > maxNodes {
|
if *nodeCount > maxNodes {
|
||||||
return fmt.Errorf("YAML node count exceeds maximum (%d)", maxNodes)
|
return fmt.Errorf("YAML node count exceeds maximum (%d)", maxNodes)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Depth-aware short-circuit: skip re-validation only when the current visit
|
// Cycle detection: if we've seen this node before, we're in a cycle.
|
||||||
// depth is the same or shallower than the depth at which this node was
|
if _, ok := seen[node]; ok {
|
||||||
// previously validated. A shallower (or equal) current depth means the
|
return nil // Already validated this subtree, skip to avoid infinite recursion.
|
||||||
// prior, deeper validation already covered any subtree depth violations.
|
|
||||||
// If the current depth exceeds the previous validation depth (e.g., an alias
|
|
||||||
// references this node deeper in the tree), we must re-traverse to ensure
|
|
||||||
// the combined effective depth doesn't exceed maxDepth.
|
|
||||||
//
|
|
||||||
// Note: using ast.Node (interface) as map key relies on pointer identity,
|
|
||||||
// which is correct because all goccy/go-yaml AST node types are pointer
|
|
||||||
// receivers (*MappingNode, *SequenceNode, etc.), never value types.
|
|
||||||
if prevDepth, ok := validated[node]; ok && depth <= prevDepth {
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
validated[node] = depth
|
seen[node] = struct{}{}
|
||||||
|
|
||||||
// Mark as visiting (on the current recursion path) for cycle detection.
|
// Handle alias nodes: follow the alias to its anchor target.
|
||||||
visiting[node] = true
|
// Increment depth when following aliases since they expand the effective structure.
|
||||||
defer func() { visiting[node] = false }()
|
if node.Kind == yaml.AliasNode && node.Alias != nil {
|
||||||
|
return checkYAMLDepth(node.Alias, depth+1, maxDepth, maxNodes, seen, nodeCount)
|
||||||
|
}
|
||||||
|
|
||||||
// Walk children based on node type.
|
for _, child := range node.Content {
|
||||||
switch n := node.(type) {
|
if err := checkYAMLDepth(child, depth+1, maxDepth, maxNodes, seen, nodeCount); err != nil {
|
||||||
case *ast.MappingNode:
|
|
||||||
for _, value := range n.Values {
|
|
||||||
if err := checkYAMLDepth(value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case *ast.MappingValueNode:
|
|
||||||
// Both Key and Value are visited at depth+1 relative to this
|
|
||||||
// MappingValueNode. Since MappingNode visits its MappingValueNode
|
|
||||||
// children at depth+1 as well, keys and values end up at depth+2
|
|
||||||
// from the parent MappingNode. This is intentional: it mirrors the
|
|
||||||
// actual nesting structure (mapping → key-value pair → key/value).
|
|
||||||
if err := checkYAMLDepth(n.Key, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.SequenceNode:
|
|
||||||
for _, value := range n.Values {
|
|
||||||
if err := checkYAMLDepth(value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case *ast.AliasNode:
|
|
||||||
// Follow alias to its target, incrementing depth since aliases expand
|
|
||||||
// the effective structure.
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.AnchorNode:
|
|
||||||
// Increment depth for anchor values as a conservative measure: the
|
|
||||||
// anchor definition itself is structural, and treating it as a depth
|
|
||||||
// level ensures that deeply nested anchors are caught at definition
|
|
||||||
// time rather than only when referenced via alias. This +1 is
|
|
||||||
// asymmetric with alias (which also increments) — by design, the
|
|
||||||
// effective depth budget for anchored-then-aliased content is reduced
|
|
||||||
// because both the definition site and the reference site each consume
|
|
||||||
// a level, making deeply nested anchor/alias pairs hit the limit sooner.
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.TagNode:
|
|
||||||
if err := checkYAMLDepth(n.Value, depth+1, maxDepth, maxNodes, validated, visiting, nodeCount); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case *ast.MergeKeyNode:
|
|
||||||
// MergeKeyNode represents the literal "<<" merge key token. It has no
|
|
||||||
// child nodes — the value side of a merge (e.g., *alias) lives in the
|
|
||||||
// parent MappingValueNode.Value, which is already recursed into above.
|
|
||||||
// Explicitly listed here (rather than in the default case) to prevent
|
|
||||||
// future library changes from silently bypassing depth checks.
|
|
||||||
default:
|
|
||||||
// Scalar leaf nodes (StringNode, IntegerNode, FloatNode, BoolNode,
|
|
||||||
// NullNode, InfinityNode, NanNode, LiteralNode) have no children to
|
|
||||||
// recurse into.
|
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -331,11 +227,7 @@ func checkYAMLDepth(node ast.Node, depth, maxDepth, maxNodes int, validated map[
|
|||||||
// ParsePersonaBytes parses persona data from bytes with a source label for errors.
|
// ParsePersonaBytes parses persona data from bytes with a source label for errors.
|
||||||
// This is useful for parsing personas fetched from external sources (e.g., Gitea API)
|
// This is useful for parsing personas fetched from external sources (e.g., Gitea API)
|
||||||
// without requiring filesystem access. Format is detected by source extension.
|
// without requiring filesystem access. Format is detected by source extension.
|
||||||
// Input is bounded by MaxPersonaFileSize to prevent resource exhaustion.
|
|
||||||
func ParsePersonaBytes(data []byte, source string) (*Persona, error) {
|
func ParsePersonaBytes(data []byte, source string) (*Persona, error) {
|
||||||
if len(data) > MaxPersonaFileSize {
|
|
||||||
return nil, fmt.Errorf("persona data from %s exceeds maximum size (%d bytes, limit %d)", source, len(data), MaxPersonaFileSize)
|
|
||||||
}
|
|
||||||
return parsePersona(data, source)
|
return parsePersona(data, source)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+42
-223
@@ -7,7 +7,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/goccy/go-yaml/ast"
|
"gopkg.in/yaml.v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLoadBuiltinPersona(t *testing.T) {
|
func TestLoadBuiltinPersona(t *testing.T) {
|
||||||
@@ -355,7 +355,7 @@ func TestCapitalizeFirst(t *testing.T) {
|
|||||||
{"HELLO", "HELLO"},
|
{"HELLO", "HELLO"},
|
||||||
{"a", "A"},
|
{"a", "A"},
|
||||||
{"", ""},
|
{"", ""},
|
||||||
{"日本語", "日本語"}, // Non-ASCII: Japanese doesn't have case
|
{"日本語", "日本語"}, // Non-ASCII: Japanese doesn't have case
|
||||||
{"über", "Über"}, // German umlaut
|
{"über", "Über"}, // German umlaut
|
||||||
{"élève", "Élève"}, // French accent
|
{"élève", "Élève"}, // French accent
|
||||||
}
|
}
|
||||||
@@ -459,14 +459,7 @@ func TestYAMLDeeplyNestedRejection(t *testing.T) {
|
|||||||
path := filepath.Join(dir, "deeply-nested.yaml")
|
path := filepath.Join(dir, "deeply-nested.yaml")
|
||||||
|
|
||||||
// Build a deeply nested YAML structure that exceeds MaxYAMLDepth (20).
|
// Build a deeply nested YAML structure that exceeds MaxYAMLDepth (20).
|
||||||
// Depth accumulation trace for "nested: \n level0: \n level1: ...":
|
// Each level adds 2 to the depth count (key + value mapping).
|
||||||
// - Document root parsed at depth 0
|
|
||||||
// - Root MappingNode children (MappingValueNodes) visited at depth 1
|
|
||||||
// - "nested" MappingValueNode: key at depth 2, value at depth 2
|
|
||||||
// - Each levelN adds depth via MappingValueNode traversal (key + value)
|
|
||||||
// - Exact depth per level depends on AST structure (MappingNode wrapping),
|
|
||||||
// but 25 levels reliably exceeds MaxYAMLDepth (20) with comfortable margin.
|
|
||||||
// The test uses 25 levels rather than exactly 21 to avoid brittleness.
|
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
sb.WriteString("name: test\nidentity: test\nnested:\n")
|
sb.WriteString("name: test\nidentity: test\nnested:\n")
|
||||||
indent := " "
|
indent := " "
|
||||||
@@ -490,35 +483,6 @@ func TestYAMLDeeplyNestedRejection(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestYAMLEmptyFileRejection(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
content string
|
|
||||||
}{
|
|
||||||
{"completely_empty", ""},
|
|
||||||
{"whitespace_only", " \n\n "},
|
|
||||||
{"comment_only", "# just a comment\n"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, tc.name+".yaml")
|
|
||||||
if err := os.WriteFile(path, []byte(tc.content), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for empty YAML input, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "empty YAML document") {
|
|
||||||
t.Errorf("expected error containing %q, got: %v", "empty YAML document", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLFileSizeLimit(t *testing.T) {
|
func TestYAMLFileSizeLimit(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
path := filepath.Join(dir, "huge.yaml")
|
path := filepath.Join(dir, "huge.yaml")
|
||||||
@@ -540,41 +504,41 @@ func TestYAMLFileSizeLimit(t *testing.T) {
|
|||||||
|
|
||||||
func TestYAMLAliasCycleDetection(t *testing.T) {
|
func TestYAMLAliasCycleDetection(t *testing.T) {
|
||||||
// Test that our checkYAMLDepth function handles alias cycles gracefully
|
// Test that our checkYAMLDepth function handles alias cycles gracefully
|
||||||
// by using the visiting map to prevent infinite recursion.
|
// by using the seen map to prevent infinite recursion.
|
||||||
|
// We test this directly because go-yaml's parser handles most cycles
|
||||||
|
// at parse time, but we need to ensure our checker is robust.
|
||||||
|
|
||||||
// Create a node structure where an alias points to a parent node,
|
// Create a node structure where an alias points to a parent node,
|
||||||
// simulating what could happen with crafted input.
|
// simulating what could happen with malicious input that bypasses
|
||||||
parent := &ast.MappingNode{
|
// go-yaml's cycle detection.
|
||||||
Values: []*ast.MappingValueNode{
|
parent := &yaml.Node{
|
||||||
{
|
Kind: yaml.MappingNode,
|
||||||
Key: &ast.StringNode{Value: "name"},
|
Content: []*yaml.Node{
|
||||||
Value: &ast.StringNode{Value: "test"},
|
{Kind: yaml.ScalarNode, Value: "name"},
|
||||||
},
|
{Kind: yaml.ScalarNode, Value: "test"},
|
||||||
|
{Kind: yaml.ScalarNode, Value: "nested"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a child that aliases back to the parent (artificial cycle)
|
// Create a child that aliases back to the parent (artificial cycle)
|
||||||
aliasToParent := &ast.AliasNode{
|
aliasToParent := &yaml.Node{
|
||||||
Value: parent,
|
Kind: yaml.AliasNode,
|
||||||
|
Alias: parent,
|
||||||
}
|
}
|
||||||
parent.Values = append(parent.Values, &ast.MappingValueNode{
|
parent.Content = append(parent.Content, aliasToParent)
|
||||||
Key: &ast.StringNode{Value: "nested"},
|
|
||||||
Value: aliasToParent,
|
|
||||||
})
|
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
validated := make(map[ast.Node]int)
|
seen := make(map[*yaml.Node]struct{})
|
||||||
visiting := make(map[ast.Node]bool)
|
|
||||||
|
|
||||||
// This should NOT hang or stack overflow - cycle detection prevents infinite recursion
|
// This should NOT hang or stack overflow - the seen map prevents infinite recursion
|
||||||
err := checkYAMLDepth(parent, 0, MaxYAMLDepth, MaxYAMLNodes, validated, visiting, &nodeCount)
|
err := checkYAMLDepth(parent, 0, MaxYAMLDepth, MaxYAMLNodes, seen, &nodeCount)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("unexpected error traversing cyclic structure: %v", err)
|
t.Errorf("unexpected error traversing cyclic structure: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Verify we tracked the parent in the validated map
|
// Verify we tracked the parent in the seen map
|
||||||
if _, ok := validated[parent]; !ok {
|
if _, ok := seen[parent]; !ok {
|
||||||
t.Error("parent node not tracked in validated map")
|
t.Error("parent node not tracked in seen map")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -630,82 +594,36 @@ func TestYAMLNodeCountLimit(t *testing.T) {
|
|||||||
func TestCheckYAMLDepthCycleDetectionDirect(t *testing.T) {
|
func TestCheckYAMLDepthCycleDetectionDirect(t *testing.T) {
|
||||||
// Direct test of cycle detection in checkYAMLDepth by creating
|
// Direct test of cycle detection in checkYAMLDepth by creating
|
||||||
// a node structure with an artificial cycle.
|
// a node structure with an artificial cycle.
|
||||||
node := &ast.MappingNode{
|
// This tests the seen map logic independent of go-yaml's parsing.
|
||||||
Values: []*ast.MappingValueNode{
|
node := &yaml.Node{
|
||||||
{
|
Kind: yaml.MappingNode,
|
||||||
Key: &ast.StringNode{Value: "key"},
|
Content: []*yaml.Node{
|
||||||
Value: &ast.StringNode{Value: "value"},
|
{Kind: yaml.ScalarNode, Value: "key"},
|
||||||
},
|
{Kind: yaml.ScalarNode, Value: "value"},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a cycle by making a child reference the parent
|
// Create a cycle by making a child reference the parent
|
||||||
cycleChild := &ast.AliasNode{
|
cycleChild := &yaml.Node{
|
||||||
Value: node, // Points back to the parent
|
Kind: yaml.AliasNode,
|
||||||
|
Alias: node, // Points back to the parent
|
||||||
}
|
}
|
||||||
node.Values = append(node.Values, &ast.MappingValueNode{
|
node.Content = append(node.Content,
|
||||||
Key: &ast.StringNode{Value: "cyclic"},
|
&yaml.Node{Kind: yaml.ScalarNode, Value: "cyclic"},
|
||||||
Value: cycleChild,
|
cycleChild,
|
||||||
})
|
)
|
||||||
|
|
||||||
nodeCount := 0
|
nodeCount := 0
|
||||||
validated := make(map[ast.Node]int)
|
seen := make(map[*yaml.Node]struct{})
|
||||||
visiting := make(map[ast.Node]bool)
|
err := checkYAMLDepth(node, 0, MaxYAMLDepth, MaxYAMLNodes, seen, &nodeCount)
|
||||||
err := checkYAMLDepth(node, 0, MaxYAMLDepth, MaxYAMLNodes, validated, visiting, &nodeCount)
|
|
||||||
|
|
||||||
// Should complete without infinite recursion due to cycle detection
|
// Should complete without infinite recursion due to cycle detection
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("unexpected error: %v", err)
|
t.Errorf("unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
// The validated map should contain multiple entries
|
// The seen map should contain multiple entries
|
||||||
if len(validated) < 2 {
|
if len(seen) < 2 {
|
||||||
t.Errorf("validated map has %d entries, expected at least 2", len(validated))
|
t.Errorf("seen map has %d entries, expected at least 2", len(seen))
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLAliasDepthBypass(t *testing.T) {
|
|
||||||
// Test that an anchored subtree first validated at a shallow depth is
|
|
||||||
// re-checked when referenced via alias at a deeper position. Without the
|
|
||||||
// depth-aware validated map, the alias reference would skip re-checking
|
|
||||||
// and allow the effective nesting to exceed MaxYAMLDepth.
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, "alias-depth-bypass.yaml")
|
|
||||||
|
|
||||||
// Build YAML with an anchor at shallow depth containing a subtree near the limit,
|
|
||||||
// then reference it via alias deep enough that effective depth exceeds MaxYAMLDepth.
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("name: test\nidentity: test\n")
|
|
||||||
|
|
||||||
// Create the anchored subtree at depth 1 (key level) that nests 15 levels deep.
|
|
||||||
sb.WriteString("anchor_key: &deep_anchor\n")
|
|
||||||
for i := 0; i < 15; i++ {
|
|
||||||
sb.WriteString(strings.Repeat(" ", i+1))
|
|
||||||
sb.WriteString(fmt.Sprintf("level%d:\n", i))
|
|
||||||
}
|
|
||||||
sb.WriteString(strings.Repeat(" ", 16))
|
|
||||||
sb.WriteString("leaf: value\n")
|
|
||||||
|
|
||||||
// Create a wrapper that nests 6 levels deep, then references the anchor.
|
|
||||||
// Effective depth at alias target = 6 (wrapper nesting) + 1 (alias) + 15 (subtree) = 22 > 20
|
|
||||||
sb.WriteString("wrapper:\n")
|
|
||||||
for i := 0; i < 6; i++ {
|
|
||||||
sb.WriteString(strings.Repeat(" ", i+1))
|
|
||||||
sb.WriteString(fmt.Sprintf("n%d:\n", i))
|
|
||||||
}
|
|
||||||
sb.WriteString(strings.Repeat(" ", 7))
|
|
||||||
sb.WriteString("alias_ref: *deep_anchor\n")
|
|
||||||
|
|
||||||
if err := os.WriteFile(path, []byte(sb.String()), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for alias depth bypass, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "nesting depth exceeds") {
|
|
||||||
t.Errorf("error = %q, want containing 'nesting depth exceeds'", err.Error())
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -858,102 +776,3 @@ identity: test identity
|
|||||||
t.Errorf("Name = %q, want %q", p.Name, "test")
|
t.Errorf("Name = %q, want %q", p.Name, "test")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestJSONTrailingContentRejected(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
content string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "trailing garbage after object",
|
|
||||||
content: `{"name":"test","identity":"test identity"}garbage`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "two JSON objects",
|
|
||||||
content: `{"name":"test","identity":"test identity"}{"name":"other"}`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "trailing array",
|
|
||||||
content: `{"name":"test","identity":"test identity"}[]`,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := filepath.Join(dir, "test.json")
|
|
||||||
if err := os.WriteFile(path, []byte(tt.content), 0644); err != nil {
|
|
||||||
t.Fatalf("failed to write test file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := LoadPersona(path)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for trailing content, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "trailing content") {
|
|
||||||
t.Errorf("error = %q, want to contain 'trailing content'", err.Error())
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParsePersonaBytesSizeLimit(t *testing.T) {
|
|
||||||
// ParsePersonaBytes should reject input exceeding MaxPersonaFileSize
|
|
||||||
oversized := make([]byte, MaxPersonaFileSize+1)
|
|
||||||
for i := range oversized {
|
|
||||||
oversized[i] = 'x'
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := ParsePersonaBytes(oversized, "oversized.yaml")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for oversized input, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "exceeds maximum size") {
|
|
||||||
t.Errorf("error = %q, want to contain 'exceeds maximum size'", err.Error())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Just under the limit should not trigger size error (may fail parse, but not size)
|
|
||||||
underLimit := []byte("name: test\nidentity: test persona\n")
|
|
||||||
p, err := ParsePersonaBytes(underLimit, "valid.yaml")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error for valid input: %v", err)
|
|
||||||
}
|
|
||||||
if p.Name != "test" {
|
|
||||||
t.Errorf("Name = %q, want %q", p.Name, "test")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestYAMLMergeKeyDepthCheck(t *testing.T) {
|
|
||||||
// Verify that YAML merge keys (<<: *alias) are properly handled by the
|
|
||||||
// depth checker. The merge key content is in the MappingValueNode.Value
|
|
||||||
// (an AliasNode), not in the MergeKeyNode itself.
|
|
||||||
p, err := ParsePersonaBytes([]byte("name: merge-test\nidentity: test\n"), "merge.yaml")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("basic parse failed: %v", err)
|
|
||||||
}
|
|
||||||
if p.Name != "merge-test" {
|
|
||||||
t.Errorf("Name = %q, want %q", p.Name, "merge-test")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test that deeply nested merge keys still hit depth limit.
|
|
||||||
// Build YAML with merge key content nested beyond MaxYAMLDepth.
|
|
||||||
var sb strings.Builder
|
|
||||||
sb.WriteString("name: deep-merge\nidentity: deep merge persona\n")
|
|
||||||
sb.WriteString("anchor: &deep\n")
|
|
||||||
indent := " "
|
|
||||||
for i := 0; i < MaxYAMLDepth+5; i++ {
|
|
||||||
sb.WriteString(indent)
|
|
||||||
sb.WriteString(fmt.Sprintf("level%d:\n", i))
|
|
||||||
indent += " "
|
|
||||||
}
|
|
||||||
sb.WriteString(indent + "leaf: value\n")
|
|
||||||
sb.WriteString("target:\n <<: *deep\n")
|
|
||||||
|
|
||||||
_, err = ParsePersonaBytes([]byte(sb.String()), "deep-merge.yaml")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for deeply nested merge key content, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "depth") {
|
|
||||||
t.Errorf("error = %q, want to contain 'depth'", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -41,3 +41,20 @@ type Client interface {
|
|||||||
Reviewer
|
Reviewer
|
||||||
Identity
|
Identity
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ReviewerSelfRequester is an optional interface implemented by adapters that support
|
||||||
|
// requesting the authenticated user as a reviewer on a pull request. This is used for
|
||||||
|
// Gitea-specific behavior (ensuring the bot appears in required-reviewer checks).
|
||||||
|
// Consumers should use interface assertion: if sr, ok := client.(ReviewerSelfRequester); ok { ... }
|
||||||
|
type ReviewerSelfRequester interface {
|
||||||
|
RequestReviewerSelf(ctx context.Context, owner, repo string, number int, user string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReviewSuperseder is an optional interface implemented by adapters that support
|
||||||
|
// marking old reviews as superseded. For Gitea this means editing the review body
|
||||||
|
// with a link to the new review and resolving inline comments. For GitHub this
|
||||||
|
// means dismissing old reviews.
|
||||||
|
// Consumers should use interface assertion: if rs, ok := client.(ReviewSuperseder); ok { ... }
|
||||||
|
type ReviewSuperseder interface {
|
||||||
|
SupersedeReviews(ctx context.Context, owner, repo string, prNumber int, oldReviews []Review, newReviewID int64, baseURL, sentinel string) error
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
package vcs
|
||||||
|
|
||||||
|
// VCSProvider identifies a VCS platform. Using a typed string instead of bare
|
||||||
|
// strings makes provider values compiler-checkable and prevents typos from
|
||||||
|
// silently passing validation.
|
||||||
|
type VCSProvider string
|
||||||
|
|
||||||
|
const (
|
||||||
|
ProviderGitea VCSProvider = "gitea"
|
||||||
|
ProviderGitHub VCSProvider = "github"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Valid reports whether p is a known VCS provider.
|
||||||
|
func (p VCSProvider) Valid() bool {
|
||||||
|
switch p {
|
||||||
|
case ProviderGitea, ProviderGitHub:
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns the string representation of the provider.
|
||||||
|
func (p VCSProvider) String() string {
|
||||||
|
return string(p)
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user