-
Notifications
You must be signed in to change notification settings - Fork 383
Expand file tree
/
Copy pathjit.test.js
More file actions
351 lines (302 loc) · 11.9 KB
/
jit.test.js
File metadata and controls
351 lines (302 loc) · 11.9 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
const core = require('@actions/core');
const github = require('@actions/github');
// Mock @actions/core
jest.mock('@actions/core', () => ({
getInput: jest.fn(),
setOutput: jest.fn(),
info: jest.fn(),
error: jest.fn(),
warning: jest.fn(),
setFailed: jest.fn(),
}));
// Mock @actions/github
jest.mock('@actions/github', () => ({
context: {
repo: {
owner: 'test-owner',
repo: 'test-repo',
},
},
getOctokit: jest.fn(),
}));
// Mock AWS SDK
jest.mock('@aws-sdk/client-ec2', () => ({
EC2Client: jest.fn().mockImplementation(() => ({
send: jest.fn(),
})),
RunInstancesCommand: jest.fn(),
TerminateInstancesCommand: jest.fn(),
waitUntilInstanceRunning: jest.fn(),
}));
// Default input values used across tests
const defaultInputs = {
'mode': 'start',
'github-token': 'test-token',
'ec2-image-id': 'ami-123',
'ec2-instance-type': 't3.micro',
'subnet-id': 'subnet-123',
'security-group-id': 'sg-123',
'label': '',
'ec2-instance-id': '',
'iam-role-name': '',
'market-type': '',
'pre-runner-script': '',
'runner-home-dir': '',
'startup-quiet-period-seconds': '',
'startup-retry-interval-seconds': '',
'startup-timeout-minutes': '5',
'run-runner-as-service': 'false',
'run-runner-as-user': '',
'ec2-volume-size': '',
'ec2-device-name': '/dev/sda1',
'ec2-volume-type': '',
'block-device-mappings': '[]',
'availability-zones-config': '',
'metadata-options': '{}',
'packages': '[]',
'aws-resource-tags': '[]',
'use-jit': 'false',
'runner-group-id': '1',
'runner-debug': 'false',
};
function setupInputs(overrides = {}) {
const inputs = { ...defaultInputs, ...overrides };
core.getInput.mockImplementation((name) => inputs[name] || '');
}
function createConfig() {
const { Config } = require('../config');
return new Config();
}
// Load a fresh aws module with custom inputs using jest.isolateModules
function loadFreshAws(inputOverrides = {}) {
setupInputs(inputOverrides);
process.env.AWS_REGION = 'us-east-1';
let aws;
jest.isolateModules(() => {
aws = require('../aws');
});
return aws;
}
describe('Config - JIT inputs', () => {
beforeEach(() => {
process.env.AWS_REGION = 'us-east-1';
});
test('reads useJit as false by default', () => {
setupInputs();
const config = createConfig();
expect(config.input.useJit).toBe(false);
});
test('reads useJit as true when set', () => {
setupInputs({ 'use-jit': 'true' });
const config = createConfig();
expect(config.input.useJit).toBe(true);
});
test('reads runnerGroupId with default value of 1', () => {
setupInputs();
const config = createConfig();
expect(config.input.runnerGroupId).toBe(1);
});
test('reads custom runnerGroupId', () => {
setupInputs({ 'runner-group-id': '42' });
const config = createConfig();
expect(config.input.runnerGroupId).toBe(42);
});
test('throws when useJit and runAsService are both true', () => {
setupInputs({ 'use-jit': 'true', 'run-runner-as-service': 'true' });
expect(() => createConfig()).toThrow(
"The 'use-jit' and 'run-runner-as-service' inputs are incompatible"
);
});
test('allows useJit without runAsService', () => {
setupInputs({ 'use-jit': 'true', 'run-runner-as-service': 'false' });
expect(() => createConfig()).not.toThrow();
});
});
describe('gh.js - getJitRunnerConfig', () => {
test('calls generate-jitconfig API and returns config', async () => {
setupInputs({ 'use-jit': 'true' });
process.env.AWS_REGION = 'us-east-1';
const mockRequest = jest.fn().mockResolvedValue({
data: {
runner: { id: 123, name: 'ec2-abc12' },
encoded_jit_config: 'base64encodedconfig',
},
});
github.getOctokit.mockReturnValue({ request: mockRequest });
let gh;
jest.isolateModules(() => {
gh = require('../gh');
});
const result = await gh.getJitRunnerConfig('abc12');
expect(mockRequest).toHaveBeenCalledWith(
'POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig',
expect.objectContaining({
owner: 'test-owner',
repo: 'test-repo',
name: 'ec2-abc12',
runner_group_id: 1,
labels: ['abc12'],
work_folder: '_work',
})
);
expect(result).toEqual({
runnerId: 123,
encodedJitConfig: 'base64encodedconfig',
});
});
test('throws on API error', async () => {
setupInputs({ 'use-jit': 'true' });
process.env.AWS_REGION = 'us-east-1';
const mockRequest = jest.fn().mockRejectedValue(new Error('API error'));
github.getOctokit.mockReturnValue({ request: mockRequest });
let gh;
jest.isolateModules(() => {
gh = require('../gh');
});
await expect(gh.getJitRunnerConfig('abc12')).rejects.toThrow('API error');
expect(core.error).toHaveBeenCalledWith('GitHub JIT runner configuration generation error');
});
});
describe('aws.js - user-data generation', () => {
test('JIT user-data does not contain config.sh', () => {
const aws = loadFreshAws({ 'use-jit': 'true' });
const userData = aws._buildUserDataScriptForTest(null, 'testlabel', 'encodedconfig123');
expect(userData).not.toContain('config.sh');
expect(userData).toContain('--jitconfig encodedconfig123');
});
test('JIT user-data with runnerHomeDir skips download', () => {
const aws = loadFreshAws({ 'use-jit': 'true', 'runner-home-dir': '/home/runner/actions-runner' });
const userData = aws._buildUserDataScriptForTest(null, 'testlabel', 'encodedconfig123');
expect(userData).toContain('/home/runner/actions-runner');
expect(userData).not.toContain('mkdir actions-runner');
expect(userData).not.toContain('config.sh');
expect(userData).toContain('--jitconfig encodedconfig123');
});
test('JIT user-data with runAsUser uses runuser', () => {
const aws = loadFreshAws({ 'use-jit': 'true', 'run-runner-as-user': 'ubuntu' });
const userData = aws._buildUserDataScriptForTest(null, 'testlabel', 'encodedconfig123');
expect(userData).toContain('runuser -u ubuntu -- ./run.sh --jitconfig encodedconfig123');
});
test('standard (non-JIT) user-data contains config.sh', () => {
const aws = loadFreshAws();
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('config.sh');
expect(userData).toContain('--token regtoken123');
expect(userData).not.toContain('--jitconfig');
});
test('standard user-data with runAsService includes svc.sh', () => {
const aws = loadFreshAws({ 'run-runner-as-service': 'true' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('svc.sh install');
expect(userData).toContain('svc.sh start');
});
test('JIT user-data does not include svc.sh', () => {
const aws = loadFreshAws({ 'use-jit': 'true' });
const userData = aws._buildUserDataScriptForTest(null, 'testlabel', 'encodedconfig123');
expect(userData).not.toContain('svc.sh');
});
test('user-data uses cloud-config format with write_files and runcmd', () => {
const aws = loadFreshAws();
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toMatch(/^#cloud-config\n/);
expect(userData).toContain('write_files:');
expect(userData).toContain('runcmd:');
});
test('user-data writes setup script to /opt/ and runs with nohup', () => {
const aws = loadFreshAws();
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('path: /opt/runner-setup.sh');
expect(userData).toContain('permissions: "0755"');
expect(userData).toContain('nohup /opt/runner-setup.sh &');
});
test('standard user-data removes stale runner config files', () => {
const aws = loadFreshAws({ 'runner-home-dir': '/home/runner/actions-runner' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('rm -f .runner .credentials .credentials_rsaparams');
});
test('JIT user-data removes stale runner config files', () => {
const aws = loadFreshAws({ 'use-jit': 'true', 'runner-home-dir': '/home/runner/actions-runner' });
const userData = aws._buildUserDataScriptForTest(null, 'testlabel', 'encodedconfig123');
expect(userData).toContain('rm -f .runner .credentials .credentials_rsaparams');
});
test('standard user-data with runAsUser uses runuser instead of su', () => {
const aws = loadFreshAws({ 'run-runner-as-user': 'ec2-user' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('runuser -u ec2-user -- ./run.sh');
expect(userData).not.toContain('su ec2-user');
});
test('standard user-data with runAsUser uses tolerant chown', () => {
const aws = loadFreshAws({ 'run-runner-as-user': 'ec2-user' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('chown -R ec2-user . 2>&1 || true');
});
test('user-data installs packages when specified', () => {
const aws = loadFreshAws({ 'packages': '["git", "docker.io"]' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('packages:');
expect(userData).toContain(' - git');
expect(userData).toContain(' - docker.io');
});
});
describe('aws.js - runner-debug', () => {
test('debug mode includes echo statements', () => {
const aws = loadFreshAws({ 'runner-debug': 'true' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).toContain('[RUNNER]');
expect(userData).toContain('echo "[RUNNER] Setup script started at');
});
test('non-debug mode excludes echo statements', () => {
const aws = loadFreshAws({ 'runner-debug': 'false' });
const userData = aws._buildUserDataScriptForTest('regtoken123', 'testlabel', null);
expect(userData).not.toContain('[RUNNER] Setup script started');
});
});
describe('Config - ec2-instance-type parsing', () => {
beforeEach(() => {
process.env.AWS_REGION = 'us-east-1';
});
test('parses single instance type string into array', () => {
setupInputs({ 'ec2-instance-type': 't3.micro' });
const config = createConfig();
expect(config.input.ec2InstanceTypes).toEqual(['t3.micro']);
expect(config.input.ec2InstanceType).toBe('t3.micro');
});
test('parses JSON array of instance types', () => {
setupInputs({ 'ec2-instance-type': '["t3.micro", "t3.small", "m5.large"]' });
const config = createConfig();
expect(config.input.ec2InstanceTypes).toEqual(['t3.micro', 't3.small', 'm5.large']);
expect(config.input.ec2InstanceType).toBe('t3.micro');
});
test('throws on empty JSON array', () => {
setupInputs({ 'ec2-instance-type': '[]' });
expect(() => createConfig()).toThrow("Invalid 'ec2-instance-type' input");
});
test('throws on invalid JSON array content', () => {
setupInputs({ 'ec2-instance-type': '[123, 456]' });
expect(() => createConfig()).toThrow("Invalid 'ec2-instance-type' input");
});
test('throws on malformed JSON', () => {
setupInputs({ 'ec2-instance-type': '[not json' });
expect(() => createConfig()).toThrow("Invalid 'ec2-instance-type' input");
});
test('handles whitespace around single type', () => {
setupInputs({ 'ec2-instance-type': ' t3.micro ' });
const config = createConfig();
expect(config.input.ec2InstanceTypes).toEqual(['t3.micro']);
});
});
describe('Config - runner-debug input', () => {
beforeEach(() => {
process.env.AWS_REGION = 'us-east-1';
});
test('reads runnerDebug as false by default', () => {
setupInputs();
const config = createConfig();
expect(config.input.runnerDebug).toBe(false);
});
test('reads runnerDebug as true when set', () => {
setupInputs({ 'runner-debug': 'true' });
const config = createConfig();
expect(config.input.runnerDebug).toBe(true);
});
});