{{ message }}
Repository navigation
Expand file tree
/
Copy pathcontext_tools_test.go
More file actions
582 lines (519 loc) · 17.6 KB
/
Copy pathcontext_tools_test.go
File metadata and controls
582 lines (519 loc) · 17.6 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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
package github
import (
"context"
"encoding/json"
"net/http"
"testing"
"time"
"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/go-github/v87/github"
"github.com/shurcooL/githubv4"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func Test_GetMe(t *testing.T) {
t.Parallel()
serverTool := GetMe(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
// Verify some basic very important properties
assert.Equal(t, "get_me", tool.Name)
assert.True(t, tool.Annotations.ReadOnlyHint, "get_me tool should be read-only")
// Setup mock user response
mockUser := &github.User{
Login: github.Ptr("testuser"),
Name: github.Ptr("Test User"),
Email: github.Ptr("test@example.com"),
Bio: github.Ptr("GitHub user for testing"),
Company: github.Ptr("Test Company"),
Location: github.Ptr("Test Location"),
HTMLURL: github.Ptr("https://github.com/testuser"),
CreatedAt: &github.Timestamp{Time: time.Now().Add(-365 * 24 * time.Hour)},
Type: github.Ptr("User"),
Hireable: github.Ptr(true),
TwitterUsername: github.Ptr("testuser_twitter"),
Plan: &github.Plan{
Name: github.Ptr("pro"),
},
}
tests := []struct {
name string
mockedClient *http.Client
clientErr string // if set, GetClient returns this error
requestArgs map[string]any
expectToolError bool
expectedUser *github.User
expectedToolErrMsg string
}{
{
name: "successful get user",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: mockResponse(t, http.StatusOK, mockUser),
}),
requestArgs: map[string]any{},
expectToolError: false,
expectedUser: mockUser,
},
{
name: "successful get user with reason",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: mockResponse(t, http.StatusOK, mockUser),
}),
requestArgs: map[string]any{
"reason": "Testing API",
},
expectToolError: false,
expectedUser: mockUser,
},
{
name: "getting client fails",
clientErr: "expected test error",
requestArgs: map[string]any{},
expectToolError: true,
expectedToolErrMsg: "failed to get GitHub client: expected test error",
},
{
name: "get user fails",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: badRequestHandler("expected test failure"),
}),
requestArgs: map[string]any{},
expectToolError: true,
expectedToolErrMsg: "expected test failure",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
var deps ToolDependencies
if tc.clientErr != "" {
deps = stubDeps{clientFn: stubClientFnErr(tc.clientErr), obsv: stubExporters()}
} else {
obs := stubExporters()
deps = BaseDeps{Client: mustNewGHClient(t, tc.mockedClient), Obsv: obs}
}
handler := serverTool.Handler(deps)
request := createMCPRequest(tc.requestArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
if tc.expectToolError {
require.True(t, result.IsError, "expected tool call result to be an error")
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedToolErrMsg)
return
}
require.False(t, result.IsError)
textContent := getTextResult(t, result)
// Unmarshal and verify the result
var returnedUser MinimalUser
err = json.Unmarshal([]byte(textContent.Text), &returnedUser)
require.NoError(t, err)
// Verify minimal user details
assert.Equal(t, *tc.expectedUser.Login, returnedUser.Login)
assert.Equal(t, *tc.expectedUser.HTMLURL, returnedUser.ProfileURL)
// Verify user details
require.NotNil(t, returnedUser.Details)
assert.Equal(t, *tc.expectedUser.Name, returnedUser.Details.Name)
assert.Equal(t, *tc.expectedUser.Email, returnedUser.Details.Email)
assert.Equal(t, *tc.expectedUser.Bio, returnedUser.Details.Bio)
assert.Equal(t, *tc.expectedUser.Company, returnedUser.Details.Company)
assert.Equal(t, *tc.expectedUser.Location, returnedUser.Details.Location)
assert.Equal(t, *tc.expectedUser.Hireable, returnedUser.Details.Hireable)
assert.Equal(t, *tc.expectedUser.TwitterUsername, returnedUser.Details.TwitterUsername)
})
}
}
func Test_GetMe_IFC_FeatureFlag(t *testing.T) {
t.Parallel()
serverTool := GetMe(translations.NullTranslationHelper)
mockUser := &github.User{
Login: github.Ptr("testuser"),
HTMLURL: github.Ptr("https://github.com/testuser"),
CreatedAt: &github.Timestamp{Time: time.Now()},
}
mockedHTTPClient := MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: mockResponse(t, http.StatusOK, mockUser),
})
depsWithIFCFeature := func(enabled bool) *BaseDeps {
return NewBaseDeps(
mustNewGHClient(t, mockedHTTPClient), nil, nil, nil,
translations.NullTranslationHelper,
FeatureFlags{},
0,
func(_ context.Context, flagName string) (bool, error) {
return flagName == FeatureFlagIFCLabels && enabled, nil
},
stubExporters(),
)
}
t.Run("feature disabled omits ifc label from result meta", func(t *testing.T) {
deps := depsWithIFCFeature(false)
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
assert.Nil(t, result.Meta, "result meta should be nil when IFC labels are disabled")
})
t.Run("feature enabled includes ifc label in result meta", func(t *testing.T) {
deps := depsWithIFCFeature(true)
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
require.NotNil(t, result.Meta, "result meta should be set when IFC labels are enabled")
ifcLabel, ok := result.Meta["ifc"]
require.True(t, ok, "result meta should contain ifc key")
ifcJSON, err := json.Marshal(ifcLabel)
require.NoError(t, err)
var ifcMap map[string]any
err = json.Unmarshal(ifcJSON, &ifcMap)
require.NoError(t, err)
assert.Equal(t, "trusted", ifcMap["integrity"])
assert.Equal(t, "public", ifcMap["confidentiality"])
})
}
func Test_GetTeams(t *testing.T) {
t.Parallel()
serverTool := GetTeams(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "get_teams", tool.Name)
assert.True(t, tool.Annotations.ReadOnlyHint, "get_teams tool should be read-only")
mockUser := &github.User{
Login: github.Ptr("testuser"),
Name: github.Ptr("Test User"),
Email: github.Ptr("test@example.com"),
Bio: github.Ptr("GitHub user for testing"),
Company: github.Ptr("Test Company"),
Location: github.Ptr("Test Location"),
HTMLURL: github.Ptr("https://github.com/testuser"),
CreatedAt: &github.Timestamp{Time: time.Now().Add(-365 * 24 * time.Hour)},
Type: github.Ptr("User"),
Hireable: github.Ptr(true),
TwitterUsername: github.Ptr("testuser_twitter"),
Plan: &github.Plan{
Name: github.Ptr("pro"),
},
}
mockTeamsResponse := githubv4mock.DataResponse(map[string]any{
"user": map[string]any{
"organizations": map[string]any{
"nodes": []map[string]any{
{
"login": "testorg1",
"teams": map[string]any{
"nodes": []map[string]any{
{
"name": "team1",
"slug": "team1",
"description": "Team 1",
},
{
"name": "team2",
"slug": "team2",
"description": "Team 2",
},
},
},
},
{
"login": "testorg2",
"teams": map[string]any{
"nodes": []map[string]any{
{
"name": "team3",
"slug": "team3",
"description": "Team 3",
},
},
},
},
},
},
},
})
mockNoTeamsResponse := githubv4mock.DataResponse(map[string]any{
"user": map[string]any{
"organizations": map[string]any{
"nodes": []map[string]any{},
},
},
})
// Create GQL clients for different test scenarios - these are factory functions
// to ensure each test gets a fresh client
gqlClientForTestuser := func() *githubv4.Client {
queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
vars := map[string]any{
"login": "testuser",
}
matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamsResponse)
httpClient := githubv4mock.NewMockedHTTPClient(matcher)
return githubv4.NewClient(httpClient)
}
gqlClientForSpecificuser := func() *githubv4.Client {
queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
vars := map[string]any{
"login": "specificuser",
}
matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamsResponse)
httpClient := githubv4mock.NewMockedHTTPClient(matcher)
return githubv4.NewClient(httpClient)
}
gqlClientNoTeams := func() *githubv4.Client {
queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
vars := map[string]any{
"login": "testuser",
}
matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockNoTeamsResponse)
httpClient := githubv4mock.NewMockedHTTPClient(matcher)
return githubv4.NewClient(httpClient)
}
// Factory function for mock HTTP clients with user response
httpClientWithUser := func() *http.Client {
return MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: mockResponse(t, http.StatusOK, mockUser),
})
}
httpClientUserFails := func() *http.Client {
return MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUser: badRequestHandler("expected test failure"),
})
}
tests := []struct {
name string
makeDeps func() ToolDependencies
requestArgs map[string]any
expectToolError bool
expectedToolErrMsg string
expectedTeamsCount int
}{
{
name: "successful get teams",
makeDeps: func() ToolDependencies {
return BaseDeps{
Client: mustNewGHClient(t, httpClientWithUser()),
GQLClient: gqlClientForTestuser(),
}
},
requestArgs: map[string]any{},
expectToolError: false,
expectedTeamsCount: 2,
},
{
name: "successful get teams for specific user",
makeDeps: func() ToolDependencies {
return BaseDeps{
GQLClient: gqlClientForSpecificuser(),
}
},
requestArgs: map[string]any{
"user": "specificuser",
},
expectToolError: false,
expectedTeamsCount: 2,
},
{
name: "no teams found",
makeDeps: func() ToolDependencies {
return BaseDeps{
Client: mustNewGHClient(t, httpClientWithUser()),
GQLClient: gqlClientNoTeams(),
}
},
requestArgs: map[string]any{},
expectToolError: false,
expectedTeamsCount: 0,
},
{
name: "getting client fails",
makeDeps: func() ToolDependencies {
return stubDeps{clientFn: stubClientFnErr("expected test error"), obsv: stubExporters()}
},
requestArgs: map[string]any{},
expectToolError: true,
expectedToolErrMsg: "failed to get GitHub client: expected test error",
},
{
name: "get user fails",
makeDeps: func() ToolDependencies {
return BaseDeps{
Client: mustNewGHClient(t, httpClientUserFails()),
Obsv: stubExporters(),
}
},
requestArgs: map[string]any{},
expectToolError: true,
expectedToolErrMsg: "expected test failure",
},
{
name: "getting GraphQL client fails",
makeDeps: func() ToolDependencies {
return stubDeps{
clientFn: stubClientFnFromHTTP(t, httpClientWithUser()),
gqlClientFn: stubGQLClientFnErr("GraphQL client error"),
obsv: stubExporters(),
}
},
requestArgs: map[string]any{},
expectToolError: true,
expectedToolErrMsg: "failed to get GitHub GQL client: GraphQL client error",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
deps := tc.makeDeps()
handler := serverTool.Handler(deps)
request := createMCPRequest(tc.requestArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
if tc.expectToolError {
require.True(t, result.IsError, "expected tool call result to be an error")
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedToolErrMsg)
return
}
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var organizations []OrganizationTeams
err = json.Unmarshal([]byte(textContent.Text), &organizations)
require.NoError(t, err)
assert.Len(t, organizations, tc.expectedTeamsCount)
if tc.expectedTeamsCount > 0 {
assert.Equal(t, "testorg1", organizations[0].Org)
assert.Len(t, organizations[0].Teams, 2)
assert.Equal(t, "team1", organizations[0].Teams[0].Name)
assert.Equal(t, "team1", organizations[0].Teams[0].Slug)
assert.Equal(t, "Team 1", organizations[0].Teams[0].Description)
if tc.expectedTeamsCount > 1 {
assert.Equal(t, "testorg2", organizations[1].Org)
assert.Len(t, organizations[1].Teams, 1)
assert.Equal(t, "team3", organizations[1].Teams[0].Name)
assert.Equal(t, "team3", organizations[1].Teams[0].Slug)
assert.Equal(t, "Team 3", organizations[1].Teams[0].Description)
}
}
})
}
}
func Test_GetTeamMembers(t *testing.T) {
t.Parallel()
serverTool := GetTeamMembers(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "get_team_members", tool.Name)
assert.True(t, tool.Annotations.ReadOnlyHint, "get_team_members tool should be read-only")
mockTeamMembersResponse := githubv4mock.DataResponse(map[string]any{
"organization": map[string]any{
"team": map[string]any{
"members": map[string]any{
"nodes": []map[string]any{
{
"login": "user1",
},
{
"login": "user2",
},
},
},
},
},
})
mockNoMembersResponse := githubv4mock.DataResponse(map[string]any{
"organization": map[string]any{
"team": map[string]any{
"members": map[string]any{
"nodes": []map[string]any{},
},
},
},
})
// Create GQL clients for different test scenarios
gqlClientWithMembers := func() *githubv4.Client {
queryStr := "query($org:String!$teamSlug:String!){organization(login: $org){team(slug: $teamSlug){members(first: 100){nodes{login}}}}}"
vars := map[string]any{
"org": "testorg",
"teamSlug": "testteam",
}
matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamMembersResponse)
httpClient := githubv4mock.NewMockedHTTPClient(matcher)
return githubv4.NewClient(httpClient)
}
gqlClientNoMembers := func() *githubv4.Client {
queryStr := "query($org:String!$teamSlug:String!){organization(login: $org){team(slug: $teamSlug){members(first: 100){nodes{login}}}}}"
vars := map[string]any{
"org": "testorg",
"teamSlug": "emptyteam",
}
matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockNoMembersResponse)
httpClient := githubv4mock.NewMockedHTTPClient(matcher)
return githubv4.NewClient(httpClient)
}
tests := []struct {
name string
deps ToolDependencies
requestArgs map[string]any
expectToolError bool
expectedToolErrMsg string
expectedMembersCount int
}{
{
name: "successful get team members",
deps: BaseDeps{GQLClient: gqlClientWithMembers()},
requestArgs: map[string]any{
"org": "testorg",
"team_slug": "testteam",
},
expectToolError: false,
expectedMembersCount: 2,
},
{
name: "team with no members",
deps: BaseDeps{GQLClient: gqlClientNoMembers()},
requestArgs: map[string]any{
"org": "testorg",
"team_slug": "emptyteam",
},
expectToolError: false,
expectedMembersCount: 0,
},
{
name: "getting GraphQL client fails",
deps: stubDeps{gqlClientFn: stubGQLClientFnErr("GraphQL client error"), obsv: stubExporters()},
requestArgs: map[string]any{
"org": "testorg",
"team_slug": "testteam",
},
expectToolError: true,
expectedToolErrMsg: "failed to get GitHub GQL client: GraphQL client error",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
handler := serverTool.Handler(tc.deps)
request := createMCPRequest(tc.requestArgs)
result, err := handler(ContextWithDeps(context.Background(), tc.deps), &request)
require.NoError(t, err)
if tc.expectToolError {
require.True(t, result.IsError, "expected tool call result to be an error")
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedToolErrMsg)
return
}
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var members []string
err = json.Unmarshal([]byte(textContent.Text), &members)
require.NoError(t, err)
assert.Len(t, members, tc.expectedMembersCount)
if tc.expectedMembersCount > 0 {
assert.Equal(t, "user1", members[0])
if tc.expectedMembersCount > 1 {
assert.Equal(t, "user2", members[1])
}
}
})
}
}
You can’t perform that action at this time.