jest-mocha-reporter/src/jest-types/TestResult.js

A reporter for jest which produces a report compatible with Atlassian Bamboo Mocha Test Parser.

/**
 * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow
 */

import type { ConsoleBuffer } from './Console';

export type RawFileCoverage = {|
  path : string,
  s : { [statementId : number] : number },
  b : { [branchId : number] : number },
  f : { [functionId : number] : number },
  l : { [lineId : number] : number },
  fnMap : { [functionId : number] : any },
  statementMap : { [statementId : number] : any },
  branchMap : { [branchId : number] : any },
  inputSourceMap? : Object,
|};

export type RawCoverage = {
  [filePath : string] : RawFileCoverage,
};

export type SerializableError = {|
  code? : mixed,
  message : string,
  stack : ?string,
  type? : string,
|};

export type Status =
  | 'passed'
  | 'failed'
  | 'skipped'
  | 'pending'
  | 'todo'
  | 'disabled';

export type Bytes = number;
export type Milliseconds = number;

type Callsite = {|
  column : number,
  line : number,
|};

export type AssertionResult = {|
  ancestorTitles : Array<string>,
  duration? : ?Milliseconds,
  failureMessages : Array<string>,
  fullName : string,
  invocations? : number,
  location : ?Callsite,
  numPassingAsserts : number,
  status : Status,
  title : string,
|};

export type AggregatedResultWithoutCoverage = {
  numFailedTests : number,
  numFailedTestSuites : number,
  numPassedTests : number,
  numPassedTestSuites : number,
  numPendingTests : number,
  numTodoTests : number,
  numPendingTestSuites : number,
  numRuntimeErrorTestSuites : number,
  numTotalTests : number,
  numTotalTestSuites : number,
  openHandles : Array<Error>,
  snapshot : SnapshotSummary,
  startTime : number,
  success : boolean,
  testResults : Array<TestResult>,
  wasInterrupted : boolean,
};

export type TestResult = {|
  console : ?ConsoleBuffer,
  coverage? : RawCoverage,
  displayName : ?string,
  failureMessage : ?string,
  leaks : boolean,
  memoryUsage? : Bytes,
  numFailingTests : number,
  numPassingTests : number,
  numPendingTests : number,
  numTodoTests : number,
  openHandles : Array<Error>,
  perfStats : {|
    end : Milliseconds,
    start : Milliseconds,
  |},
  skipped : boolean,
  snapshot : {|
    added : number,
    fileDeleted : boolean,
    matched : number,
    unchecked : number,
    uncheckedKeys : Array<string>,
    unmatched : number,
    updated : number,
  |},
  sourceMaps : { [sourcePath : string] : string },
  testExecError? : SerializableError,
  testFilePath : string,
  testResults : Array<AssertionResult>,
|};

export type UncheckedSnapshot = {|
  filePath : string,
  keys : Array<string>,
|};

export type SnapshotSummary = {|
  added : number,
  didUpdate : boolean,
  failure : boolean,
  filesAdded : number,
  filesRemoved : number,
  filesUnmatched : number,
  filesUpdated : number,
  matched : number,
  total : number,
  unchecked : number,
  uncheckedKeysByFile : Array<UncheckedSnapshot>,
  unmatched : number,
  updated : number,
|};