{{ message }}
Repository navigation
Expand file tree
/
Copy pathserver_test.go
More file actions
557 lines (516 loc) · 16.3 KB
/
Copy pathserver_test.go
File metadata and controls
557 lines (516 loc) · 16.3 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
package http
import (
"context"
"encoding/base64"
"encoding/json"
"io"
"log/slog"
"net/http"
"net/http/httptest"
"strings"
"testing"
ghcontext "github.com/github/github-mcp-server/pkg/context"
"github.com/github/github-mcp-server/pkg/github"
"github.com/github/github-mcp-server/pkg/http/middleware"
"github.com/github/github-mcp-server/pkg/http/oauth"
"github.com/github/github-mcp-server/pkg/inventory"
"github.com/github/github-mcp-server/pkg/utils"
"github.com/go-chi/chi/v5"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestRunHTTPServerRejectsInvalidStaticTools(t *testing.T) {
tests := []struct {
name string
enabledTools []string
}{
{
name: "mixed valid and invalid tools",
enabledTools: []string{"get_file_contents", "nonexistent_tool"},
},
{
name: "all invalid tools",
enabledTools: []string{"nonexistent_tool", "another_nonexistent_tool"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := RunHTTPServer(ServerConfig{
Version: "test",
Host: "https://github.com",
EnabledTools: tt.enabledTools,
})
require.ErrorIs(t, err, inventory.ErrUnknownTools)
assert.ErrorContains(t, err, "failed to build inventory")
})
}
}
func TestNewOAuthConfig(t *testing.T) {
tests := []struct {
name string
authorizationServer string
}{
{
name: "unset preserves host-derived authorization server",
},
{
name: "explicit override is propagated",
authorizationServer: "https://oauth-proxy.example.com",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cfg := newOAuthConfig(ServerConfig{
BaseURL: "https://mcp.example.com",
ResourcePath: "/mcp",
TrustProxyHeaders: true,
AuthorizationServer: tt.authorizationServer,
})
assert.Equal(t, &oauth.Config{
BaseURL: "https://mcp.example.com",
ResourcePath: "/mcp",
TrustProxyHeaders: true,
AuthorizationServer: tt.authorizationServer,
}, cfg)
})
}
}
func TestHTTPRouterCORSContract(t *testing.T) {
router := newHTTPRouter(
func(r chi.Router) {
r.Use(middleware.ExtractUserToken(&oauth.Config{
BaseURL: "https://mcp.example.com",
ResourcePath: "/mcp",
}))
r.Post("/", func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNoContent)
})
},
func(r chi.Router) {
r.Get("/metadata", func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNoContent)
})
r.Get("/metadata-error", func(w http.ResponseWriter, _ *http.Request) {
http.Error(w, "metadata unavailable", http.StatusInternalServerError)
})
},
)
tests := []struct {
name string
method string
path string
requestHeaders string
expectedStatus int
expectChallenge bool
expectedAllow []string
}{
{
name: "MCP preflight",
method: http.MethodOptions,
path: "/",
requestHeaders: "content-type, mcp-method, mcp-name, mcp-param-owner, mcp-param-region",
expectedStatus: http.StatusOK,
expectedAllow: []string{"Content-Type", "Mcp-Method", "Mcp-Name", "Mcp-Param-owner", "Mcp-Param-Region"},
},
{
name: "metadata preflight",
method: http.MethodOptions,
path: "/metadata",
requestHeaders: "content-type",
expectedStatus: http.StatusOK,
expectedAllow: []string{"Content-Type"},
},
{
name: "authentication challenge",
method: http.MethodPost,
path: "/",
expectedStatus: http.StatusUnauthorized,
expectChallenge: true,
},
{
name: "metadata success",
method: http.MethodGet,
path: "/metadata",
expectedStatus: http.StatusNoContent,
},
{
name: "metadata error",
method: http.MethodGet,
path: "/metadata-error",
expectedStatus: http.StatusInternalServerError,
},
{
name: "method not allowed",
method: http.MethodPost,
path: "/metadata",
expectedStatus: http.StatusMethodNotAllowed,
},
{
name: "not found",
method: http.MethodGet,
path: "/not-found",
expectedStatus: http.StatusNotFound,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
req := httptest.NewRequest(tt.method, tt.path, nil)
req.Header.Set("Origin", "https://confer.to")
if tt.method == http.MethodOptions {
req.Header.Set("Access-Control-Request-Method", http.MethodPost)
req.Header.Set("Access-Control-Request-Headers", tt.requestHeaders)
}
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
assert.Equal(t, tt.expectedStatus, rec.Code)
assert.Equal(t, "*", rec.Header().Get("Access-Control-Allow-Origin"))
assert.Empty(t, rec.Header().Get("Access-Control-Allow-Credentials"))
assert.Contains(t, rec.Header().Get("Access-Control-Expose-Headers"), "Mcp-Session-Id")
assert.Contains(t, rec.Header().Get("Access-Control-Expose-Headers"), "WWW-Authenticate")
for _, header := range tt.expectedAllow {
assert.Contains(t, rec.Header().Get("Access-Control-Allow-Headers"), header)
}
if tt.expectChallenge {
assert.Equal(t,
`Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource/mcp"`,
rec.Header().Get("WWW-Authenticate"),
)
}
})
}
}
func TestOAuthChallengeMetadataRouteContracts(t *testing.T) {
const baseURL = "https://mcp.example.com"
oauthCfg := &oauth.Config{
BaseURL: baseURL,
ResourcePath: "/mcp",
}
apiHost, err := utils.NewAPIHost("https://api.github.com")
require.NoError(t, err)
oauthHandler, err := oauth.NewAuthHandler(oauthCfg, apiHost)
require.NoError(t, err)
resourcePaths := []string{
"/",
"/readonly",
"/insiders",
"/readonly/insiders",
"/x/repos",
"/x/repos/readonly",
"/x/repos/insiders",
"/x/repos/readonly/insiders",
}
router := newHTTPRouter(
func(r chi.Router) {
r.Use(middleware.ExtractUserToken(oauthCfg))
for _, path := range resourcePaths {
r.Post(path, func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNoContent)
})
}
},
oauthHandler.RegisterRoutes,
)
for _, path := range resourcePaths {
t.Run(path, func(t *testing.T) {
req := httptest.NewRequest(http.MethodPost, path, nil)
req.Header.Set("Origin", "https://confer.to")
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
require.Equal(t, http.StatusUnauthorized, rec.Code)
assert.Equal(t, "*", rec.Header().Get("Access-Control-Allow-Origin"))
challenge := rec.Header().Get("WWW-Authenticate")
require.True(t, strings.HasPrefix(challenge, `Bearer resource_metadata="`))
metadataURL := strings.TrimSuffix(
strings.TrimPrefix(challenge, `Bearer resource_metadata="`),
`"`,
)
metadataPath := strings.TrimPrefix(metadataURL, baseURL)
req = httptest.NewRequest(http.MethodGet, metadataPath, nil)
req.Header.Set("Origin", "https://confer.to")
rec = httptest.NewRecorder()
router.ServeHTTP(rec, req)
require.Equal(t, http.StatusOK, rec.Code)
assert.Equal(t, "*", rec.Header().Get("Access-Control-Allow-Origin"))
var metadata map[string]any
require.NoError(t, json.Unmarshal(rec.Body.Bytes(), &metadata))
expectedResourcePath := "/mcp"
if path != "/" {
expectedResourcePath += path
}
assert.Equal(t, baseURL+expectedResourcePath, metadata["resource"])
})
}
// Query-bearing MCP server URLs must round-trip: the challenge's
// resource_metadata URL and the served metadata document's "resource"
// must both carry the exact same query as the URL the client connects to,
// because go-sdk validates metadata.resource with exact string equality.
queryPath := "/x/repos?features=issue_dependencies"
t.Run(queryPath, func(t *testing.T) {
req := httptest.NewRequest(http.MethodPost, queryPath, nil)
req.Header.Set("Origin", "https://confer.to")
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
require.Equal(t, http.StatusUnauthorized, rec.Code)
challenge := rec.Header().Get("WWW-Authenticate")
require.True(t, strings.HasPrefix(challenge, `Bearer resource_metadata="`))
metadataURL := strings.TrimSuffix(
strings.TrimPrefix(challenge, `Bearer resource_metadata="`),
`"`,
)
assert.Equal(t,
baseURL+"/.well-known/oauth-protected-resource/mcp/x/repos?features=issue_dependencies",
metadataURL,
)
metadataPaths := []string{
strings.TrimPrefix(metadataURL, baseURL),
oauth.OAuthProtectedResourcePrefix + queryPath,
}
for _, metadataPath := range metadataPaths {
req = httptest.NewRequest(http.MethodGet, metadataPath, nil)
req.Header.Set("Origin", "https://confer.to")
rec = httptest.NewRecorder()
router.ServeHTTP(rec, req)
require.Equal(t, http.StatusOK, rec.Code)
var metadata map[string]any
require.NoError(t, json.Unmarshal(rec.Body.Bytes(), &metadata))
assert.Equal(t, baseURL+"/mcp"+queryPath, metadata["resource"])
}
})
req := httptest.NewRequest(
http.MethodGet,
oauth.OAuthProtectedResourcePrefix+"/mcp/unknown",
nil,
)
req.Header.Set("Origin", "https://confer.to")
rec := httptest.NewRecorder()
router.ServeHTTP(rec, req)
assert.Equal(t, http.StatusNotFound, rec.Code)
assert.Equal(t, "*", rec.Header().Get("Access-Control-Allow-Origin"))
assert.Empty(t, rec.Header().Get("WWW-Authenticate"))
}
func TestInitGlobalToolScopeMapUsesHost(t *testing.T) {
tests := []struct {
name string
hostType utils.HostType
want string
}{
{
name: "dotcom uses semantic search",
hostType: utils.HostTypeDotcom,
want: "Search issues using natural-language semantic matching. Best for conceptual or paraphrased queries (e.g. \"login fails after password reset\"). Already scoped to is:issue.",
},
{
name: "GHES uses lexical search",
hostType: utils.HostTypeGHES,
want: "Search for issues in GitHub repositories using issues search syntax already scoped to is:issue",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
translations := make(map[string]string)
translator := func(key, defaultValue string) string {
if value, ok := translations[key]; ok {
return value
}
translations[key] = defaultValue
return defaultValue
}
require.NoError(t, initGlobalToolScopeMap(translator, tt.hostType))
tool := github.SearchIssues(translator, github.WithHost(tt.hostType))
assert.Equal(t, tt.want, tool.Tool.Description)
})
}
}
func TestCreateHTTPFeatureChecker(t *testing.T) {
tests := []struct {
name string
staticFeatures []string
staticInsiders bool
flagName string
headerFeatures []string
insidersMode bool
wantEnabled bool
}{
{
name: "allowed issues_granular flag accepted from header",
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: []string{github.FeatureFlagIssuesGranular},
wantEnabled: true,
},
{
name: "allowed pull_requests_granular flag accepted from header",
flagName: github.FeatureFlagPullRequestsGranular,
headerFeatures: []string{github.FeatureFlagPullRequestsGranular},
wantEnabled: true,
},
{
name: "MCP Apps form deferral opt-out accepted from header",
flagName: github.MCPAppsDisableFormDeferralFeatureFlag,
headerFeatures: []string{github.MCPAppsDisableFormDeferralFeatureFlag},
wantEnabled: true,
},
{
name: "unknown flag in header is ignored",
flagName: "unknown_flag",
headerFeatures: []string{"unknown_flag"},
wantEnabled: false,
},
{
name: "allowed flag not in header returns false",
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: nil,
wantEnabled: false,
},
{
name: "allowed flag with different flag in header returns false",
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: []string{github.FeatureFlagPullRequestsGranular},
wantEnabled: false,
},
{
name: "multiple allowed flags in header",
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: []string{github.FeatureFlagIssuesGranular, github.FeatureFlagPullRequestsGranular},
wantEnabled: true,
},
{
name: "empty header features",
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: []string{},
wantEnabled: false,
},
{
name: "insiders mode enables CSV output without header",
flagName: github.FeatureFlagCSVOutput,
insidersMode: true,
wantEnabled: true,
},
{
name: "insiders mode does not disable MCP Apps form deferral",
flagName: github.MCPAppsDisableFormDeferralFeatureFlag,
insidersMode: true,
wantEnabled: false,
},
{
name: "static feature is enabled without header",
staticFeatures: []string{github.FeatureFlagCSVOutput},
flagName: github.FeatureFlagCSVOutput,
wantEnabled: true,
},
{
name: "static features combine with header features",
staticFeatures: []string{github.FeatureFlagCSVOutput},
flagName: github.FeatureFlagIssuesGranular,
headerFeatures: []string{github.FeatureFlagIssuesGranular},
wantEnabled: true,
},
{
name: "static insiders enables insiders flags without route context",
staticInsiders: true,
flagName: github.FeatureFlagCSVOutput,
wantEnabled: true,
},
{
name: "insiders mode does not auto-enable ifc labels",
flagName: github.FeatureFlagIFCLabels,
insidersMode: true,
wantEnabled: false,
},
{
name: "insiders mode does not enable granular flags",
flagName: github.FeatureFlagIssuesGranular,
insidersMode: true,
wantEnabled: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
checker := createHTTPFeatureChecker(tt.staticFeatures, tt.staticInsiders)
ctx := context.Background()
if len(tt.headerFeatures) > 0 {
ctx = ghcontext.WithHeaderFeatures(ctx, tt.headerFeatures)
}
if tt.insidersMode {
ctx = ghcontext.WithInsidersMode(ctx, true)
}
enabled, err := checker(ctx, tt.flagName)
require.NoError(t, err)
assert.Equal(t, tt.wantEnabled, enabled)
})
}
}
func TestResolveListenAddress(t *testing.T) {
tests := []struct {
name string
host string
port int
want string
}{
{
name: "empty host falls back to :port",
host: "",
port: 8082,
want: ":8082",
},
{
name: "ipv4 host is joined with port",
host: "127.0.0.1",
port: 9090,
want: "127.0.0.1:9090",
},
{
name: "ipv6 host is bracketed and joined with port",
host: "::1",
port: 9090,
want: "[::1]:9090",
},
{
name: "hostname is joined with port",
host: "localhost",
port: 8082,
want: "localhost:8082",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := resolveListenAddress(tt.host, tt.port)
assert.Equal(t, tt.want, got)
})
}
}
func TestConfigureRequestState(t *testing.T) {
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
t.Run("missing key disables delete repository", func(t *testing.T) {
cfg := &ServerConfig{}
sealer, err := configureRequestState(cfg, logger)
require.NoError(t, err)
assert.Nil(t, sealer)
assert.True(t, cfg.disableDeleteRepository)
})
t.Run("valid key configures sealer", func(t *testing.T) {
cfg := &ServerConfig{
MRTRStateKey: base64.StdEncoding.EncodeToString([]byte("0123456789abcdef0123456789abcdef")),
}
sealer, err := configureRequestState(cfg, logger)
require.NoError(t, err)
require.NotNil(t, sealer)
assert.False(t, cfg.disableDeleteRepository)
token, err := sealer.Seal(context.Background(), []byte("state"))
require.NoError(t, err)
opened, err := sealer.Open(token)
require.NoError(t, err)
assert.Equal(t, []byte("state"), opened)
})
t.Run("malformed key fails", func(t *testing.T) {
cfg := &ServerConfig{MRTRStateKey: "invalid"}
_, err := configureRequestState(cfg, logger)
require.ErrorContains(t, err, "invalid "+MRTRStateKeyEnv)
})
}
func TestHeaderAllowedFeatureFlagsMatchesAllowed(t *testing.T) {
// Ensure HeaderAllowedFeatureFlags delegates to AllowedFeatureFlags
allowed := github.HeaderAllowedFeatureFlags()
assert.Equal(t, github.AllowedFeatureFlags, allowed,
"HeaderAllowedFeatureFlags() should match AllowedFeatureFlags")
assert.NotEmpty(t, allowed, "AllowedFeatureFlags should not be empty")
}
You can’t perform that action at this time.