/
unit.test.ts
442 lines (393 loc) · 17.2 KB
/
unit.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
import * as process from 'process'
import * as fs from 'fs'
import * as os from 'os'
import * as vcpkgaction from '../src/vcpkg-action'
import * as actionlib from '@lukka/action-lib'
import * as cache from '@actions/cache'
import * as runvcpkglib from '@lukka/run-vcpkg-lib'
import * as path from 'path'
import * as baseutil from '@lukka/base-util-lib'
import * as vcpkgutils from '../src/vcpkg-utils'
import * as core from '@actions/core'
import * as vcpkgpostaction from '../src/vcpkg-post-action'
jest.setTimeout(15 * 1000);
// Mocks entire action-lib module.
//??jest.mock("@lukka/action-lib");
const baseUtil = new baseutil.BaseUtilLib(new actionlib.ActionLib());
let warningMock: jest.SpyInstance;
let errorMock: jest.SpyInstance;
let debugMock: jest.SpyInstance;
let infoMock: jest.SpyInstance;
let getFileHashMock: jest.SpyInstance;
let getStateMock: jest.SpyInstance;
let setStateMock: jest.SpyInstance;
let getBinDirMock: jest.SpyInstance;
let getVcpkgCacheDirMock: jest.SpyInstance;
let getVcpkgDirMock: jest.SpyInstance;
// Mocks entire run-vcpkg-lib module.
jest.mock("@lukka/run-vcpkg-lib");
function clearInputs(): void {
Object.keys(process.env)
.filter((key) => key.match(/^INPUT_/))
.forEach((key) => {
delete process.env[key];
});
}
function printStackFrame(): void {
if (process.env.DEBUG) console.trace();
}
beforeAll(async () => {
});
beforeEach(() => {
process.env.GITHUB_WORKSPACE = os.tmpdir();
jest.resetAllMocks();
jest.spyOn(runvcpkglib, "getOrdinaryCachedPaths").mockImplementation(
function (vcpkgRoot): string[] {
return [vcpkgRoot];
});
warningMock = jest.spyOn(baseUtil.baseLib, 'warning').mockImplementation((msg: string) => {
console.log(`baselib.warning(): ${msg}`);
printStackFrame();
});
infoMock = jest.spyOn(baseUtil.baseLib, 'info').mockImplementation((msg: string) => {
console.log(`baselib.info(): ${msg}`);
printStackFrame();
});
debugMock = jest.spyOn(baseUtil.baseLib, 'debug').mockImplementation((msg: string) => {
console.log(`baselib.debug(): ${msg}`);
printStackFrame();
});
errorMock = jest.spyOn(baseUtil.baseLib, 'error').mockImplementation((msg: string) => {
console.log(`baselib.error(): ${msg}`);
printStackFrame();
});
setStateMock = jest.spyOn(baseUtil.baseLib, "setState").mockImplementation((name: string, value: string): void => {
console.log(`setStateMock(): ${name}='${value}'`);
process.env[name] = value;
});
getStateMock = jest.spyOn(baseUtil.baseLib, "getState").mockImplementation((name: string): string => {
console.log(`getStateMock(): ${name}='${process.env[name]}'`);
return process.env[name] ?? "";
});
getFileHashMock = jest.spyOn(baseUtil, 'getFileHash').mockImplementation((file: string) => {
return Promise.resolve([file, `hash-of-${file}`]);
});
getBinDirMock = jest.spyOn(baseUtil.baseLib, 'getBinDir').mockImplementation(() => {
return Promise.resolve(path.join(os.tmpdir(), "bin"));
});
getVcpkgCacheDirMock = jest.spyOn(runvcpkglib, 'getDefaultVcpkgCacheDirectory').mockImplementation((baselib) => {
return Promise.resolve(path.join(os.tmpdir(), "vcpkg_cache"));
});
getVcpkgDirMock = jest.spyOn(runvcpkglib, 'getDefaultVcpkgDirectory').mockImplementation((baselib) => {
return Promise.resolve(path.join(os.tmpdir(), "vcpkg"));
});
});
afterEach(() => {
clearInputs();
});
afterAll(async () => {
});
test('run-vcpkg: basic run no exception', async () => {
// Arrange.
process.env[`INPUT_${vcpkgaction.additionalCachedPathsInput.toUpperCase()}`] = "/a/path/";
// Act.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await vcpkg.run();
// No assert.
});
test('run-vcpkg: basic run with exception', async () => {
// Arrange.
jest.spyOn(baseUtil, "wrapOp").mockImplementationOnce(() => { throw new Error(); });
// Act and Assert.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await expect(async () => await vcpkg.run()).rejects.toThrowError();
// Run post action.
const vcpkgPostAction = new vcpkgpostaction.VcpkgPostAction(
baseUtil,
false,
baseutil.createKeySet(["primary"]),
['/dummy/Path/'],
"primary");
await vcpkgPostAction.run();
});
test('run-vcpkg: basic run with exception on saving the cache', async () => {
// Arrange.
jest.spyOn(cache, "saveCache").mockImplementationOnce(() => { throw new Error(); });
// Act and Assert.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await vcpkg.run();
// Run post action.
const vcpkgPostAction = new vcpkgpostaction.VcpkgPostAction(
baseUtil,
false,
baseutil.createKeySet(["primary"]),
['/dummy/Path/'],
null);
await vcpkgPostAction.run();
});
test('run-vcpkg: cache hit', async () => {
// Arrange.
const primaryHitKey = "hit";
const keys = baseutil.createKeySet([primaryHitKey]);
const saveCacheSpy = jest.spyOn(cache, "saveCache").mockImplementation(
function (a, b, c): Promise<number> {
return Promise.resolve(17);
});
jest.spyOn(vcpkgutils.Utils,
"computeCacheKeys").mockReturnValue(Promise.resolve(keys));
const restoreCacheSpy = jest.spyOn(cache, "restoreCache").mockImplementation(
function (a, b, c): Promise<string> { return Promise.resolve(primaryHitKey); });
process.env.INPUT_VCPKGDIRECTORY = "/var/tmp/vcpkg";
process.env.INPUT_APPENDEDCACHEKEY = "appendedCacheKey";
// Act.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await vcpkg.run();
// Asserts.
expect(restoreCacheSpy).toBeCalledTimes(1);
const key = restoreCacheSpy.mock.calls[0][1];
// Run post action.
const vcpkgPostAction = new vcpkgpostaction.VcpkgPostAction(baseUtil,
false,
keys,
['/dummy/Path/'],
keys.primary);
await vcpkgPostAction.run();
// Cache was hit, and cache.save() must not be called in the post-action.
expect(saveCacheSpy).toBeCalledTimes(0);
});
test('run-vcpkg: cache miss', async () => {
// Arrange.
const saveCacheSpy = jest.spyOn(cache, "saveCache").mockImplementation(
function (a, b, c): Promise<number> { return Promise.resolve(42); });
// Mock returns an underfined key since it is a cache miss.
const restoreCacheSpy = jest.spyOn(cache, "restoreCache").mockImplementation(
function (a, b, c): Promise<string | undefined> { return Promise.resolve(undefined); });
const vcpkgRunnerRunSpy = jest.spyOn(runvcpkglib.VcpkgRunner.prototype, "run");
// Act.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await vcpkg.run();
// Asserts.
expect(restoreCacheSpy).toBeCalledTimes(1);
const key = restoreCacheSpy.mock.calls[0][1];
// Cache was missed, and cache.save() is not going to be called in the action, but it
// will in the post action.
expect(saveCacheSpy).toBeCalledTimes(0);
// The "key cache hit" must be empty as there was no cache hit.
expect(core.getState(vcpkgaction.VCPKG_KEY_CACHE_HIT_STATE)).toBeFalsy();
console.log(core.getState(vcpkgaction.VCPKG_CACHE_COMPUTEDKEY_STATE));
expect(vcpkgRunnerRunSpy).toBeCalledTimes(0);
// Run post action.
// Artificially set the state for VCPKG_CACHE_COMPUTEDKEY_STATE (it would only be set if this
// code is running by an GitHub runner indeed)
process.env.STATE_VCPKG_CACHE_COMPUTEDKEY_STATE = '{"primary":"runnerOS=darwin","restore":[]}';
const vcpkgPostAction = new vcpkgpostaction.VcpkgPostAction(baseUtil,
false,
baseutil.createKeySet([key]),
['/dummy/Path/'],
null);
await vcpkgPostAction.run();
// Cache was missed, and cache.save() is called in the post-action.
expect(saveCacheSpy).toBeCalledTimes(1);
expect(saveCacheSpy.mock.calls[0][1]).toBe(key);
});
test('run-vcpkg: cache must not be restored/saved when "doNotCache" is true', async () => {
// Arrange.
const saveCacheSpy = jest.spyOn(cache, "saveCache");
const restoreCacheSpy = jest.spyOn(cache, "restoreCache");
const vcpkgRunnerRunSpy = jest.spyOn(runvcpkglib.VcpkgRunner.prototype, "run");
process.env["INPUT_DONOTCACHE"] = "true";
// Act.
const vcpkg: vcpkgaction.VcpkgAction = new vcpkgaction.VcpkgAction(baseUtil);
await vcpkg.run();
// Asserts.
// doNotCache is true, no cache operation must be carried.
expect(restoreCacheSpy).toBeCalledTimes(0);
expect(saveCacheSpy).toBeCalledTimes(0);
expect(vcpkgRunnerRunSpy).toBeCalledTimes(0);
});
test('isExactKeyMatch() tests', () => {
expect(vcpkgutils.Utils.isExactKeyMatch("hash1", "hash2")).toBeFalsy();
expect(vcpkgutils.Utils.isExactKeyMatch("hash2", "hash")).toBeFalsy();
expect(vcpkgutils.Utils.isExactKeyMatch("hash", "hash")).toBeTruthy();
});
test('getVcpkgCommitId() must return undefined when the path is not the root of a Git repository', async () => {
// Arrange
const vcpkgrunnerGetCommitIdMock = jest.spyOn(runvcpkglib.VcpkgRunner, 'getCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<string> {
return Promise.resolve("1234");
});
// It must return undefined when the path is not the _root_ of a Git repository.
const nonGitRootPath = path.resolve(__dirname);
process.env.GITHUB_WORKSPACE = nonGitRootPath;
// Act and Assert
expect(await vcpkgutils.Utils.getVcpkgCommitId(baseUtil, nonGitRootPath)).toStrictEqual([undefined, undefined]);
expect(vcpkgrunnerGetCommitIdMock).toBeCalledTimes(0);
});
test('getVcpkgCommitId() tests', async () => {
const p = path.resolve(path.join(__dirname, ".."));
// It must return undefined when GITHUB_WORKSPACE is not defined.
delete process.env.GITHUB_WORKSPACE;
expect(await vcpkgutils.Utils.getVcpkgCommitId(baseUtil, p)).toStrictEqual([undefined, undefined]);
// It must return undefined when the path is not existent
process.env.GITHUB_WORKSPACE = "/var/tmp/anything";
process.env.INPUT_VCPKGDIRECTORY = "/vcpkg";
expect(await vcpkgutils.Utils.getVcpkgCommitId(baseUtil, p)).toStrictEqual([undefined, false]);
{
// vcpkg submodule scenario.
const expectedVcpkgSubmoduleCommitId = "commit_id_sha";
jest.spyOn(fs, 'readFileSync').mockImplementationOnce(function (filePath) {
return expectedVcpkgSubmoduleCommitId;
});
jest.spyOn(fs, 'existsSync').mockImplementationOnce(function (filePath) {
return true;
});
const commitId = await vcpkgutils.Utils.getVcpkgCommitId(baseUtil, p);
expect(commitId).toStrictEqual([expectedVcpkgSubmoduleCommitId, true]);
}
{
// vcpkg non-submodule scenario.
const expectedVcpkgSubmoduleCommitId = "commit_id_sha";
jest.spyOn(fs, 'existsSync').mockImplementationOnce(function (filePath) {
return false;
});
jest.spyOn(runvcpkglib.VcpkgRunner, "getCommitId").mockImplementation(
function (baseUtil, fullVcpkgPath): Promise<string> {
return Promise.resolve<string>(expectedVcpkgSubmoduleCommitId);
});
const commitId = await vcpkgutils.Utils.getVcpkgCommitId(baseUtil, p);
expect(commitId).toStrictEqual([expectedVcpkgSubmoduleCommitId, false]);
}
});
test('computeCacheKey(): vcpkg not as a submodule (no commit id user provided and no vcpkg.json found)', async () => {
// Arrange.
const expected: baseutil.KeySet = {
"primary": "runnerOS=imageos-vcpkgGitCommit=1234_appendedKey=appendedCacheKey",
"restore":
[
"runnerOS=imageos-vcpkgGitCommit=1234"
]
};
process.env.ImageOS = "imageos";
const getFileHashMock = jest.spyOn(baseUtil, 'getFileHash').mockImplementation((file: string) => {
return Promise.resolve([null, null]);
});
const vcpkgCommitIdMock = jest.spyOn(vcpkgutils.Utils, 'getVcpkgCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<[string, boolean]> {
return Promise.resolve(["1234", false]);
});
// Act and Assert.
expect(await vcpkgutils.Utils.computeCacheKeys(
baseUtil,
null,
null,
".",
"",
"appendedCacheKey")).toStrictEqual(expected);
expect(warningMock).toBeCalledTimes(0);
// Cleanup.
vcpkgCommitIdMock.mockClear();
getFileHashMock.mockClear();
});
test('computeCacheKey(): vcpkg not as a submodule (no commit id user provided)', async () => {
// Arrange.
const expected: baseutil.KeySet = {
"primary": "runnerOS=imageos-vcpkgGitCommit=1234_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json_appendedKey=appendedCacheKey",
"restore":
[
"runnerOS=imageos-vcpkgGitCommit=1234_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json",
"runnerOS=imageos-vcpkgGitCommit=1234"
]
};
process.env.ImageOS = "imageos";
const vcpkgCommitIdMock = jest.spyOn(vcpkgutils.Utils, 'getVcpkgCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<[string, boolean]> {
return Promise.resolve(["1234", false]);
});
// Act and Assert.
expect(await vcpkgutils.Utils.computeCacheKeys(
baseUtil,
"hash-of-vcpkg.json",
"hash-of-vcpkg-configuration.json",
".",
"",
"appendedCacheKey")).toStrictEqual(expected);
expect(warningMock).toBeCalledTimes(0);
// Cleanup.
vcpkgCommitIdMock.mockClear();
});
test('computeCacheKey(): vcpkg as a submodule (no commit id user provided)', async () => {
// Arrange.
const expected: baseutil.KeySet = {
"primary": "runnerOS=imageos-vcpkgGitCommit=5678_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json_appendedKey=appendedCacheKey",
"restore":
[
"runnerOS=imageos-vcpkgGitCommit=5678_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json",
"runnerOS=imageos-vcpkgGitCommit=5678"
]
};
process.env.ImageOS = "imageos";
const vcpkgCommitIdMock = jest.spyOn(vcpkgutils.Utils, 'getVcpkgCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<[string, boolean]> {
return Promise.resolve(["5678", true]);
});
// Act and Assert.
expect(await vcpkgutils.Utils.computeCacheKeys(
baseUtil,
"hash-of-vcpkg.json",
"hash-of-vcpkg-configuration.json",
".",
"",
"appendedCacheKey")).toStrictEqual(expected);
expect(warningMock).toBeCalledTimes(0);
// Cleanup.
vcpkgCommitIdMock.mockClear();
});
test('computeCacheKey(): vcpkg as a submodule, with user provided Git commit id, it must trigger a warning', async () => {
// Arrange.
const expected: baseutil.KeySet = {
"primary": "runnerOS=imageos-vcpkgGitCommit=0912_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json_appendedKey=appendedCacheKey",
"restore":
[
"runnerOS=imageos-vcpkgGitCommit=0912_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json",
"runnerOS=imageos-vcpkgGitCommit=0912"
]
};
process.env.ImageOS = "imageos";
const vcpkgCommitIdMock = jest.spyOn(vcpkgutils.Utils, 'getVcpkgCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<[string, boolean]> {
return Promise.resolve(["0912", true /* is submodule must be true */]);
});
// Act and Assert.
expect(await vcpkgutils.Utils.computeCacheKeys(
baseUtil,
"hash-of-vcpkg.json",
"hash-of-vcpkg-configuration.json",
path.resolve("."),
"vcpkgcommitid",
"appendedCacheKey")).toStrictEqual(expected);
expect(warningMock).toBeCalledTimes(1);
vcpkgCommitIdMock.mockClear();
});
test('computeCacheKey(): vcpkg with user provided commit it must not trigger a warning', async () => {
// Arrange.
const expected: baseutil.KeySet = {
"primary": "runnerOS=imageos-vcpkgGitCommit=userId_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json_appendedKey=appendedCacheKey",
"restore": [
"runnerOS=imageos-vcpkgGitCommit=userId_vcpkgJson=hash-of-vcpkg.json-vcpkgConfigurationJson=hash-of-vcpkg-configuration.json",
"runnerOS=imageos-vcpkgGitCommit=userId"]
};
process.env.ImageOS = "imageos";
const vcpkgCommitIdMock = jest.spyOn(vcpkgutils.Utils, 'getVcpkgCommitId').
mockImplementationOnce(function (baseUtilLib, path): Promise<[string | undefined, boolean]> {
return Promise.resolve([undefined, false]);
});
// Act and assert.
expect(await vcpkgutils.Utils.computeCacheKeys(
baseUtil,
"hash-of-vcpkg.json",
"hash-of-vcpkg-configuration.json",
"/Users/luca/github/run-vcpkg/__tests__/assets/",
"userId",
"appendedCacheKey")).toStrictEqual(expected);
expect(warningMock).toBeCalledTimes(0);
});