@reporters/github 1.4.0 → 1.5.0

package/README.md

@@ -25,11 +25,19 @@ yarn add --dev @reporters/github
 
 ## Result
 
-when test failed, you can see the result as an annotation on the failed line.
+when test failed, annotations will be added inside the github UI, with corresponding errors and diagnostics.
+see [example run](https://github.com/MoLow/reporters/actions/runs/5607828636):
 
-<img width="810" alt="Screen Shot 2022-12-20 at 3 40 36" src="https://user-images.githubusercontent.com/8221854/208561892-28b821b1-1771-4063-baa2-6e14186ae3bf.png">
+#### Inline annotations
 
-additionally, this reporter will add a summary of the tests to the github action.
+<img width="810" alt="Inline Annotation" src="https://user-images.githubusercontent.com/8221854/254798653-0c06278e-696b-42eb-8275-364b7eb3133b.png">
 
-<img width="815" alt="Screen Shot 2022-12-20 at 3 43 47" src="https://user-images.githubusercontent.com/8221854/208561887-c3eccbd8-7506-4a8f-a18c-2892605f3243.png">
+additionally, Annotations and summary will be added to the summary of the test run.
+
+#### Annotations
+
+<img width="810" alt="Annotation" src="https://user-images.githubusercontent.com/8221854/254798495-38c2a8ea-c9e0-4e87-a13e-677826b72192.png">
+
+#### Summary
+<img width="815" alt="Summary" src="https://github.com/MoLow/reporters/assets/8221854/8934f5bb-3342-430c-9ae0-3c608a40c9f0">
 

package/index.js

@@ -13,8 +13,10 @@ const isFile = (name) => name?.startsWith(WORKSPACE);
 const getFilePath = (name) => (isFile(name) ? path.relative(WORKSPACE, require.resolve(name) ?? '') : null);
 
 const parseStack = (error, file) => {
-  const stackLines = (error?.stack ?? '').split(/\r?\n/);
+  const err = error?.code === 'ERR_TEST_FAILURE' ? error?.cause : error;
+  const stackLines = (err?.stack ?? '').split(/\r?\n/);
   const line = stackLines.find((l) => l.includes(file)) ?? stackLines[0];
+
   return line ? stack.parseLine(line) : null;
 };
 
@@ -51,12 +53,14 @@ module.exports = async function githubReporter(source) {
         core.debug(`completed running ${event.data.name}`);
         break;
       case 'test:fail': {
-        const error = util.inspect(
-          event.data.details?.error,
-          { colors: false, breakLength: Infinity },
-        );
-        const location = parseStack(event.data.details?.error, getFilePath(event.data.file));
-        core.error(error, {
+        const error = event.data.details?.error;
+        if (error?.code === 'ERR_TEST_FAILURE' && error?.failureType === 'subtestsFailed') {
+          // this means the failed subtests are already reported
+          // no need to re-annotate the file itself
+          break;
+        }
+        const location = parseStack(error, getFilePath(event.data.file));
+        core.error(util.inspect(error, { colors: false, breakLength: Infinity }), {
           file: location?.file ?? getFilePath(event.data.file),
           startLine: location?.line,
           startColumn: location?.column,
@@ -75,7 +79,6 @@ module.exports = async function githubReporter(source) {
         break;
     }
   }
-  core.startGroup(`Test results (${counter.pass} passed, ${counter.fail} failed)`);
   const formatedDiagnostics = diagnostics.map((d) => {
     const [key, ...rest] = d.split(' ');
     const value = rest.join(' ');
@@ -84,6 +87,7 @@ module.exports = async function githubReporter(source) {
       DIAGNOSTIC_VALUES[key] ? DIAGNOSTIC_VALUES[key](value) : value,
     ];
   });
+  core.startGroup(`Test results (${formatedDiagnostics.find(([key]) => key === DIAGNOSTIC_KEYS.pass)?.[1] ?? counter.pass} passed, ${formatedDiagnostics.find(([key]) => key === DIAGNOSTIC_KEYS.fail)?.[1] ?? counter.fail} failed)`);
   core.notice(formatedDiagnostics.map((d) => d.join(': ')).join(EOL));
   core.endGroup();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reporters/github",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",
@@ -13,6 +13,9 @@
     "@actions/core": "^1.10.0",
     "stack-utils": "^2.0.6"
   },
+  "files": [
+    "./index.js"
+  ],
   "scripts": {
     "test": "node --test-reporter=spec --test-reporter-destination=stdout  --test-reporter=./index.js --test-reporter-destination=stdout --test"
   },

package/CHANGELOG.md

@@ -1,76 +0,0 @@
-# Changelog
-
-## [1.4.0](https://github.com/MoLow/reporters/compare/github-v1.3.0...github-v1.4.0) (2023-07-18)
-
-
-### Features
-
-* support node 18 ([02c8957](https://github.com/MoLow/reporters/commit/02c8957ffca3cb8376f7ad5a94f4627c70b7f8e5))
-
-## [1.3.0](https://github.com/MoLow/reporters/compare/github-v1.2.0...github-v1.3.0) (2023-07-05)
-
-
-### Features
-
-* publish with provenance ([6ee1e46](https://github.com/MoLow/reporters/commit/6ee1e46040329edeb0f40f753093b6952984f001))
-
-## [1.2.0](https://github.com/MoLow/reporters/compare/github-v1.1.3...github-v1.2.0) (2023-05-30)
-
-
-### Features
-
-* report node 20 features ([c99a76c](https://github.com/MoLow/reporters/commit/c99a76c0f6bef75abb2c053c82c88448b0c82690))
-
-## [1.1.3](https://github.com/MoLow/reporters/compare/github-v1.1.2...github-v1.1.3) (2023-04-03)
-
-
-### Bug Fixes
-
-* allow multiple roots ([590df94](https://github.com/MoLow/reporters/commit/590df948f8a4626fc29e8ce185e08d2226a307ba))
-
-## [1.1.2](https://github.com/MoLow/reporters/compare/github-v1.1.1...github-v1.1.2) (2023-02-28)
-
-
-### Bug Fixes
-
-* **github:** remove redundant diagnostics ([b62df32](https://github.com/MoLow/reporters/commit/b62df3280b141af763386a68b0b4e386bef907e7))
-
-## [1.1.1](https://github.com/MoLow/reporters/compare/github-v1.1.0...github-v1.1.1) (2023-02-28)
-
-
-### Bug Fixes
-
-* **github:** silent if not running on github actions ([#33](https://github.com/MoLow/reporters/issues/33)) ([a480454](https://github.com/MoLow/reporters/commit/a480454ac7ca0471744ec00b69a6c67a1d3c8ada))
-
-## [1.1.0](https://github.com/MoLow/reporters/compare/github-v1.0.2...github-v1.1.0) (2023-02-02)
-
-
-### Features
-
-* use reported file ([#30](https://github.com/MoLow/reporters/issues/30)) ([4c70922](https://github.com/MoLow/reporters/commit/4c709222734de88af71c5a086622c3b022d51fd5))
-
-## [1.0.2](https://github.com/MoLow/reporters/compare/github-v1.0.1...github-v1.0.2) (2022-12-25)
-
-
-### Bug Fixes
-
-* fix package description ([cec07c7](https://github.com/MoLow/reporters/commit/cec07c70d37b3ed43947b17312a6bd58f095510f))
-* some package.json links ([c51a616](https://github.com/MoLow/reporters/commit/c51a61648e29f5baca539ded1b09c2af3f5e0a4a))
-
-## [1.0.1](https://github.com/MoLow/reporters/compare/github-v1.0.0...github-v1.0.1) (2022-12-20)
-
-
-### Bug Fixes
-
-* fix monorepos release ([8386ef0](https://github.com/MoLow/reporters/commit/8386ef0ea7bfe0c0325e171aa7122eeccb17bad3))
-* fix monorepos release ([3c5ee61](https://github.com/MoLow/reporters/commit/3c5ee6126fe961363b3feccf1ba6594a0849855b))
-* fix monorepos release ([7eebffb](https://github.com/MoLow/reporters/commit/7eebffb46ab627beaa2b10023a08dd3271f819e9))
-* fix monorepos release ([9c66f37](https://github.com/MoLow/reporters/commit/9c66f37b010f782e70c3cdf2bf827d30c4aa71c2))
-* fix monorepos release ([d844919](https://github.com/MoLow/reporters/commit/d844919c8684216155b8f1c0acc98d907b3a5cdb))
-* fix monorepos release ([d5610e2](https://github.com/MoLow/reporters/commit/d5610e29db730dc4ffa3f9721a85d5f3c7749b2c))
-* fix typo ([#22](https://github.com/MoLow/reporters/issues/22)) ([0308fac](https://github.com/MoLow/reporters/commit/0308fac968799a0fd877460deeaa5503bc53d09f))
-* reset changelogs ([1e114ce](https://github.com/MoLow/reporters/commit/1e114ced7201cf9897f2cf79b5a4fb46f1b085fb))
-
-## 1.0.0 (2022-12-19)
-
-Initial release

package/tests/index.test.js

@@ -1,31 +0,0 @@
-const { test, describe } = require('node:test');
-const { spawnSync } = require('child_process');
-const { tmpdir } = require('os');
-const { join } = require('path');
-const assert = require('assert');
-const path = require('path');
-const { readFileSync, writeFileSync } = require('fs');
-const { compareLines } = require('../../../tests/utils');
-// eslint-disable-next-line import/no-dynamic-require
-const output = require(`./output.${process.version.split('.')[0]}`);
-
-const GITHUB_STEP_SUMMARY = join(tmpdir(), 'github-actions-test-reporter');
-writeFileSync(GITHUB_STEP_SUMMARY, '');
-
-describe('github reporter', () => {
-  const child = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], {
-    env: { GITHUB_ACTIONS: true, GITHUB_STEP_SUMMARY, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
-  });
-
-  test('spwan with reporter', () => {
-    assert.strictEqual(child.stderr?.toString(), '');
-    compareLines(child.stdout?.toString(), output.stdout);
-    compareLines(readFileSync(GITHUB_STEP_SUMMARY).toString(), output.summary);
-  });
-
-  test('should noop if not in github actions', () => {
-    const silentChild = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], { env: { } });
-    assert.strictEqual(silentChild.stderr?.toString(), '');
-    assert.strictEqual(silentChild.stdout?.toString(), '');
-  });
-});

package/tests/output.v18.js

@@ -1,26 +0,0 @@
-module.exports = {
-  stdout: `::debug::starting to run tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::starting to run fails
-::error title=fails,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {%0A  failureType: 'testCodeFailure',%0A  cause: Error: this is an error%0A      at .*.<anonymous> (.*/example.js:6:11).*
-::debug::starting to run is a diagnostic
-::debug::completed running is a diagnostic
-::notice file=tests/example.js::this is a diagnostic
-::error title=tests,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
-::debug::starting to run more tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::completed running more tests
-::debug::starting to run is skipped
-::debug::completed running is skipped
-::debug::starting to run is a todo
-::debug::completed running is a todo
-::group::Test results \\(6 passed, 2 failed\\)
-::notice::Total Tests: 6%0ASuites 📂: 2%0APassed ✅: 3%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 1%0ATodo 📝: 1%0ADuration 🕐: .*ms
-::endgroup::
-`,
-  summary: `<h1>Test Results</h1>
-<table><tr><td>Total Tests</td><td>6</td></tr><tr><td>Suites 📂</td><td>2</td></tr><tr><td>Passed ✅</td><td>3</td></tr><tr><td>Failed ❌</td><td>1</td></tr><tr><td>Canceled 🚫</td><td>0</td></tr><tr><td>Skipped ⏭️</td><td>1</td></tr><tr><td>Todo 📝</td><td>1</td></tr><tr><td>Duration 🕐</td><td>.*ms</td></tr></table>
-`,
-};

package/tests/output.v19.js

@@ -1,26 +0,0 @@
-module.exports = {
-  stdout: `::debug::starting to run tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::starting to run fails
-::error title=fails,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {%0A  failureType: 'testCodeFailure',%0A  cause: Error: this is an error%0A      at .*.<anonymous> (.*/example.js:6:11).*
-::debug::starting to run is a diagnostic
-::debug::completed running is a diagnostic
-::notice file=tests/example.js::this is a diagnostic
-::error title=tests,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
-::debug::starting to run more tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::completed running more tests
-::debug::starting to run is skipped
-::debug::completed running is skipped
-::debug::starting to run is a todo
-::debug::completed running is a todo
-::group::Test results \\(6 passed, 2 failed\\)
-::notice::Total Tests: 6%0ASuites 📂: 2%0APassed ✅: 3%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 1%0ATodo 📝: 1%0ADuration 🕐: .*ms
-::endgroup::
-`,
-  summary: `<h1>Test Results</h1>
-<table><tr><td>Total Tests</td><td>6</td></tr><tr><td>Suites 📂</td><td>2</td></tr><tr><td>Passed ✅</td><td>3</td></tr><tr><td>Failed ❌</td><td>1</td></tr><tr><td>Canceled 🚫</td><td>0</td></tr><tr><td>Skipped ⏭️</td><td>1</td></tr><tr><td>Todo 📝</td><td>1</td></tr><tr><td>Duration 🕐</td><td>.*ms</td></tr></table>
-`,
-};

package/tests/output.v20.js

@@ -1,26 +0,0 @@
-module.exports = {
-  stdout: `::debug::starting to run tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::starting to run fails
-::error title=fails,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {%0A  failureType: 'testCodeFailure',%0A  cause: Error: this is an error%0A      at .*.<anonymous> (.*/example.js:6:11).*
-::debug::starting to run is a diagnostic
-::debug::completed running is a diagnostic
-::notice file=tests/example.js::this is a diagnostic
-::error title=tests,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
-::debug::starting to run more tests
-::debug::starting to run is ok
-::debug::completed running is ok
-::debug::completed running more tests
-::debug::starting to run is skipped
-::debug::completed running is skipped
-::debug::starting to run is a todo
-::debug::completed running is a todo
-::group::Test results \\(6 passed, 2 failed\\)
-::notice::Total Tests: 6%0ASuites 📂: 2%0APassed ✅: 3%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 1%0ATodo 📝: 1%0ADuration 🕐: .*ms
-::endgroup::
-`,
-  summary: `<h1>Test Results</h1>
-<table><tr><td>Total Tests</td><td>6</td></tr><tr><td>Suites 📂</td><td>2</td></tr><tr><td>Passed ✅</td><td>3</td></tr><tr><td>Failed ❌</td><td>1</td></tr><tr><td>Canceled 🚫</td><td>0</td></tr><tr><td>Skipped ⏭️</td><td>1</td></tr><tr><td>Todo 📝</td><td>1</td></tr><tr><td>Duration 🕐</td><td>.*ms</td></tr></table>
-`,
-};