@reporters/github 1.1.3 → 1.3.0

package/CHANGELOG.md

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

package/README.md

@@ -33,4 +33,3 @@ additionally, this reporter will add a summary of the tests to the github action
 
 <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">
 
-

package/index.js

@@ -20,12 +20,13 @@ const parseStack = (error, file) => {
 
 const DIAGNOSTIC_KEYS = {
   tests: 'Total Tests',
+  suites: 'Suites 📂',
   pass: 'Passed ✅',
   fail: 'Failed ❌',
   cancelled: 'Canceled 🚫',
   skipped: 'Skipped ⏭️',
   todo: 'Todo 📝',
-  duration_ms: 'Duration',
+  duration_ms: 'Duration 🕐',
 };
 
 const DIAGNOSTIC_VALUES = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reporters/github",
-  "version": "1.1.3",
+  "version": "1.3.0",
   "description": "A github actions reporter for `node:test`",
   "keywords": [
     "github actions",

package/tests/index.test.js

@@ -1,3 +1,4 @@
+const { test, describe } = require('node:test');
 const { spawnSync } = require('child_process');
 const { tmpdir } = require('os');
 const { join } = require('path');
@@ -5,19 +6,26 @@ const assert = require('assert');
 const path = require('path');
 const { readFileSync, writeFileSync } = require('fs');
 const { compareLines } = require('../../../tests/utils');
-const output = require('./output');
+// 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, '');
 
-const child = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], {
-  env: { GITHUB_ACTIONS: true, GITHUB_STEP_SUMMARY, GITHUB_WORKSPACE: path.resolve(__dirname, '../../../') },
-});
+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, '../../../') },
+  });
 
-assert.strictEqual(child.stderr?.toString(), '');
-compareLines(child.stdout?.toString(), output.stdout);
-compareLines(readFileSync(GITHUB_STEP_SUMMARY).toString(), output.summary);
+  test('spwan with reporter', () => {
+    assert.strictEqual(child.stderr?.toString(), '');
+    compareLines(child.stdout?.toString(), output.stdout);
+    compareLines(readFileSync(GITHUB_STEP_SUMMARY).toString(), output.summary);
+  });
 
-const silentChild = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example'], { env: { } });
-assert.strictEqual(silentChild.stderr?.toString(), '');
-assert.strictEqual(silentChild.stdout?.toString(), '');
+  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.js → output.v18.js}

@@ -12,11 +12,15 @@ module.exports = {
 ::debug::starting to run is ok
 ::debug::completed running is ok
 ::debug::completed running more tests
-::group::Test results \\(4 passed, 2 failed\\)
-::notice::Total Tests: 2%0APassed ✅: 1%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 0%0ATodo 📝: 0%0ADuration: .*ms
+::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: 4%0APassed ✅: 1%0AFailed ❌: 1%0ACanceled 🚫: 0%0ASkipped ⏭️: 1%0ATodo 📝: 1%0ADuration 🕐: .*ms
 ::endgroup::
 `,
   summary: `<h1>Test Results</h1>
-<table><tr><td>Total Tests</td><td>2</td></tr><tr><td>Passed ✅</td><td>1</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>
+<table><tr><td>Total Tests</td><td>4</td></tr><tr><td>Passed ✅</td><td>1</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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,26 @@
+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>
+`,
+};