@reporters/junit 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.0.3](https://github.com/MoLow/reporters/compare/junit-v1.0.2...junit-v1.0.3) (2023-03-12)
+
+
+### Bug Fixes
+
+* **junit:** support more usecases ([72359c3](https://github.com/MoLow/reporters/commit/72359c3983334d7712c4d404a0ae297b9ef9e859))
+
+## [1.0.2](https://github.com/MoLow/reporters/compare/junit-v1.0.1...junit-v1.0.2) (2022-12-25)
+
+
+### Bug Fixes
+
+* some package.json links ([c51a616](https://github.com/MoLow/reporters/commit/c51a61648e29f5baca539ded1b09c2af3f5e0a4a))
+
 ## [1.0.1](https://github.com/MoLow/reporters/compare/junit-v1.0.0...junit-v1.0.1) (2022-12-20)
 
 

package/README.md

@@ -1,6 +1,7 @@
-[![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)
+[![npm version](https://img.shields.io/npm/v/@reporters/junit)](https://www.npmjs.com/package/@reporters/junit) ![tests](https://github.com/MoLow/reporters/actions/workflows/test.yaml/badge.svg?branch=main)
 # Junit Reporter
-A Junit reporter for `node:test`
+A Junit reporter for `node:test`.
+intendend for use with major CI tools like Jenkins, CircleCI, etc that consume Junit reports.
 
 ## Installation
 
@@ -22,3 +23,39 @@ node --test \
 
 ## Example 
 
+Ouput of the following test file:
+
+```js
+const { describe, it } = require('node:test');
+
+describe('tests', () => {
+  it('is ok', () => {});
+  it('fails', () => {
+    throw new Error('this is an error');
+  });
+});
+```
+
+```xml
+  <testsuite name="tests" time="0.00239" disabled="0" errors="0" tests="2" failures="1" skipped="0" hostname="PC.localdomain">
+    <testcase name="is ok" time="0.00057" classname="test"></testcase>
+    <testcase name="fails" time="0.00017" classname="test" failure="this is an error">
+      <failure message="this is an error" type="testCodeFailure">
+[Error [ERR_TEST_FAILURE]: this is an error] {
+  failureType: 'testCodeFailure',
+  cause: Error: this is an error
+      at Object.&lt;anonymous&gt; (/Users/test/reporters/tests/example.js:6:11)
+      at ItTest.runInAsyncScope (node:async_hooks:204:9)
+      at ItTest.run (node:internal/test_runner/test:547:25)
+      at Suite.processPendingSubtests (node:internal/test_runner/test:302:27)
+      at ItTest.postRun (node:internal/test_runner/test:632:19)
+      at ItTest.run (node:internal/test_runner/test:575:10)
+      at async Promise.all (index 0)
+      at async Suite.run (node:internal/test_runner/test:798:7),
+  code: 'ERR_TEST_FAILURE'
+}
+      </failure>
+    </testcase>
+  </testsuite>
+</testsuites>
+```

package/index.js

@@ -1,4 +1,3 @@
-const assert = require('node:assert');
 const util = require('node:util');
 const { hostname } = require('node:os');
 
@@ -14,7 +13,7 @@ function escapeContent(s = '') {
 
 function treeToXML(tree) {
   if (typeof tree === 'string') {
-    return escapeContent(tree);
+    return `${escapeContent(tree)}\n`;
   }
   const {
     tag, props, nesting, children,
@@ -22,12 +21,12 @@ function treeToXML(tree) {
   const propsString = Object.entries(props)
     .map(([key, value]) => `${key}="${escapeProperty(String(value))}"`)
     .join(' ');
-  const indent = '  '.repeat(nesting + 1);
-  const newLine = children?.length ? '\n' : '';
-  const postIndent = newLine ? indent : '';
-  const postNewLine = newLine ? '' : '\n';
-  const childrenString = `${newLine}${(children ?? []).map(treeToXML).join('')}${newLine}${postIndent}`;
-  return `${indent}<${tag} ${propsString}>${childrenString}</${tag}>${postNewLine}`;
+  const indent = '\t'.repeat(nesting + 1);
+  if (!children?.length) {
+    return `${indent}<${tag} ${propsString}/>\n`;
+  }
+  const childrenString = `${(children ?? []).map(treeToXML).join('')}`;
+  return `${indent}<${tag} ${propsString}>\n${childrenString}${indent}</${tag}>\n`;
 }
 
 function isFailure(node) {
@@ -42,27 +41,38 @@ module.exports = async function* junitReporter(source) {
   yield '<?xml version="1.0" encoding="utf-8"?>\n';
   yield '<testsuites>\n';
   let currentSuite = null;
+
+  function startTest(event) {
+    const originalSuite = currentSuite;
+    currentSuite = {
+      props: { name: event.data.name },
+      nesting: event.data.nesting,
+      parent: currentSuite,
+      children: [],
+    };
+    originalSuite?.children.push(currentSuite);
+  }
+
   for await (const event of source) {
     switch (event.type) {
       case 'test:start': {
-        const originalSuite = currentSuite;
-        currentSuite = {
-          props: { name: event.data.name },
-          nesting: event.data.nesting,
-          parent: currentSuite,
-          children: [],
-        };
-        originalSuite?.children.push(currentSuite);
+        startTest(event);
         break;
       }
       case 'test:pass':
       case 'test:fail': {
+        if (!currentSuite) {
+          startTest({ data: { name: 'root', nesting: 0 } });
+        }
+        if (currentSuite.props.name !== event.data.name
+          || currentSuite.nesting !== event.data.nesting) {
+          startTest(event);
+        }
         const currentTest = currentSuite;
         if (currentSuite?.nesting === event.data.nesting && currentSuite?.parent) {
           currentSuite = currentSuite.parent;
         }
-        assert.strictEqual(currentTest.props.name, event.data.name);
-        currentTest.props.time = (event.data.details.duration_ms / 1000).toFixed(5);
+        currentTest.props.time = (event.data.details.duration_ms / 1000).toFixed(6);
         if (currentTest.children.length > 0) {
           currentTest.tag = 'testsuite';
           currentTest.props.disabled = 0;
@@ -73,19 +83,19 @@ module.exports = async function* junitReporter(source) {
           currentTest.props.hostname = HOSTNAME;
         } else {
           currentTest.tag = 'testcase';
-          currentTest.props.classname = 'test';
+          currentTest.props.classname = event.data.classname ?? 'test';
           if (event.data.skip) {
-            currentTest.children.push({ nesting: event.data.nesting + 1, tag: 'skipped', props: { message: event.data.skip } });
+            currentTest.children.push({ nesting: event.data.nesting + 1, tag: 'skipped', props: { type: 'skipped', message: event.data.skip } });
           }
           if (event.data.todo) {
-            currentTest.children.push({ nesting: event.data.nesting + 1, tag: 'skipped', props: { message: event.data.todo } });
+            currentTest.children.push({ nesting: event.data.nesting + 1, tag: 'skipped', props: { type: 'todo', message: event.data.todo } });
           }
           if (event.type === 'test:fail') {
             const error = event.data.details?.error;
             currentTest.children.push({
               nesting: event.data.nesting + 1,
               tag: 'failure',
-              props: { message: error?.message ?? '', type: error.failureType || error.code },
+              props: { type: error?.failureType || error?.code, message: error?.message ?? '' },
               children: [util.inspect(
                 event.data.details?.error,
                 { colors: false, breakLength: Infinity },
@@ -104,5 +114,5 @@ module.exports = async function* junitReporter(source) {
     }
   }
   yield treeToXML(currentSuite);
-  yield '\n</testsuites>\n';
+  yield '</testsuites>\n';
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reporters/junit",
-  "version": "1.0.1",
-  "description": "A junit reporter for `node:test`",
+  "version": "1.0.3",
+  "description": "A jUnit reporter for `node:test`",
   "keywords": [
     "junit",
     "node:test",
@@ -10,9 +10,13 @@
     "reporters"
   ],
   "scripts": {
-    "test": "echo ''"
+    "test": "node --test-reporter=spec --test-reporter-destination=stdout --test-reporter=../github/index.js --test-reporter-destination=stdout --test"
+  },
+  "bugs": {
+    "url": "https://github.com/MoLow/reporters/issues"
   },
   "main": "index.js",
+  "homepage": "https://github.com/MoLow/reporters/tree/main/packages/junit",
   "repository": "https://github.com/MoLow/reporters.git",
   "author": "Moshe Atlow",
   "license": "MIT"

package/tests/index.test.js

@@ -0,0 +1,9 @@
+const { spawnSync } = require('child_process');
+const assert = require('assert');
+const { compareLines } = require('../../../tests/utils');
+const output = require('./output');
+
+const child = spawnSync(process.execPath, ['--test-reporter', './index.js', '../../tests/example']);
+
+assert.strictEqual(child.stderr?.toString(), '');
+compareLines(child.stdout?.toString(), output.stdout);

package/tests/output.js

@@ -0,0 +1,27 @@
+module.exports = {
+  stdout: `<\\?xml version="1.0" encoding="utf-8"\\?>
+<testsuites>
+\t<testsuite name="tests" time=".*" disabled="0" errors="0" tests="2" failures="1" skipped="0" hostname=".*">
+\t\t<testcase name="is ok" time=".*" classname="test"/>
+\t\t<testcase name="fails" time=".*" classname="test" failure="this is an error">
+\t\t\t<failure type="testCodeFailure" message="this is an error">
+\\[Error \\[ERR_TEST_FAILURE\\]: this is an error\\] {
+  failureType: 'testCodeFailure',
+  cause: Error: this is an error
+      at Object.&lt;anonymous&gt; (.*)
+      .*
+      .*
+      .*
+      .*
+      .*
+      .*
+      .*
+      .*
+  code: 'ERR_TEST_FAILURE'
+}
+\t\t\t</failure>
+\t\t</testcase>
+\t</testsuite>
+</testsuites>
+`,
+};