feat: Add GitHub Actions Reporter

CHANGELOG.md

@@ -26,6 +26,7 @@
 - `[jest-mock]` [**BREAKING**] Rename exported utility types `ConstructorLike`, `MethodLike`, `ConstructorLikeKeys`, `MethodLikeKeys`, `PropertyLikeKeys`; remove exports of utility types `ArgumentsOf`, `ArgsType`, `ConstructorArgumentsOf` - TS builtin utility types `ConstructorParameters` and `Parameters` should be used instead ([#12435](https://github.com/facebook/jest/pull/12435))
 - `[jest-mock]` Improve `isMockFunction` to infer types of passed function ([#12442](https://github.com/facebook/jest/pull/12442))
 - `[jest-mock]` Add support for auto-mocking async generator functions ([#11080](https://github.com/facebook/jest/pull/11080))
+- `[jest-reporters]` Add GitHub Actions reporter ([#11320](https://github.com/facebook/jest/pull/11320))
 - `[jest-resolve]` [**BREAKING**] Add support for `package.json` `exports` ([#11961](https://github.com/facebook/jest/pull/11961), [#12373](https://github.com/facebook/jest/pull/12373))
 - `[jest-resolve, jest-runtime]` Add support for `data:` URI import and mock ([#12392](https://github.com/facebook/jest/pull/12392))
 - `[jest-resolve, jest-runtime]` Add support for async resolver ([#11540](https://github.com/facebook/jest/pull/11540))

packages/jest-reporters/package.json

@@ -19,6 +19,7 @@
     "@jest/types": "^28.0.0-alpha.5",
     "@types/node": "*",
     "chalk": "^4.0.0",
+    "ci-info": "^3.2.0",
     "collect-v8-coverage": "^1.0.0",
     "exit": "^0.1.2",
     "glob": "^7.1.2",

packages/jest-reporters/src/GithubActionsReporter.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+
+import {GITHUB_ACTIONS} from 'ci-info';
+import type {AggregatedResult, TestResult} from '@jest/test-result';
+import BaseReporter from './BaseReporter';
+import type {Context} from './types';
+
+const lineAndColumnInStackTrace = /^.*?:([0-9]+):([0-9]+).*$/;
+
+function replaceEntities(s: string): string {
+  const substitutions: Array<[RegExp, string]> = [
+    [/%/, '%25'],
+    [/\r/g, '%0D'],
+    [/\n/g, '%0A'],
+  ];
+  return substitutions.reduce((acc, sub) => acc.replace(...sub), s);
+}
+
+export default class GithubActionsReporter extends BaseReporter {
+  onRunComplete(
+    _contexts?: Set<Context>,
+    aggregatedResults?: AggregatedResult,
+  ): void {
+    if (!GITHUB_ACTIONS) {
+      return;
+    }
+
+    const messages = getMessages(aggregatedResults?.testResults);
+
+    for (const message of messages) {
+      this.log(message);
+    }
+  }
+}
+
+function getMessages(results: Array<TestResult> | undefined) {
+  if (!results) return [];
+
+  return results.reduce(
+    flatMap(({testFilePath, testResults}) =>
+      testResults
+        .filter(r => r.status === 'failed')
+        .reduce(
+          flatMap(r => r.failureMessages),
+          [],
+        )
+        .map(m => replaceEntities(m))
+        .map(m => lineAndColumnInStackTrace.exec(m))
+        .filter((m): m is RegExpExecArray => m !== null)
+        .map(
+          ([message, line, col]) =>
+            `::error file=${testFilePath},line=${line},col=${col}::${message}`,
+        ),
+    ),
+    [],
+  );
+}
+
+function flatMap<In, Out>(map: (x: In) => Array<Out>) {
+  return (out: Array<Out>, entry: In) => out.concat(...map(entry));
+}

packages/jest-reporters/src/__tests__/GithubActionsReporter.test.js

@@ -0,0 +1,127 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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';
+
+let GithubActionsReporter;
+
+const write = process.stderr.write;
+const globalConfig = {
+  rootDir: 'root',
+  watch: false,
+};
+
+let results = [];
+
+function requireReporter() {
+  jest.isolateModules(() => {
+    GithubActionsReporter = require('../GithubActionsReporter').default;
+  });
+}
+
+beforeEach(() => {
+  process.stderr.write = result => results.push(result);
+});
+
+afterEach(() => {
+  results = [];
+  process.stderr.write = write;
+});
+
+const aggregatedResults = {
+  numFailedTestSuites: 1,
+  numFailedTests: 1,
+  numPassedTestSuites: 0,
+  numTotalTestSuites: 1,
+  numTotalTests: 1,
+  snapshot: {
+    added: 0,
+    didUpdate: false,
+    failure: false,
+    filesAdded: 0,
+    filesRemoved: 0,
+    filesRemovedList: [],
+    filesUnmatched: 0,
+    filesUpdated: 0,
+    matched: 0,
+    total: 0,
+    unchecked: 0,
+    uncheckedKeysByFile: [],
+    unmatched: 0,
+    updated: 0,
+  },
+  startTime: 0,
+  success: false,
+  testResults: [
+    {
+      numFailingTests: 1,
+      numPassingTests: 0,
+      numPendingTests: 0,
+      numTodoTests: 0,
+      openHandles: [],
+      perfStats: {
+        end: 1234,
+        runtime: 1234,
+        slow: false,
+        start: 0,
+      },
+      skipped: false,
+      snapshot: {
+        added: 0,
+        fileDeleted: false,
+        matched: 0,
+        unchecked: 0,
+        uncheckedKeys: [],
+        unmatched: 0,
+        updated: 0,
+      },
+      testFilePath: '/home/runner/work/jest/jest/some.test.js',
+      testResults: [
+        {
+          ancestorTitles: [Array],
+          duration: 7,
+          failureDetails: [Array],
+          failureMessages: [
+            `
+              Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n
+              \n
+              Expected: \u001b[32m\"b\"\u001b[39m\n
+              Received: \u001b[31m\"a\"\u001b[39m\n
+                  at Object.<anonymous> (/home/runner/work/jest/jest/some.test.js:4:17)\n
+                  at Object.asyncJestTest (/home/runner/work/jest/jest/node_modules/jest-jasmine2/build/jasmineAsyncInstall.js:106:37)\n
+                  at /home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:45:12\n
+                  at new Promise (<anonymous>)\n
+                  at mapper (/home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:28:19)\n
+                  at /home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:75:41\n
+                  at processTicksAndRejections (internal/process/task_queues.js:93:5)
+            `,
+          ],
+          fullName: 'asserts that a === b',
+          location: null,
+          numPassingAsserts: 0,
+          status: 'failed',
+          title: 'asserts that a === b',
+        },
+      ],
+    },
+  ],
+};
+
+test("reporter returns empty string if GITHUB_ACTIONS isn't set", () => {
+  requireReporter();
+  const testReporter = new GithubActionsReporter(globalConfig);
+  testReporter.onRunComplete(new Set(), aggregatedResults);
+  expect(results.join('').replace(/\\/g, '/')).toMatchSnapshot();
+});
+
+test('reporter extracts the correct filename, line, and column', () => {
+  jest.doMock('ci-info', () => ({GITHUB_ACTIONS: true}));
+
+  requireReporter();
+  const testReporter = new GithubActionsReporter(globalConfig);
+  testReporter.onRunComplete(new Set(), aggregatedResults);
+  expect(results.join('').replace(/\\/g, '/')).toMatchSnapshot();
+});

packages/jest-reporters/src/__tests__/__snapshots__/GithubActionsReporter.test.js.snap

@@ -0,0 +1,8 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`reporter extracts the correct filename, line, and column 1`] = `
+"::error file=/home/runner/work/jest/jest/some.test.js,line=4,col=17::%0A              Error: <dim>expect(</><red>received</><dim>).</>toBe<dim>(</><green>expected</><dim>) // Object.is equality</>%0A%0A              %0A%0A              Expected: <green>"b"</>%0A%0A              Received: <red>"a"</>%0A%0A                  at Object.<anonymous> (/home/runner/work/jest/jest/some.test.js:4:17)%0A%0A                  at Object.asyncJestTest (/home/runner/work/jest/jest/node_modules/jest-jasmine2/build/jasmineAsyncInstall.js:106:37)%0A%0A                  at /home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:45:12%0A%0A                  at new Promise (<anonymous>)%0A%0A                  at mapper (/home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:28:19)%0A%0A                  at /home/runner/work/jest/jest/node_modules/jest-jasmine2/build/queueRunner.js:75:41%0A%0A                  at processTicksAndRejections (internal/process/task_queues.js:93:5)%0A            
+"
+`;
+
+exports[`reporter returns empty string if GITHUB_ACTIONS isn't set 1`] = `""`;

packages/jest-reporters/src/index.ts

@@ -26,6 +26,7 @@ export {default as DefaultReporter} from './DefaultReporter';
 export {default as NotifyReporter} from './NotifyReporter';
 export {default as SummaryReporter} from './SummaryReporter';
 export {default as VerboseReporter} from './VerboseReporter';
+export {default as GithubActionsReporter} from './GithubActionsReporter';
 export type {
   Context,
   Reporter,

yarn.lock

@@ -2743,6 +2743,7 @@ __metadata:
     "@types/node": "*"
     "@types/node-notifier": ^8.0.0
     chalk: ^4.0.0
+    ci-info: ^3.2.0
     collect-v8-coverage: ^1.0.0
     exit: ^0.1.2
     glob: ^7.1.2