playwright/test-runner/src/cli.ts

/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';
import program from 'commander';
import { installTransform } from './transform';
import { Runner } from './runner';
import { TestCollector } from './testCollector';

let beforeFunction;
let afterFunction;
let matrix = {};

global['before'] = (fn => beforeFunction = fn);
global['after'] = (fn => afterFunction = fn);
global['matrix'] = (m => matrix = m);

program
  .version('Version ' + /** @type {any} */ (require)('../package.json').version)
  .option('--forbid-only', 'Fail if exclusive test(s) encountered', false)
  .option('-g, --grep <grep>', 'Only run tests matching this string or regexp', '.*')
  .option('-j, --jobs <jobs>', 'Number of concurrent jobs for --parallel; use 1 to run in serial, default: (number of CPU cores / 2)', Math.ceil(require('os').cpus().length / 2).toString())
  .option('--reporter <reporter>', 'Specify reporter to use', '')
  .option('--trial-run', 'Only collect the matching tests and report them as passing')
  .option('--quiet', 'Suppress stdio', false)
  .option('--debug', 'Run tests in-process for debugging', false)
  .option('--output <outputDir>', 'Folder for output artifacts, default: test-results', path.join(process.cwd(), 'test-results'))
  .option('--timeout <timeout>', 'Specify test timeout threshold (in milliseconds), default: 10000', '10000')
  .option('-u, --update-snapshots', 'Use this flag to re-record every snapshot that fails during this test run')
  .action(async (command) => {
    // Collect files]
    const testDir = path.resolve(process.cwd(), command.args[0]);
    const files = collectFiles(testDir, '', command.args.slice(1));

    const revertBabelRequire = installTransform();
    let hasSetup = false;
    try {
      hasSetup = fs.statSync(path.join(testDir, 'setup.js')).isFile();
    } catch (e) {
    }
    try {
      hasSetup = hasSetup || fs.statSync(path.join(testDir, 'setup.ts')).isFile();
    } catch (e) {
    }

    if (hasSetup)
      require(path.join(testDir, 'setup'));
    revertBabelRequire();

    const testCollector = new TestCollector(files, matrix, {
      forbidOnly: command.forbidOnly || undefined,
      grep: command.grep,
      timeout: command.timeout,
    });
    const rootSuite = testCollector.suite;
    if (command.forbidOnly && testCollector.hasOnly()) {
      console.error('=====================================');
      console.error(' --forbid-only found a focused test.');
      console.error('=====================================');
      process.exit(1);
    }

    const total = rootSuite.total();
    if (!total) {
      console.error('=================');
      console.error(' no tests found.');
      console.error('=================');
      process.exit(1);
    }

    // Trial run does not need many workers, use one.
    const jobs = (command.trialRun || command.debug) ? 1 : command.jobs;
    const runner = new Runner(rootSuite, total, {
      debug: command.debug,
      quiet: command.quiet,
      grep: command.grep,
      jobs,
      outputDir: command.output,
      reporter: command.reporter,
      snapshotDir: path.join(testDir, '__snapshots__'),
      testDir,
      timeout: command.timeout,
      trialRun: command.trialRun,
      updateSnapshots: command.updateSnapshots
    });
    try {
      if (beforeFunction)
        await beforeFunction();
      await runner.run();
      await runner.stop();
    } finally {
      if (afterFunction)
        await afterFunction();
    }
    process.exit(runner.stats.failures ? 1 : 0);
  });

program.parse(process.argv);

function collectFiles(testDir, dir, filters) {
  const fullDir = path.join(testDir, dir);
  if (fs.statSync(fullDir).isFile())
    return [fullDir];
  const files = [];
  for (const name of fs.readdirSync(fullDir)) {
    if (fs.lstatSync(path.join(fullDir, name)).isDirectory()) {
      files.push(...collectFiles(testDir, path.join(dir, name), filters));
      continue;
    }
    if (!name.endsWith('spec.ts'))
      continue;
    const relativeName = path.join(dir, name);
    const fullName = path.join(testDir, relativeName);
    if (!filters.length) {
      files.push(fullName);
      continue;
    }
    for (const filter of filters) {
      if (relativeName.includes(filter)) {
        files.push(fullName);
        break;
      }
    }
  }
  return files;
}