/
_executor.test.ts
517 lines (448 loc) · 20.3 KB
/
_executor.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
import { Executor, ExecutorOptions } from "../Executor"
import { FakeCI } from "../../ci_source/providers/Fake"
import { FakePlatform } from "../../platforms/FakePlatform"
import {
emptyResults,
failsResults,
inlineFailResults,
inlineMessageResults,
inlineMultipleWarnResults,
inlineMultipleWarnResults2,
inlineWarnResults,
warnResults,
} from "./fixtures/ExampleDangerResults"
import inlineRunner from "../runners/inline"
import { jsonDSLGenerator } from "../dslGenerator"
import { jsonToDSL } from "../jsonToDSL"
import { DangerDSLType } from "../../dsl/DangerDSL"
import { singleViolationSingleFileResults } from "../../dsl/_tests/fixtures/ExampleDangerResults"
import { inlineTemplate } from "../templates/githubIssueTemplate"
import { DangerResults, inlineResultsIntoResults, resultsIntoInlineResults } from "../../dsl/DangerResults"
const defaultConfig: ExecutorOptions = {
stdoutOnly: false,
verbose: false,
jsonOnly: false,
dangerID: "123",
passURLForDSL: false,
failOnErrors: false,
noPublishCheck: false,
ignoreOutOfDiffComments: false,
}
class FakeProcces {
constructor(public exitCode: number = 0) {}
}
const fakeCI = new FakeCI({})
const defaultDsl = (platform: any): Promise<DangerDSLType> => {
return jsonDSLGenerator(platform, fakeCI, {} as any).then((jsonDSL) => {
jsonDSL.github = {
pr: {
number: 1,
base: { sha: "321", repo: { full_name: "321" } },
head: { sha: "123", repo: { full_name: "123" } },
},
} as any
return jsonToDSL(jsonDSL, fakeCI)
})
}
const mockPayloadForResults = (results: DangerResults): any => {
return resultsIntoInlineResults(results).map((inlineResult) => {
const comment = inlineTemplate(
defaultConfig.dangerID,
inlineResultsIntoResults(inlineResult),
inlineResult.file,
inlineResult.line
)
return { id: 1234, body: comment, ownedByDanger: true }
})
}
describe("setup", () => {
it("gets diff / pr info in setup", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
platform.getPlatformGitRepresentation = jest.fn()
platform.getPlatformReviewDSLRepresentation = jest.fn()
await exec.dslForDanger()
expect(platform.getPlatformGitRepresentation).toBeCalled()
expect(platform.getPlatformReviewDSLRepresentation).toBeCalled()
})
it("gets diff / pr info / utils in setup", async () => {
const exec = new Executor(new FakeCI({}), new FakePlatform(), inlineRunner, defaultConfig, new FakeProcces())
const dsl = await exec.dslForDanger()
expect(dsl.git).toBeTruthy()
expect(dsl.github).toBeTruthy()
expect(dsl.utils).toBeTruthy()
})
it("Creates a DangerResults for a raising dangerfile", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
// This is a real error occurring when Danger modifies the Dangerfile
// as it is given a path of ""
const error = {
name: "Error",
message: "ENOENT: no such file or directory",
}
const results = await exec.runDanger("", { danger: dsl } as any)
expect(results.fails.length).toBeGreaterThan(0)
const markdown = results.markdowns[0].message
expect(markdown).toMatch(error.name)
expect(markdown).toMatch(error.message)
})
it("Deletes a post when there are no messages", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.deleteMainComment = jest.fn()
await exec.handleResults(emptyResults, dsl.git)
expect(platform.deleteMainComment).toBeCalled()
})
it("Deletes a post when 'removePreviousComments' option has been specified", async () => {
const platform = new FakePlatform()
const exec = new Executor(
new FakeCI({}),
platform,
inlineRunner,
{ ...defaultConfig, removePreviousComments: true },
new FakeProcces()
)
const dsl = await defaultDsl(platform)
platform.deleteMainComment = jest.fn()
await exec.handleResults(warnResults, dsl.git)
expect(platform.deleteMainComment).toBeCalled()
})
it("Fails if the failOnErrors option is true and there are fails on the build", async () => {
const platform = new FakePlatform()
const strictConfig: ExecutorOptions = {
stdoutOnly: false,
verbose: false,
jsonOnly: false,
dangerID: "123",
passURLForDSL: false,
failOnErrors: true,
ignoreOutOfDiffComments: false,
}
const exec = new Executor(new FakeCI({}), platform, inlineRunner, strictConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.deleteMainComment = jest.fn()
await exec.handleResults(failsResults, dsl.git)
expect(exec.process.exitCode).toEqual(1)
})
it("Doesn't fail if the failOnErrors option is false and there are fails on the build", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.deleteMainComment = jest.fn()
await exec.handleResults(failsResults, dsl.git)
expect(exec.process.exitCode).toEqual(0)
})
it("Updates or Creates comments for warnings", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(warnResults, dsl.git)
expect(platform.updateOrCreateComment).toBeCalled()
})
it("Creates comments (rather than update or create) for warnings when newComment option is passed", async () => {
const platform = new FakePlatform()
const exec = new Executor(
new FakeCI({}),
platform,
inlineRunner,
{ ...defaultConfig, newComment: true },
new FakeProcces()
)
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(warnResults, dsl.git)
expect(platform.createComment).toBeCalled()
expect(platform.updateOrCreateComment).not.toBeCalled()
})
it("Updates or Creates comments for warnings, without GitDSL", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(warnResults)
expect(platform.updateOrCreateComment).toBeCalled()
})
it("Creates comments (rather than update or create) for warnings, without GitDSL, when newComment option is passed", async () => {
const platform = new FakePlatform()
const exec = new Executor(
new FakeCI({}),
platform,
inlineRunner,
{ ...defaultConfig, newComment: true },
new FakeProcces()
)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(warnResults)
expect(platform.createComment).toBeCalled()
expect(platform.updateOrCreateComment).not.toBeCalled()
})
it("Sends inline comments and returns regular results for failures", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createInlineComment = jest.fn().mockReturnValue(new Promise<any>((_, reject) => reject()))
let results = await exec.sendInlineComments(singleViolationSingleFileResults, dsl.git, [])
expect(results).toEqual(singleViolationSingleFileResults)
})
it("Creates an inline comment for warning", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createInlineComment = jest.fn()
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(inlineWarnResults, dsl.git)
expect(platform.createInlineComment).toBeCalled()
})
it("Creates multiple inline comments as a review", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createInlineReview = jest.fn()
platform.createInlineComment = jest.fn()
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(inlineMultipleWarnResults, dsl.git)
expect(platform.createInlineReview).toBeCalled()
expect(platform.createInlineComment).not.toBeCalled()
expect(platform.updateOrCreateComment).not.toBeCalled()
})
it("Creates multiple inline comments if review fails", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createInlineReview = jest.fn().mockImplementation(() => {
throw new Error("Should not be called")
})
platform.createInlineComment = jest.fn()
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(inlineMultipleWarnResults, dsl.git)
expect(platform.createInlineReview).toBeCalled()
expect(platform.createInlineComment).not.toBeCalled()
expect(platform.updateOrCreateComment).toBeCalled()
})
it("Invalid inline comment is ignored if ignoreOutOfDiffComments is true", async () => {
const platform = new FakePlatform()
const config = Object.assign({}, defaultConfig, { ignoreOutOfDiffComments: true })
const exec = new Executor(new FakeCI({}), platform, inlineRunner, config, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createInlineComment = jest.fn().mockReturnValue(new Promise<any>((_, reject) => reject()))
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
await exec.handleResults(inlineWarnResults, dsl.git)
expect(platform.createComment).not.toBeCalled()
expect(platform.updateOrCreateComment).not.toBeCalled()
})
it("Updates an inline comment as the new one was different than the old", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = inlineWarnResults
const newResults = inlineFailResults
const inlineResults = resultsIntoInlineResults(previousResults)[0]
const comment = inlineTemplate(defaultConfig.dangerID, previousResults, inlineResults.file, inlineResults.line)
const previousComments = [{ id: 1234, body: comment, ownedByDanger: true }]
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).toBeCalled()
expect(platform.createInlineComment).not.toBeCalled()
})
it("Updates multiple inline comments", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = inlineMultipleWarnResults
const newResults = inlineMultipleWarnResults2
const previousComments = mockPayloadForResults(previousResults)
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
platform.deleteInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).toHaveBeenCalledTimes(3)
expect(platform.createInlineComment).not.toBeCalled()
expect(platform.deleteInlineComment).not.toBeCalled()
})
it("Doesn't update/create an inline comment as the old was the same as the new", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = inlineWarnResults
const newResults = previousResults
const inlineResults = resultsIntoInlineResults(previousResults)[0]
const comment = inlineTemplate(defaultConfig.dangerID, previousResults, inlineResults.file, inlineResults.line)
const previousComments = [{ id: 1234, body: comment, ownedByDanger: true }]
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).not.toBeCalled()
expect(platform.createInlineComment).not.toBeCalled()
})
it("Creates new inline comment as none of the old ones was for this file/line", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = inlineWarnResults
const newResults = inlineMessageResults
const inlineResults = resultsIntoInlineResults(previousResults)[0]
const comment = inlineTemplate(defaultConfig.dangerID, previousResults, inlineResults.file, inlineResults.line)
const previousComments = [{ id: 1234, body: comment, ownedByDanger: true }]
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).not.toBeCalled()
expect(platform.createInlineComment).toBeCalled()
})
it("Deletes all old inline comments because new results are all clear", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = {
fails: [],
warnings: [
{ message: "1", file: "1.swift", line: 1 },
{ message: "2", file: "2.swift", line: 2 },
],
messages: [],
markdowns: [],
}
const previousComments = mockPayloadForResults(previousResults)
const newResults = emptyResults
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
platform.deleteInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).not.toBeCalled()
expect(platform.createInlineComment).not.toBeCalled()
expect(platform.deleteInlineComment).toHaveBeenCalledTimes(2)
})
it("Deletes all old inline comments when 'removePreviousComments' option has been specified", async () => {
const platform = new FakePlatform()
const exec = new Executor(
new FakeCI({}),
platform,
inlineRunner,
{ ...defaultConfig, removePreviousComments: true },
new FakeProcces()
)
const dsl = await defaultDsl(platform)
const previousComments = mockPayloadForResults(inlineMultipleWarnResults)
platform.getInlineComments = jest.fn().mockResolvedValueOnce(previousComments).mockResolvedValueOnce([])
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
platform.deleteInlineComment = jest.fn()
await exec.handleResults(warnResults, dsl.git)
expect(platform.deleteInlineComment).toHaveBeenCalledTimes(3)
})
it("Deletes old inline comment when not applicable in new results", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
const previousResults = {
fails: [],
warnings: [
{ message: "1", file: "1.swift", line: 1 },
{ message: "2", file: "2.swift", line: 2 },
],
messages: [],
markdowns: [],
}
const newResults = {
fails: [],
warnings: [
{ message: "1", file: "1.swift", line: 2 },
{ message: "2", file: "2.swift", line: 3 },
],
messages: [],
markdowns: [],
}
const previousComments = mockPayloadForResults(previousResults)
platform.getInlineComments = jest.fn().mockReturnValue(new Promise((r) => r(previousComments)))
platform.updateInlineComment = jest.fn()
platform.createInlineComment = jest.fn()
platform.deleteInlineComment = jest.fn()
await exec.handleResults(newResults, dsl.git)
expect(platform.updateInlineComment).not.toBeCalled()
expect(platform.createInlineComment).toHaveBeenCalledTimes(2)
expect(platform.deleteInlineComment).toHaveBeenCalledTimes(2)
})
it("Updates the status with success for a passed empty results", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
platform.updateStatus = jest.fn()
await exec.handleResults(emptyResults, dsl.git)
expect(platform.updateStatus).toBeCalledWith(true, expect.any(String), undefined, defaultConfig.dangerID)
})
it("Updates the status with success for a passed results", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
platform.updateStatus = jest.fn()
await exec.handleResults(warnResults, dsl.git)
expect(platform.updateStatus).toBeCalledWith(
true,
"Found some issues. Don't worry, everything is fixable.",
undefined,
defaultConfig.dangerID
)
})
it("Updates the status with success for failing results", async () => {
const platform = new FakePlatform()
const exec = new Executor(new FakeCI({}), platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
platform.updateStatus = jest.fn()
await exec.handleResults(failsResults, dsl.git)
expect(platform.updateStatus).toBeCalledWith(
false,
"Found some issues. Don't worry, everything is fixable.",
undefined,
defaultConfig.dangerID
)
})
it("Passes the URL from a platform to the updateStatus", async () => {
const platform = new FakePlatform()
const ci: any = new FakeCI({})
ci.ciRunURL = "https://url.com"
const exec = new Executor(ci, platform, inlineRunner, defaultConfig, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
platform.updateStatus = jest.fn()
await exec.handleResults(failsResults, dsl.git)
expect(platform.updateStatus).toBeCalledWith(expect.anything(), expect.anything(), ci.ciRunURL, expect.anything())
})
it("Doesn't update status when check publishing feature is disabled", async () => {
const platform = new FakePlatform()
const ci: any = new FakeCI({})
ci.ciRunURL = "https://url.com"
const config = {
...defaultConfig,
noPublishCheck: true,
}
const exec = new Executor(ci, platform, inlineRunner, config, new FakeProcces())
const dsl = await defaultDsl(platform)
platform.createComment = jest.fn()
platform.updateOrCreateComment = jest.fn()
platform.updateStatus = jest.fn()
await exec.handleResults(failsResults, dsl.git)
expect(platform.updateStatus).not.toBeCalled()
})
})