playwright/test/runner/index.js

/**
 * 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.
 */

const fs = require('fs');
const path = require('path');
const program = require('commander');
const { Runner } = require('./runner');
const Mocha = require('mocha');
const { fixturesUI } = require('./fixturesUI');

class NullReporter {}

program
  .version('Version ' + 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))
  .option('--reporter <reporter>', 'Specify reporter to use', '')
  .option('--trial-run', 'Only collect the matching tests and report them as passing')
  .option('--dumpio', 'Dump stdout and stderr from workers', false)
  .option('--timeout <timeout>', 'Specify test timeout threshold (in milliseconds), default: 10000', 10000)
  .action(async (command) => {
    // Collect files
    const files = [];
    collectFiles(path.join(process.cwd(), command.args[0]), command.args.slice(1), files);
    const rootSuite = new Mocha.Suite('', new Mocha.Context(), true);

    let total = 0;
    // Build the test model, suite per file.
    for (const file of files) {
      const mocha = new Mocha({
        forbidOnly: command.forbidOnly || undefined,
        reporter: NullReporter,
        retries: command.retries,
        timeout: command.timeout,
        ui: fixturesUI.bind(null, true),
      });
      if (command.grep)
        mocha.grep(command.grep);
      mocha.addFile(file);
      let runner;
      await new Promise(f => {
        runner = mocha.run(f);
      });
      total += runner.grepTotal(mocha.suite);

      rootSuite.addSuite(mocha.suite);
      mocha.suite.title = path.basename(file);
    }

    // Filter tests.
    if (rootSuite.hasOnly())
      rootSuite.filterOnly();
    if (!command.reporter) {
      console.log();
      total = Math.min(total, rootSuite.total()); // First accounts for grep, second for only.
      console.log(`Running ${total} tests using ${Math.min(command.jobs, total)} workers`);
    }

    // Trial run does not need many workers, use one.
    const jobs = command.trialRun ? 1 : command.jobs;
    const runner = new Runner(rootSuite, {
      dumpio: command.dumpio,
      grep: command.grep,
      jobs,
      reporter: command.reporter,
      retries: command.retries,
      timeout: command.timeout,
      trialRun: command.trialRun,
    });
    await runner.run(files);
    await runner.stop();
    process.exit(runner.stats.failures ? 1 : 0);
  });

program.parse(process.argv);

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