forked from cypress-io/github-action
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
500 lines (432 loc) · 12.6 KB
/
index.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
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
// @ts-check
const core = require('@actions/core')
const exec = require('@actions/exec')
const io = require('@actions/io')
const { Octokit } = require('@octokit/rest')
const hasha = require('hasha')
const got = require('got')
const { restoreCache, saveCache } = require('cache/lib/index')
const fs = require('fs')
const os = require('os')
const path = require('path')
const quote = require('quote')
const cliParser = require('argument-vector')()
const findYarnWorkspaceRoot = require('find-yarn-workspace-root')
/**
* A small utility for checking when an URL responds, kind of
* a poor man's https://www.npmjs.com/package/wait-on
*/
const ping = (url, timeout) => {
const start = +new Date()
return got(url, {
retry: {
retries(retry, error) {
const now = +new Date()
core.debug(
`${now - start}ms ${error.method} ${error.host} ${
error.code
}`
)
if (now - start > timeout) {
console.error('%s timed out', url)
return 0
}
return 1000
}
}
})
}
/**
* Parses input command, finds the tool and
* the runs the command.
*/
const execCommand = (
fullCommand,
waitToFinish = true,
label = 'executing'
) => {
const cwd = cypressCommandOptions.cwd
console.log('%s with command "%s"', label, fullCommand)
console.log('current working directory "%s"', cwd)
const args = cliParser.parse(fullCommand)
core.debug(`parsed command: ${args.join(' ')}`)
return io.which(args[0], true).then(toolPath => {
core.debug(`found command "${toolPath}"`)
core.debug(`with arguments ${args.slice(1).join(' ')}`)
const toolArguments = args.slice(1)
const argsString = toolArguments.join(' ')
core.debug(`running ${quote(toolPath)} ${argsString} in ${cwd}`)
core.debug('without waiting for the promise to resolve')
const promise = exec.exec(
quote(toolPath),
toolArguments,
cypressCommandOptions
)
if (waitToFinish) {
return promise
}
})
}
const isWindows = () => os.platform() === 'win32'
const homeDirectory = os.homedir()
const platformAndArch = `${process.platform}-${process.arch}`
const workingDirectory =
core.getInput('working-directory') || process.cwd()
/**
* When running "npm install" or any other Cypress-related commands,
* use the install directory as current working directory
*/
const cypressCommandOptions = {
cwd: workingDirectory
}
const yarnFilename = path.join(
findYarnWorkspaceRoot(workingDirectory) || workingDirectory,
'yarn.lock'
)
const packageLockFilename = path.join(
workingDirectory,
'package-lock.json'
)
const useYarn = () => fs.existsSync(yarnFilename)
const lockHash = () => {
const lockFilename = useYarn() ? yarnFilename : packageLockFilename
return hasha.fromFileSync(lockFilename)
}
// enforce the same NPM cache folder across different operating systems
const NPM_CACHE_FOLDER = path.join(homeDirectory, '.npm')
const getNpmCache = () => {
const o = {}
let key = core.getInput('cache-key')
const hash = lockHash()
if (!key) {
if (useYarn()) {
key = `yarn-${platformAndArch}-${hash}`
} else {
key = `npm-${platformAndArch}-${hash}`
}
} else {
console.log('using custom cache key "%s"', key)
}
if (useYarn()) {
o.inputPath = path.join(homeDirectory, '.cache', 'yarn')
} else {
o.inputPath = NPM_CACHE_FOLDER
}
o.restoreKeys = o.primaryKey = key
return o
}
// custom Cypress binary cache folder
// see https://on.cypress.io/caching
const CYPRESS_CACHE_FOLDER = path.join(
homeDirectory,
'.cache',
'Cypress'
)
core.debug(
`using custom Cypress cache folder "${CYPRESS_CACHE_FOLDER}"`
)
const getCypressBinaryCache = () => {
const o = {
inputPath: CYPRESS_CACHE_FOLDER,
restoreKeys: `cypress-${platformAndArch}-`
}
o.primaryKey = o.restoreKeys + lockHash()
return o
}
const restoreCachedNpm = () => {
core.debug('trying to restore cached NPM modules')
const NPM_CACHE = getNpmCache()
return restoreCache(
NPM_CACHE.inputPath,
NPM_CACHE.primaryKey,
NPM_CACHE.restoreKeys
)
}
const saveCachedNpm = () => {
core.debug('saving NPM modules')
const NPM_CACHE = getNpmCache()
return saveCache(NPM_CACHE.inputPath, NPM_CACHE.primaryKey)
}
const restoreCachedCypressBinary = () => {
core.debug('trying to restore cached Cypress binary')
const CYPRESS_BINARY_CACHE = getCypressBinaryCache()
return restoreCache(
CYPRESS_BINARY_CACHE.inputPath,
CYPRESS_BINARY_CACHE.primaryKey,
CYPRESS_BINARY_CACHE.restoreKeys
)
}
const saveCachedCypressBinary = () => {
core.debug('saving Cypress binary')
const CYPRESS_BINARY_CACHE = getCypressBinaryCache()
return saveCache(
CYPRESS_BINARY_CACHE.inputPath,
CYPRESS_BINARY_CACHE.primaryKey
)
}
const install = () => {
// prevent lots of progress messages during install
core.exportVariable('CI', '1')
core.exportVariable('CYPRESS_CACHE_FOLDER', CYPRESS_CACHE_FOLDER)
// Note: need to quote found tool to avoid Windows choking on
// npm paths with spaces like "C:\Program Files\nodejs\npm.cmd ci"
if (useYarn()) {
core.debug('installing NPM dependencies using Yarn')
return io.which('yarn', true).then(yarnPath => {
core.debug(`yarn at "${yarnPath}"`)
return exec.exec(
quote(yarnPath),
['--frozen-lockfile'],
cypressCommandOptions
)
})
} else {
core.debug('installing NPM dependencies')
core.exportVariable('npm_config_cache', NPM_CACHE_FOLDER)
return io.which('npm', true).then(npmPath => {
core.debug(`npm at "${npmPath}"`)
return exec.exec(quote(npmPath), ['ci'], cypressCommandOptions)
})
}
}
const verifyCypressBinary = () => {
core.debug('Verifying Cypress')
core.exportVariable('CYPRESS_CACHE_FOLDER', CYPRESS_CACHE_FOLDER)
return io.which('npx', true).then(npxPath => {
return exec.exec(
quote(npxPath),
['cypress', 'verify'],
cypressCommandOptions
)
})
}
/**
* Grabs a boolean GitHub Action parameter input and casts it.
* @param {string} name - parameter name
* @param {boolean} defaultValue - default value to use if the parameter was not specified
* @returns {boolean} converted input argument or default value
*/
const getInputBool = (name, defaultValue = false) => {
const param = core.getInput(name)
if (param === 'true' || param === '1') {
return true
}
if (param === 'false' || param === '0') {
return false
}
return defaultValue
}
const buildAppMaybe = () => {
const buildApp = core.getInput('build')
if (!buildApp) {
return
}
core.debug(`building application using "${buildApp}"`)
return execCommand(buildApp, true, 'build app')
}
const startServerMaybe = () => {
let startCommand
if (isWindows()) {
// allow custom Windows start command
startCommand =
core.getInput('start-windows') || core.getInput('start')
} else {
startCommand = core.getInput('start')
}
if (!startCommand) {
core.debug('No start command found')
return
}
return execCommand(startCommand, false, 'start server')
}
const waitOnMaybe = () => {
const waitOn = core.getInput('wait-on')
if (!waitOn) {
return
}
const waitOnTimeout = core.getInput('wait-on-timeout') || '60'
console.log(
'waiting on "%s" with timeout of %s seconds',
waitOn,
waitOnTimeout
)
const waitTimeoutMs = parseFloat(waitOnTimeout) * 1000
return ping(waitOn, waitTimeoutMs)
}
const I = x => x
const runTests = async () => {
const runTests = getInputBool('runTests', true)
if (!runTests) {
console.log('Skipping running tests: runTests parameter is false')
return
}
// export common environment variables that help run Cypress
core.exportVariable('CYPRESS_CACHE_FOLDER', CYPRESS_CACHE_FOLDER)
core.exportVariable('TERM', 'xterm')
const customCommand = core.getInput('command')
if (customCommand) {
console.log('Using custom test command: %s', customCommand)
return execCommand(customCommand, true, 'run tests')
}
core.debug('Running Cypress tests')
const quoteArgument = isWindows() ? quote : I
const commandPrefix = core.getInput('command-prefix')
const record = getInputBool('record')
const parallel = getInputBool('parallel')
const headless = getInputBool('headless')
// TODO using yarn to run cypress when yarn is used for install
// split potentially long
let cmd = []
if (commandPrefix) {
// we need to split the command prefix into individual arguments
// otherwise they are passed all as a single string
const parts = commandPrefix.split(' ')
cmd = cmd.concat(parts)
core.debug(`with concatenated command prefix: ${cmd.join(' ')}`)
}
// push each CLI argument separately
cmd.push('cypress')
cmd.push('run')
if (headless) {
cmd.push('--headless')
}
if (record) {
cmd.push('--record')
}
if (parallel) {
cmd.push('--parallel')
}
const group = core.getInput('group')
if (group) {
cmd.push('--group')
cmd.push(quoteArgument(group))
}
const tag = core.getInput('tag')
if (tag) {
cmd.push('--tag')
cmd.push(quoteArgument(tag))
}
const configInput = core.getInput('config')
if (configInput) {
cmd.push('--config')
cmd.push(quoteArgument(configInput))
}
const spec = core.getInput('spec')
if (spec) {
cmd.push('--spec')
cmd.push(quoteArgument(spec))
}
const configFileInput = core.getInput('config-file')
if (configFileInput) {
cmd.push('--config-file')
cmd.push(quoteArgument(configFileInput))
}
if (parallel || group) {
const {
GITHUB_WORKFLOW,
GITHUB_SHA,
GITHUB_TOKEN,
GITHUB_RUN_ID,
GITHUB_REPOSITORY
} = process.env
const [owner, repo] = GITHUB_REPOSITORY.split('/')
let parallelId = `${GITHUB_WORKFLOW} - ${GITHUB_SHA}`
if (GITHUB_TOKEN) {
const client = new Octokit({
auth: GITHUB_TOKEN
})
const resp = await client.request(
'GET /repos/:owner/:repo/actions/runs/:run_id',
{
owner,
repo,
run_id: GITHUB_RUN_ID
}
)
if (resp && resp.data) {
core.exportVariable('GH_BRANCH', resp.data.head_branch)
}
const runsList = await client.request(
'GET /repos/:owner/:repo/actions/runs/:run_id/jobs',
{
owner,
repo,
run_id: GITHUB_RUN_ID
}
)
if (runsList && runsList.data) {
// Use the total_count, every time a job is restarted the list has
// the number of jobs including current run and previous runs, every time
// it appends the result.
parallelId = `${GITHUB_RUN_ID}-${runsList.data.total_count}`
}
}
const customCiBuildId = core.getInput('ci-build-id') || parallelId
cmd.push('--ci-build-id')
cmd.push(quoteArgument(customCiBuildId))
}
const browser = core.getInput('browser')
if (browser) {
cmd.push('--browser')
// TODO should browser be quoted?
// If it is a path, it might have spaces
cmd.push(browser)
}
const envInput = core.getInput('env')
if (envInput) {
// TODO should env be quoted?
// If it is a JSON, it might have spaces
cmd.push('--env')
cmd.push(envInput)
}
console.log('Cypress test command: npx %s', cmd.join(' '))
// since we have quoted arguments ourselves, do not double quote them
const opts = {
...cypressCommandOptions,
windowsVerbatimArguments: false
}
core.debug(`in working directory "${cypressCommandOptions.cwd}"`)
const npxPath = await io.which('npx', true)
core.debug(`npx path: ${npxPath}`)
return exec.exec(quote(npxPath), cmd, opts)
}
const installMaybe = () => {
const installParameter = getInputBool('install', true)
if (!installParameter) {
console.log('Skipping install because install parameter is false')
return Promise.resolve()
}
return Promise.all([
restoreCachedNpm(),
restoreCachedCypressBinary()
]).then(([npmCacheHit, cypressCacheHit]) => {
core.debug(`npm cache hit ${npmCacheHit}`)
core.debug(`cypress cache hit ${cypressCacheHit}`)
return install().then(() => {
if (npmCacheHit && cypressCacheHit) {
core.debug('no need to verify Cypress binary or save caches')
return
}
return verifyCypressBinary()
.then(saveCachedNpm)
.then(saveCachedCypressBinary)
})
})
}
installMaybe()
.then(buildAppMaybe)
.then(startServerMaybe)
.then(waitOnMaybe)
.then(runTests)
.then(() => {
core.debug('all done, exiting')
// force exit to avoid waiting for child processes,
// like the server we have started
// see https://github.com/actions/toolkit/issues/216
process.exit(0)
})
.catch(error => {
console.log(error)
core.setFailed(error.message)
process.exit(1)
})