-
Notifications
You must be signed in to change notification settings - Fork 712
Expand file tree
/
Copy pathscale-up.test.ts
More file actions
1904 lines (1655 loc) · 66.5 KB
/
scale-up.test.ts
File metadata and controls
1904 lines (1655 loc) · 66.5 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
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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { PutParameterCommand, SSMClient } from '@aws-sdk/client-ssm';
import { mockClient } from 'aws-sdk-client-mock';
import 'aws-sdk-client-mock-jest/vitest';
// Using vi.mocked instead of jest-mock
import nock from 'nock';
import { performance } from 'perf_hooks';
import * as ghAuth from '../github/auth';
import { createRunner, listEC2Runners } from './../aws/runners';
import { RunnerInputParameters } from './../aws/runners.d';
import * as scaleUpModule from './scale-up';
import { getParameter } from '@aws-github-runner/aws-ssm-util';
import { publishRetryMessage } from './job-retry';
import { describe, it, expect, beforeEach, vi } from 'vitest';
import type { Octokit } from '@octokit/rest';
const mockOctokit = {
paginate: vi.fn(),
checks: { get: vi.fn() },
actions: {
createRegistrationTokenForOrg: vi.fn(),
createRegistrationTokenForRepo: vi.fn(),
getJobForWorkflowRun: vi.fn(),
generateRunnerJitconfigForOrg: vi.fn(),
generateRunnerJitconfigForRepo: vi.fn(),
},
apps: {
getOrgInstallation: vi.fn(),
getRepoInstallation: vi.fn(),
},
};
const mockCreateRunner = vi.mocked(createRunner);
const mockListRunners = vi.mocked(listEC2Runners);
const mockSSMClient = mockClient(SSMClient);
const mockSSMgetParameter = vi.mocked(getParameter);
const mockPublishRetryMessage = vi.mocked(publishRetryMessage);
vi.mock('@octokit/rest', () => ({
Octokit: vi.fn().mockImplementation(function () {
return mockOctokit;
}),
}));
vi.mock('./../aws/runners', async () => ({
createRunner: vi.fn(),
listEC2Runners: vi.fn(),
tag: vi.fn(),
}));
vi.mock('./../github/auth', async () => ({
createGithubAppAuth: vi.fn(),
createGithubInstallationAuth: vi.fn(),
createOctokitClient: vi.fn(),
}));
vi.mock('@aws-github-runner/aws-ssm-util', async () => {
const actual = (await vi.importActual(
'@aws-github-runner/aws-ssm-util',
)) as typeof import('@aws-github-runner/aws-ssm-util');
return {
...actual,
getParameter: vi.fn(),
};
});
vi.mock('./job-retry', () => ({
publishRetryMessage: vi.fn(),
checkAndRetryJob: vi.fn(),
}));
export type RunnerType = 'ephemeral' | 'non-ephemeral';
// for ephemeral and non-ephemeral runners
const RUNNER_TYPES: RunnerType[] = ['ephemeral', 'non-ephemeral'];
const mockedAppAuth = vi.mocked(ghAuth.createGithubAppAuth);
const mockedInstallationAuth = vi.mocked(ghAuth.createGithubInstallationAuth);
const mockCreateClient = vi.mocked(ghAuth.createOctokitClient);
const TEST_DATA_SINGLE: scaleUpModule.ActionRequestMessageSQS = {
id: 1,
eventType: 'workflow_job',
repositoryName: 'hello-world',
repositoryOwner: 'Codertocat',
installationId: 2,
repoOwnerType: 'Organization',
messageId: 'foobar',
};
const TEST_DATA: scaleUpModule.ActionRequestMessageSQS[] = [
{
...TEST_DATA_SINGLE,
messageId: 'foobar',
},
];
const cleanEnv = process.env;
const EXPECTED_RUNNER_PARAMS: RunnerInputParameters = {
environment: 'unit-test-environment',
runnerType: 'Org',
runnerOwner: TEST_DATA_SINGLE.repositoryOwner,
numberOfRunners: 1,
launchTemplateName: 'lt-1',
ec2instanceCriteria: {
instanceTypes: ['m5.large'],
targetCapacityType: 'spot',
instanceAllocationStrategy: 'lowest-price',
},
subnets: ['subnet-123'],
tracingEnabled: false,
onDemandFailoverOnError: [],
};
let expectedRunnerParams: RunnerInputParameters;
function setDefaults() {
process.env = { ...cleanEnv };
process.env.PARAMETER_GITHUB_APP_ID_NAME = 'github-app-id';
process.env.GITHUB_APP_KEY_BASE64 = 'TEST_CERTIFICATE_DATA';
process.env.GITHUB_APP_ID = '1337';
process.env.GITHUB_APP_CLIENT_ID = 'TEST_CLIENT_ID';
process.env.GITHUB_APP_CLIENT_SECRET = 'TEST_CLIENT_SECRET';
process.env.RUNNERS_MAXIMUM_COUNT = '3';
process.env.ENVIRONMENT = EXPECTED_RUNNER_PARAMS.environment;
process.env.LAUNCH_TEMPLATE_NAME = 'lt-1';
process.env.SUBNET_IDS = 'subnet-123';
process.env.INSTANCE_TYPES = 'm5.large';
process.env.INSTANCE_TARGET_CAPACITY_TYPE = 'spot';
process.env.ENABLE_ON_DEMAND_FAILOVER = undefined;
}
beforeEach(() => {
nock.disableNetConnect();
vi.resetModules();
vi.clearAllMocks();
setDefaults();
defaultSSMGetParameterMockImpl();
defaultOctokitMockImpl();
mockCreateRunner.mockImplementation(async () => {
return ['i-12345'];
});
mockListRunners.mockImplementation(async () => [
{
instanceId: 'i-1234',
launchTime: new Date(),
type: 'Org',
owner: TEST_DATA_SINGLE.repositoryOwner,
},
]);
mockedAppAuth.mockResolvedValue({
type: 'app',
token: 'token',
appId: TEST_DATA_SINGLE.installationId,
expiresAt: 'some-date',
});
mockedInstallationAuth.mockResolvedValue({
type: 'token',
tokenType: 'installation',
token: 'token',
createdAt: 'some-date',
expiresAt: 'some-date',
permissions: {},
repositorySelection: 'all',
installationId: 0,
});
mockCreateClient.mockResolvedValue(mockOctokit as unknown as Octokit);
});
describe('scaleUp with GHES', () => {
beforeEach(() => {
process.env.GHES_URL = 'https://github.enterprise.something';
});
it('checks queued workflows', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).toBeCalledWith({
job_id: TEST_DATA_SINGLE.id,
owner: TEST_DATA_SINGLE.repositoryOwner,
repo: TEST_DATA_SINGLE.repositoryName,
});
});
it('does not list runners when no workflows are queued', async () => {
mockOctokit.actions.getJobForWorkflowRun.mockImplementation(() => ({
data: { total_count: 0 },
}));
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).not.toBeCalled();
});
describe('on org level', () => {
beforeEach(() => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'true';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.RUNNER_NAME_PREFIX = 'unit-test-';
process.env.RUNNER_GROUP_NAME = 'Default';
process.env.SSM_CONFIG_PATH = '/github-action-runners/default/runners/config';
process.env.SSM_TOKEN_PATH = '/github-action-runners/default/runners/config';
process.env.RUNNER_LABELS = 'label1,label2';
expectedRunnerParams = { ...EXPECTED_RUNNER_PARAMS };
mockSSMClient.reset();
});
it('gets the current org level runners', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).toBeCalledWith({
environment: 'unit-test-environment',
runnerType: 'Org',
runnerOwner: TEST_DATA_SINGLE.repositoryOwner,
});
});
it('does not create a token when maximum runners has been reached', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('does create a runner if maximum is set to -1', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '-1';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).not.toHaveBeenCalled();
expect(createRunner).toHaveBeenCalled();
});
it('creates a token when maximum runners has not been reached', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).toBeCalledWith({
org: TEST_DATA_SINGLE.repositoryOwner,
});
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('creates a runner with correct config', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('creates a runner with labels in a specific group', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
process.env.RUNNER_GROUP_NAME = 'TEST_GROUP';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('creates a runner with ami id override from ssm parameter', async () => {
process.env.AMI_ID_SSM_PARAMETER_NAME = 'my-ami-id-param';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith({ ...expectedRunnerParams, amiIdSsmParameterName: 'my-ami-id-param' });
});
it('Throws an error if runner group does not exist for ephemeral runners', async () => {
process.env.RUNNER_GROUP_NAME = 'test-runner-group';
mockSSMgetParameter.mockImplementation(async () => {
throw new Error('ParameterNotFound');
});
await expect(scaleUpModule.scaleUp(TEST_DATA)).rejects.toBeInstanceOf(Error);
expect(mockOctokit.paginate).toHaveBeenCalledTimes(1);
});
it('Discards event if it is a User repo and org level runners is enabled', async () => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'true';
const USER_REPO_TEST_DATA = structuredClone(TEST_DATA);
USER_REPO_TEST_DATA[0].repoOwnerType = 'User';
await scaleUpModule.scaleUp(USER_REPO_TEST_DATA);
expect(createRunner).not.toHaveBeenCalled();
});
it('create SSM parameter for runner group id if it does not exist', async () => {
mockSSMgetParameter.mockImplementation(async () => {
throw new Error('ParameterNotFound');
});
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.paginate).toHaveBeenCalledTimes(1);
expect(mockSSMClient).toHaveReceivedCommandTimes(PutParameterCommand, 2);
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: `${process.env.SSM_CONFIG_PATH}/runner-group/${process.env.RUNNER_GROUP_NAME}`,
Value: '1',
Type: 'String',
});
});
it('Does not create SSM parameter for runner group id if it exists', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.paginate).toHaveBeenCalledTimes(0);
expect(mockSSMClient).toHaveReceivedCommandTimes(PutParameterCommand, 1);
});
it('create start runner config for ephemeral runners ', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '2';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.generateRunnerJitconfigForOrg).toBeCalledWith({
org: TEST_DATA_SINGLE.repositoryOwner,
name: 'unit-test-i-12345',
runner_group_id: 1,
labels: ['label1', 'label2'],
});
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: '/github-action-runners/default/runners/config/i-12345',
Value: 'TEST_JIT_CONFIG_ORG',
Type: 'SecureString',
Tags: [
{
Key: 'InstanceId',
Value: 'i-12345',
},
],
});
});
it('create start runner config for non-ephemeral runners ', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
process.env.RUNNERS_MAXIMUM_COUNT = '2';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.generateRunnerJitconfigForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForOrg).toBeCalled();
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: '/github-action-runners/default/runners/config/i-12345',
Value:
'--url https://github.enterprise.something/Codertocat --token 1234abcd ' +
'--labels label1,label2 --runnergroup Default',
Type: 'SecureString',
Tags: [
{
Key: 'InstanceId',
Value: 'i-12345',
},
],
});
});
it.each(RUNNER_TYPES)(
'calls create start runner config of 40' + ' instances (ssm rate limit condition) to test time delay ',
async (type: RunnerType) => {
process.env.ENABLE_EPHEMERAL_RUNNERS = type === 'ephemeral' ? 'true' : 'false';
process.env.RUNNERS_MAXIMUM_COUNT = '40';
mockCreateRunner.mockImplementation(async () => {
return instances;
});
mockListRunners.mockImplementation(async () => {
return [];
});
const startTime = performance.now();
const instances = [
'i-1234',
'i-5678',
'i-5567',
'i-5569',
'i-5561',
'i-5560',
'i-5566',
'i-5536',
'i-5526',
'i-5516',
'i-122',
'i-123',
'i-124',
'i-125',
'i-126',
'i-127',
'i-128',
'i-129',
'i-130',
'i-131',
'i-132',
'i-133',
'i-134',
'i-135',
'i-136',
'i-137',
'i-138',
'i-139',
'i-140',
'i-141',
'i-142',
'i-143',
'i-144',
'i-145',
'i-146',
'i-147',
'i-148',
'i-149',
'i-150',
'i-151',
];
await scaleUpModule.scaleUp(TEST_DATA);
const endTime = performance.now();
expect(endTime - startTime).toBeGreaterThan(1000);
expect(mockSSMClient).toHaveReceivedCommandTimes(PutParameterCommand, 40);
},
10000,
);
});
describe('on repo level', () => {
beforeEach(() => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'false';
process.env.RUNNER_NAME_PREFIX = 'unit-test';
expectedRunnerParams = { ...EXPECTED_RUNNER_PARAMS };
expectedRunnerParams.runnerType = 'Repo';
expectedRunnerParams.runnerOwner = `${TEST_DATA_SINGLE.repositoryOwner}/${TEST_DATA_SINGLE.repositoryName}`;
// `--url https://github.enterprise.something/${TEST_DATA_SINGLE.repositoryOwner}/${TEST_DATA_SINGLE.repositoryName}`,
// `--token 1234abcd`,
// ];
});
it('gets the current repo level runners', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).toBeCalledWith({
environment: 'unit-test-environment',
runnerType: 'Repo',
runnerOwner: `${TEST_DATA_SINGLE.repositoryOwner}/${TEST_DATA_SINGLE.repositoryName}`,
});
});
it('does not create a token when maximum runners has been reached', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('creates a token when maximum runners has not been reached', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).toBeCalledWith({
owner: TEST_DATA_SINGLE.repositoryOwner,
repo: TEST_DATA_SINGLE.repositoryName,
});
});
it('uses the default runner max count', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = undefined;
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForRepo).toBeCalledWith({
owner: TEST_DATA_SINGLE.repositoryOwner,
repo: TEST_DATA_SINGLE.repositoryName,
});
});
it('creates a runner with correct config and labels', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('creates a runner and ensure the group argument is ignored', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
process.env.RUNNER_GROUP_NAME = 'TEST_GROUP_IGNORED';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('Check error is thrown', async () => {
const mockCreateRunners = vi.mocked(createRunner);
mockCreateRunners.mockRejectedValue(new Error('no retry'));
await expect(scaleUpModule.scaleUp(TEST_DATA)).rejects.toThrow('no retry');
mockCreateRunners.mockReset();
});
});
describe('Batch processing', () => {
beforeEach(() => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'true';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.RUNNERS_MAXIMUM_COUNT = '10';
});
const createTestMessages = (
count: number,
overrides: Partial<scaleUpModule.ActionRequestMessageSQS>[] = [],
): scaleUpModule.ActionRequestMessageSQS[] => {
return Array.from({ length: count }, (_, i) => ({
...TEST_DATA_SINGLE,
id: i + 1,
messageId: `message-${i}`,
...overrides[i],
}));
};
it('Should handle multiple messages for the same organization', async () => {
const messages = createTestMessages(3);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(1);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 3,
runnerOwner: TEST_DATA_SINGLE.repositoryOwner,
}),
);
});
it('Should handle multiple messages for different organizations', async () => {
const messages = createTestMessages(3, [
{ repositoryOwner: 'org1' },
{ repositoryOwner: 'org2' },
{ repositoryOwner: 'org1' },
]);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(2);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2,
runnerOwner: 'org1',
}),
);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 1,
runnerOwner: 'org2',
}),
);
});
it('Should handle multiple messages for different repositories when org-level is disabled', async () => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'false';
const messages = createTestMessages(3, [
{ repositoryOwner: 'owner1', repositoryName: 'repo1' },
{ repositoryOwner: 'owner1', repositoryName: 'repo2' },
{ repositoryOwner: 'owner1', repositoryName: 'repo1' },
]);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(2);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2,
runnerOwner: 'owner1/repo1',
}),
);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 1,
runnerOwner: 'owner1/repo2',
}),
);
});
it('Should reject messages when maximum runners limit is reached', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1'; // Set to 1 so with 1 existing, no new ones can be created
mockListRunners.mockImplementation(async () => [
{
instanceId: 'i-existing',
launchTime: new Date(),
type: 'Org',
owner: TEST_DATA_SINGLE.repositoryOwner,
},
]);
const messages = createTestMessages(3);
const rejectedMessages = await scaleUpModule.scaleUp(messages);
expect(createRunner).not.toHaveBeenCalled(); // No runners should be created
expect(rejectedMessages).toHaveLength(3); // All 3 messages should be rejected
});
it('Should handle partial EC2 instance creation failures', async () => {
mockCreateRunner.mockImplementation(async () => ['i-12345']); // Only creates 1 instead of requested 3
const messages = createTestMessages(3);
const rejectedMessages = await scaleUpModule.scaleUp(messages);
expect(rejectedMessages).toHaveLength(2); // 3 requested - 1 created = 2 failed
expect(rejectedMessages).toEqual(['message-0', 'message-1']);
});
it('Should filter out invalid event types for ephemeral runners', async () => {
const messages = createTestMessages(3, [
{ eventType: 'workflow_job' },
{ eventType: 'check_run' },
{ eventType: 'workflow_job' },
]);
const rejectedMessages = await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2, // Only workflow_job events processed
}),
);
expect(rejectedMessages).toContain('message-1'); // check_run event rejected
});
it('Should skip invalid repo owner types but not reject them', async () => {
const messages = createTestMessages(3, [
{ repoOwnerType: 'Organization' },
{ repoOwnerType: 'User' }, // Invalid for org-level runners
{ repoOwnerType: 'Organization' },
]);
const rejectedMessages = await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2, // Only Organization events processed
}),
);
expect(rejectedMessages).not.toContain('message-1'); // User repo not rejected, just skipped
});
it('Should skip messages when jobs are not queued', async () => {
mockOctokit.actions.getJobForWorkflowRun.mockImplementation((params) => {
const isQueued = params.job_id === 1 || params.job_id === 3; // Only jobs 1 and 3 are queued
return {
data: {
status: isQueued ? 'queued' : 'completed',
},
};
});
const messages = createTestMessages(3);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2, // Only queued jobs processed
}),
);
});
it('Should create separate GitHub clients for different installations', async () => {
// Override the default mock to return different installation IDs
mockOctokit.apps.getOrgInstallation.mockReset();
mockOctokit.apps.getOrgInstallation.mockImplementation((params) => ({
data: {
id: params.org === 'org1' ? 100 : 200,
},
}));
const messages = createTestMessages(2, [
{ repositoryOwner: 'org1', installationId: 0 },
{ repositoryOwner: 'org2', installationId: 0 },
]);
await scaleUpModule.scaleUp(messages);
expect(mockCreateClient).toHaveBeenCalledTimes(3); // 1 app client, 2 repo installation clients
expect(mockedInstallationAuth).toHaveBeenCalledWith(100, 'https://github.enterprise.something/api/v3');
expect(mockedInstallationAuth).toHaveBeenCalledWith(200, 'https://github.enterprise.something/api/v3');
});
it('Should reuse GitHub clients for same installation', async () => {
const messages = createTestMessages(3, [
{ repositoryOwner: 'same-org' },
{ repositoryOwner: 'same-org' },
{ repositoryOwner: 'same-org' },
]);
await scaleUpModule.scaleUp(messages);
expect(mockCreateClient).toHaveBeenCalledTimes(2); // 1 app client, 1 installation client
expect(mockedInstallationAuth).toHaveBeenCalledTimes(1);
});
it('Should return empty array when no valid messages to process', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
const messages = createTestMessages(2, [
{ eventType: 'check_run' }, // Invalid for ephemeral
{ eventType: 'check_run' }, // Invalid for ephemeral
]);
const rejectedMessages = await scaleUpModule.scaleUp(messages);
expect(createRunner).not.toHaveBeenCalled();
expect(rejectedMessages).toEqual(['message-0', 'message-1']);
});
it('Should handle unlimited runners configuration', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '-1';
const messages = createTestMessages(10);
await scaleUpModule.scaleUp(messages);
expect(listEC2Runners).not.toHaveBeenCalled(); // No need to check current runners
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 10, // All messages processed
}),
);
});
});
});
describe('scaleUp with public GH', () => {
it('checks queued workflows', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).toBeCalledWith({
job_id: TEST_DATA_SINGLE.id,
owner: TEST_DATA_SINGLE.repositoryOwner,
repo: TEST_DATA_SINGLE.repositoryName,
});
});
it('not checking queued workflows', async () => {
process.env.ENABLE_JOB_QUEUED_CHECK = 'false';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).not.toBeCalled();
});
it('does not list runners when no workflows are queued', async () => {
mockOctokit.actions.getJobForWorkflowRun.mockImplementation(() => ({
data: { status: 'completed' },
}));
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).not.toBeCalled();
});
describe('on org level', () => {
beforeEach(() => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'true';
process.env.RUNNER_NAME_PREFIX = 'unit-test';
expectedRunnerParams = { ...EXPECTED_RUNNER_PARAMS };
});
it('gets the current org level runners', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).toBeCalledWith({
environment: 'unit-test-environment',
runnerType: 'Org',
runnerOwner: TEST_DATA_SINGLE.repositoryOwner,
});
});
it('does not create a token when maximum runners has been reached', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('creates a token when maximum runners has not been reached', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).toBeCalledWith({
org: TEST_DATA_SINGLE.repositoryOwner,
});
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('creates a runner with correct config', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('creates a runner with labels in s specific group', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
process.env.RUNNER_GROUP_NAME = 'TEST_GROUP';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
});
describe('on repo level', () => {
beforeEach(() => {
mockSSMClient.reset();
process.env.ENABLE_ORGANIZATION_RUNNERS = 'false';
process.env.RUNNER_NAME_PREFIX = 'unit-test';
expectedRunnerParams = { ...EXPECTED_RUNNER_PARAMS };
expectedRunnerParams.runnerType = 'Repo';
expectedRunnerParams.runnerOwner = `${TEST_DATA_SINGLE.repositoryOwner}/${TEST_DATA_SINGLE.repositoryName}`;
});
it('gets the current repo level runners', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(listEC2Runners).toBeCalledWith({
environment: 'unit-test-environment',
runnerType: 'Repo',
runnerOwner: `${TEST_DATA_SINGLE.repositoryOwner}/${TEST_DATA_SINGLE.repositoryName}`,
});
});
it('does not create a token when maximum runners has been reached', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).not.toBeCalled();
});
it('creates a token when maximum runners has not been reached', async () => {
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.createRegistrationTokenForOrg).not.toBeCalled();
expect(mockOctokit.actions.createRegistrationTokenForRepo).toBeCalledWith({
owner: TEST_DATA_SINGLE.repositoryOwner,
repo: TEST_DATA_SINGLE.repositoryName,
});
});
it('creates a runner with correct config and labels', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('creates a runner with correct config and labels and on demand failover enabled.', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
process.env.ENABLE_ON_DEMAND_FAILOVER_FOR_ERRORS = JSON.stringify(['InsufficientInstanceCapacity']);
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith({
...expectedRunnerParams,
onDemandFailoverOnError: ['InsufficientInstanceCapacity'],
});
});
it('creates a runner and ensure the group argument is ignored', async () => {
process.env.RUNNER_LABELS = 'label1,label2';
process.env.RUNNER_GROUP_NAME = 'TEST_GROUP_IGNORED';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('ephemeral runners only run with workflow_job event, others should fail.', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.ENABLE_JOB_QUEUED_CHECK = 'false';
const USER_REPO_TEST_DATA = structuredClone(TEST_DATA);
USER_REPO_TEST_DATA[0].eventType = 'check_run';
await expect(scaleUpModule.scaleUp(USER_REPO_TEST_DATA)).resolves.toEqual(['foobar']);
});
it('creates a ephemeral runner with JIT config.', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.ENABLE_JOB_QUEUED_CHECK = 'false';
process.env.SSM_TOKEN_PATH = '/github-action-runners/default/runners/config';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).not.toBeCalled();
expect(createRunner).toBeCalledWith(expectedRunnerParams);
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: '/github-action-runners/default/runners/config/i-12345',
Value: 'TEST_JIT_CONFIG_REPO',
Type: 'SecureString',
Tags: [
{
Key: 'InstanceId',
Value: 'i-12345',
},
],
});
});
it('creates a ephemeral runner with registration token.', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.ENABLE_JIT_CONFIG = 'false';
process.env.ENABLE_JOB_QUEUED_CHECK = 'false';
process.env.SSM_TOKEN_PATH = '/github-action-runners/default/runners/config';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).not.toBeCalled();
expect(createRunner).toBeCalledWith(expectedRunnerParams);
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: '/github-action-runners/default/runners/config/i-12345',
Value: '--url https://github.com/Codertocat/hello-world --token 1234abcd --ephemeral',
Type: 'SecureString',
Tags: [
{
Key: 'InstanceId',
Value: 'i-12345',
},
],
});
});
it('JIT config is ignored for non-ephemeral runners.', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'false';
process.env.ENABLE_JIT_CONFIG = 'true';
process.env.ENABLE_JOB_QUEUED_CHECK = 'false';
process.env.RUNNER_LABELS = 'jit';
process.env.SSM_TOKEN_PATH = '/github-action-runners/default/runners/config';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).not.toBeCalled();
expect(createRunner).toBeCalledWith(expectedRunnerParams);
expect(mockSSMClient).toHaveReceivedNthSpecificCommandWith(1, PutParameterCommand, {
Name: '/github-action-runners/default/runners/config/i-12345',
Value: '--url https://github.com/Codertocat/hello-world --token 1234abcd --labels jit',
Type: 'SecureString',
Tags: [
{
Key: 'InstanceId',
Value: 'i-12345',
},
],
});
});
it('creates a ephemeral runner after checking job is queued.', async () => {
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.ENABLE_JOB_QUEUED_CHECK = 'true';
await scaleUpModule.scaleUp(TEST_DATA);
expect(mockOctokit.actions.getJobForWorkflowRun).toBeCalled();
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('disable auto update on the runner.', async () => {
process.env.DISABLE_RUNNER_AUTOUPDATE = 'true';
await scaleUpModule.scaleUp(TEST_DATA);
expect(createRunner).toBeCalledWith(expectedRunnerParams);
});
it('Scaling error should return failed message IDs so retry can be triggered.', async () => {
process.env.RUNNERS_MAXIMUM_COUNT = '1';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
await expect(scaleUpModule.scaleUp(TEST_DATA)).resolves.toEqual(['foobar']);
});
});
describe('Batch processing', () => {
const createTestMessages = (
count: number,
overrides: Partial<scaleUpModule.ActionRequestMessageSQS>[] = [],
): scaleUpModule.ActionRequestMessageSQS[] => {
return Array.from({ length: count }, (_, i) => ({
...TEST_DATA_SINGLE,
id: i + 1,
messageId: `message-${i}`,
...overrides[i],
}));
};
beforeEach(() => {
setDefaults();
process.env.ENABLE_ORGANIZATION_RUNNERS = 'true';
process.env.ENABLE_EPHEMERAL_RUNNERS = 'true';
process.env.RUNNERS_MAXIMUM_COUNT = '10';
});
it('Should handle multiple messages for the same organization', async () => {
const messages = createTestMessages(3);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(1);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 3,
runnerOwner: TEST_DATA_SINGLE.repositoryOwner,
}),
);
});
it('Should handle multiple messages for different organizations', async () => {
const messages = createTestMessages(3, [
{ repositoryOwner: 'org1' },
{ repositoryOwner: 'org2' },
{ repositoryOwner: 'org1' },
]);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(2);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2,
runnerOwner: 'org1',
}),
);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 1,
runnerOwner: 'org2',
}),
);
});
it('Should handle multiple messages for different repositories when org-level is disabled', async () => {
process.env.ENABLE_ORGANIZATION_RUNNERS = 'false';
const messages = createTestMessages(3, [
{ repositoryOwner: 'owner1', repositoryName: 'repo1' },
{ repositoryOwner: 'owner1', repositoryName: 'repo2' },
{ repositoryOwner: 'owner1', repositoryName: 'repo1' },
]);
await scaleUpModule.scaleUp(messages);
expect(createRunner).toHaveBeenCalledTimes(2);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 2,
runnerOwner: 'owner1/repo1',
}),
);
expect(createRunner).toHaveBeenCalledWith(
expect.objectContaining({
numberOfRunners: 1,
runnerOwner: 'owner1/repo2',