-
Notifications
You must be signed in to change notification settings - Fork 41
Expand file tree
/
Copy pathhandle-fix-limit.test.mts
More file actions
450 lines (371 loc) · 12.7 KB
/
handle-fix-limit.test.mts
File metadata and controls
450 lines (371 loc) · 12.7 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
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { coanaFix } from './coana-fix.mts'
import type { FixConfig } from './types.mts'
// Mock all external dependencies.
const mockSpawnCoanaDlx = vi.hoisted(() => vi.fn())
const mockSetupSdk = vi.hoisted(() => vi.fn())
const mockFetchSupportedScanFileNames = vi.hoisted(() => vi.fn())
const mockGetPackageFilesForScan = vi.hoisted(() => vi.fn())
const mockHandleApiCall = vi.hoisted(() => vi.fn())
const mockGetFixEnv = vi.hoisted(() => vi.fn())
const mockGetSocketFixPrs = vi.hoisted(() => vi.fn())
const mockFetchGhsaDetails = vi.hoisted(() => vi.fn())
const mockGitUnstagedModifiedFiles = vi.hoisted(() => vi.fn())
vi.mock('../../utils/dlx.mts', () => ({
spawnCoanaDlx: mockSpawnCoanaDlx,
}))
vi.mock('../../utils/sdk.mts', () => ({
setupSdk: mockSetupSdk,
}))
vi.mock('../scan/fetch-supported-scan-file-names.mts', () => ({
fetchSupportedScanFileNames: mockFetchSupportedScanFileNames,
}))
vi.mock('../../utils/path-resolve.mts', () => ({
getPackageFilesForScan: mockGetPackageFilesForScan,
}))
vi.mock('../../utils/api.mts', () => ({
handleApiCall: mockHandleApiCall,
}))
vi.mock('./env-helpers.mts', () => ({
checkCiEnvVars: vi.fn(() => ({ missing: [], present: [] })),
getCiEnvInstructions: vi.fn(() => 'Set CI env vars'),
getFixEnv: mockGetFixEnv,
}))
vi.mock('./pull-request.mts', () => ({
getSocketFixPrs: mockGetSocketFixPrs,
openSocketFixPr: vi.fn(),
}))
vi.mock('../../utils/github.mts', () => ({
enablePrAutoMerge: vi.fn(),
fetchGhsaDetails: mockFetchGhsaDetails,
setGitRemoteGithubRepoUrl: vi.fn(),
}))
vi.mock('../../utils/git.mts', () => ({
gitCheckoutBranch: vi.fn(() => Promise.resolve(true)),
gitCommit: vi.fn(() => Promise.resolve(true)),
gitCreateBranch: vi.fn(() => Promise.resolve(true)),
gitDeleteBranch: vi.fn(() => Promise.resolve(true)),
gitPushBranch: vi.fn(() => Promise.resolve(true)),
gitRemoteBranchExists: vi.fn(() => Promise.resolve(false)),
gitResetAndClean: vi.fn(() => Promise.resolve(true)),
gitUnstagedModifiedFiles: mockGitUnstagedModifiedFiles,
}))
vi.mock('./branch-cleanup.mts', () => ({
cleanupErrorBranches: vi.fn(),
cleanupFailedPrBranches: vi.fn(),
cleanupStaleBranch: vi.fn(() => Promise.resolve(true)),
cleanupSuccessfulPrLocalBranch: vi.fn(),
}))
describe('socket fix --pr-limit behavior verification', () => {
const baseConfig: FixConfig = {
all: false,
applyFixes: true,
autopilot: false,
coanaVersion: undefined,
cwd: '/test/cwd',
disableMajorUpdates: false,
ecosystems: [],
exclude: [],
ghsas: [],
include: [],
minSatisfying: false,
minimumReleaseAge: '',
orgSlug: 'test-org',
outputFile: '',
prCheck: true,
prLimit: 10,
rangeStyle: 'preserve',
showAffectedDirectDependencies: false,
spinner: undefined,
unknownFlags: [],
}
beforeEach(() => {
vi.clearAllMocks()
// Default mock implementations.
mockSetupSdk.mockResolvedValue({
ok: true,
data: {
uploadManifestFiles: vi.fn(),
},
})
mockFetchSupportedScanFileNames.mockResolvedValue({
ok: true,
data: ['package.json', 'package-lock.json'],
})
mockGetPackageFilesForScan.mockResolvedValue([
'/test/cwd/package.json',
'/test/cwd/package-lock.json',
])
mockHandleApiCall.mockResolvedValue({
ok: true,
data: { tarHash: 'test-hash-123' },
})
mockGetFixEnv.mockResolvedValue({
githubToken: '',
gitUserEmail: '',
gitUserName: '',
isCi: false,
repoInfo: null,
})
mockGitUnstagedModifiedFiles.mockResolvedValue({
ok: true,
data: [],
})
})
describe('local mode (no PRs)', () => {
it('should process all GHSAs in local mode (no limit)', async () => {
const ghsas = [
'GHSA-1111-1111-1111',
'GHSA-2222-2222-2222',
'GHSA-3333-3333-3333',
'GHSA-4444-4444-4444',
'GHSA-5555-5555-5555',
]
// Mock successful fix result.
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
const result = await coanaFix({
...baseConfig,
ghsas,
prLimit: 3, // prLimit should have no effect in local mode.
})
expect(result.ok).toBe(true)
// Verify spawnCoanaDlx was called once with all GHSAs (local mode has no limit).
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(1)
const callArgs = mockSpawnCoanaDlx.mock.calls[0]?.[0] as string[]
expect(callArgs).toContain('--apply-fixes-to')
// Find the index of --apply-fixes-to and check the next arguments.
const applyFixesIndex = callArgs.indexOf('--apply-fixes-to')
const ghsaArgs = callArgs
.slice(applyFixesIndex + 1)
.filter(arg => arg.startsWith('GHSA-'))
// All 5 GHSAs should be processed in local mode.
expect(ghsaArgs).toEqual([
'GHSA-1111-1111-1111',
'GHSA-2222-2222-2222',
'GHSA-3333-3333-3333',
'GHSA-4444-4444-4444',
'GHSA-5555-5555-5555',
])
})
it('should process all provided GHSAs in local mode', async () => {
const ghsas = ['GHSA-1111-1111-1111', 'GHSA-2222-2222-2222']
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
const result = await coanaFix({
...baseConfig,
ghsas,
})
expect(result.ok).toBe(true)
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(1)
const callArgs = mockSpawnCoanaDlx.mock.calls[0]?.[0] as string[]
const applyFixesIndex = callArgs.indexOf('--apply-fixes-to')
const ghsaArgs = callArgs
.slice(applyFixesIndex + 1)
.filter(arg => arg.startsWith('GHSA-'))
expect(ghsaArgs).toEqual(['GHSA-1111-1111-1111', 'GHSA-2222-2222-2222'])
})
it('should return early when no GHSAs are provided and none are discovered', async () => {
// Discovery returns empty array.
mockSpawnCoanaDlx.mockResolvedValueOnce({
ok: true,
data: JSON.stringify([]),
})
const result = await coanaFix({
...baseConfig,
ghsas: [],
})
expect(result.ok).toBe(true)
expect(result.data?.fixed).toBe(false)
// Only discovery call, no fix call since no GHSAs found.
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(1)
})
it('should discover vulnerabilities when no GHSAs are provided', async () => {
// First call is for discovery (returns vulnerability IDs).
mockSpawnCoanaDlx.mockResolvedValueOnce({
ok: true,
data: JSON.stringify(['GHSA-aaaa-aaaa-aaaa', 'GHSA-bbbb-bbbb-bbbb']),
})
// Second call is to apply fixes to the discovered IDs.
mockSpawnCoanaDlx.mockResolvedValueOnce({
ok: true,
data: 'fix applied',
})
const result = await coanaFix({
...baseConfig,
ghsas: [],
})
expect(result.ok).toBe(true)
// When ghsas is empty, it first discovers vulnerabilities, then applies fixes.
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(2)
// First call is discovery (no --apply-fixes-to).
const discoveryArgs = mockSpawnCoanaDlx.mock.calls[0]?.[0] as string[]
expect(discoveryArgs).toContain('find-vulnerabilities')
expect(discoveryArgs).not.toContain('--apply-fixes-to')
// Second call applies fixes to discovered IDs.
const applyArgs = mockSpawnCoanaDlx.mock.calls[1]?.[0] as string[]
expect(applyArgs).toContain('--apply-fixes-to')
})
})
describe('PR mode', () => {
beforeEach(() => {
// Enable PR mode.
mockGetFixEnv.mockResolvedValue({
baseBranch: 'main',
githubToken: 'test-token',
gitEmail: 'test@example.com',
gitUser: 'test-user',
isCi: true,
repoInfo: {
defaultBranch: 'main',
owner: 'test-owner',
repo: 'test-repo',
},
})
mockGetSocketFixPrs.mockResolvedValue([])
mockFetchGhsaDetails.mockResolvedValue(new Map())
})
it('should process only N GHSAs when --pr-limit N is specified in PR mode', async () => {
const ghsas = [
'GHSA-aaaa-aaaa-aaaa',
'GHSA-bbbb-bbbb-bbbb',
'GHSA-cccc-cccc-cccc',
'GHSA-dddd-dddd-dddd',
]
// First call discovers vulnerabilities.
mockSpawnCoanaDlx.mockResolvedValueOnce({
ok: true,
data: JSON.stringify(ghsas),
})
// Subsequent calls are for individual GHSA fixes.
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
mockGitUnstagedModifiedFiles.mockResolvedValue({
ok: true,
data: ['package.json'],
})
const result = await coanaFix({
...baseConfig,
ghsas: [], // Empty to trigger discovery.
prLimit: 2,
})
expect(result.ok).toBe(true)
// First call to discover vulnerabilities, then 2 calls for the fixes.
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(3)
})
it('should adjust prLimit based on existing open PRs', async () => {
const ghsas = [
'GHSA-aaaa-aaaa-aaaa',
'GHSA-bbbb-bbbb-bbbb',
'GHSA-cccc-cccc-cccc',
]
// Mock 1 existing open PR.
mockGetSocketFixPrs.mockResolvedValueOnce([
{ number: 123, state: 'OPEN' },
])
// Second call returns no open PRs for specific GHSAs.
mockGetSocketFixPrs.mockResolvedValue([])
mockSpawnCoanaDlx.mockResolvedValueOnce({
ok: true,
data: JSON.stringify(ghsas),
})
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
mockGitUnstagedModifiedFiles.mockResolvedValue({
ok: true,
data: ['package.json'],
})
const result = await coanaFix({
...baseConfig,
ghsas: [], // Empty to trigger discovery.
prLimit: 3,
})
expect(result.ok).toBe(true)
// With prLimit 3 and 1 existing PR, adjusted limit is 2.
// So: 1 discovery call + 2 fix calls = 3 total.
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(3)
})
it('should process no GHSAs when existing open PRs exceed prLimit', async () => {
// Mock 5 existing open PRs.
mockGetSocketFixPrs.mockResolvedValue([
{ number: 1, state: 'OPEN' },
{ number: 2, state: 'OPEN' },
{ number: 3, state: 'OPEN' },
{ number: 4, state: 'OPEN' },
{ number: 5, state: 'OPEN' },
])
const result = await coanaFix({
...baseConfig,
ghsas: [], // Empty to trigger discovery.
prLimit: 3,
})
expect(result.ok).toBe(true)
expect(result.data?.fixed).toBe(false)
// With 5 open PRs and prLimit 3, adjusted limit is 0, so no processing.
expect(mockSpawnCoanaDlx).not.toHaveBeenCalled()
})
})
describe('--id filtering in local mode', () => {
it('should process all provided GHSA IDs in local mode (prLimit ignored)', async () => {
const ghsas = [
'GHSA-1111-1111-1111',
'GHSA-2222-2222-2222',
'GHSA-3333-3333-3333',
'GHSA-4444-4444-4444',
'GHSA-5555-5555-5555',
]
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
const result = await coanaFix({
...baseConfig,
ghsas,
prLimit: 2, // Should be ignored in local mode.
})
expect(result.ok).toBe(true)
// Should process all 5 GHSAs in local mode (prLimit is ignored).
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(1)
const callArgs = mockSpawnCoanaDlx.mock.calls[0]?.[0] as string[]
const applyFixesIndex = callArgs.indexOf('--apply-fixes-to')
const ghsaArgs = callArgs
.slice(applyFixesIndex + 1)
.filter(arg => arg.startsWith('GHSA-'))
expect(ghsaArgs).toHaveLength(5)
expect(ghsaArgs).toEqual([
'GHSA-1111-1111-1111',
'GHSA-2222-2222-2222',
'GHSA-3333-3333-3333',
'GHSA-4444-4444-4444',
'GHSA-5555-5555-5555',
])
})
it('should handle single GHSA ID in local mode', async () => {
const ghsas = ['GHSA-1111-1111-1111']
mockSpawnCoanaDlx.mockResolvedValue({
ok: true,
data: 'fix applied',
})
const result = await coanaFix({
...baseConfig,
ghsas,
})
expect(result.ok).toBe(true)
expect(mockSpawnCoanaDlx).toHaveBeenCalledTimes(1)
const callArgs = mockSpawnCoanaDlx.mock.calls[0]?.[0] as string[]
const applyFixesIndex = callArgs.indexOf('--apply-fixes-to')
const ghsaArgs = callArgs
.slice(applyFixesIndex + 1)
.filter(arg => arg.startsWith('GHSA-'))
expect(ghsaArgs).toEqual(['GHSA-1111-1111-1111'])
})
})
})