{{ message }}
Repository navigation
Expand file tree
/
Copy pathdependabot_test.go
More file actions
338 lines (314 loc) · 10.9 KB
/
Copy pathdependabot_test.go
File metadata and controls
338 lines (314 loc) · 10.9 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
package github
import (
"context"
"encoding/json"
"net/http"
"testing"
"github.com/github/github-mcp-server/internal/toolsnaps"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v92/github"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func Test_GetDependabotAlert(t *testing.T) {
// Verify tool definition
toolDef := GetDependabotAlert(translations.NullTranslationHelper)
tool := toolDef.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
// Validate tool schema
assert.Equal(t, "get_dependabot_alert", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.True(t, tool.Annotations.ReadOnlyHint, "get_dependabot_alert tool should be read-only")
// Setup mock alert for success case
mockAlert := &github.DependabotAlert{
Number: new(42),
State: new("open"),
HTMLURL: new("https://github.com/owner/repo/security/dependabot/42"),
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedAlert *github.DependabotAlert
expectedErrMsg string
}{
{
name: "successful alert fetch",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepoByAlertNumber: mockResponse(t, http.StatusOK, mockAlert),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"alertNumber": float64(42),
},
expectError: false,
expectedAlert: mockAlert,
},
{
name: "alert fetch fails",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepoByAlertNumber: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte(`{"message": "Not Found"}`))
}),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"alertNumber": float64(9999),
},
expectError: true,
expectedErrMsg: "Your token may not have access to Dependabot alerts on owner/repo",
},
{
name: "alert fetch forbidden",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepoByAlertNumber: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusForbidden)
_, _ = w.Write([]byte(`{"message": "Resource not accessible by integration"}`))
}),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"alertNumber": float64(42),
},
expectError: true,
expectedErrMsg: "Your token may not have access to Dependabot alerts on owner/repo",
},
}
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 := toolDef.Handler(deps)
// Create call request
request := createMCPRequest(tc.requestArgs)
// Call handler
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
// Verify results
if tc.expectError {
require.NoError(t, err)
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.NoError(t, err)
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 returnedAlert github.DependabotAlert
err = json.Unmarshal([]byte(textContent.Text), &returnedAlert)
assert.NoError(t, err)
assert.Equal(t, *tc.expectedAlert.Number, *returnedAlert.Number)
assert.Equal(t, *tc.expectedAlert.State, *returnedAlert.State)
assert.Equal(t, *tc.expectedAlert.HTMLURL, *returnedAlert.HTMLURL)
})
}
}
func Test_ListDependabotAlerts(t *testing.T) {
// Verify tool definition once
toolDef := ListDependabotAlerts(translations.NullTranslationHelper)
tool := toolDef.Tool
require.NoError(t, toolsnaps.Test(tool.Name, tool))
assert.Equal(t, "list_dependabot_alerts", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.True(t, tool.Annotations.ReadOnlyHint, "list_dependabot_alerts tool should be read-only")
// Setup mock alerts for success case
criticalAlert := github.DependabotAlert{
Number: new(1),
HTMLURL: new("https://github.com/owner/repo/security/dependabot/1"),
State: new("open"),
SecurityAdvisory: &github.DependabotSecurityAdvisory{
Severity: new("critical"),
},
}
highSeverityAlert := github.DependabotAlert{
Number: new(2),
HTMLURL: new("https://github.com/owner/repo/security/dependabot/2"),
State: new("fixed"),
SecurityAdvisory: &github.DependabotSecurityAdvisory{
Severity: new("high"),
},
}
tests := []struct {
name string
mockedClient *http.Client
requestArgs map[string]any
expectError bool
expectedAlerts []*github.DependabotAlert
expectedNextCursor string
expectedErrMsg string
}{
{
name: "successful open alerts listing",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: expectQueryParams(t, map[string]string{
"state": "open",
"per_page": "30",
}).andThen(
mockResponse(t, http.StatusOK, []*github.DependabotAlert{&criticalAlert}),
),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"state": "open",
},
expectError: false,
expectedAlerts: []*github.DependabotAlert{&criticalAlert},
},
{
name: "successful severity filtered listing",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: expectQueryParams(t, map[string]string{
"severity": "high",
"per_page": "30",
}).andThen(
mockResponse(t, http.StatusOK, []*github.DependabotAlert{&highSeverityAlert}),
),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"severity": "high",
},
expectError: false,
expectedAlerts: []*github.DependabotAlert{&highSeverityAlert},
},
{
name: "successful all alerts listing",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: expectQueryParams(t, map[string]string{
"per_page": "30",
}).andThen(
mockResponse(t, http.StatusOK, []*github.DependabotAlert{&criticalAlert, &highSeverityAlert}),
),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
},
expectError: false,
expectedAlerts: []*github.DependabotAlert{&criticalAlert, &highSeverityAlert},
},
{
name: "successful alerts listing with cursor pagination",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: expectQueryParams(t, map[string]string{
"after": "Y3Vyc29yOnYyOpK5",
"per_page": "100",
}).andThen(
mockResponse(t, http.StatusOK, []*github.DependabotAlert{&criticalAlert}),
),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
"after": "Y3Vyc29yOnYyOpK5",
"perPage": float64(100),
},
expectError: false,
expectedAlerts: []*github.DependabotAlert{&criticalAlert},
},
{
name: "successful alerts listing surfaces next page cursor",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: expectQueryParams(t, map[string]string{
"per_page": "30",
}).andThen(
func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Link", `<https://api.github.com/repos/owner/repo/dependabot/alerts?after=nextcursor123&per_page=30>; rel="next"`)
w.WriteHeader(http.StatusOK)
b, err := json.Marshal([]*github.DependabotAlert{&criticalAlert})
require.NoError(t, err)
_, _ = w.Write(b)
},
),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
},
expectError: false,
expectedAlerts: []*github.DependabotAlert{&criticalAlert},
expectedNextCursor: "nextcursor123",
},
{
name: "alerts listing fails",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusUnauthorized)
_, _ = w.Write([]byte(`{"message": "Unauthorized access"}`))
}),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
},
expectError: true,
expectedErrMsg: "failed to list alerts",
},
{
name: "alerts listing forbidden includes token hint",
mockedClient: MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposDependabotAlertsByOwnerByRepo: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusForbidden)
_, _ = w.Write([]byte(`{"message": "Resource not accessible by integration"}`))
}),
}),
requestArgs: map[string]any{
"owner": "owner",
"repo": "repo",
},
expectError: true,
expectedErrMsg: "Your token may not have access to Dependabot alerts on owner/repo",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
client := mustNewGHClient(t, tc.mockedClient)
deps := BaseDeps{Client: client}
handler := toolDef.Handler(deps)
request := createMCPRequest(tc.requestArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
if tc.expectError {
require.NoError(t, err)
require.True(t, result.IsError)
errorContent := getErrorResult(t, result)
assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
return
}
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
// Unmarshal and verify the result
var returnedResult struct {
Alerts []*github.DependabotAlert `json:"alerts"`
PageInfo struct {
HasNextPage bool `json:"hasNextPage"`
NextCursor string `json:"nextCursor"`
} `json:"pageInfo"`
}
err = json.Unmarshal([]byte(textContent.Text), &returnedResult)
assert.NoError(t, err)
assert.Len(t, returnedResult.Alerts, len(tc.expectedAlerts))
for i, alert := range returnedResult.Alerts {
assert.Equal(t, *tc.expectedAlerts[i].Number, *alert.Number)
assert.Equal(t, *tc.expectedAlerts[i].HTMLURL, *alert.HTMLURL)
assert.Equal(t, *tc.expectedAlerts[i].State, *alert.State)
if tc.expectedAlerts[i].SecurityAdvisory != nil && tc.expectedAlerts[i].SecurityAdvisory.Severity != nil &&
alert.SecurityAdvisory != nil && alert.SecurityAdvisory.Severity != nil {
assert.Equal(t, *tc.expectedAlerts[i].SecurityAdvisory.Severity, *alert.SecurityAdvisory.Severity)
}
}
assert.Equal(t, tc.expectedNextCursor, returnedResult.PageInfo.NextCursor)
assert.Equal(t, tc.expectedNextCursor != "", returnedResult.PageInfo.HasNextPage)
})
}
}
You can’t perform that action at this time.