gitlink-cli/shortcuts/pr/pr_test.go

679 lines
19 KiB
Go

package pr
import (
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"testing"
"github.com/gitlink-org/gitlink-cli/internal/client"
"github.com/gitlink-org/gitlink-cli/internal/output"
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
)
func TestPRCommentPostsToCorrectIssueJournal(t *testing.T) {
var journalPayload map[string]interface{}
var journalPath string
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case r.Method == "GET" && r.URL.Path == "/owner/repo/pulls/13.json":
writeJSON(t, w, map[string]interface{}{
"issue": map[string]interface{}{
"id": float64(142301),
"subject": "test PR",
},
"pull_request": map[string]interface{}{
"id": float64(14791),
},
})
case r.Method == "POST" && r.URL.Path == "/v1/owner/repo/issues/142301/journals.json":
journalPath = r.URL.Path
journalPayload = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{
"id": float64(12345),
"message": "评论成功",
})
default:
t.Fatalf("unexpected request: %s %s", r.Method, r.URL.Path)
}
}))
defer server.Close()
err := runPRShortcut(t, server, "comment", map[string]string{
"id": "13",
"body": "LGTM, looks good!",
})
if err != nil {
t.Fatalf("comment shortcut failed: %v", err)
}
if journalPath == "" {
t.Fatal("journal endpoint was not called")
}
assertEqual(t, journalPayload["notes"], "LGTM, looks good!")
}
func TestPRCommentFailsWhenPRNotFound(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusNotFound)
writeJSON(t, w, map[string]interface{}{
"status": 404,
"error": "Not Found",
})
}))
defer server.Close()
err := runPRShortcut(t, server, "comment", map[string]string{
"id": "999",
"body": "test",
})
if err == nil {
t.Fatal("expected error for non-existent PR, got nil")
}
}
func TestPRCommentFailsWhenIssueFieldMissing(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
writeJSON(t, w, map[string]interface{}{
"pull_request": map[string]interface{}{
"id": float64(14791),
},
})
}))
defer server.Close()
err := runPRShortcut(t, server, "comment", map[string]string{
"id": "13",
"body": "test",
})
if err == nil {
t.Fatal("expected error when issue field is missing, got nil")
}
}
// --- list ---
func TestPRList(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET, got %s", r.Method)
}
if r.URL.Path != "/v1/owner/repo/pulls.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
if r.URL.Query().Get("status") != "0" {
t.Fatalf("expected status=0, got %s", r.URL.Query().Get("status"))
}
if r.URL.Query().Get("page") != "1" {
t.Fatalf("expected page=1, got %s", r.URL.Query().Get("page"))
}
writeJSON(t, w, []interface{}{
map[string]interface{}{"id": float64(1), "title": "PR 1"},
})
}))
defer server.Close()
err := runPRShortcut(t, server, "list", map[string]string{"state": "open", "page": "1", "limit": "20"})
if err != nil {
t.Fatalf("list failed: %v", err)
}
}
func TestPRListWithFilters(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/v1/owner/repo/pulls.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
query := r.URL.Query()
assertEqual(t, query.Get("status"), "1")
assertEqual(t, query.Get("keyword"), "release")
assertEqual(t, query.Get("priority_id"), "2")
assertEqual(t, query.Get("issue_tag_id"), "3")
assertEqual(t, query.Get("version_id"), "4")
assertEqual(t, query.Get("reviewer_id"), "5")
assertEqual(t, query.Get("assign_user_id"), "6")
assertEqual(t, query.Get("sort_by"), "updated_at")
assertEqual(t, query.Get("sort_direction"), "desc")
writeJSON(t, w, map[string]interface{}{"pulls": []interface{}{}})
}))
defer server.Close()
err := runPRShortcut(t, server, "list", map[string]string{
"state": "merged",
"keyword": "release",
"priority-id": "2",
"tag-id": "3",
"milestone-id": "4",
"reviewer-id": "5",
"assignee-id": "6",
"sort-by": "updated_at",
"sort-direction": "desc",
"page": "2",
"limit": "50",
})
if err != nil {
t.Fatalf("list with filters failed: %v", err)
}
}
func TestPRListStateAllOmitsStatus(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/v1/owner/repo/pulls.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
if got := r.URL.Query().Get("status"); got != "" {
t.Fatalf("status should be omitted for all, got %q", got)
}
writeJSON(t, w, map[string]interface{}{"pulls": []interface{}{}})
}))
defer server.Close()
err := runPRShortcut(t, server, "list", map[string]string{"state": "all", "page": "1", "limit": "20"})
if err != nil {
t.Fatalf("list all failed: %v", err)
}
}
// --- create ---
func TestPRCreate(t *testing.T) {
var payload map[string]interface{}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
t.Fatalf("expected POST, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
payload = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{"id": float64(42), "title": "feat: new"})
}))
defer server.Close()
err := runPRShortcut(t, server, "create", map[string]string{
"title": "feat: new",
"head": "feature/x",
"base": "master",
"body": "description",
})
if err != nil {
t.Fatalf("create failed: %v", err)
}
assertEqual(t, payload["title"], "feat: new")
assertEqual(t, payload["head"], "feature/x")
assertEqual(t, payload["base"], "master")
assertEqual(t, payload["body"], "description")
}
func TestPRCreateNoBody(t *testing.T) {
var payload map[string]interface{}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
payload = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{"id": float64(43), "title": "feat: nob"})
}))
defer server.Close()
err := runPRShortcut(t, server, "create", map[string]string{
"title": "feat: nob",
"head": "feature/y",
})
if err != nil {
t.Fatalf("create failed: %v", err)
}
if _, ok := payload["body"]; ok {
t.Fatal("body should not be in payload when not provided")
}
}
// --- view ---
func TestPRView(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls/42.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
writeJSON(t, w, map[string]interface{}{
"id": float64(42),
"title": "feat: new",
})
}))
defer server.Close()
err := runPRShortcut(t, server, "view", map[string]string{"id": "42"})
if err != nil {
t.Fatalf("view failed: %v", err)
}
}
// --- merge ---
func TestPRMerge(t *testing.T) {
var payload map[string]interface{}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
t.Fatalf("expected POST, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls/42/pr_merge.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
payload = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{"message": "merged"})
}))
defer server.Close()
err := runPRShortcut(t, server, "merge", map[string]string{"id": "42"})
if err != nil {
t.Fatalf("merge failed: %v", err)
}
assertEqual(t, payload["do"], "merge")
}
func TestPRMergeSquash(t *testing.T) {
var payload map[string]interface{}
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
payload = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{"message": "squashed"})
}))
defer server.Close()
err := runPRShortcut(t, server, "merge", map[string]string{"id": "42", "method": "squash"})
if err != nil {
t.Fatalf("merge squash failed: %v", err)
}
assertEqual(t, payload["do"], "squash")
}
// --- refuse ---
func TestPRRefuse(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
t.Fatalf("expected POST, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls/42/refuse_merge.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
writeJSON(t, w, map[string]interface{}{"message": "closed"})
}))
defer server.Close()
err := runPRShortcut(t, server, "refuse", map[string]string{"id": "42"})
if err != nil {
t.Fatalf("refuse failed: %v", err)
}
}
// --- files ---
func TestPRFiles(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls/42/files.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
writeJSON(t, w, []interface{}{
map[string]interface{}{"filename": "main.go", "status": "modified"},
})
}))
defer server.Close()
err := runPRShortcut(t, server, "files", map[string]string{"id": "42"})
if err != nil {
t.Fatalf("files failed: %v", err)
}
}
// --- diff ---
func TestPRDiff(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Fatalf("expected GET, got %s", r.Method)
}
if r.URL.Path != "/owner/repo/pulls/42/files.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
writeJSON(t, w, []interface{}{
map[string]interface{}{"filename": "main.go", "patch": "@@ -1 +1 @@"},
})
}))
defer server.Close()
err := runPRShortcut(t, server, "diff", map[string]string{"id": "42"})
if err != nil {
t.Fatalf("diff failed: %v", err)
}
}
// --- edit ---
func editServer(t *testing.T, current map[string]interface{}, put *map[string]interface{}) *httptest.Server {
t.Helper()
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/owner/repo/pulls/42.json" {
t.Fatalf("unexpected path: %s", r.URL.Path)
}
switch r.Method {
case "GET":
writeJSON(t, w, current)
case "PUT":
*put = decodeJSON(t, r)
writeJSON(t, w, map[string]interface{}{})
default:
t.Fatalf("unexpected method: %s", r.Method)
}
}))
}
func TestPREditPreservesUnspecifiedFields(t *testing.T) {
var put map[string]interface{}
server := editServer(t, map[string]interface{}{
"id": float64(42),
"title": "original title",
"body": "original body",
"head": "feature/x",
"base": "master",
"issue": map[string]interface{}{
"id": float64(105),
"issue_tags": []interface{}{
map[string]interface{}{"id": float64(7), "name": "bug"},
map[string]interface{}{"id": float64(9), "name": "urgent"},
},
},
}, &put)
defer server.Close()
err := runPRShortcut(t, server, "edit", map[string]string{
"id": "42",
"body": "updated body",
"base": "develop",
})
if err != nil {
t.Fatalf("edit failed: %v", err)
}
if put == nil {
t.Fatal("PUT was not called")
}
assertEqual(t, put["title"], "original title")
assertEqual(t, put["body"], "updated body")
assertEqual(t, put["head"], "feature/x")
assertEqual(t, put["base"], "develop")
tags, ok := put["issue_tag_ids"].([]interface{})
if !ok || len(tags) != 2 || fmt.Sprintf("%v", tags[0]) != "7" || fmt.Sprintf("%v", tags[1]) != "9" {
t.Fatalf("expected preserved tag ids [7 9], got %v", put["issue_tag_ids"])
}
if _, ok := put["receivers_login"].([]interface{}); !ok {
t.Fatalf("expected receivers_login array, got %v", put["receivers_login"])
}
}
func TestPREditTagIDsOverride(t *testing.T) {
var put map[string]interface{}
server := editServer(t, map[string]interface{}{
"title": "keep",
"body": "keep",
"head": "src",
"base": "master",
"issue": map[string]interface{}{
"issue_tags": []interface{}{
map[string]interface{}{"id": float64(7)},
},
},
}, &put)
defer server.Close()
err := runPRShortcut(t, server, "edit", map[string]string{
"id": "42",
"tag-ids": "3, 5",
})
if err != nil {
t.Fatalf("edit failed: %v", err)
}
tags, ok := put["issue_tag_ids"].([]interface{})
if !ok || len(tags) != 2 || fmt.Sprintf("%v", tags[0]) != "3" || fmt.Sprintf("%v", tags[1]) != "5" {
t.Fatalf("expected tag ids [3 5], got %v", put["issue_tag_ids"])
}
}
// The non-v1 detail endpoint nests the branch names under pull_request.head /
// pull_request.base (branch-name strings), which is the shape the live API
// actually returns; editing title-only must still preserve them.
func TestPREditReadsNestedPullRequestFields(t *testing.T) {
var put map[string]interface{}
server := editServer(t, map[string]interface{}{
"pull_request": map[string]interface{}{
"title": "nested title",
"body": "nested body",
"head": "topic",
"base": "main",
},
"issue": map[string]interface{}{"id": float64(1)},
}, &put)
defer server.Close()
err := runPRShortcut(t, server, "edit", map[string]string{
"id": "42",
"title": "new title",
})
if err != nil {
t.Fatalf("edit failed: %v", err)
}
assertEqual(t, put["title"], "new title")
assertEqual(t, put["body"], "nested body")
assertEqual(t, put["head"], "topic")
assertEqual(t, put["base"], "main")
}
func TestPREditRequiresAtLeastOneField(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
t.Fatalf("no request expected, got %s %s", r.Method, r.URL.Path)
}))
defer server.Close()
err := runPRShortcut(t, server, "edit", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error when no edit fields are provided")
}
}
func TestPREditHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "edit", map[string]string{"id": "42", "title": "x"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
// --- extractIssueID ---
func TestExtractIssueID(t *testing.T) {
id, err := extractIssueID(&output.Envelope{Data: map[string]interface{}{
"issue": map[string]interface{}{"id": float64(42)},
}})
if err != nil {
t.Fatalf("extractIssueID error: %v", err)
}
if id != 42 {
t.Fatalf("= %d, want 42", id)
}
}
func TestExtractIssueIDNotMap(t *testing.T) {
_, err := extractIssueID(&output.Envelope{Data: "not a map"})
if err == nil {
t.Fatal("expected error for non-map data")
}
}
func TestExtractIssueIDMissingIssue(t *testing.T) {
_, err := extractIssueID(&output.Envelope{Data: map[string]interface{}{"pr": map[string]interface{}{}}})
if err == nil {
t.Fatal("expected error for missing issue field")
}
}
func TestExtractIssueIDMissingID(t *testing.T) {
_, err := extractIssueID(&output.Envelope{Data: map[string]interface{}{
"issue": map[string]interface{}{"subject": "test"},
}})
if err == nil {
t.Fatal("expected error for missing issue.id")
}
}
// --- HTTP error paths ---
func TestPRListHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "list", map[string]string{"page": "1", "limit": "20"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRCreateHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "create", map[string]string{"title": "test", "head": "feature/x"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRViewHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "view", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRMergeHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "merge", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRRefuseHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "refuse", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRFilesHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "files", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func TestPRDiffHTTPError(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte("server error"))
}))
defer server.Close()
err := runPRShortcut(t, server, "diff", map[string]string{"id": "42"})
if err == nil {
t.Fatal("expected error for HTTP 500")
}
}
func runPRShortcut(t *testing.T, server *httptest.Server, name string, args map[string]string) error {
t.Helper()
shortcut := findPRShortcut(t, name)
ctx := &common.RuntimeContext{
Client: &client.Client{
HTTP: server.Client(),
BaseURL: server.URL,
},
Owner: "owner",
Repo: "repo",
Format: "json",
Args: args,
}
return shortcut.Run(ctx)
}
func findPRShortcut(t *testing.T, name string) *common.Shortcut {
t.Helper()
for _, shortcut := range Shortcuts() {
if shortcut.Name == name {
return shortcut
}
}
t.Fatalf("shortcut %q not found", name)
return nil
}
func decodeJSON(t *testing.T, r *http.Request) map[string]interface{} {
t.Helper()
var payload map[string]interface{}
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
t.Fatalf("failed to decode request body: %v", err)
}
return payload
}
func writeJSON(t *testing.T, w http.ResponseWriter, payload interface{}) {
t.Helper()
w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(payload); err != nil {
t.Fatalf("failed to write response: %v", err)
}
}
func assertEqual(t *testing.T, got interface{}, want interface{}) {
t.Helper()
if fmt.Sprintf("%v", got) != fmt.Sprintf("%v", want) {
t.Fatalf("got %v (%T), want %v (%T)", got, got, want, want)
}
}