playwright/test-runner/src/test.ts

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

export type Configuration = { name: string, value: string }[];

type TestStatus = 'passed' | 'failed' | 'timedOut' | 'skipped';

export class Test {
  suite: Suite;
  title: string;
  file: string;
  only = false;
  slow = false;
  timeout = 0;
  fn: Function;
  results: TestResult[] = [];

  _id: string;
  // Skipped & flaky are resolved based on options in worker only
  // We will compute them there and send to the runner (front-end)
  _skipped = false;
  _flaky = false;
  _overriddenFn: Function;
  _startTime: number;
  _expectedStatus: TestStatus = 'passed';

  constructor(title: string, fn: Function) {
    this.title = title;
    this.fn = fn;
  }

  titlePath(): string[] {
    return [...this.suite.titlePath(), this.title];
  }

  fullTitle(): string {
    return this.titlePath().join(' ');
  }

  _appendResult(): TestResult {
    const result: TestResult = {
      duration: 0,
      expectedStatus: 'passed',
      stdout: [],
      stderr: [],
      data: {}
    };
    this.results.push(result);
    return result;
  }

  _ok(): boolean {
    if (this._skipped || this.suite._isSkipped())
      return true;
    const hasFailedResults = !!this.results.find(r => r.status !== r.expectedStatus);
    if (!hasFailedResults)
      return true;
    if (!this._flaky)
      return false;
    const hasPassedResults = !!this.results.find(r => r.status === r.expectedStatus);
    return hasPassedResults;
  }

  _hasResultWithStatus(status: TestStatus): boolean {
    return !!this.results.find(r => r.status === status);
  }

  _clone(): Test {
    const test = new Test(this.title, this.fn);
    test.suite = this.suite;
    test.only = this.only;
    test.file = this.file;
    test.timeout = this.timeout;
    test._flaky = this._flaky;
    test._overriddenFn = this._overriddenFn;
    return test;
  }
}

export type TestResult = {
  duration: number;
  status?: TestStatus;
  expectedStatus: TestStatus;
  error?: any;
  stdout: (string | Buffer)[];
  stderr: (string | Buffer)[];
  data: any;
}

export class Suite {
  title: string;
  parent?: Suite;
  suites: Suite[] = [];
  tests: Test[] = [];
  only = false;
  file: string;
  configuration: Configuration;

  // Skipped & flaky are resolved based on options in worker only
  // We will compute them there and send to the runner (front-end)
  _skipped = false;
  _configurationString: string;

  _hooks: { type: string, fn: Function } [] = [];
  _entries: (Suite | Test)[] = [];

  constructor(title: string, parent?: Suite) {
    this.title = title;
    this.parent = parent;
  }

  titlePath(): string[] {
    if (!this.parent)
      return [];
    return [...this.parent.titlePath(), this.title];
  }

  total(): number {
    let count = 0;
    this.findTest(fn => {
      ++count;
    });
    return count;
  }

  _isSkipped(): boolean {
    return this._skipped || (this.parent && this.parent._isSkipped());
  }

  _addTest(test: Test) {
    test.suite = this;
    this.tests.push(test);
    this._entries.push(test);
  }

  _addSuite(suite: Suite) {
    suite.parent = this;
    this.suites.push(suite);
    this._entries.push(suite);
  }

  eachSuite(fn: (suite: Suite) => boolean | void): boolean {
    for (const suite of this.suites) {
      if (suite.eachSuite(fn))
        return true;
    }
    return false;
  }

  findTest(fn: (test: Test) => boolean | void): boolean {
    for (const suite of this.suites) {
      if (suite.findTest(fn))
        return true;
    }
    for (const test of this.tests) {
      if (fn(test))
        return true;
    }
    return false;
  }

  _clone(): Suite {
    const suite = new Suite(this.title);
    suite.only = this.only;
    suite.file = this.file;
    suite._skipped = this._skipped;
    return suite;
  }

  _renumber() {
    let ordinal = 0;
    this.findTest((test: Test) => {
      // All tests are identified with their ordinals.
      test._id = `${ordinal++}@${this.file}::[${this._configurationString}]`;
    });
  }

  _addHook(type: string, fn: any) {
    this._hooks.push({ type, fn });
  }

  _hasTestsToRun(): boolean {
    let found = false;
    this.findTest(test => {
      if (!test._skipped) {
        found = true;
        return true;
      }
    });
    return found;
  }
}

export function serializeConfiguration(configuration: Configuration): string {
  const tokens = [];
  for (const { name, value } of configuration)
    tokens.push(`${name}=${value}`);
  return tokens.join(', ');
}

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

function trimCycles(obj: any): any {
  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;
      })
  );
}