@reporters/github 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [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/README.md

@@ -1,6 +1,8 @@
+[![npm version](https://img.shields.io/npm/v/@reporters/github)](https://www.npmjs.com/package/@reporters/github) ![tests](https://github.com/MoLow/reporters/actions/workflows/test.yaml/badge.svg?branch=main)
+
 # Github Actions Reporter
 A Github actions reporter for `node:test`
-
+ 
 ## Installation
 
 ```bash
@@ -13,15 +15,22 @@ yarn add --dev @reporters/github
 
 ## Usage
 
-```bash
-node --test \
-  --test-reporter=@reporters/github --test-reporter-destination=stdout \
-  --test-reporter=spec --test-reporter-destination=stdout
+```yaml
+# .github/workflows/test.yml
+- name: Run tests
+  run: node --test \
+    --test-reporter=@reporters/github --test-reporter-destination=stdout \
+    --test-reporter=spec --test-reporter-destination=stdout
 ```
 
-## Features
+## Result
+
+when test failed, you can see the result as an annotation on the failed line.
+
+<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">
+
+additionally, this reporter will add a summary of the tests to the github action.
 
-### annotations
+<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">
 
-### summary
 

package/index.js

@@ -1,6 +1,7 @@
 const path = require('node:path');
 const util = require('node:util');
 const { EOL } = require('node:os');
+const core = require('@actions/core');
 const StackUtils = require('stack-utils');
 
 const WORKSPACE = process.env.GITHUB_WORKSPACE ?? '';
@@ -17,29 +18,19 @@ const parseStack = (error, file) => {
   return line ? stack.parseLine(line) : null;
 };
 
-const escapeData = (s = '') => s
-  .replace(/%/g, '%25')
-  .replace(/\r/g, '%0D')
-  .replace(/\n/g, '%0A');
-
-const escapeProperty = (s = '') => escapeData(s)
-  .replace(/:/g, '%3A')
-  .replace(/,/g, '%2C');
-
-const propsToString = (props = {}) => {
-  const entries = Object.entries(props);
-  if (entries.length === 0) {
-    return '';
-  }
-
-  const result = entries
-    .filter(([, value]) => Boolean(value))
-    .map(([key, value]) => `${key}=${escapeProperty(String(value))}`).join(',');
-
-  return ` ${result}`;
+const DIAGNOSTIC_KEYS = {
+  tests: 'Total Tests',
+  pass: 'Passed ✅',
+  fail: 'Failed ❌',
+  cancelled: 'Canceled 🚫',
+  skipped: 'Skipped ⏭️',
+  todo: 'Todo 📝',
+  duration_ms: 'Duration',
 };
 
-const report = (command, message, pros) => process.stdout.write(`::${command}${propsToString(pros)}::${escapeData(message)}${EOL}`);
+const DIAGNOSTIC_VALUES = {
+  duration_ms: (value) => `${Number(value).toFixed(3)}ms`,
+};
 
 module.exports = async function githubReporter(source) {
   const counter = { pass: 0, fail: 0 };
@@ -49,11 +40,11 @@ module.exports = async function githubReporter(source) {
     switch (event.type) {
       case 'test:start':
         currentFile = getCurrentFile(event.data.name) || currentFile;
-        report('debug', `starting to run ${event.data.name}`);
+        core.debug(`starting to run ${event.data.name}`);
         break;
       case 'test:pass':
         counter.pass += 1;
-        report('debug', `completed running ${event.data.name}`);
+        core.debug(`completed running ${event.data.name}`);
         currentFile = isFile(event.data.name) ? null : currentFile;
         break;
       case 'test:fail': {
@@ -62,10 +53,10 @@ module.exports = async function githubReporter(source) {
           { colors: false, breakLength: Infinity },
         );
         const location = parseStack(event.data.details?.error, currentFile);
-        report('error', error, {
+        core.error(error, {
           file: location?.file ?? currentFile,
-          line: location?.line,
-          col: location?.column,
+          startLine: location?.line,
+          startColumn: location?.column,
           title: event.data.name,
         });
         counter.fail += 1;
@@ -73,7 +64,7 @@ module.exports = async function githubReporter(source) {
         break;
       } case 'test:diagnostic':
         if (currentFile) {
-          report('notice', event.data.message, { file: currentFile });
+          core.notice(event.data.message, { file: currentFile });
         } else {
           diagnostics.push(event.data.message);
         }
@@ -82,7 +73,20 @@ module.exports = async function githubReporter(source) {
         break;
     }
   }
-  report('group', `Test results (${counter.pass} passed, ${counter.fail} failed)`);
-  report('notice', diagnostics.join(EOL));
-  report('endgroup');
+  core.startGroup(`Test results (${counter.pass} passed, ${counter.fail} failed)`);
+  const formatedDiagnostics = diagnostics.map((d) => {
+    const [key, ...rest] = d.split(' ');
+    const value = rest.join(' ');
+    return [
+      DIAGNOSTIC_KEYS[key] ?? key,
+      DIAGNOSTIC_VALUES[key] ? DIAGNOSTIC_VALUES[key](value) : value,
+    ];
+  });
+  core.notice(formatedDiagnostics.map((d) => d.join(': ')).join(EOL));
+  core.endGroup();
+
+  await core.summary
+    .addHeading('Test Results')
+    .addTable(formatedDiagnostics)
+    .write();
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reporters/github",
-  "version": "1.0.0",
-  "description": "A junit reporter for `node:test`",
+  "version": "1.0.2",
+  "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",
     "node:test",
@@ -10,9 +10,17 @@
     "reporters"
   ],
   "dependencies": {
+    "@actions/core": "^1.10.0",
     "stack-utils": "^2.0.6"
   },
+  "scripts": {
+    "test": "../../prebuilt --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

@@ -0,0 +1,18 @@
+const { spawnSync } = require('child_process');
+const { tmpdir } = require('os');
+const { join } = require('path');
+const assert = require('assert');
+const { readFileSync, writeFileSync } = require('fs');
+const { compareLines } = require('../../../tests/utils');
+const output = require('./output');
+
+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 },
+});
+
+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,15 @@
+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=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' }
+::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>
+`,
+};