-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
ignore.test.ts
680 lines (599 loc) · 21.1 KB
/
ignore.test.ts
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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
// eslint-disable-next-line camelcase -- This is a test file
import child_process, {
type ChildProcess,
type ExecException,
} from "node:child_process";
import {
spyConsole,
spyExit,
type SpyExit,
mockEnv,
validateLogs,
} from "@turbo/test-utils";
import { turboIgnore } from "../src/ignore";
import { TurboIgnoreTelemetry, TelemetryConfig } from "@turbo/telemetry";
function expectBuild(mockExit: SpyExit) {
expect(mockExit.exit).toHaveBeenCalledWith(1);
}
function expectIgnore(mockExit: SpyExit) {
expect(mockExit.exit).toHaveBeenCalledWith(0);
}
describe("turboIgnore()", () => {
mockEnv();
const mockExit = spyExit();
const mockConsole = spyConsole();
const telemetry = new TurboIgnoreTelemetry({
api: "https://example.com",
packageInfo: {
name: "turbo-ignore",
version: "1.0.0",
},
config: new TelemetryConfig({
configPath: "test-config-path",
config: {
telemetry_enabled: false,
telemetry_id: "telemetry-test-id",
telemetry_salt: "telemetry-salt",
},
}),
});
it("throws error and allows build when exec fails", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
{ message: "error details" } as unknown as ExecException,
"stdout",
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore("test-workspace", { telemetry });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-workspace...[HEAD^]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(["UNKNOWN_ERROR: error details"], mockConsole.error, {
prefix: "≫ ",
});
expectBuild(mockExit);
mockExec.mockRestore();
});
it("throws pretty error and allows build when exec fails", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
{
message:
"run failed: We did not detect an in-use package manager for your project",
} as unknown as ExecException,
"stdout",
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore("test-workspace", {});
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-workspace...[HEAD^]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(
[
`turbo-ignore could not complete - no package manager detected, please commit a lockfile, or set "packageManager" in your root "package.json"`,
],
mockConsole.warn,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExec.mockRestore();
});
it("throws pretty error and allows build when can't find previous sha", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "too-far-back";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
{
message:
" ERROR run failed: failed to resolve packages to run: commit too-far-back does not exist",
} as unknown as ExecException,
"stdout",
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore("test-workspace", { telemetry });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-workspace...[too-far-back]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(
[
`turbo-ignore could not complete - a ref or SHA is invalid. It could have been removed from the branch history via a force push, or this could be a shallow clone with insufficient history`,
],
mockConsole.warn,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("throws pretty error and allows build when fallback fails", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
{
message:
"ERROR run failed: failed to resolve packages to run: commit HEAD^ does not exist",
} as unknown as ExecException,
"stdout",
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore("test-workspace", { fallback: "HEAD^" });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-workspace...[HEAD^]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(
[
`turbo-ignore could not complete - parent commit does not exist or is unreachable`,
],
mockConsole.warn,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExec.mockRestore();
});
it("skips checks and allows build when no workspace can be found", () => {
turboIgnore(undefined, { directory: "__fixtures__/no-app" });
validateLogs(
[
() => [
"≫ ",
expect.stringContaining(
" could not be found. turbo-ignore inferencing failed"
),
],
],
mockConsole.error,
{ prefix: "≫ " }
);
expectBuild(mockExit);
});
it("skips checks and allows build when a workspace with no name is found", () => {
turboIgnore(undefined, { directory: "__fixtures__/invalid-app" });
validateLogs(
[
() => [
"≫ ",
expect.stringContaining(' is missing the "name" field (required).'),
],
],
mockConsole.error,
{ prefix: "≫ " }
);
expectBuild(mockExit);
});
it("skips checks and allows build when no monorepo root can be found", () => {
turboIgnore(undefined, { directory: "/" });
expectBuild(mockExit);
expect(mockConsole.error).toHaveBeenLastCalledWith(
"≫ ",
"Monorepo root not found. turbo-ignore inferencing failed"
);
});
it("skips checks and allows build when TURBO_FORCE is set", () => {
process.env.TURBO_FORCE = "true";
turboIgnore(undefined, { directory: "test-workspace" });
expect(mockConsole.log).toHaveBeenNthCalledWith(
2,
"≫ ",
"`TURBO_FORCE` detected"
);
expectBuild(mockExit);
});
it("allows build when no comparison is returned", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
turboIgnore("test-app", { directory: "__fixtures__/app" });
expect(mockConsole.log).toHaveBeenNthCalledWith(
4,
"≫ ",
'No previous deployments found for "test-app" on branch "my-branch"'
);
expectBuild(mockExit);
});
it("skips build for `previousDeploy` comparison with no changes", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":[],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
`Found previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch"`,
'Analyzing results of `npx turbo run build --filter="test-app...[last-deployed-sha]" --dry=json`',
"This project and its dependencies are not affected",
() => expect.stringContaining("⏭ Ignoring the change"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectIgnore(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("allows build for `previousDeploy` comparison with changes", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":["test-app"],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, {
task: "workspace#build",
directory: "__fixtures__/app",
});
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "workspace#build" as the task from the arguments',
'Found previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch"',
'Analyzing results of `npx turbo run "workspace#build" --filter="test-app...[last-deployed-sha]" --dry=json`',
'This commit affects "test-app"',
() => expect.stringContaining("✓ Proceeding with deployment"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("allows build for `previousDeploy` comparison with single dependency change", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":["test-app", "ui"],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
'Found previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch"',
'Analyzing results of `npx turbo run build --filter="test-app...[last-deployed-sha]" --dry=json`',
'This commit affects "test-app" and 1 dependency (ui)',
() => expect.stringContaining("✓ Proceeding with deployment"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("allows build for `previousDeploy` comparison with multiple dependency changes", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":["test-app", "ui", "tsconfig"],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
'Found previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch"',
'Analyzing results of `npx turbo run build --filter="test-app...[last-deployed-sha]" --dry=json`',
'This commit affects "test-app" and 2 dependencies (ui, tsconfig)',
() => expect.stringContaining("✓ Proceeding with deployment"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("allows build for unavailable `previousDeploy` comparison with fallback", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockImplementation((cmd: string) => {
if (cmd.includes("git cat-file")) {
throw new Error("fatal: Not a valid object name last-deployed-sha");
}
return "";
});
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":["test-app"],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, {
task: "workspace#build",
fallback: "HEAD^2",
directory: "__fixtures__/app",
});
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "workspace#build" as the task from the arguments',
'Previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch" is unreachable.',
"Falling back to ref HEAD^2",
'Analyzing results of `npx turbo run "workspace#build" --filter="test-app...[HEAD^2]" --dry=json`',
'This commit affects "test-app"',
() => expect.stringContaining("✓ Proceeding with deployment"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("throws error and allows build when json cannot be parsed", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(null, "stdout", "stderr") as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-app...[HEAD^]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(
[
'Failed to parse JSON output from `npx turbo run build --filter="test-app...[HEAD^]" --dry=json`.',
],
mockConsole.error,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExec.mockRestore();
});
it("throws error and allows build when stdout is null", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
null as unknown as string,
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-app...[HEAD^]" --dry=json`,
expect.anything(),
expect.anything()
);
validateLogs(
[
'Failed to parse JSON output from `npx turbo run build --filter="test-app...[HEAD^]" --dry=json`.',
],
mockConsole.error,
{ prefix: "≫ " }
);
expectBuild(mockExit);
mockExec.mockRestore();
});
it("skips when commit message contains a skip string", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_COMMIT_MESSAGE = "[vercel skip]";
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
"Found commit message: [vercel skip]",
() => expect.stringContaining("⏭ Ignoring the change"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectIgnore(mockExit);
});
it("deploys when commit message contains a deploy string", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_COMMIT_MESSAGE = "[vercel deploy]";
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
"Found commit message: [vercel deploy]",
() => expect.stringContaining("✓ Proceeding with deployment"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectBuild(mockExit);
});
it("runs full turbo-ignore check when commit message contains a conflicting string", () => {
process.env.VERCEL = "1";
process.env.VERCEL_GIT_COMMIT_MESSAGE = "[vercel deploy] [vercel skip]";
process.env.VERCEL_GIT_PREVIOUS_SHA = "last-deployed-sha";
process.env.VERCEL_GIT_COMMIT_REF = "my-branch";
const mockExecSync = jest
.spyOn(child_process, "execSync")
.mockReturnValue("commit");
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages":[],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app" });
validateLogs(
[
"Using Turborepo to determine if this project is affected by the commit...\n",
'Inferred "test-app" as workspace from "package.json"',
'Using "build" as the task as it was unspecified',
"Conflicting commit messages found: [vercel deploy] and [vercel skip]",
`Found previous deployment ("last-deployed-sha") for "test-app" on branch "my-branch"`,
'Analyzing results of `npx turbo run build --filter="test-app...[last-deployed-sha]" --dry=json`',
"This project and its dependencies are not affected",
() => expect.stringContaining("⏭ Ignoring the change"),
],
mockConsole.log,
{ prefix: "≫ " }
);
expectIgnore(mockExit);
mockExecSync.mockRestore();
mockExec.mockRestore();
});
it("passes max buffer to turbo execution", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages": [],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, { directory: "__fixtures__/app", maxBuffer: 1024 });
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-app...[HEAD^]" --dry=json`,
expect.objectContaining({ maxBuffer: 1024 }),
expect.anything()
);
mockExec.mockRestore();
});
it("runs with telemetry", () => {
const mockExec = jest
.spyOn(child_process, "exec")
.mockImplementation((command, options, callback) => {
if (callback) {
return callback(
null,
'{"packages": [],"tasks":[]}',
"stderr"
) as unknown as ChildProcess;
}
return {} as unknown as ChildProcess;
});
turboIgnore(undefined, {
directory: "__fixtures__/app",
maxBuffer: 1024,
telemetry,
});
expect(mockExec).toHaveBeenCalledWith(
`npx turbo run build --filter="test-app...[HEAD^]" --dry=json`,
expect.objectContaining({ maxBuffer: 1024 }),
expect.anything()
);
mockExec.mockRestore();
});
});