Compare commits

..

1 Commits

Author SHA1 Message Date
Lunny Xiao 72bbfabf00 test(label,milestone): cover tool registration and handler paths
Add operation/label/label_test.go verifying the label_read/label_write
tools register under the "label" scope with the expected method enums
and read/write classification, plus httptest coverage for
list_repo_labels and create_repo_label. Extend
operation/milestone/milestone_test.go with the equivalent registration
assertions and an httptest-backed list milestones test.

Co-Authored-By: Codet <codet@commitgo.dev> (GPT-5-Codex)
2026-08-24 00:18:30 -07:00
7 changed files with 303 additions and 324 deletions
+2 -52
View File
@@ -55,9 +55,9 @@ var (
IssueReadTool = tool.NewDefinition(
IssueReadToolName,
"Read issue: details, comments, labels, or the full discussion as Markdown.",
"Read issue: details, comments, or labels.",
annotation.ReadOnly("Read issue details"),
tool.String("method", tool.Required(), tool.Enum("get", "get_comments", "get_labels", "get_discussion_markdown")),
tool.String("method", tool.Required(), tool.Enum("get", "get_comments", "get_labels")),
tool.String("owner", tool.Required(), tool.Description(params.OwnerDesc)),
tool.String("repo", tool.Required(), tool.Description(params.RepoDesc)),
tool.Number("issue_number", tool.Required()),
@@ -112,8 +112,6 @@ func issueReadFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult,
return getIssueCommentsByIndexFn(ctx, args)
case "get_labels":
return getIssueLabelsFn(ctx, args)
case "get_discussion_markdown":
return getIssueDiscussionMarkdownFn(ctx, args)
default:
return to.ErrorResult(fmt.Errorf("unknown method: %s", method))
}
@@ -400,54 +398,6 @@ func getIssueCommentsByIndexFn(ctx context.Context, args map[string]any) (*mcp.C
return to.TextResult(out)
}
func getIssueDiscussionMarkdownFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner")
if err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
index, err := params.GetIndex(args, "issue_number")
if err != nil {
return to.ErrorResult(err)
}
var issue issueWithAssets
issuePath := fmt.Sprintf("repos/%s/%s/issues/%d", url.PathEscape(owner), url.PathEscape(repo), index)
if _, err := gitea.DoJSON(ctx, "GET", issuePath, nil, nil, &issue); err != nil {
return to.ErrorResult(fmt.Errorf("get %v/%v/issue/%v err: %v", owner, repo, index, err))
}
var comments []commentWithAssets
commentsPath := fmt.Sprintf("repos/%s/%s/issues/%d/comments", url.PathEscape(owner), url.PathEscape(repo), index)
if _, err := gitea.DoJSON(ctx, "GET", commentsPath, nil, nil, &comments); err != nil {
return to.ErrorResult(fmt.Errorf("get %v/%v/issues/%v/comments err: %v", owner, repo, index, err))
}
discComments := make([]discussionComment, 0, len(comments))
for i := range comments {
discComments = append(discComments, discussionComment{
Author: slim.UserLogin(comments[i].Poster),
CreatedAt: comments[i].Created,
Body: slim.BodyWithAttachments(comments[i].Body, comments[i].Assets),
})
}
md := formatDiscussionMarkdown(discussionIssue{
Number: issue.Index,
Title: issue.Title,
Author: slim.UserLogin(issue.Poster),
State: string(issue.State),
Labels: slim.LabelNames(issue.Labels),
Body: slim.BodyWithAttachments(issue.Body, issue.Assets),
CreatedAt: issue.Created,
}, discComments)
return to.RawTextResult(md)
}
func getIssueLabelsFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner")
if err != nil {
-113
View File
@@ -266,119 +266,6 @@ func Test_getIssueByIndexFn_includesAttachments(t *testing.T) {
}
}
func Test_getIssueDiscussionMarkdownFn(t *testing.T) {
const (
owner = "octo"
repo = "demo"
)
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/api/v1/version":
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/42", owner, repo):
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`{
"number": 42,
"title": "bug with screenshot",
"body": "see attached",
"state": "open",
"user": {"login": "octocat"},
"labels": [{"name": "bug"}],
"created_at": "2026-01-02T15:04:05Z",
"assets": [
{"id": 1, "name": "shot.png", "size": 1024, "browser_download_url": "https://example/shot.png"}
]
}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/42/comments", owner, repo):
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`[
{"id": 1, "body": "see this", "user": {"login": "reviewer"}, "created_at": "2026-01-03T09:00:00Z", "assets": [
{"id": 9, "name": "log.txt", "size": 200, "browser_download_url": "https://example/log.txt"}
]}
]`))
default:
http.NotFound(w, r)
}
})
server := httptest.NewServer(handler)
defer server.Close()
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
flag.Host, flag.Token, flag.Version = server.URL, "", "test"
defer func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion }()
args := map[string]any{
"owner": owner, "repo": repo, "issue_number": float64(42),
}
res, err := getIssueDiscussionMarkdownFn(context.Background(), args)
if err != nil {
t.Fatalf("getIssueDiscussionMarkdownFn() error = %v", err)
}
if res.IsError {
t.Fatalf("unexpected error result: %v", res.Content)
}
body := res.Content[0].(*mcp.TextContent).Text
for _, want := range []string{
"# bug with screenshot (#42)",
"**Author:** octocat",
"**State:** open",
"**Labels:** bug",
"[shot.png](https://example/shot.png)",
"### reviewer on 2026-01-03T09:00:00Z",
"[log.txt](https://example/log.txt)",
} {
if !strings.Contains(body, want) {
t.Fatalf("expected markdown to contain %q, got:\n%s", want, body)
}
}
}
func Test_getIssueDiscussionMarkdownFn_noComments(t *testing.T) {
const (
owner = "octo"
repo = "demo"
)
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/api/v1/version":
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/7", owner, repo):
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`{"number": 7, "title": "quiet issue", "state": "open", "user": {"login": "octocat"}}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/issues/7/comments", owner, repo):
w.Header().Set("Content-Type", "application/json")
_, _ = w.Write([]byte(`[]`))
default:
http.NotFound(w, r)
}
})
server := httptest.NewServer(handler)
defer server.Close()
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
flag.Host, flag.Token, flag.Version = server.URL, "", "test"
defer func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion }()
args := map[string]any{
"owner": owner, "repo": repo, "issue_number": float64(7),
}
res, err := getIssueDiscussionMarkdownFn(context.Background(), args)
if err != nil {
t.Fatalf("getIssueDiscussionMarkdownFn() error = %v", err)
}
if res.IsError {
t.Fatalf("unexpected error result: %v", res.Content)
}
body := res.Content[0].(*mcp.TextContent).Text
if !strings.Contains(body, "_No comments yet._") {
t.Fatalf("expected placeholder for no comments, got:\n%s", body)
}
}
func Test_getIssueCommentsByIndexFn_includesAttachments(t *testing.T) {
const (
owner = "octo"
-63
View File
@@ -1,63 +0,0 @@
package issue
import (
"fmt"
"strings"
"time"
)
type discussionIssue struct {
Number int64
Title string
Author string
State string
Labels []string
Body string
CreatedAt time.Time
}
type discussionComment struct {
Author string
CreatedAt time.Time
Body string
}
// formatDiscussionMarkdown renders an issue and its comments as a single
// Markdown document suitable for display without further parsing.
func formatDiscussionMarkdown(issue discussionIssue, comments []discussionComment) string {
var b strings.Builder
fmt.Fprintf(&b, "# %s (#%d)\n\n", issue.Title, issue.Number)
fmt.Fprintf(&b, "**Author:** %s\n", issue.Author)
fmt.Fprintf(&b, "**State:** %s\n", issue.State)
if len(issue.Labels) > 0 {
fmt.Fprintf(&b, "**Labels:** %s\n", strings.Join(issue.Labels, ", "))
}
if !issue.CreatedAt.IsZero() {
fmt.Fprintf(&b, "**Created:** %s\n", issue.CreatedAt.UTC().Format(time.RFC3339))
}
b.WriteString("\n")
b.WriteString(strings.TrimSpace(issue.Body))
b.WriteString("\n\n---\n\n## Comments\n\n")
if len(comments) == 0 {
b.WriteString("_No comments yet._\n")
return b.String()
}
for i, c := range comments {
fmt.Fprintf(&b, "### %s", c.Author)
if !c.CreatedAt.IsZero() {
fmt.Fprintf(&b, " on %s", c.CreatedAt.UTC().Format(time.RFC3339))
}
b.WriteString("\n\n")
b.WriteString(strings.TrimSpace(c.Body))
if i < len(comments)-1 {
b.WriteString("\n\n---\n\n")
} else {
b.WriteString("\n")
}
}
return b.String()
}
-85
View File
@@ -1,85 +0,0 @@
package issue
import (
"strings"
"testing"
"time"
)
func Test_formatDiscussionMarkdown_includesIssueAndComments(t *testing.T) {
created := time.Date(2026, 1, 2, 15, 4, 5, 0, time.UTC)
commentTime := time.Date(2026, 1, 3, 9, 0, 0, 0, time.UTC)
md := formatDiscussionMarkdown(
discussionIssue{
Number: 42,
Title: "bug with screenshot",
Author: "octocat",
State: "open",
Labels: []string{"bug", "help wanted"},
Body: "see attached",
CreatedAt: created,
},
[]discussionComment{
{Author: "reviewer", CreatedAt: commentTime, Body: "thanks for reporting"},
},
)
wantSubstrings := []string{
"# bug with screenshot (#42)",
"**Author:** octocat",
"**State:** open",
"**Labels:** bug, help wanted",
"**Created:** 2026-01-02T15:04:05Z",
"see attached",
"## Comments",
"### reviewer",
"2026-01-03T09:00:00Z",
"thanks for reporting",
}
for _, want := range wantSubstrings {
if !strings.Contains(md, want) {
t.Fatalf("expected markdown to contain %q, got:\n%s", want, md)
}
}
}
func Test_formatDiscussionMarkdown_noComments(t *testing.T) {
md := formatDiscussionMarkdown(
discussionIssue{
Number: 1,
Title: "no comments yet",
Author: "octocat",
State: "open",
},
nil,
)
if !strings.Contains(md, "## Comments") {
t.Fatalf("expected a Comments section, got:\n%s", md)
}
if !strings.Contains(md, "_No comments yet._") {
t.Fatalf("expected placeholder for no comments, got:\n%s", md)
}
}
func Test_formatDiscussionMarkdown_attachmentBodyIsInlined(t *testing.T) {
md := formatDiscussionMarkdown(
discussionIssue{
Number: 7,
Title: "with attachment",
Author: "octocat",
State: "open",
Body: "see attached\n\n[shot.png](https://example/shot.png)",
},
[]discussionComment{
{Author: "reviewer", Body: "log attached\n\n[log.txt](https://example/log.txt)"},
},
)
if !strings.Contains(md, "[shot.png](https://example/shot.png)") {
t.Fatalf("expected issue attachment link in markdown, got:\n%s", md)
}
if !strings.Contains(md, "[log.txt](https://example/log.txt)") {
t.Fatalf("expected comment attachment link in markdown, got:\n%s", md)
}
}
+193
View File
@@ -0,0 +1,193 @@
package label
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"reflect"
"sort"
"sync"
"testing"
"gitea.com/gitea/gitea-mcp/pkg/flag"
"gitea.com/gitea/gitea-mcp/pkg/tool"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
func Test_Tool_Registration(t *testing.T) {
if got := Tool.Scope(); got != "label" {
t.Fatalf("Scope() = %q, want %q", got, "label")
}
readTools := Tool.ReadTools()
if len(readTools) != 1 || readTools[0].Tool.Name != LabelReadToolName {
t.Fatalf("ReadTools() = %v, want exactly [%s]", toolNames(readTools), LabelReadToolName)
}
if !readTools[0].Tool.Annotations.ReadOnlyHint {
t.Fatalf("%s must be marked read-only", LabelReadToolName)
}
writeTools := Tool.WriteTools()
if len(writeTools) != 1 || writeTools[0].Tool.Name != LabelWriteToolName {
t.Fatalf("WriteTools() = %v, want exactly [%s]", toolNames(writeTools), LabelWriteToolName)
}
if writeTools[0].Tool.Annotations.ReadOnlyHint {
t.Fatalf("%s must not be marked read-only", LabelWriteToolName)
}
assertMethodEnum(t, LabelReadTool, []string{"list_repo_labels", "get_repo_label", "list_org_labels"})
assertMethodEnum(t, LabelWriteTool, []string{
"create_repo_label", "edit_repo_label", "delete_repo_label",
"create_org_label", "edit_org_label", "delete_org_label",
})
}
func toolNames(tools []tool.ServerTool) []string {
names := make([]string, len(tools))
for i, serverTool := range tools {
names[i] = serverTool.Tool.Name
}
return names
}
func assertMethodEnum(t *testing.T, definition *mcp.Tool, want []string) {
t.Helper()
schema, ok := definition.InputSchema.(map[string]any)
if !ok {
t.Fatalf("%s: input schema = %T, want map[string]any", definition.Name, definition.InputSchema)
}
properties, ok := schema["properties"].(map[string]any)
if !ok {
t.Fatalf("%s: properties = %T, want map[string]any", definition.Name, schema["properties"])
}
method, ok := properties["method"].(map[string]any)
if !ok {
t.Fatalf("%s: method property = %T, want map[string]any", definition.Name, properties["method"])
}
enum, ok := method["enum"].([]string)
if !ok {
t.Fatalf("%s: method enum = %T, want []string", definition.Name, method["enum"])
}
got := append([]string{}, enum...)
sort.Strings(got)
wantSorted := append([]string{}, want...)
sort.Strings(wantSorted)
if !reflect.DeepEqual(got, wantSorted) {
t.Fatalf("%s: method enum = %v, want %v", definition.Name, enum, want)
}
}
func Test_labelReadFn_listRepoLabels(t *testing.T) {
const (
owner = "octo"
repo = "demo"
)
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/api/v1/version":
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/labels", owner, repo):
_, _ = w.Write([]byte(`[{"id":1,"name":"bug","color":"ff0000","description":"a bug"}]`))
default:
http.NotFound(w, r)
}
}))
defer server.Close()
withTestFlags(t, server.URL)
result, err := labelReadFn(context.Background(), map[string]any{
"method": "list_repo_labels",
"owner": owner,
"repo": repo,
})
if err != nil || result.IsError {
t.Fatalf("list_repo_labels err=%v result=%v", err, result)
}
var labels []map[string]any
decodeResult(t, result, &labels)
if len(labels) != 1 || labels[0]["name"] != "bug" {
t.Fatalf("unexpected labels: %v", labels)
}
}
func Test_labelWriteFn_createRepoLabel(t *testing.T) {
const (
owner = "octo"
repo = "demo"
)
var (
mu sync.Mutex
body map[string]any
)
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case r.URL.Path == "/api/v1/version":
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
case r.URL.Path == fmt.Sprintf("/api/v1/repos/%s/%s/labels", owner, repo) && r.Method == http.MethodPost:
mu.Lock()
_ = json.NewDecoder(r.Body).Decode(&body)
mu.Unlock()
_, _ = w.Write([]byte(`{"id":7,"name":"bug","color":"ff0000","description":"a bug"}`))
default:
http.NotFound(w, r)
}
}))
defer server.Close()
withTestFlags(t, server.URL)
result, err := labelWriteFn(context.Background(), map[string]any{
"method": "create_repo_label",
"owner": owner,
"repo": repo,
"name": "bug",
"color": "ff0000",
"description": "a bug",
})
if err != nil || result.IsError {
t.Fatalf("create_repo_label err=%v result=%v", err, result)
}
mu.Lock()
defer mu.Unlock()
if body["name"] != "bug" || body["color"] != "ff0000" {
t.Fatalf("unexpected request body: %v", body)
}
var label map[string]any
decodeResult(t, result, &label)
if label["name"] != "bug" {
t.Fatalf("unexpected label: %v", label)
}
}
func withTestFlags(t *testing.T, host string) {
t.Helper()
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
flag.Host, flag.Token, flag.Version = host, "", "test"
t.Cleanup(func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion })
}
func decodeResult(t *testing.T, result *mcp.CallToolResult, out any) {
t.Helper()
if len(result.Content) != 1 {
t.Fatalf("result content = %v, want exactly one item", result.Content)
}
text, ok := result.Content[0].(*mcp.TextContent)
if !ok {
t.Fatalf("result content = %T, want *mcp.TextContent", result.Content[0])
}
if err := json.Unmarshal([]byte(text.Text), out); err != nil {
t.Fatalf("decode result: %v", err)
}
}
+108
View File
@@ -7,14 +7,122 @@ import (
"maps"
"net/http"
"net/http/httptest"
"reflect"
"sort"
"sync"
"testing"
"gitea.com/gitea/gitea-mcp/pkg/flag"
"gitea.com/gitea/gitea-mcp/pkg/tool"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
func Test_Tool_Registration(t *testing.T) {
if got := Tool.Scope(); got != "milestone" {
t.Fatalf("Scope() = %q, want %q", got, "milestone")
}
readTools := Tool.ReadTools()
if len(readTools) != 1 || readTools[0].Tool.Name != MilestoneReadToolName {
t.Fatalf("ReadTools() = %v, want exactly [%s]", toolNames(readTools), MilestoneReadToolName)
}
if !readTools[0].Tool.Annotations.ReadOnlyHint {
t.Fatalf("%s must be marked read-only", MilestoneReadToolName)
}
writeTools := Tool.WriteTools()
if len(writeTools) != 1 || writeTools[0].Tool.Name != MilestoneWriteToolName {
t.Fatalf("WriteTools() = %v, want exactly [%s]", toolNames(writeTools), MilestoneWriteToolName)
}
if writeTools[0].Tool.Annotations.ReadOnlyHint {
t.Fatalf("%s must not be marked read-only", MilestoneWriteToolName)
}
assertMethodEnum(t, MilestoneReadTool, []string{"get", "list"})
assertMethodEnum(t, MilestoneWriteTool, []string{"create", "update", "edit", "delete"})
}
func toolNames(tools []tool.ServerTool) []string {
names := make([]string, len(tools))
for i, serverTool := range tools {
names[i] = serverTool.Tool.Name
}
return names
}
func assertMethodEnum(t *testing.T, definition *mcp.Tool, want []string) {
t.Helper()
schema, ok := definition.InputSchema.(map[string]any)
if !ok {
t.Fatalf("%s: input schema = %T, want map[string]any", definition.Name, definition.InputSchema)
}
properties, ok := schema["properties"].(map[string]any)
if !ok {
t.Fatalf("%s: properties = %T, want map[string]any", definition.Name, schema["properties"])
}
method, ok := properties["method"].(map[string]any)
if !ok {
t.Fatalf("%s: method property = %T, want map[string]any", definition.Name, properties["method"])
}
enum, ok := method["enum"].([]string)
if !ok {
t.Fatalf("%s: method enum = %T, want []string", definition.Name, method["enum"])
}
got := append([]string{}, enum...)
sort.Strings(got)
wantSorted := append([]string{}, want...)
sort.Strings(wantSorted)
if !reflect.DeepEqual(got, wantSorted) {
t.Fatalf("%s: method enum = %v, want %v", definition.Name, enum, want)
}
}
func Test_listMilestonesFn(t *testing.T) {
const (
owner = "octo"
repo = "demo"
)
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/api/v1/version":
_, _ = w.Write([]byte(`{"version":"1.12.0"}`))
case fmt.Sprintf("/api/v1/repos/%s/%s/milestones", owner, repo):
_, _ = w.Write([]byte(`[{"id":1,"title":"v1","state":"open"}]`))
default:
http.NotFound(w, r)
}
}))
defer server.Close()
origHost, origToken, origVersion := flag.Host, flag.Token, flag.Version
flag.Host, flag.Token, flag.Version = server.URL, "", "test"
defer func() { flag.Host, flag.Token, flag.Version = origHost, origToken, origVersion }()
result, err := listMilestonesFn(context.Background(), map[string]any{
"owner": owner,
"repo": repo,
})
if err != nil || result.IsError {
t.Fatalf("list err=%v result=%v", err, result)
}
text, ok := result.Content[0].(*mcp.TextContent)
if !ok {
t.Fatalf("result content = %T, want *mcp.TextContent", result.Content[0])
}
var milestones []map[string]any
if err := json.Unmarshal([]byte(text.Text), &milestones); err != nil {
t.Fatalf("decode result: %v", err)
}
if len(milestones) != 1 || milestones[0]["title"] != "v1" {
t.Fatalf("unexpected milestones: %v", milestones)
}
}
func Test_milestoneWriteFn_dueOn(t *testing.T) {
const (
owner = "octo"
-11
View File
@@ -23,17 +23,6 @@ func TextResult(v any) (*mcp.CallToolResult, error) {
}, nil
}
// RawTextResult returns text as-is, without JSON-encoding it. Use it for
// content that is already meant to be read directly, such as Markdown.
func RawTextResult(text string) (*mcp.CallToolResult, error) {
if flag.Debug {
log.Debugf("Text Result: %s", text)
}
return &mcp.CallToolResult{
Content: []mcp.Content{&mcp.TextContent{Text: text}},
}, nil
}
func ErrorResult(err error) (*mcp.CallToolResult, error) {
log.Errorf("%s", err.Error())
var result mcp.CallToolResult