@reporters/github 1.0.1 → 1.1.0

package/CHANGELOG.md

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

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/);
@@ -35,37 +35,32 @@ const DIAGNOSTIC_VALUES = {
 module.exports = async function githubReporter(source) {
   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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reporters/github",
-  "version": "1.0.1",
-  "description": "A junit reporter for `node:test`",
+  "version": "1.1.0",
+  "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",
     "node:test",
@@ -14,9 +14,13 @@
     "stack-utils": "^2.0.6"
   },
   "scripts": {
-    "test": "node tests/index.test.js"
+    "test": "node --test-reporter=spec --test"
+  },
+  "bugs": {
+    "url": "https://github.com/MoLow/reporters/issues"
   },
   "main": "index.js",
+  "homepage": "https://github.com/MoLow/reporters/tree/main/packages/github",
   "repository": "https://github.com/MoLow/reporters.git",
   "author": "Moshe Atlow",
   "license": "MIT"

package/tests/index.test.js

@@ -1,6 +1,19 @@
-const events = require('./events');
-const reporter = require('../index');
+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');
 
-// use the reporter manually until --test-reporter is released
-process.env.GITHUB_STEP_SUMMARY ??= '/dev/null';
-reporter(events);
+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, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
+});
+
+assert.strictEqual(child.stderr?.toString(), '');
+compareLines(child.stdout?.toString(), output.stdout);
+compareLines(readFileSync(GITHUB_STEP_SUMMARY).toString(), output.summary);

package/tests/output.js

@@ -0,0 +1,22 @@
+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 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::
+`,
+  summary: `<h1>Test Results</h1>
+<table><tr><td>Total Tests</td><td>1</td></tr><tr><td>Passed ✅</td><td>0</td></tr><tr><td>Failed ❌</td><td>1</td></tr><tr><td>Canceled 🚫</td><td>0</td></tr><tr><td>Skipped ⏭️</td><td>0</td></tr><tr><td>Todo 📝</td><td>0</td></tr><tr><td>Duration</td><td>.*ms</td></tr></table>
+`,
+};

package/tests/events.js

@@ -1,170 +0,0 @@
-const WORKSPACE = process.env.GITHUB_WORKSPACE ?? '';
-
-module.exports = [
-  {
-    type: 'test:start',
-    data: {
-      nesting: 0,
-      name: `${WORKSPACE}/tests/fixtures/example.js`,
-    },
-  },
-  {
-    type: 'test:start',
-    data: {
-      nesting: 1,
-      name: 'tests',
-    },
-  },
-  {
-    type: 'test:start',
-    data: {
-      nesting: 2,
-      name: 'is ok',
-    },
-  },
-  {
-    type: 'test:pass',
-    data: {
-      name: 'is ok',
-      nesting: 2,
-      testNumber: '1',
-      details: {
-        duration_ms: 0.139292,
-      },
-    },
-  },
-  {
-    type: 'test:start',
-    data: {
-      nesting: 2,
-      name: 'fails',
-    },
-  },
-  {
-    type: 'test:fail',
-    data: {
-      name: 'fails',
-      nesting: 2,
-      testNumber: '2',
-      details: {
-        duration_ms: 0.275709,
-        error: Object.assign(new Error(''), {
-          failureType: 'testCodeFailure',
-          cause: {
-            code: 'ERR_TEST_FAILURE',
-          },
-          code: 'ERR_TEST_FAILURE',
-          stack: `    at Object.<anonymous> (${WORKSPACE}/tests/fixtures/example.js:6:11)\n    at ItTest.runInAsyncScope (node:async_hooks:204:9)\n    ... 5 lines matching cause stack trace ...\n    at async Suite.run (node:internal/test_runner/test:798:7) {\n  failureType: 'testCodeFailure',\n  cause:     at Object.<anonymous> (${WORKSPACE}/tests/fixtures/example.js:6:11)\n      at ItTest.runInAsyncScope (node:async_hooks:204:9)\n      at ItTest.run (node:internal/test_runner/test:547:25)\n      at Suite.processPendingSubtests (node:internal/test_runner/test:302:27)\n      at ItTest.postRun (node:internal/test_runner/test:632:19)\n      at ItTest.run (node:internal/test_runner/test:575:10)\n      at async Promise.all (index 0)\n      at async Suite.run (node:internal/test_runner/test:798:7)`,
-        }),
-      },
-    },
-  },
-  {
-    type: 'test:plan',
-    data: {
-      nesting: 2,
-      count: 2,
-    },
-  },
-  {
-    type: 'test:fail',
-    data: {
-      name: 'tests',
-      nesting: 1,
-      testNumber: '1',
-      details: {
-        duration_ms: 2.925542,
-        error: Object.assign(new Error('1 subtest failed'), {
-          failureType: 'subtestsFailed',
-          cause: {
-            code: 'ERR_TEST_FAILURE',
-          },
-          code: 'ERR_TEST_FAILURE',
-          stack: '',
-        }),
-      },
-    },
-  },
-  {
-    type: 'test:plan',
-    data: {
-      nesting: 1,
-      count: 1,
-    },
-  },
-  {
-    type: 'test:fail',
-    data: {
-      name: `${WORKSPACE}/tests/fixtures/example.js`,
-      nesting: 0,
-      testNumber: 1,
-      details: {
-        duration_ms: 86.369584,
-        error: Object.assign(new Error('test failed'), {
-          failureType: 'subtestsFailed',
-          cause: 'test failed',
-          code: 'ERR_TEST_FAILURE',
-          exitCode: 1,
-          signal: null,
-          stack: '',
-        }),
-      },
-    },
-  },
-  {
-    type: 'test:plan',
-    data: {
-      nesting: 0,
-      count: 1,
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'tests 1',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'pass 0',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'fail 1',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'cancelled 0',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'skipped 0',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'todo 0',
-    },
-  },
-  {
-    type: 'test:diagnostic',
-    data: {
-      nesting: 0,
-      message: 'duration_ms 87.068833',
-    },
-  },
-];