playwright/test/runner/testRunner.js

/**
 * Copyright Microsoft Corporation. All rights reserved.
 *
 * 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 path = require('path');
const Mocha = require('mocha');
const { FixturePool, rerunRegistrations, fixturesForCallback } = require('./fixtures');
const { fixturesUI } = require('./fixturesUI');
const { EventEmitter } = require('events');

const fixturePool = new FixturePool();
global.expect = require('expect');
global.testOptions = require('./testOptions');
const GoldenUtils = require('./GoldenUtils');

class NullReporter {}

class TestRunner extends EventEmitter {
  constructor(entry, options) {
    super();
    this.mocha = new Mocha({
      reporter: NullReporter,
      timeout: options.timeout,
      ui: fixturesUI.bind(null, {
        testWrapper: fn => this._testWrapper(fn),
        hookWrapper: (hook, fn) => this._hookWrapper(hook, fn),
        ignoreOnly: true
      }),
    });
    this._currentOrdinal = -1;
    this._failedWithError = false;
    this._file = entry.file;
    this._ordinals = new Set(entry.ordinals);
    this._remaining = new Set(entry.ordinals);
    this._trialRun = options.trialRun;
    this._passes = 0;
    this._failures = 0;
    this._pending = 0;
    this._configuredFile = entry.configuredFile;
    this._configurationObject = entry.configurationObject;
    this._configurationString = entry.configurationString;
    this._parsedGeneratorConfiguration = new Map();
    for (const {name, value} of this._configurationObject)
      this._parsedGeneratorConfiguration.set(name, value);
    this._relativeTestFile = path.relative(options.testDir, this._file);
    this.mocha.addFile(this._file);
    this.mocha.loadFiles();
    this.suite = this.mocha.suite;
  }

  async run() {
    let callback;
    const result = new Promise(f => callback = f);
    rerunRegistrations(this._file, 'test');
    for (const [name, value] of this._parsedGeneratorConfiguration)
      fixturePool.generators.set(name, value);
    const runner = this.mocha.run(callback);

    const constants = Mocha.Runner.constants;
    runner.on(constants.EVENT_TEST_BEGIN, test => {
      relativeTestFile = this._relativeTestFile;
      if (this._failedWithError)
        return;
      const ordinal = ++this._currentOrdinal;
      if (this._ordinals.size && !this._ordinals.has(ordinal))
        return;
      this._remaining.delete(ordinal);
      this.emit('test', { test: this._serializeTest(test, ordinal) });
    });

    runner.on(constants.EVENT_TEST_PENDING, test => {
      if (this._failedWithError)
        return;
      const ordinal = ++this._currentOrdinal;
      if (this._ordinals.size && !this._ordinals.has(ordinal))
        return;
      this._remaining.delete(ordinal);
      ++this._pending;
      this.emit('pending', { test: this._serializeTest(test, ordinal) });
    });

    runner.on(constants.EVENT_TEST_PASS, test => {
      if (this._failedWithError)
        return;

      const ordinal = this._currentOrdinal;
      if (this._ordinals.size && !this._ordinals.has(ordinal))
        return;
      ++this._passes;
      this.emit('pass', { test: this._serializeTest(test, ordinal) });
    });

    runner.on(constants.EVENT_TEST_FAIL, (test, error) => {
      if (this._failedWithError)
        return;
      ++this._failures;
      this._failedWithError = error;
      this.emit('fail', {
        test: this._serializeTest(test, this._currentOrdinal),
        error: serializeError(error),
      });
    });

    runner.once(constants.EVENT_RUN_END, async () => {
      this.emit('done', {
        stats: this._serializeStats(runner.stats),
        error: this._failedWithError,
        remaining: [...this._remaining],
        total: runner.stats.tests
      });
    });
    await result;
  }

  _shouldRunTest(hook) {
    if (this._trialRun || this._failedWithError)
      return false;
    if (hook) {
      // Hook starts before we bump the test ordinal.
      if (!this._ordinals.has(this._currentOrdinal + 1))
        return false;
    } else {
      if (!this._ordinals.has(this._currentOrdinal))
        return false;
    }
    return true;
  }

  _testWrapper(fn) {
    const wrapped = fixturePool.wrapTestCallback(fn);
    return wrapped ? (done, ...args) => {
      if (!this._shouldRunTest()) {
        done();
        return;
      }
      wrapped(...args).then(done).catch(done);
    } : undefined;
  }

  _hookWrapper(hook, fn) {
    if (!this._shouldRunTest(true))
      return;
    return hook(async () => {
      return await fixturePool.resolveParametersAndRun(fn);
    });
  }

  _serializeTest(test, ordinal) {
    return {
      id: `${ordinal}@${this._configuredFile}`,
      duration: test.duration,
    };
  }
  
  _serializeStats(stats) {
    return {
      passes: this._passes,
      failures: this._failures,
      pending: this._pending,
      duration: stats.duration || 0,
    }
  }  
}

function trimCycles(obj) {
  const cache = new Set();
  return JSON.parse(
    JSON.stringify(obj, function(key, value) {
      if (typeof value === 'object' && value !== null) {
        if (cache.has(value))
          return '' + value;
        cache.add(value);
      }
      return value;
    })
  );
}

function serializeError(error) {
  if (error instanceof Error) {
    return {
      message: error.message,
      stack: error.stack
    }
  }
  return trimCycles(error);
}

let relativeTestFile;

function initializeImageMatcher(options) {
  function toMatchImage(received, name, config) {
    const { pass, message } = GoldenUtils.compare(received, name, { ...options, relativeTestFile, config });
    return { pass, message: () => message };
  };
  global.expect.extend({ toMatchImage });
}

module.exports = { TestRunner, initializeImageMatcher, fixturePool };