mirror of
https://github.com/cypress-io/cypress.git
synced 2026-01-24 07:59:03 -06:00
31ee30b6f3
* chore: rename snapshots and spec files to fit vitest convention (#32405) * chore: move compiled files to dist directory to make vitest convertion easier (#32406) * chore: convert utils to vitest (#32407) * chore: convert logger to vitest * chore: convert errors spec to vitest * chore: convert cypress spec to vitest * chore: convert `exec` directory to `vitest` (#32428) * chore: cut over exec directory to vitest * Update cli/test/lib/exec/run.spec.ts * Update cli/test/lib/exec/run.spec.ts * Update cli/test/lib/exec/run.spec.ts * chore: convert the CLI and build script specs over to vitest (#32438) * chore: convert tasks directory to vitest (#32434) change way verify module is exported due to issues interpreting module (thinks its an esm) rework scripts as we cannot run an empty mocha suite chore: fix snapshots and verify requires that are internal to the cypress project fix stubbing issues with fs-extra which is also used by request-progress under the hood fix issues where xvfb was stopping prematurely * chore: remove files no longer used now that mocha tests are converted to vitest (#32455) * build binaries * chore: fix CLI tests (#32484) * chore: remove CI branch
125 lines
2.8 KiB
TypeScript
125 lines
2.8 KiB
TypeScript
import os from 'os'
|
|
import Bluebird from 'bluebird'
|
|
import Xvfb from '@cypress/xvfb'
|
|
import { stripIndent } from 'common-tags'
|
|
import Debug from 'debug'
|
|
import { throwFormErrorText, errors } from '../errors'
|
|
import util from '../util'
|
|
|
|
const debug: any = Debug('cypress:cli')
|
|
const debugXvfb: any = Debug('cypress:xvfb')
|
|
|
|
debug.Debug = debugXvfb.Debug = Debug
|
|
|
|
const xvfbOptions: any = {
|
|
displayNum: process.env.XVFB_DISPLAY_NUM,
|
|
timeout: 30000, // milliseconds
|
|
// need to explicitly define screen otherwise electron will crash
|
|
// https://github.com/cypress-io/cypress/issues/6184
|
|
xvfb_args: ['-screen', '0', '1280x1024x24'],
|
|
onStderrData (data: any): void {
|
|
if (debugXvfb.enabled) {
|
|
debugXvfb(data.toString())
|
|
}
|
|
},
|
|
}
|
|
|
|
const xvfb: any = Bluebird.promisifyAll(new Xvfb(xvfbOptions))
|
|
|
|
const xvfbModule = {
|
|
_debugXvfb: debugXvfb, // expose for testing
|
|
|
|
_xvfb: xvfb, // expose for testing
|
|
|
|
_xvfbOptions: xvfbOptions, // expose for testing
|
|
|
|
async start (): Promise<any> {
|
|
debug('Starting Xvfb')
|
|
|
|
try {
|
|
await xvfb.startAsync()
|
|
|
|
return null
|
|
} catch (e: any) {
|
|
if (e.nonZeroExitCode === true) {
|
|
const raiseErrorFn = throwFormErrorText(errors.nonZeroExitCodeXvfb)
|
|
|
|
await raiseErrorFn(e)
|
|
}
|
|
|
|
if (e.known) {
|
|
throw e
|
|
}
|
|
|
|
const raiseErrorFn = throwFormErrorText(errors.missingXvfb)
|
|
|
|
await raiseErrorFn(e)
|
|
}
|
|
},
|
|
|
|
async stop (): Promise<null> {
|
|
debug('Stopping Xvfb')
|
|
|
|
try {
|
|
await xvfb.stopAsync()
|
|
|
|
return null
|
|
} catch (e) {
|
|
return null
|
|
}
|
|
},
|
|
|
|
isNeeded (): boolean {
|
|
if (process.env.ELECTRON_RUN_AS_NODE) {
|
|
debug('Environment variable ELECTRON_RUN_AS_NODE detected, xvfb is not needed')
|
|
|
|
return false // xvfb required for electron processes only.
|
|
}
|
|
|
|
if (os.platform() !== 'linux') {
|
|
return false
|
|
}
|
|
|
|
if (process.env.DISPLAY) {
|
|
const issueUrl = util.getGitHubIssueUrl(4034)
|
|
|
|
const message = stripIndent`
|
|
DISPLAY environment variable is set to ${process.env.DISPLAY} on Linux
|
|
Assuming this DISPLAY points at working X11 server,
|
|
Cypress will not spawn own Xvfb
|
|
|
|
NOTE: if the X11 server is NOT working, Cypress will exit without explanation,
|
|
see ${issueUrl}
|
|
Solution: Unset the DISPLAY variable and try again:
|
|
DISPLAY= npx cypress run ...
|
|
`
|
|
|
|
debug(message)
|
|
|
|
return false
|
|
}
|
|
|
|
debug('undefined DISPLAY environment variable')
|
|
debug('Cypress will spawn its own Xvfb')
|
|
|
|
return true
|
|
},
|
|
|
|
// async method, resolved with Boolean
|
|
async verify (): Promise<boolean> {
|
|
try {
|
|
await xvfb.startAsync()
|
|
|
|
return true
|
|
} catch (err: any) {
|
|
debug('Could not verify xvfb: %s', err.message)
|
|
|
|
return false
|
|
} finally {
|
|
await xvfb.stopAsync()
|
|
}
|
|
},
|
|
}
|
|
|
|
export default xvfbModule
|