{{ message }}
Repository navigation
Expand file tree
/
Copy pathissue_fields_test.go
More file actions
309 lines (298 loc) · 8.65 KB
/
Copy pathissue_fields_test.go
File metadata and controls
309 lines (298 loc) · 8.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
package github
import (
"context"
"encoding/json"
"testing"
"github.com/github/github-mcp-server/internal/githubv4mock"
"github.com/github/github-mcp-server/internal/toolsnaps"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/jsonschema-go/jsonschema"
"github.com/shurcooL/githubv4"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func Test_ListIssueFields(t *testing.T) {
// Verify tool definition
serverTool := ListIssueFields(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "list_issue_fields", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.True(t, tool.Annotations.ReadOnlyHint)
assert.Contains(t, tool.InputSchema.(*jsonschema.Schema).Properties, "owner")
assert.Contains(t, tool.InputSchema.(*jsonschema.Schema).Properties, "repo")
assert.ElementsMatch(t, tool.InputSchema.(*jsonschema.Schema).Required, []string{"owner"})
assert.Equal(t, []string{"repo", "read:org"}, serverTool.ScopeAccess.Scopes)
assert.NotNil(t, serverTool.ScopeAccess.Visible)
assert.NotNil(t, serverTool.ScopeAccess.Challenge)
queryStruct := issueFieldsRepoQuery{}
defaultVars := map[string]any{
"owner": githubv4.String("testowner"),
"name": githubv4.String("testrepo"),
}
orgQueryStruct := issueFieldsOrgQuery{}
defaultOrgVars := map[string]any{
"login": githubv4.String("testowner"),
}
tests := []struct {
name string
requestArgs map[string]any
mockQueryStruct any
mockVars map[string]any
gqlResponse githubv4mock.GQLResponse
expectError bool
expectedFields []IssueField
expectedErrMsg string
}{
{
name: "no fields returns empty list",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issueFields": map[string]any{
"nodes": []any{},
},
},
}),
expectedFields: []IssueField{},
},
{
name: "text field returned",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issueFields": map[string]any{
"nodes": []any{
map[string]any{
"__typename": "IssueFieldText",
"id": "IFT_1",
"fullDatabaseId": "42",
"name": "DRI",
"description": "Directly responsible individual",
"dataType": "TEXT",
"visibility": "ORG_ONLY",
},
},
},
},
}),
expectedFields: []IssueField{
{
ID: "IFT_1",
DatabaseID: 42,
Name: "DRI",
Description: "Directly responsible individual",
DataType: "TEXT",
Visibility: "ORG_ONLY",
},
},
},
{
name: "single_select field with options returned",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issueFields": map[string]any{
"nodes": []any{
map[string]any{
"__typename": "IssueFieldSingleSelect",
"id": "IFSS_1",
"fullDatabaseId": "99",
"name": "Priority",
"description": "Level of importance",
"dataType": "SINGLE_SELECT",
"visibility": "ALL",
"options": []any{
map[string]any{
"id": "OPT_1",
"name": "High",
"color": "red",
},
map[string]any{
"id": "OPT_2",
"name": "Low",
"color": "blue",
},
},
},
},
},
},
}),
expectedFields: []IssueField{
{
ID: "IFSS_1",
DatabaseID: 99,
Name: "Priority",
Description: "Level of importance",
DataType: "SINGLE_SELECT",
Visibility: "ALL",
Options: []IssueSingleSelectFieldOption{
{ID: "OPT_1", Name: "High", Color: "red"},
{ID: "OPT_2", Name: "Low", Color: "blue"},
},
},
},
},
{
name: "missing owner parameter",
requestArgs: map[string]any{
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{}),
expectError: true,
expectedErrMsg: "missing required parameter: owner",
},
{
name: "no repo returns org-level fields",
requestArgs: map[string]any{
"owner": "testowner",
},
mockQueryStruct: orgQueryStruct,
mockVars: defaultOrgVars,
gqlResponse: githubv4mock.DataResponse(map[string]any{
"organization": map[string]any{
"issueFields": map[string]any{
"nodes": []any{
map[string]any{
"__typename": "IssueFieldText",
"id": "IFT_1",
"fullDatabaseId": "77",
"name": "DRI",
"dataType": "TEXT",
"visibility": "ORG_ONLY",
},
},
},
},
}),
expectedFields: []IssueField{
{ID: "IFT_1", DatabaseID: 77, Name: "DRI", DataType: "TEXT", Visibility: "ORG_ONLY"},
},
},
{
name: "number field returned",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issueFields": map[string]any{
"nodes": []any{
map[string]any{
"__typename": "IssueFieldNumber",
"id": "IFN_1",
"fullDatabaseId": "101",
"name": "Engineering Staffing",
"dataType": "NUMBER",
"visibility": "ORG_ONLY",
},
},
},
},
}),
expectedFields: []IssueField{
{ID: "IFN_1", DatabaseID: 101, Name: "Engineering Staffing", DataType: "NUMBER", Visibility: "ORG_ONLY"},
},
},
{
name: "date field returned",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issueFields": map[string]any{
"nodes": []any{
map[string]any{
"__typename": "IssueFieldDate",
"id": "IFD_1",
"fullDatabaseId": "202",
"name": "Target Date",
"dataType": "DATE",
"visibility": "ORG_ONLY",
},
},
},
},
}),
expectedFields: []IssueField{
{ID: "IFD_1", DatabaseID: 202, Name: "Target Date", DataType: "DATE", Visibility: "ORG_ONLY"},
},
},
{
name: "graphql error returns failure",
requestArgs: map[string]any{
"owner": "testowner",
"repo": "testrepo",
},
gqlResponse: githubv4mock.ErrorResponse("boom"),
expectError: true,
expectedErrMsg: "failed to list issue fields",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
qs := tc.mockQueryStruct
if qs == nil {
qs = queryStruct
}
vars := tc.mockVars
if vars == nil {
vars = defaultVars
}
mockedHTTPClient := githubv4mock.NewMockedHTTPClient(
githubv4mock.NewQueryMatcher(qs, vars, tc.gqlResponse),
)
gqlClient := githubv4.NewClient(mockedHTTPClient)
deps := BaseDeps{GQLClient: gqlClient}
handler := serverTool.Handler(deps)
request := createMCPRequest(tc.requestArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
if tc.expectError {
if err != nil {
assert.Contains(t, err.Error(), tc.expectedErrMsg)
return
}
require.NotNil(t, result)
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.NoError(t, err)
require.NotNil(t, result)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var returnedFields []IssueField
err = json.Unmarshal([]byte(textContent.Text), &returnedFields)
require.NoError(t, err)
require.Equal(t, len(tc.expectedFields), len(returnedFields))
for i, expected := range tc.expectedFields {
assert.Equal(t, expected.ID, returnedFields[i].ID)
assert.Equal(t, expected.DatabaseID, returnedFields[i].DatabaseID)
assert.Equal(t, expected.Name, returnedFields[i].Name)
assert.Equal(t, expected.DataType, returnedFields[i].DataType)
assert.Equal(t, expected.Visibility, returnedFields[i].Visibility)
if expected.Options != nil {
require.Equal(t, len(expected.Options), len(returnedFields[i].Options))
for j, opt := range expected.Options {
assert.Equal(t, opt.Name, returnedFields[i].Options[j].Name)
assert.Equal(t, opt.Color, returnedFields[i].Options[j].Color)
}
}
}
})
}
}
You can’t perform that action at this time.