From de54fa8da281cd6393ffbe28bd1380ce58056db4 Mon Sep 17 00:00:00 2001 From: Virgil Date: Wed, 1 Apr 2026 22:59:42 +0000 Subject: [PATCH] feat: add pull review request endpoints Co-Authored-By: Virgil --- docs/api-contract.md | 2 ++ pulls.go | 16 ++++++++++ pulls_test.go | 72 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 90 insertions(+) diff --git a/docs/api-contract.md b/docs/api-contract.md index ecf1098..74b50a0 100644 --- a/docs/api-contract.md +++ b/docs/api-contract.md @@ -167,9 +167,11 @@ Coverage notes: rows list direct tests when a symbol is named in test names or r | method | PackageService.List | `func (s *PackageService) List(ctx context.Context, owner string) ([]types.Package, error)` | List returns all packages for a given owner. | `TestPackageService_Good_List` | | method | PackageService.ListFiles | `func (s *PackageService) ListFiles(ctx context.Context, owner, pkgType, name, version string) ([]types.PackageFile, error)` | ListFiles returns all files for a specific package version. | `TestPackageService_Good_ListFiles` | | method | PullService.DismissReview | `func (s *PullService) DismissReview(ctx context.Context, owner, repo string, index, reviewID int64, msg string) error` | DismissReview dismisses a pull request review. | No direct tests. | +| method | PullService.CancelReviewRequests | `func (s *PullService) CancelReviewRequests(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) error` | CancelReviewRequests cancels review requests for a pull request. | `TestPullService_CancelReviewRequests_Good` | | method | PullService.IterReviews | `func (s *PullService) IterReviews(ctx context.Context, owner, repo string, index int64) iter.Seq2[types.PullReview, error]` | IterReviews returns an iterator over all reviews on a pull request. | No direct tests. | | method | PullService.ListReviews | `func (s *PullService) ListReviews(ctx context.Context, owner, repo string, index int64) ([]types.PullReview, error)` | ListReviews returns all reviews on a pull request. | No direct tests. | | method | PullService.Merge | `func (s *PullService) Merge(ctx context.Context, owner, repo string, index int64, method string) error` | Merge merges a pull request. Method is one of "merge", "rebase", "rebase-merge", "squash", "fast-forward-only", "manually-merged". | `TestPullService_Bad_Merge`, `TestPullService_Good_Merge` | +| method | PullService.RequestReviewers | `func (s *PullService) RequestReviewers(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) ([]types.PullReview, error)` | RequestReviewers creates review requests for a pull request. | `TestPullService_RequestReviewers_Good` | | method | PullService.SubmitReview | `func (s *PullService) SubmitReview(ctx context.Context, owner, repo string, index int64, review map[string]any) (*types.PullReview, error)` | SubmitReview creates a new review on a pull request. | No direct tests. | | method | PullService.UndismissReview | `func (s *PullService) UndismissReview(ctx context.Context, owner, repo string, index, reviewID int64) error` | UndismissReview undismisses a pull request review. | No direct tests. | | method | PullService.Update | `func (s *PullService) Update(ctx context.Context, owner, repo string, index int64) error` | Update updates a pull request branch with the base branch. | No direct tests. | diff --git a/pulls.go b/pulls.go index 879b15c..b5fac00 100644 --- a/pulls.go +++ b/pulls.go @@ -62,6 +62,22 @@ func (s *PullService) IterReviewers(ctx context.Context, owner, repo string) ite return ListIter[types.User](ctx, s.client, path, nil) } +// RequestReviewers creates review requests for a pull request. +func (s *PullService) RequestReviewers(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) ([]types.PullReview, error) { + path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/requested_reviewers", pathParams("owner", owner, "repo", repo, "index", int64String(index))) + var out []types.PullReview + if err := s.client.Post(ctx, path, opts, &out); err != nil { + return nil, err + } + return out, nil +} + +// CancelReviewRequests cancels review requests for a pull request. +func (s *PullService) CancelReviewRequests(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) error { + path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/requested_reviewers", pathParams("owner", owner, "repo", repo, "index", int64String(index))) + return s.client.DeleteWithBody(ctx, path, opts) +} + // SubmitReview creates a new review on a pull request. func (s *PullService) SubmitReview(ctx context.Context, owner, repo string, index int64, review map[string]any) (*types.PullReview, error) { path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews", pathParams("owner", owner, "repo", repo, "index", int64String(index))) diff --git a/pulls_test.go b/pulls_test.go index 230c5d7..eadd3d8 100644 --- a/pulls_test.go +++ b/pulls_test.go @@ -165,6 +165,78 @@ func TestPullService_IterReviewers_Good(t *testing.T) { } } +func TestPullService_RequestReviewers_Good(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodPost { + t.Errorf("expected POST, got %s", r.Method) + } + if r.URL.Path != "/api/v1/repos/core/go-forge/pulls/7/requested_reviewers" { + t.Errorf("wrong path: %s", r.URL.Path) + http.NotFound(w, r) + return + } + var body types.PullReviewRequestOptions + if err := json.NewDecoder(r.Body).Decode(&body); err != nil { + t.Fatalf("decode body: %v", err) + } + if len(body.Reviewers) != 2 || body.Reviewers[0] != "alice" || body.Reviewers[1] != "bob" { + t.Fatalf("got reviewers %#v", body.Reviewers) + } + if len(body.TeamReviewers) != 1 || body.TeamReviewers[0] != "platform" { + t.Fatalf("got team reviewers %#v", body.TeamReviewers) + } + json.NewEncoder(w).Encode([]types.PullReview{ + {ID: 101, Body: "requested"}, + }) + })) + defer srv.Close() + + f := NewForge(srv.URL, "tok") + reviews, err := f.Pulls.RequestReviewers(context.Background(), "core", "go-forge", 7, &types.PullReviewRequestOptions{ + Reviewers: []string{"alice", "bob"}, + TeamReviewers: []string{"platform"}, + }) + if err != nil { + t.Fatal(err) + } + if len(reviews) != 1 || reviews[0].ID != 101 || reviews[0].Body != "requested" { + t.Fatalf("got %#v", reviews) + } +} + +func TestPullService_CancelReviewRequests_Good(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodDelete { + t.Errorf("expected DELETE, got %s", r.Method) + } + if r.URL.Path != "/api/v1/repos/core/go-forge/pulls/7/requested_reviewers" { + t.Errorf("wrong path: %s", r.URL.Path) + http.NotFound(w, r) + return + } + var body types.PullReviewRequestOptions + if err := json.NewDecoder(r.Body).Decode(&body); err != nil { + t.Fatalf("decode body: %v", err) + } + if len(body.Reviewers) != 1 || body.Reviewers[0] != "alice" { + t.Fatalf("got reviewers %#v", body.Reviewers) + } + if len(body.TeamReviewers) != 1 || body.TeamReviewers[0] != "platform" { + t.Fatalf("got team reviewers %#v", body.TeamReviewers) + } + w.WriteHeader(http.StatusNoContent) + })) + defer srv.Close() + + f := NewForge(srv.URL, "tok") + if err := f.Pulls.CancelReviewRequests(context.Background(), "core", "go-forge", 7, &types.PullReviewRequestOptions{ + Reviewers: []string{"alice"}, + TeamReviewers: []string{"platform"}, + }); err != nil { + t.Fatal(err) + } +} + func TestPullService_Merge_Good(t *testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost {