const path = require('canonical-path'); const fs = require('fs-extra'); const argv = require('yargs').argv; const globby = require('globby'); const xSpawn = require('cross-spawn'); const treeKill = require('tree-kill'); const shelljs = require('shelljs'); shelljs.set('-e'); const AIO_PATH = path.join(__dirname, '../../'); const SHARED_PATH = path.join(__dirname, '/shared'); const EXAMPLES_PATH = path.join(AIO_PATH, './content/examples/'); const PROTRACTOR_CONFIG_FILENAME = path.join(__dirname, './shared/protractor.config.js'); const SJS_SPEC_FILENAME = 'e2e-spec.ts'; const CLI_SPEC_FILENAME = 'e2e/app.e2e-spec.ts'; const EXAMPLE_CONFIG_FILENAME = 'example-config.json'; const IGNORED_EXAMPLES = [ // temporary ignores 'quickstart', 'http', 'setup', 'webpack', 'upgrade-p' ]; /** * Run Protractor End-to-End Tests for Doc Samples * * Flags * --filter to filter/select _example app subdir names * e.g. --filter=foo // all example apps with 'foo' in their folder names. * * --setup run yarn install, copy boilerplate and update webdriver * e.g. --setup * * --local to use the locally built Angular packages, rather than versions from npm * Must be used in conjunction with --setup as this is when the packages are copied. * e.g. --setup --local * * --shard to shard the specs into groups to allow you to run them in parallel * e.g. --shard=0/2 // the even specs: 0, 2, 4, etc * e.g. --shard=1/2 // the odd specs: 1, 3, 5, etc * e.g. --shard=1/3 // the second of every three specs: 1, 4, 7, etc */ function runE2e() { if (argv.setup) { // Run setup. console.log('runE2e: setup boilerplate'); const installPackagesCommand = `example-use-${argv.local ? 'local' : 'npm'}`; const addBoilerplateCommand = 'boilerplate:add'; shelljs.exec(`yarn ${installPackagesCommand}`, { cwd: AIO_PATH }); shelljs.exec(`yarn ${addBoilerplateCommand}`, { cwd: AIO_PATH }); } const outputFile = path.join(AIO_PATH, './protractor-results.txt'); return Promise.resolve() .then(() => findAndRunE2eTests(argv.filter, outputFile, argv.shard)) .then((status) => { reportStatus(status, outputFile); if (status.failed.length > 0) { return Promise.reject('Some test suites failed'); } }).catch(function (e) { console.log(e); process.exitCode = 1; }); } // Finds all of the *e2e-spec.tests under the examples folder along with the corresponding apps // that they should run under. Then run each app/spec collection sequentially. function findAndRunE2eTests(filter, outputFile, shard) { const shardParts = shard ? shard.split('/') : [0,1]; const shardModulo = parseInt(shardParts[0], 10); const shardDivider = parseInt(shardParts[1], 10); // create an output file with header. const startTime = new Date().getTime(); let header = `Doc Sample Protractor Results on ${new Date().toLocaleString()}\n`; header += ` Filter: ${filter ? filter : 'All tests'}\n\n`; fs.writeFileSync(outputFile, header); // Run the tests sequentially. const status = { passed: [], failed: [] }; return getE2eSpecs(EXAMPLES_PATH, filter) .then(e2eSpecPaths => { Object.keys(e2eSpecPaths).forEach(key => { const value = e2eSpecPaths[key]; e2eSpecPaths[key] = value.filter((p, index) => index % shardDivider === shardModulo); }); return e2eSpecPaths.systemjs.reduce((promise, specPath) => { return promise.then(() => { const examplePath = path.dirname(specPath); return runE2eTestsSystemJS(examplePath, outputFile).then(ok => { const arr = ok ? status.passed : status.failed; arr.push(examplePath); }); }); }, Promise.resolve()) .then(() => { return e2eSpecPaths.cli.reduce((promise, specPath) => { return promise.then(() => { return runE2eTestsCLI(specPath, outputFile).then(ok => { const arr = ok ? status.passed : status.failed; arr.push(specPath); }); }); }, Promise.resolve()); }); }) .then(() => { const stopTime = new Date().getTime(); status.elapsedTime = (stopTime - startTime) / 1000; return status; }); } // Start the example in appDir; then run protractor with the specified // fileName; then shut down the example. // All protractor output is appended to the outputFile. // SystemJS version function runE2eTestsSystemJS(appDir, outputFile) { const config = loadExampleConfig(appDir); const appBuildSpawnInfo = spawnExt('yarn', [config.build], { cwd: appDir }); const appRunSpawnInfo = spawnExt('yarn', [config.run, '-s'], { cwd: appDir }, true); let run = runProtractorSystemJS(appBuildSpawnInfo.promise, appDir, appRunSpawnInfo, outputFile); if (fs.existsSync(appDir + '/aot/index.html')) { run = run.then((ok) => ok && runProtractorAoT(appDir, outputFile)); } return run; } function runProtractorSystemJS(prepPromise, appDir, appRunSpawnInfo, outputFile) { const specFilename = path.resolve(`${appDir}/${SJS_SPEC_FILENAME}`); return prepPromise .catch(function () { const emsg = `Application at ${appDir} failed to transpile.\n\n`; console.log(emsg); fs.appendFileSync(outputFile, emsg); return Promise.reject(emsg); }) .then(function () { let transpileError = false; // Start protractor. const spawnInfo = spawnExt('yarn', ['protractor', PROTRACTOR_CONFIG_FILENAME, `--specs=${specFilename}`, '--params.appDir=' + appDir, '--params.outputFile=' + outputFile ], { cwd: SHARED_PATH }); spawnInfo.proc.stderr.on('data', function (data) { transpileError = transpileError || /npm ERR! Exit status 100/.test(data.toString()); }); return spawnInfo.promise.catch(function () { if (transpileError) { const emsg = `${specFilename} failed to transpile.\n\n`; console.log(emsg); fs.appendFileSync(outputFile, emsg); } return Promise.reject(); }); }) .then( function () { return finish(appRunSpawnInfo.proc.pid, true); }, function () { return finish(appRunSpawnInfo.proc.pid, false); } ); } function finish(spawnProcId, ok) { // Ugh... proc.kill does not work properly on windows with child processes. // appRun.proc.kill(); treeKill(spawnProcId); return ok; } // Run e2e tests over the AOT build for projects that examples it. function runProtractorAoT(appDir, outputFile) { fs.appendFileSync(outputFile, '++ AoT version ++\n'); const aotBuildSpawnInfo = spawnExt('yarn', ['build:aot'], { cwd: appDir }); let promise = aotBuildSpawnInfo.promise; const copyFileCmd = 'copy-dist-files.js'; if (fs.existsSync(appDir + '/' + copyFileCmd)) { promise = promise.then(() => spawnExt('node', [copyFileCmd], { cwd: appDir }).promise); } const aotRunSpawnInfo = spawnExt('yarn', ['serve:aot'], { cwd: appDir }, true); return runProtractorSystemJS(promise, appDir, aotRunSpawnInfo, outputFile); } // Start the example in appDir; then run protractor with the specified // fileName; then shut down the example. // All protractor output is appended to the outputFile. // CLI version function runE2eTestsCLI(appDir, outputFile) { // `--preserve-symlinks` is needed due the symlinked `node_modules/` in each example. // `--no-webdriver-update` is needed to preserve the ChromeDriver version already installed. const args = ['e2e', '--preserve-symlinks', '--no-webdriver-update']; const e2eSpawn = spawnExt('yarn', args, { cwd: appDir }); return e2eSpawn.promise.then( function () { fs.appendFileSync(outputFile, `Passed: ${appDir}\n\n`); return finish(e2eSpawn.proc.pid, true); }, function () { fs.appendFileSync(outputFile, `Failed: ${appDir}\n\n`); return finish(e2eSpawn.proc.pid, false); } ); } // Report final status. function reportStatus(status, outputFile) { let log = ['']; log.push('Suites passed:'); status.passed.forEach(function (val) { log.push(' ' + val); }); if (status.failed.length == 0) { log.push('All tests passed'); } else { log.push('Suites failed:'); status.failed.forEach(function (val) { log.push(' ' + val); }); } log.push('\nElapsed time: ' + status.elapsedTime + ' seconds'); log = log.join('\n'); console.log(log); fs.appendFileSync(outputFile, log); } // Returns both a promise and the spawned process so that it can be killed if needed. function spawnExt(command, args, options, ignoreClose = false) { let proc; const promise = new Promise((resolve, reject) => { let descr = command + ' ' + args.join(' '); console.log('running: ' + descr); try { proc = xSpawn.spawn(command, args, options); } catch (e) { console.log(e); reject(e); return { proc: null, promise }; } proc.stdout.on('data', function (data) { process.stdout.write(data.toString()); }); proc.stderr.on('data', function (data) { process.stdout.write(data.toString()); }); proc.on('close', function (returnCode) { console.log(`completed: ${descr} \n`); // Many tasks (e.g., tsc) complete but are actually errors; // Confirm return code is zero. returnCode === 0 || ignoreClose ? resolve(0) : reject(returnCode); }); proc.on('error', function (data) { console.log(`completed with error: ${descr} \n`); console.log(data.toString()); reject(data); }); }); return { proc, promise }; } function getE2eSpecs(basePath, filter) { let specs = {}; return getE2eSpecsFor(basePath, SJS_SPEC_FILENAME, filter).then(sjsPaths => { specs.systemjs = sjsPaths; }).then(() => { return getE2eSpecsFor(basePath, CLI_SPEC_FILENAME, filter).then(cliPaths => { return cliPaths.map(p => { return p.replace(`${CLI_SPEC_FILENAME}`, ''); }); }); }).then(cliPaths => { specs.cli = cliPaths; }).then(() => specs); } // Find all e2e specs in a given example folder. function getE2eSpecsFor(basePath, specFile, filter) { // Only get spec file at the example root. const e2eSpecGlob = `${filter ? `*${filter}*` : '*'}/${specFile}`; return globby(e2eSpecGlob, { cwd: basePath, nodir: true }) .then(paths => paths .filter(file => !IGNORED_EXAMPLES.some(ignored => file.startsWith(ignored))) .map(file => path.join(basePath, file)) ); } // Load configuration for an example. Used for SystemJS function loadExampleConfig(exampleFolder) { // Default config. let config = { build: 'build', run: 'serve:e2e' }; try { const exampleConfig = fs.readJsonSync(`${exampleFolder}/${EXAMPLE_CONFIG_FILENAME}`); Object.assign(config, exampleConfig); } catch (e) { } return config; } runE2e();