@reporters/github 1.0.2 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
 
 

package/index.js

@@ -10,7 +10,7 @@ const stack = new StackUtils({ cwd: WORKSPACE, internals: StackUtils.nodeInterna
 
 const isFile = (name) => name?.startsWith(WORKSPACE);
 
-const getCurrentFile = (name) => (isFile(name) ? path.relative(WORKSPACE, name) : null);
+const getFilePath = (name) => (isFile(name) ? path.relative(WORKSPACE, require.resolve(name) ?? '') : null);
 
 const parseStack = (error, file) => {
   const stackLines = (error?.stack ?? '').split(/\r?\n/);
@@ -33,39 +33,39 @@ const DIAGNOSTIC_VALUES = {
 };
 
 module.exports = async function githubReporter(source) {
+  if (!process.env.GITHUB_ACTIONS) {
+    // eslint-disable-next-line no-unused-vars
+    for await (const _ of source);
+    return;
+  }
   const counter = { pass: 0, fail: 0 };
   const diagnostics = [];
-  let currentFile = null;
   for await (const event of source) {
     switch (event.type) {
       case 'test:start':
-        currentFile = getCurrentFile(event.data.name) || currentFile;
         core.debug(`starting to run ${event.data.name}`);
         break;
       case 'test:pass':
         counter.pass += 1;
         core.debug(`completed running ${event.data.name}`);
-        currentFile = isFile(event.data.name) ? null : currentFile;
         break;
       case 'test:fail': {
         const error = util.inspect(
           event.data.details?.error,
           { colors: false, breakLength: Infinity },
         );
-        const location = parseStack(event.data.details?.error, currentFile);
+        const location = parseStack(event.data.details?.error, getFilePath(event.data.file));
         core.error(error, {
-          file: location?.file ?? currentFile,
+          file: location?.file ?? getFilePath(event.data.file),
           startLine: location?.line,
           startColumn: location?.column,
           title: event.data.name,
         });
         counter.fail += 1;
-        currentFile = isFile(event.data.name) ? null : currentFile;
         break;
       } case 'test:diagnostic':
-        if (currentFile) {
-          core.notice(event.data.message, { file: currentFile });
-        } else {
+        core.notice(event.data.message, { file: getFilePath(event.data.file) });
+        if (event.data.nesting === 0) {
           diagnostics.push(event.data.message);
         }
         break;
@@ -85,8 +85,10 @@ module.exports = async function githubReporter(source) {
   core.notice(formatedDiagnostics.map((d) => d.join(': ')).join(EOL));
   core.endGroup();
 
-  await core.summary
-    .addHeading('Test Results')
-    .addTable(formatedDiagnostics)
-    .write();
+  if (process.env.GITHUB_STEP_SUMMARY) {
+    await core.summary
+      .addHeading('Test Results')
+      .addTable(formatedDiagnostics)
+      .write();
+  }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reporters/github",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",
@@ -14,7 +14,7 @@
     "stack-utils": "^2.0.6"
   },
   "scripts": {
-    "test": "../../prebuilt --test"
+    "test": "node --test-reporter=spec --test-reporter-destination=stdout  --test-reporter=./index.js --test-reporter-destination=stdout --test"
   },
   "bugs": {
     "url": "https://github.com/MoLow/reporters/issues"

package/tests/index.test.js

@@ -2,6 +2,7 @@ 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');
 const output = require('./output');
@@ -10,7 +11,7 @@ const GITHUB_STEP_SUMMARY = join(tmpdir(), 'github-actions-test-reporter');
 writeFileSync(GITHUB_STEP_SUMMARY, '');
 
 const child = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], {
-  env: { GITHUB_STEP_SUMMARY },
+  env: { GITHUB_ACTIONS: true, GITHUB_STEP_SUMMARY, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
 });
 
 assert.strictEqual(child.stderr?.toString(), '');

package/tests/output.js

@@ -3,8 +3,15 @@ module.exports = {
 ::debug::starting to run is ok
 ::debug::completed running is ok
 ::debug::starting to run fails
-::error title=fails,file=fails::\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {%0A  failureType: 'testCodeFailure',%0A  cause: Error: this is an error%0A      at Object.<anonymous> (.*/example.js:6:11).*
-::error title=tests::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
+::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 Object.<anonymous> (.*/example.js:6:11).*
+::error title=tests,file=tests/example.js::\\[Error \\[ERR_TEST_FAILURE\\]: 1 subtest failed\\] { failureType: 'subtestsFailed', cause: '1 subtest failed', code: 'ERR_TEST_FAILURE' }
+::notice file=tests/example.js::tests 1
+::notice file=tests/example.js::pass 0
+::notice file=tests/example.js::fail 1
+::notice file=tests/example.js::cancelled 0
+::notice file=tests/example.js::skipped 0
+::notice file=tests/example.js::todo 0
+::notice file=tests/example.js::duration_ms .*
 ::group::Test results \\(1 passed, 2 failed\\)
 ::notice::Total Tests: 1%0APassed ✅: 0%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 0%0ATodo 📝: 0%0ADuration: .*ms
 ::endgroup::