mirror of
https://github.com/cypress-io/cypress.git
synced 2026-01-02 04:29:55 -06:00
342 lines
9.2 KiB
TypeScript
342 lines
9.2 KiB
TypeScript
import os from 'os'
|
|
import fs from 'fs-extra'
|
|
import path from 'path'
|
|
import _ from 'lodash'
|
|
import del from 'del'
|
|
import chalk from 'chalk'
|
|
import electron from '@packages/electron'
|
|
import la from 'lazy-ass'
|
|
|
|
import * as packages from './util/packages'
|
|
import * as meta from './meta'
|
|
import xvfb from '../../cli/lib/exec/xvfb'
|
|
import smoke from './smoke'
|
|
import { spawn, execSync } from 'child_process'
|
|
import { transformRequires } from './util/transform-requires'
|
|
import execa from 'execa'
|
|
import { testStaticAssets } from './util/testStaticAssets'
|
|
import performanceTracking from '../../system-tests/lib/performance'
|
|
|
|
const CY_ROOT_DIR = path.join(__dirname, '..', '..')
|
|
|
|
const log = function (msg) {
|
|
const time = new Date()
|
|
const timeStamp = time.toLocaleTimeString()
|
|
|
|
console.log(timeStamp, chalk.yellow(msg), chalk.blue(meta.PLATFORM))
|
|
}
|
|
|
|
interface BuildCypressAppOpts {
|
|
platform: meta.PlatformName
|
|
version: string
|
|
skipSigning?: boolean
|
|
keepBuild?: boolean
|
|
}
|
|
|
|
// For debugging the flow without rebuilding each time
|
|
|
|
export async function buildCypressApp (options: BuildCypressAppOpts) {
|
|
const { platform, version, skipSigning = false, keepBuild = false } = options
|
|
|
|
log('#checkPlatform')
|
|
if (platform !== os.platform()) {
|
|
throw new Error('Platform mismatch')
|
|
}
|
|
|
|
const DIST_DIR = meta.distDir()
|
|
|
|
log('#cleanupPlatform')
|
|
fs.rmSync(meta.TMP_BUILD_DIR, { force: true, recursive: true })
|
|
fs.rmSync(path.resolve('build'), { force: true, recursive: true })
|
|
fs.rmSync(path.resolve('packages', 'electron', 'dist'), { force: true, recursive: true })
|
|
|
|
log(`symlinking ${meta.TMP_BUILD_DIR} -> ${path.resolve('build')}`)
|
|
fs.symlinkSync(
|
|
meta.TMP_BUILD_DIR,
|
|
path.resolve('build'),
|
|
'dir',
|
|
)
|
|
|
|
if (!keepBuild) {
|
|
log('#buildPackages')
|
|
await execa('yarn', ['lerna', 'run', 'build-prod', '--stream', '--ignore', 'cli'], {
|
|
stdio: 'inherit',
|
|
cwd: CY_ROOT_DIR,
|
|
})
|
|
}
|
|
|
|
// Copy Packages: We want to copy the package.json, files, and output
|
|
log('#copyAllToDist')
|
|
await packages.copyAllToDist(DIST_DIR)
|
|
fs.copySync(path.join(CY_ROOT_DIR, 'patches'), path.join(DIST_DIR, 'patches'))
|
|
|
|
const jsonRoot = fs.readJSONSync(path.join(CY_ROOT_DIR, 'package.json'))
|
|
|
|
const packageJsonContents = _.omit(jsonRoot, [
|
|
'devDependencies',
|
|
'lint-staged',
|
|
'engines',
|
|
'scripts',
|
|
])
|
|
|
|
fs.writeJsonSync(meta.distDir('package.json'), {
|
|
...packageJsonContents,
|
|
scripts: {
|
|
postinstall: 'patch-package',
|
|
},
|
|
}, { spaces: 2 })
|
|
|
|
// Copy the yarn.lock file so we have a consistent install
|
|
fs.copySync(path.join(CY_ROOT_DIR, 'yarn.lock'), meta.distDir('yarn.lock'))
|
|
|
|
log('#replace local npm versions')
|
|
const dirsSeen = await packages.replaceLocalNpmVersions(DIST_DIR)
|
|
|
|
log('#remove local npm dirs that are not needed')
|
|
await packages.removeLocalNpmDirs(DIST_DIR, dirsSeen)
|
|
|
|
log('#install production dependencies')
|
|
execSync('yarn --production', {
|
|
cwd: DIST_DIR,
|
|
stdio: 'inherit',
|
|
})
|
|
|
|
// TODO: Validate no-hoists / single copies of libs
|
|
|
|
// Remove extra directories that are large/unneeded
|
|
log('#remove extra dirs')
|
|
await del([
|
|
meta.distDir('**', 'image-q', 'demo'),
|
|
meta.distDir('**', 'gifwrap', 'test'),
|
|
meta.distDir('**', 'pixelmatch', 'test'),
|
|
meta.distDir('**', '@jimp', 'tiff', 'test'),
|
|
meta.distDir('**', '@cypress', 'icons', '**/*.{ai,eps}'),
|
|
meta.distDir('**', 'esprima', 'test'),
|
|
meta.distDir('**', 'bmp-js', 'test'),
|
|
meta.distDir('**', 'exif-parser', 'test'),
|
|
meta.distDir('**', 'app-module-path', 'test'),
|
|
], { force: true })
|
|
|
|
console.log('Deleted excess directories')
|
|
|
|
log('#createRootPackage')
|
|
const electronVersion = electron.getElectronVersion()
|
|
const electronNodeVersion = await electron.getElectronNodeVersion()
|
|
|
|
fs.writeJSONSync(meta.distDir('package.json'), {
|
|
name: 'cypress',
|
|
productName: 'Cypress',
|
|
description: jsonRoot.description,
|
|
version, // Cypress version
|
|
electronVersion,
|
|
electronNodeVersion,
|
|
main: 'index.js',
|
|
scripts: {},
|
|
env: 'production',
|
|
}, { spaces: 2 })
|
|
|
|
fs.writeFileSync(meta.distDir('index.js'), `\
|
|
process.env.CYPRESS_INTERNAL_ENV = process.env.CYPRESS_INTERNAL_ENV || 'production'
|
|
require('./packages/server')\
|
|
`)
|
|
|
|
// removeTypeScript
|
|
await del([
|
|
// include ts files of packages
|
|
meta.distDir('**', '*.ts'),
|
|
|
|
// except those in node_modules
|
|
`!${meta.distDir('**', 'node_modules', '**', '*.ts')}`,
|
|
], { force: true })
|
|
|
|
// cleanJs
|
|
if (!keepBuild) {
|
|
await packages.runAllCleanJs()
|
|
}
|
|
|
|
// transformSymlinkRequires
|
|
log('#transformSymlinkRequires')
|
|
|
|
await transformRequires(meta.distDir())
|
|
|
|
log(`#testVersion ${meta.distDir()}`)
|
|
await testVersion(meta.distDir(), version)
|
|
|
|
log('#testStaticAssets')
|
|
await testStaticAssets(meta.distDir())
|
|
|
|
log('#removeCyAndBinFolders')
|
|
await del([
|
|
meta.distDir('node_modules', '.bin'),
|
|
meta.distDir('packages', '*', 'node_modules', '.bin'),
|
|
meta.distDir('packages', 'server', '.cy'),
|
|
], { force: true })
|
|
|
|
// when we copy packages/electron, we get the "dist" folder with
|
|
// empty Electron app, symlinked to our server folder
|
|
// in production build, we do not need this link, and it
|
|
// would not work anyway with code signing
|
|
|
|
// hint: you can see all symlinks in the build folder
|
|
// using "find build/darwin/Cypress.app/ -type l -ls"
|
|
log('#removeDevElectronApp')
|
|
fs.removeSync(meta.distDir('packages', 'electron', 'dist'))
|
|
|
|
// electronPackAndSign
|
|
log('#electronPackAndSign')
|
|
// See the internal wiki document "Signing Test Runner on MacOS"
|
|
// to learn how to get the right Mac certificate for signing and notarizing
|
|
// the built Test Runner application
|
|
|
|
const appFolder = meta.distDir()
|
|
const outputFolder = meta.buildRootDir()
|
|
|
|
const iconFilename = getIconFilename()
|
|
|
|
console.log(`output folder: ${outputFolder}`)
|
|
|
|
const args = [
|
|
'--publish=never',
|
|
`--c.electronVersion=${electronVersion}`,
|
|
`--c.directories.app=${appFolder}`,
|
|
`--c.directories.output=${outputFolder}`,
|
|
`--c.icon=${iconFilename}`,
|
|
// for now we cannot pack source files in asar file
|
|
// because electron-builder does not copy nested folders
|
|
// from packages/*/node_modules
|
|
// see https://github.com/electron-userland/electron-builder/issues/3185
|
|
// so we will copy those folders later ourselves
|
|
'--c.asar=false',
|
|
]
|
|
|
|
console.log('electron-builder arguments:')
|
|
console.log(args.join(' '))
|
|
|
|
try {
|
|
await execa('electron-builder', args, {
|
|
stdio: 'inherit',
|
|
})
|
|
} catch (e) {
|
|
if (!skipSigning) {
|
|
throw e
|
|
}
|
|
}
|
|
|
|
// lsDistFolder
|
|
console.log('in build folder %s', meta.buildDir())
|
|
|
|
const { stdout } = await execa('ls', ['-la', meta.buildDir()])
|
|
|
|
console.log(stdout)
|
|
|
|
// testVersion(buildAppDir)
|
|
await testVersion(meta.buildAppDir(), version)
|
|
|
|
// runSmokeTests
|
|
let usingXvfb = xvfb.isNeeded()
|
|
|
|
try {
|
|
if (usingXvfb) {
|
|
await xvfb.start()
|
|
}
|
|
|
|
const executablePath = meta.buildAppExecutable()
|
|
|
|
await smoke.test(executablePath)
|
|
} finally {
|
|
if (usingXvfb) {
|
|
await xvfb.stop()
|
|
}
|
|
}
|
|
|
|
// verifyAppCanOpen
|
|
if (platform === 'darwin' && !skipSigning) {
|
|
const appFolder = meta.zipDir()
|
|
|
|
await new Promise<void>((resolve, reject) => {
|
|
const args = ['-a', '-vvvv', appFolder]
|
|
|
|
console.log(`cmd: spctl ${args.join(' ')}`)
|
|
const sp = spawn('spctl', args, { stdio: 'inherit' })
|
|
|
|
return sp.on('exit', (code) => {
|
|
if (code === 0) {
|
|
return resolve()
|
|
}
|
|
|
|
return reject(new Error('Verifying App via GateKeeper failed'))
|
|
})
|
|
})
|
|
}
|
|
|
|
if (platform === 'win32') {
|
|
return
|
|
}
|
|
|
|
log(`#printPackageSizes ${appFolder}`)
|
|
|
|
// "du" - disk usage utility
|
|
// -d -1 depth of 1
|
|
// -h human readable sizes (K and M)
|
|
const diskUsageResult = await execa('du', ['-d', '1', appFolder])
|
|
|
|
const lines = diskUsageResult.stdout.split(os.EOL)
|
|
|
|
// will store {package name: package size}
|
|
const data = {}
|
|
|
|
lines.forEach((line) => {
|
|
const parts = line.split('\t')
|
|
const packageSize = parseFloat(parts[0])
|
|
const folder = parts[1]
|
|
|
|
const packageName = path.basename(folder)
|
|
|
|
if (packageName === 'packages') {
|
|
return // root "packages" information
|
|
}
|
|
|
|
data[packageName] = packageSize
|
|
})
|
|
|
|
const sizes = _.fromPairs(_.sortBy(_.toPairs(data), 1))
|
|
|
|
console.log(sizes)
|
|
|
|
performanceTracking.track('test runner size', sizes)
|
|
}
|
|
|
|
function getIconFilename () {
|
|
const filenames = {
|
|
darwin: 'cypress.icns',
|
|
win32: 'cypress.ico',
|
|
linux: 'icon_512x512.png',
|
|
}
|
|
const iconFilename = electron.icons().getPathToIcon(filenames[meta.PLATFORM])
|
|
|
|
console.log(`For platform ${meta.PLATFORM} using icon ${iconFilename}`)
|
|
|
|
return iconFilename
|
|
}
|
|
|
|
async function testVersion (dir: string, version: string) {
|
|
log('#testVersion')
|
|
|
|
console.log('testing dist package version')
|
|
console.log('by calling: node index.js --version')
|
|
console.log('in the folder %s', dir)
|
|
|
|
const result = await execa('node', ['index.js', '--version'], {
|
|
cwd: dir,
|
|
})
|
|
|
|
la(result.stdout, 'missing output when getting built version', result)
|
|
|
|
console.log('app in %s', dir)
|
|
console.log('built app version', result.stdout)
|
|
la(result.stdout === version, 'different version reported',
|
|
result.stdout, 'from input version to build', version)
|
|
|
|
console.log('✅ using node --version works')
|
|
}
|