Add testLocationInResults option

CHANGELOG.md

@@ -42,6 +42,7 @@
 * `[jest-runtime]` Support sourcemaps in transformers ([#3458](https://github.com/facebook/jest/pull/3458))
 * `[jest-snapshot]` Add a serializer for `jest.fn` to allow a snapshot of a jest mock ([#4668](https://github.com/facebook/jest/pull/4668))
 * `[jest-worker]` Initial version of parallel worker abstraction, say hello! ([#4497](https://github.com/facebook/jest/pull/4497))
+* `[jest-jasmine2]` Add `testLocationInResults` flag to add location information per spec to test results ([#4782](https://github.com/facebook/jest/pull/4782))
 
 ### Chore & Maintenance
 * `[*]` [**BREAKING**] Drop support for Node.js version 4

docs/CLI.md

@@ -189,6 +189,19 @@ Prevent tests from printing messages through the console.
 
 Alias: `-t`. Run only tests and test suites with a name that matches the regex.  For example, suppose you want to run only tests related to authorization which will have names like `"GET /api/posts with auth"`, then you can use `jest -t=auth`. 
 
+### `--testLocationInResults`
+
+Adds a `location` field to test results. Useful if you want to report the location of a test in a reporter.
+
+Note that `column` is 0-indexed while `line` is not.
+
+```json
+{
+  "column": 4,
+  "line": 5
+}
+``` 
+
 ### `--testPathPattern=<regex>`
 
 A regexp pattern string that is matched against all tests paths before executing the test.

integration_tests/__tests__/__snapshots__/show_config.test.js.snap

@@ -38,6 +38,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
       \\"setupFiles\\": [],
       \\"snapshotSerializers\\": [],
       \\"testEnvironment\\": \\"jest-environment-jsdom\\",
+      \\"testLocationInResults\\": false,
       \\"testMatch\\": [
         \\"**/__tests__/**/*.js?(x)\\",
         \\"**/?(*.)(spec|test).js?(x)\\"

integration_tests/__tests__/location_in_results.test.js

@@ -0,0 +1,33 @@
+/**
+ * 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
+ */
+'use strict';
+
+const runJest = require('../runJest');
+
+it('defaults to null for location', () => {
+  const result = runJest.json('location_in_results').json;
+
+  const assertions = result.testResults[0].assertionResults;
+  expect(result.success).toBe(true);
+  expect(result.numTotalTests).toBe(2);
+  expect(assertions[0].location).toBeNull();
+  expect(assertions[1].location).toBeNull();
+});
+
+it('adds correct location info when provided with flag', () => {
+  const result = runJest.json('location_in_results', [
+    '--testLocationInResults',
+  ]).json;
+
+  const assertions = result.testResults[0].assertionResults;
+  expect(result.success).toBe(true);
+  expect(result.numTotalTests).toBe(2);
+  expect(assertions[0].location).toEqual({column: 1, line: 9});
+  expect(assertions[1].location).toEqual({column: 3, line: 14});
+});

integration_tests/location_in_results/__tests__/test.js

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+'use strict';
+
+it('no ancestors', () => {
+  expect(true).toBeTruthy();
+});
+
+describe('nested', () => {
+  it('also works', () => {
+    expect(true).toBeTruthy();
+  });
+});

integration_tests/location_in_results/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

packages/jest-cli/src/cli/args.js

@@ -451,6 +451,11 @@ export const options = {
     description: 'Exit code of `jest` command if the test run failed',
     type: 'string', // number
   },
+  testLocationInResults: {
+    default: false,
+    description: 'Add `location` information to the test results',
+    type: 'boolean',
+  },
   testMatch: {
     description: 'The glob patterns Jest uses to detect test files.',
     type: 'array',

packages/jest-config/src/defaults.js

@@ -56,6 +56,7 @@ export default ({
   snapshotSerializers: [],
   testEnvironment: 'jest-environment-jsdom',
   testFailureExitCode: 1,
+  testLocationInResults: false,
   testMatch: ['**/__tests__/**/*.js?(x)', '**/?(*.)(spec|test).js?(x)'],
   testPathIgnorePatterns: [NODE_MODULES_REGEXP],
   testRegex: '',

packages/jest-config/src/index.js

@@ -143,6 +143,7 @@ const getConfigs = (
       skipNodeResolution: options.skipNodeResolution,
       snapshotSerializers: options.snapshotSerializers,
       testEnvironment: options.testEnvironment,
+      testLocationInResults: options.testLocationInResults,
       testMatch: options.testMatch,
       testPathIgnorePatterns: options.testPathIgnorePatterns,
       testRegex: options.testRegex,

packages/jest-config/src/normalize.js

@@ -480,6 +480,7 @@ export default function normalize(options: InitialOptions, argv: Argv) {
       case 'skipNodeResolution':
       case 'testEnvironment':
       case 'testFailureExitCode':
+      case 'testLocationInResults':
       case 'testNamePattern':
       case 'testRegex':
       case 'testURL':

packages/jest-config/src/valid_config.js

@@ -78,6 +78,7 @@ export default ({
   snapshotSerializers: ['my-serializer-module'],
   testEnvironment: 'jest-environment-jsdom',
   testFailureExitCode: 1,
+  testLocationInResults: false,
   testMatch: ['**/__tests__/**/*.js?(x)', '**/?(*.)(spec|test).js?(x)'],
   testNamePattern: 'test signature',
   testPathIgnorePatterns: [NODE_MODULES_REGEXP],

packages/jest-jasmine2/package.json

@@ -8,6 +8,7 @@
   "license": "MIT",
   "main": "build/index.js",
   "dependencies": {
+    "callsites": "^2.0.0",
     "chalk": "^2.0.1",
     "expect": "^21.2.1",
     "graceful-fs": "^4.1.11",

packages/jest-jasmine2/src/index.js

@@ -16,6 +16,7 @@ import type Runtime from 'jest-runtime';
 
 import path from 'path';
 import fs from 'fs';
+import callsites from 'callsites';
 import JasmineReporter from './reporter';
 import {install as jasmineAsyncInstall} from './jasmine_async';
 
@@ -44,6 +45,18 @@ async function jasmine2(
   Object.assign(environment.global, jasmineInterface);
   env.addReporter(jasmineInterface.jsApiReporter);
 
+  if (config.testLocationInResults === true) {
+    const originalIt = environment.global.it;
+    environment.global.it = (...args) => {
+      const stack = callsites()[1];
+      const it = originalIt(...args);
+
+      it.result.__callsite = stack;
+
+      return it;
+    };
+  }
+
   jasmineAsyncInstall(environment.global);
 
   environment.global.test = environment.global.it;

packages/jest-jasmine2/src/reporter.js

@@ -24,6 +24,7 @@ type Suite = {
 };
 
 type SpecResult = {
+  __callsite?: Object,
   description: string,
   duration?: Milliseconds,
   failedExpectations: Array<FailedAssertion>,
@@ -150,11 +151,19 @@ export default class Jasmine2Reporter {
     const duration = start ? Date.now() - start : undefined;
     const status =
       specResult.status === 'disabled' ? 'pending' : specResult.status;
+    const location = specResult.__callsite
+      ? {
+          column: specResult.__callsite.getColumnNumber(),
+          // $FlowFixMe: https://github.com/facebook/flow/issues/5213
+          line: specResult.__callsite.getLineNumber(),
+        }
+      : null;
     const results = {
       ancestorTitles,
       duration,
       failureMessages: [],
       fullName: specResult.fullName,
+      location,
       numPassingAsserts: 0, // Jasmine2 only returns an array of failed asserts.
       status,
       title: specResult.description,

packages/jest-util/src/format_test_results.js

@@ -62,6 +62,7 @@ function formatTestAssertion(
     ancestorTitles: assertion.ancestorTitles,
     failureMessages: null,
     fullName: assertion.fullName,
+    location: assertion.location,
     status: assertion.status,
     title: assertion.title,
   };

test_utils.js

@@ -85,6 +85,7 @@ const DEFAULT_PROJECT_CONFIG: ProjectConfig = {
   skipNodeResolution: false,
   snapshotSerializers: [],
   testEnvironment: 'node',
+  testLocationInResults: false,
   testMatch: [],
   testPathIgnorePatterns: [],
   testRegex: '.test.js$',

types/Config.js

@@ -48,6 +48,7 @@ export type DefaultOptions = {|
   snapshotSerializers: Array<Path>,
   testEnvironment: string,
   testFailureExitCode: string | number,
+  testLocationInResults: boolean,
   testMatch: Array<Glob>,
   testPathIgnorePatterns: Array<string>,
   testRegex: string,
@@ -119,6 +120,7 @@ export type InitialOptions = {
   snapshotSerializers?: Array<Path>,
   testEnvironment?: string,
   testFailureExitCode?: string | number,
+  testLocationInResults?: boolean,
   testMatch?: Array<Glob>,
   testNamePattern?: string,
   testPathDirs?: Array<Path>,
@@ -215,6 +217,7 @@ export type ProjectConfig = {|
   snapshotSerializers: Array<Path>,
   testEnvironment: string,
   testMatch: Array<Glob>,
+  testLocationInResults: boolean,
   testPathIgnorePatterns: Array<string>,
   testRegex: string,
   testRunner: string,

types/TestResult.js

@@ -83,11 +83,17 @@ export type Status = 'passed' | 'failed' | 'skipped' | 'pending';
 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,
+  location: ?Callsite,
   numPassingAsserts: number,
   status: Status,
   title: string,
@@ -96,6 +102,7 @@ export type AssertionResult = {|
 export type FormattedAssertionResult = {
   failureMessages: Array<string> | null,
   fullName: string,
+  location: ?Callsite,
   status: Status,
   title: string,
 };