{{ message }}
Repository navigation
Expand file tree
/
Copy pathgists_test.go
More file actions
646 lines (579 loc) · 19.4 KB
/
Copy pathgists_test.go
File metadata and controls
646 lines (579 loc) · 19.4 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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
package github
import (
"context"
"encoding/json"
"net/http"
"testing"
"time"
"github.com/github/github-mcp-server/internal/toolsnaps"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v89/github"
"github.com/google/jsonschema-go/jsonschema"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func Test_ListGists(t *testing.T) {
// Verify tool definition
serverTool := ListGists(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "list_gists", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.True(t, tool.Annotations.ReadOnlyHint, "list_gists tool should be read-only")
schema, ok := tool.InputSchema.(*jsonschema.Schema)
require.True(t, ok, "InputSchema should be *jsonschema.Schema")
assert.Contains(t, schema.Properties, "username")
assert.Contains(t, schema.Properties, "since")
assert.Contains(t, schema.Properties, "page")
assert.Contains(t, schema.Properties, "perPage")
assert.Empty(t, schema.Required)
// Setup mock gists for success case
mockGists := []*github.Gist{
{
ID: github.Ptr("gist1"),
Description: github.Ptr("First Gist"),
HTMLURL: github.Ptr("https://gist.github.com/user/gist1"),
Public: github.Ptr(true),
CreatedAt: &github.Timestamp{Time: time.Date(2023, 1, 1, 0, 0, 0, 0, time.UTC)},
Owner: &github.User{Login: github.Ptr("user")},
Files: map[github.GistFilename]github.GistFile{
"file1.txt": {
Filename: github.Ptr("file1.txt"),
Content: github.Ptr("content of file 1"),
},
},
},
{
ID: github.Ptr("gist2"),
Description: github.Ptr("Second Gist"),
HTMLURL: github.Ptr("https://gist.github.com/testuser/gist2"),
Public: github.Ptr(false),
CreatedAt: &github.Timestamp{Time: time.Date(2023, 2, 1, 0, 0, 0, 0, time.UTC)},
Owner: &github.User{Login: github.Ptr("testuser")},
Files: map[github.GistFilename]github.GistFile{
"file2.js": {
Filename: github.Ptr("file2.js"),
Content: github.Ptr("console.log('hello');"),
},
},
},
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedGists []*github.Gist
expectedErrMsg string
}{
{
name: "list authenticated user's gists",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGists: mockResponse(t, http.StatusOK, mockGists),
}),
requestArgs: map[string]any{},
expectError: false,
expectedGists: mockGists,
},
{
name: "list specific user's gists",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetUsersGistsByUsername: mockResponse(t, http.StatusOK, mockGists),
}),
requestArgs: map[string]any{
"username": "testuser",
},
expectError: false,
expectedGists: mockGists,
},
{
name: "list gists with pagination and since parameter",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGists: expectQueryParams(t, map[string]string{
"since": "2023-01-01T00:00:00Z",
"page": "2",
"per_page": "5",
}).andThen(
mockResponse(t, http.StatusOK, mockGists),
),
}),
requestArgs: map[string]any{
"since": "2023-01-01T00:00:00Z",
"page": float64(2),
"perPage": float64(5),
},
expectError: false,
expectedGists: mockGists,
},
{
name: "invalid since parameter",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGists: mockResponse(t, http.StatusOK, mockGists),
}),
requestArgs: map[string]any{
"since": "invalid-date",
},
expectError: true,
expectedErrMsg: "invalid since timestamp",
},
{
name: "list gists fails with error",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGists: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusUnauthorized)
_, _ = w.Write([]byte(`{"message": "Requires authentication"}`))
}),
}),
requestArgs: map[string]any{},
expectError: true,
expectedErrMsg: "failed to list gists",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := mustNewGHClient(t, tc.mockedClient)
deps := BaseDeps{
Client: client,
}
handler := serverTool.Handler(deps)
// Create call request
request := createMCPRequest(tc.requestArgs)
// Call handler
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
// Verify results
if tc.expectError {
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.False(t, result.IsError)
// Parse the result and get the text content if no error
textContent := getTextResult(t, result)
// Unmarshal and verify the result
var returnedGists []*github.Gist
err = json.Unmarshal([]byte(textContent.Text), &returnedGists)
require.NoError(t, err)
assert.Len(t, returnedGists, len(tc.expectedGists))
for i, gist := range returnedGists {
assert.Equal(t, *tc.expectedGists[i].ID, *gist.ID)
assert.Equal(t, *tc.expectedGists[i].Description, *gist.Description)
assert.Equal(t, *tc.expectedGists[i].HTMLURL, *gist.HTMLURL)
assert.Equal(t, *tc.expectedGists[i].Public, *gist.Public)
}
})
}
}
func Test_GetGist(t *testing.T) {
// Verify tool definition
serverTool := GetGist(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "get_gist", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.True(t, tool.Annotations.ReadOnlyHint, "get_gist tool should be read-only")
schema, ok := tool.InputSchema.(*jsonschema.Schema)
require.True(t, ok, "InputSchema should be *jsonschema.Schema")
assert.Contains(t, schema.Properties, "gist_id")
assert.Contains(t, schema.Required, "gist_id")
// Setup mock gist for success case
mockGist := github.Gist{
ID: github.Ptr("gist1"),
Description: github.Ptr("First Gist"),
HTMLURL: github.Ptr("https://gist.github.com/user/gist1"),
Public: github.Ptr(true),
CreatedAt: &github.Timestamp{Time: time.Date(2023, 1, 1, 0, 0, 0, 0, time.UTC)},
Owner: &github.User{Login: github.Ptr("user")},
Files: map[github.GistFilename]github.GistFile{
github.GistFilename("file1.txt"): {
Filename: github.Ptr("file1.txt"),
Content: github.Ptr("content of file 1"),
},
},
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedGists github.Gist
expectedErrMsg string
}{
{
name: "Successful fetching different gist",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGistsByGistID: mockResponse(t, http.StatusOK, mockGist),
}),
requestArgs: map[string]any{
"gist_id": "gist1",
},
expectError: false,
expectedGists: mockGist,
},
{
name: "gist_id parameter missing",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetGistsByGistID: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusUnprocessableEntity)
_, _ = w.Write([]byte(`{"message": "Invalid Request"}`))
}),
}),
requestArgs: map[string]any{},
expectError: true,
expectedErrMsg: "missing required parameter: gist_id",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := mustNewGHClient(t, tc.mockedClient)
deps := BaseDeps{
Client: client,
}
handler := serverTool.Handler(deps)
// Create call request
request := createMCPRequest(tc.requestArgs)
// Call handler
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
// Verify results
if tc.expectError {
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.False(t, result.IsError)
// Parse the result and get the text content if no error
textContent := getTextResult(t, result)
// Unmarshal and verify the result
var returnedGists github.Gist
err = json.Unmarshal([]byte(textContent.Text), &returnedGists)
require.NoError(t, err)
assert.Equal(t, *tc.expectedGists.ID, *returnedGists.ID)
assert.Equal(t, *tc.expectedGists.Description, *returnedGists.Description)
assert.Equal(t, *tc.expectedGists.HTMLURL, *returnedGists.HTMLURL)
assert.Equal(t, *tc.expectedGists.Public, *returnedGists.Public)
})
}
}
func Test_CreateGist(t *testing.T) {
// Verify tool definition
serverTool := CreateGist(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "create_gist", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.False(t, tool.Annotations.ReadOnlyHint, "create_gist tool should not be read-only")
schema, ok := tool.InputSchema.(*jsonschema.Schema)
require.True(t, ok, "InputSchema should be *jsonschema.Schema")
assert.Contains(t, schema.Properties, "description")
assert.Contains(t, schema.Properties, "filename")
assert.Contains(t, schema.Properties, "content")
assert.Contains(t, schema.Properties, "public")
// Verify required parameters
assert.Contains(t, schema.Required, "filename")
assert.Contains(t, schema.Required, "content")
// Setup mock data for test cases
createdGist := &github.Gist{
ID: github.Ptr("new-gist-id"),
Description: github.Ptr("Test Gist"),
HTMLURL: github.Ptr("https://gist.github.com/user/new-gist-id"),
Public: github.Ptr(false),
CreatedAt: &github.Timestamp{Time: time.Now()},
Owner: &github.User{Login: github.Ptr("user")},
Files: map[github.GistFilename]github.GistFile{
"test.go": {
Filename: github.Ptr("test.go"),
Content: github.Ptr("package main\n\nfunc main() {\n\tfmt.Println(\"Hello, Gist!\")\n}"),
},
},
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedErrMsg string
expectedGist *github.Gist
}{
{
name: "create gist successfully",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PostGists: mockResponse(t, http.StatusCreated, createdGist),
}),
requestArgs: map[string]any{
"filename": "test.go",
"content": "package main\n\nfunc main() {\n\tfmt.Println(\"Hello, Gist!\")\n}",
"description": "Test Gist",
"public": false,
},
expectError: false,
expectedGist: createdGist,
},
{
name: "missing required filename",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{}),
requestArgs: map[string]any{
"content": "test content",
"description": "Test Gist",
},
expectError: true,
expectedErrMsg: "missing required parameter: filename",
},
{
name: "missing required content",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{}),
requestArgs: map[string]any{
"filename": "test.go",
"description": "Test Gist",
},
expectError: true,
expectedErrMsg: "missing required parameter: content",
},
{
name: "api returns error",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PostGists: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusUnauthorized)
_, _ = w.Write([]byte(`{"message": "Requires authentication"}`))
}),
}),
requestArgs: map[string]any{
"filename": "test.go",
"content": "package main",
"description": "Test Gist",
},
expectError: true,
expectedErrMsg: "failed to create gist",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := mustNewGHClient(t, tc.mockedClient)
deps := BaseDeps{
Client: client,
}
handler := serverTool.Handler(deps)
// Create call request
request := createMCPRequest(tc.requestArgs)
// Call handler
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
// Verify results
if tc.expectError {
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.False(t, result.IsError)
assert.NotNil(t, result)
// Parse the result and get the text content
textContent := getTextResult(t, result)
// Unmarshal and verify the minimal result
var gist MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &gist)
require.NoError(t, err)
assert.Equal(t, tc.expectedGist.GetHTMLURL(), gist.URL)
})
}
}
func Test_UpdateGist(t *testing.T) {
// Verify tool definition
serverTool := UpdateGist(translations.NullTranslationHelper)
tool := serverTool.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "update_gist", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.False(t, tool.Annotations.ReadOnlyHint, "update_gist tool should not be read-only")
schema, ok := tool.InputSchema.(*jsonschema.Schema)
require.True(t, ok, "InputSchema should be *jsonschema.Schema")
assert.Contains(t, schema.Properties, "gist_id")
assert.Contains(t, schema.Properties, "description")
assert.Contains(t, schema.Properties, "filename")
assert.Contains(t, schema.Properties, "content")
// Verify required parameters
assert.Contains(t, schema.Required, "gist_id")
assert.Contains(t, schema.Required, "filename")
assert.Contains(t, schema.Required, "content")
// Setup mock data for test cases
updatedGist := &github.Gist{
ID: github.Ptr("existing-gist-id"),
Description: github.Ptr("Updated Test Gist"),
HTMLURL: github.Ptr("https://gist.github.com/user/existing-gist-id"),
Public: github.Ptr(true),
UpdatedAt: &github.Timestamp{Time: time.Now()},
Owner: &github.User{Login: github.Ptr("user")},
Files: map[github.GistFilename]github.GistFile{
"updated.go": {
Filename: github.Ptr("updated.go"),
Content: github.Ptr("package main\n\nfunc main() {\n\tfmt.Println(\"Updated Gist!\")\n}"),
},
},
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedErrMsg string
expectedGist *github.Gist
}{
{
name: "update gist successfully",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PatchGistsByGistID: mockResponse(t, http.StatusOK, updatedGist),
}),
requestArgs: map[string]any{
"gist_id": "existing-gist-id",
"filename": "updated.go",
"content": "package main\n\nfunc main() {\n\tfmt.Println(\"Updated Gist!\")\n}",
"description": "Updated Test Gist",
},
expectError: false,
expectedGist: updatedGist,
},
{
name: "missing required gist_id",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{}),
requestArgs: map[string]any{
"filename": "updated.go",
"content": "updated content",
"description": "Updated Test Gist",
},
expectError: true,
expectedErrMsg: "missing required parameter: gist_id",
},
{
name: "missing required filename",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{}),
requestArgs: map[string]any{
"gist_id": "existing-gist-id",
"content": "updated content",
"description": "Updated Test Gist",
},
expectError: true,
expectedErrMsg: "missing required parameter: filename",
},
{
name: "missing required content",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{}),
requestArgs: map[string]any{
"gist_id": "existing-gist-id",
"filename": "updated.go",
"description": "Updated Test Gist",
},
expectError: true,
expectedErrMsg: "missing required parameter: content",
},
{
name: "api returns error",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PatchGistsByGistID: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte(`{"message": "Not Found"}`))
}),
}),
requestArgs: map[string]any{
"gist_id": "nonexistent-gist-id",
"filename": "updated.go",
"content": "package main",
"description": "Updated Test Gist",
},
expectError: true,
expectedErrMsg: "failed to update gist",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := mustNewGHClient(t, tc.mockedClient)
deps := BaseDeps{
Client: client,
}
handler := serverTool.Handler(deps)
// Create call request
request := createMCPRequest(tc.requestArgs)
// Call handler
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
// Verify results
if tc.expectError {
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.False(t, result.IsError)
assert.NotNil(t, result)
// Parse the result and get the text content
textContent := getTextResult(t, result)
// Unmarshal and verify the minimal result
var updateResp MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &updateResp)
require.NoError(t, err)
assert.Equal(t, tc.expectedGist.GetHTMLURL(), updateResp.URL)
})
}
}
func Test_UpdateGist_DescriptionOnlySentWhenProvided(t *testing.T) {
serverTool := UpdateGist(translations.NullTranslationHelper)
updatedGist := &github.Gist{
ID: github.Ptr("existing-gist-id"),
HTMLURL: github.Ptr("https://gist.github.com/user/existing-gist-id"),
}
cases := []struct {
name string
args map[string]any
wantDescPresent bool
wantDescValue string
}{
{
name: "omitted description is not sent, preserving the existing one",
args: map[string]any{
"gist_id": "existing-gist-id",
"filename": "updated.go",
"content": "package main",
},
wantDescPresent: false,
},
{
name: "explicit empty description is sent to clear it",
args: map[string]any{
"gist_id": "existing-gist-id",
"filename": "updated.go",
"content": "package main",
"description": "",
},
wantDescPresent: true,
wantDescValue: "",
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
var gotBody map[string]any
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
PatchGistsByGistID: func(w http.ResponseWriter, r *http.Request) {
require.NoError(t, json.NewDecoder(r.Body).Decode(&gotBody))
w.WriteHeader(http.StatusOK)
_, _ = w.Write(MustMarshal(updatedGist))
},
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(tc.args)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
desc, present := gotBody["description"]
assert.Equal(t, tc.wantDescPresent, present, "description key presence in PATCH body")
if tc.wantDescPresent {
assert.Equal(t, tc.wantDescValue, desc)
}
})
}
}
You can’t perform that action at this time.