-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.test.js
475 lines (404 loc) · 14.6 KB
/
index.test.js
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
const { Toolkit } = require("actions-toolkit");
const mockedEnv = require("mocked-env");
const nock = require("nock");
nock.disableNetConnect();
var MockDate = require("mockdate");
const merge_commit_sha = "253187c4c33beddeb518eb331e4efaf41b2f4feb";
const sha = "fe4f4ff2f32bc41d04757bfbae347f8be189d091";
describe("Hold Your Horses", () => {
let action, tools, restore, restoreTest;
Toolkit.run = jest.fn((actionFn) => {
action = actionFn;
});
require(".");
beforeEach(() => {
restore = mockedEnv({
GITHUB_WORKFLOW: "Hold Your Horses",
GITHUB_ACTION: "Hold Your Horses Action",
GITHUB_ACTOR: "mheap",
GITHUB_WORKSPACE: "/tmp",
GITHUB_SHA: merge_commit_sha,
GITHUB_REPOSITORY: "mheap/test-repo-hyh-stream",
GITHUB_EVENT_NAME: "",
GITHUB_EVENT_PATH: "",
});
tools = new Toolkit();
tools.context.loadPerTestEnv = function () {
this.payload = process.env.GITHUB_EVENT_PATH
? require(process.env.GITHUB_EVENT_PATH)
: {};
this.event = process.env.GITHUB_EVENT_NAME;
};
tools.exit.success = jest.fn();
tools.exit.failure = jest.fn();
tools.log.info = jest.fn();
tools.log.error = jest.fn();
tools.log.pending = jest.fn();
tools.log.complete = jest.fn();
});
afterEach(() => {
restore();
restoreTest();
MockDate.reset();
nock.cleanAll();
});
describe(`On comment`, () => {
it(`does not trigger when the comment does not contain /skipwait`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "issue_comment",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/issue-comment-invalid.json`,
});
// No mocks as nothing should execute
await action(tools);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it(`does not trigger when /skipwait is not the first item in the comment`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "issue_comment",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/issue-comment-invalid-command-after.json`,
});
// No mocks as nothing should execute
await action(tools);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it(`responds that no-one is trusted to skip`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "issue_comment",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/issue-comment-valid.json`,
});
mockCommentAdded(
"Sorry, skipping the required wait time isn't enabled on this repo"
);
await action(tools);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it(`responds that the current user is not allowed to skip`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "issue_comment",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/issue-comment-valid.json`,
INPUT_TRUSTED: "oneuser,another_user",
});
mockCommentAdded(
"Sorry, you're not in the list of approved users. You can ask one of the following people to comment for you if needed: \n * oneuser\n * another_user"
);
await action(tools);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it(`marks all checks as done and adds a label`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "issue_comment",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/issue-comment-valid.json`,
INPUT_TRUSTED: "mheap",
});
mockGetSinglePr(8);
mockStatuses([["pending", "2020-03-07T16:50:47Z"]]);
mockUpdateStatus("success", "Review time elapsed").reply(200);
mockUpdateStatus("success", "Review time elapsed", sha).reply(200);
mockLabelAdded(["hold-your-horses:skipped"]);
await action(tools);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
});
["opened", "synchronize"].forEach((event) => {
describe(`On PR ${event}`, () => {
it(`runs to completion`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "pull_request",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/pr-${event}.json`,
});
mockUpdateStatus(
"pending",
"Giving others the opportunity to review"
).reply(200);
await action(tools);
expect(tools.log.pending).toHaveBeenCalledWith(
"Adding pending status check"
);
expect(tools.log.complete).toHaveBeenCalledWith(
"Added pending status check"
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it(`handles errors`, async () => {
restoreTest = testEnv(tools, {
GITHUB_EVENT_NAME: "pull_request",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/pr-${event}.json`,
});
mockUpdateStatus(
"pending",
"Giving others the opportunity to review"
).reply(422, {
message: `No commit found for SHA: ${merge_commit_sha}`,
documentation_url:
"https://developer.github.com/v3/repos/statuses/#create-a-status",
});
await action(tools);
expect(tools.log.pending).toHaveBeenCalledWith(
"Adding pending status check"
);
expect(tools.exit.failure).toHaveBeenCalledWith(
`No commit found for SHA: ${merge_commit_sha}`
);
});
});
});
describe(`On schedule`, () => {
describe(`Setting the duration`, () => {
it("has a default duration", async () => {
restoreTest = scheduleTrigger(tools);
mockAllSuccessRequests();
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
"Running with duration of PT10M"
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("accepts a user specified duration", async () => {
restoreTest = scheduleTrigger(tools, "PT3M");
mockAllSuccessRequests();
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
"Running with duration of PT3M"
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
// Duration isn't parseable
it("fails when the duration isn't parseable", async () => {
restoreTest = scheduleTrigger(tools, "invalid_duration");
mockAllSuccessRequests();
await action(tools);
expect(tools.exit.failure).toHaveBeenCalledWith(
"Invalid duration provided: invalid_duration"
);
});
});
describe(`Changing check state`, () => {
it("updates the status when the required duration has elapsed (default)", async () => {
restoreTest = scheduleTrigger(tools, "PT10M");
// The pending event occured at 2020-03-07T16:50:47Z
// which means for the duration to have elapsed, we should mock the
// current time to be more than 10 minutes later
MockDate.set("2020-03-07T17:02:12Z");
// Mock all the other requests
mockAllSuccessRequests();
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
`Marking ${merge_commit_sha} as done`
);
expect(tools.log.info).toHaveBeenCalledWith(`Marking ${sha} as done`);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("chooses the first date based label when a custom duration is enabled", async () => {
restoreTest = scheduleTrigger(
tools,
"PT10M",
"bug=PT30M,feature=PT45M"
);
// The pending event occured at 2020-03-07T16:50:47Z
// which means for the duration to have elapsed, we should mock the
// current time to be more than 30 minutes later
MockDate.set("2020-03-07T17:22:12Z");
// Mock all the other requests
mockAllSuccessRequests([
{
name: "bug",
},
{
name: "feature",
},
]);
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
`Running with duration of PT30M`
);
expect(tools.log.info).toHaveBeenCalledWith(
`Marking ${merge_commit_sha} as done`
);
expect(tools.log.info).toHaveBeenCalledWith(`Marking ${sha} as done`);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("skips the update when the required duration has not elapsed", async () => {
restoreTest = scheduleTrigger(tools, "PT10M");
// The pending event occured at 2020-03-07T16:50:47Z
// which means for the duration to NOT have elapsed, we should mock the
// current time to be less than 10 minutes later
MockDate.set("2020-03-07T16:53:12Z");
// Mock all the other requests
mockAllSuccessRequests();
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
`Skipping ${merge_commit_sha} and ${sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("handles the most recent check already being a success", async () => {
restoreTest = scheduleTrigger(tools);
mockOpenPulls();
mockStatuses([
["success", "2020-03-07T16:54:12Z"],
["pending", "2020-03-07T16:50:47Z"],
]);
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(
`Check is already success for ${merge_commit_sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
});
describe("Unexpected cases", () => {
it("handles errors when updating the merge commit status to success", async () => {
restoreTest = scheduleTrigger(tools);
mockOpenPulls();
mockStatuses([["pending", "2020-03-07T16:50:47Z"]]);
mockUpdateStatus("success", "Review time elapsed").reply(422, {
message: `No commit found for SHA: ${merge_commit_sha}`,
documentation_url:
"https://developer.github.com/v3/repos/statuses/#create-a-status",
});
await action(tools);
expect(tools.log.error).toHaveBeenCalledWith(
`No commit found for SHA: ${merge_commit_sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("handles errors when updating the head commit status to success", async () => {
restoreTest = scheduleTrigger(tools);
mockOpenPulls();
mockStatuses([["pending", "2020-03-07T16:50:47Z"]]);
mockUpdateStatus("success", "Review time elapsed").reply(200);
mockUpdateStatus("success", "Review time elapsed", sha).reply(422, {
message: `No commit found for SHA: ${sha}`,
documentation_url:
"https://developer.github.com/v3/repos/statuses/#create-a-status",
});
await action(tools);
expect(tools.log.error).toHaveBeenCalledWith(
`No commit found for SHA: ${sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("handles no statuses being present for the provided ref", async () => {
restoreTest = scheduleTrigger(tools);
mockOpenPulls();
mockStatuses([]);
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(`Found 0 statuses`);
expect(tools.log.info).toHaveBeenCalledWith(
`No statuses for ${merge_commit_sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
it("handles statuses being returned, but none with the correct context", async () => {
restoreTest = scheduleTrigger(tools);
mockOpenPulls();
// Mock Statuses
nock("https://api.github.com")
.get(
`/repos/mheap/test-repo-hyh-stream/commits/${merge_commit_sha}/statuses`
)
.reply(200, [
{
state: "success",
context: "some-other-check",
updated_at: "2018-01-01T00:00:00~",
},
]);
await action(tools);
expect(tools.log.info).toHaveBeenCalledWith(`Found 1 statuses`);
expect(tools.log.info).toHaveBeenCalledWith(
`No statuses for ${merge_commit_sha}`
);
expect(tools.exit.success).toHaveBeenCalledWith("Action finished");
});
});
});
});
function testEnv(tools, params) {
const r = mockedEnv(params);
tools.context.loadPerTestEnv();
return r;
}
function scheduleTrigger(tools, duration, labels) {
const opts = {
GITHUB_EVENT_NAME: "schedule",
GITHUB_EVENT_PATH: `${__dirname}/fixtures/schedule.json`,
};
if (duration) {
opts["INPUT_DURATION"] = duration;
}
if (labels) {
opts["INPUT_LABEL_DURATIONS"] = labels;
}
return testEnv(tools, opts);
}
function mockUpdateStatus(state, description, mockSha) {
// Default to the merge commit, but allow a value to be passed
// in case we need to overwrite it
mockSha = mockSha || merge_commit_sha;
return nock("https://api.github.com").post(
`/repos/mheap/test-repo-hyh-stream/statuses/${mockSha}`,
{
state,
context: "hold-your-horses",
description,
}
);
}
function mockOpenPulls(labels) {
nock("https://api.github.com")
.get("/repos/mheap/test-repo-hyh-stream/pulls?state=open")
.reply(200, [
{
merge_commit_sha,
head: {
sha,
},
labels: labels || [],
},
]);
}
function mockStatuses(states) {
const response = [];
for (let s of states) {
response.push({
state: s[0],
context: "hold-your-horses",
updated_at: s[1],
});
}
nock("https://api.github.com")
.get(
`/repos/mheap/test-repo-hyh-stream/commits/${merge_commit_sha}/statuses`
)
.reply(200, response);
}
function mockAllSuccessRequests(labels) {
mockOpenPulls(labels);
mockStatuses([["pending", "2020-03-07T16:50:47Z"]]);
mockUpdateStatus("success", "Review time elapsed").reply(200);
mockUpdateStatus("success", "Review time elapsed", sha).reply(200);
}
function mockCommentAdded(body) {
nock("https://api.github.com")
.post("/repos/mheap/test-repo-hyh-stream/issues/8/comments", {
body,
})
.reply(200);
}
function mockGetSinglePr(number) {
nock("https://api.github.com")
.get(`/repos/mheap/test-repo-hyh-stream/pulls/${number}`)
.reply(200, {
merge_commit_sha,
head: {
sha,
},
});
}
function mockLabelAdded(labels) {
nock("https://api.github.com")
.post("/repos/mheap/test-repo-hyh-stream/issues/8/labels", {
labels,
})
.reply(200);
}