@reporters/junit 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [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)
 # 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@reporters/junit",
-  "version": "1.0.1",
-  "description": "A junit reporter for `node:test`",
+  "version": "1.0.2",
+  "description": "A jUnit reporter for `node:test`",
   "keywords": [
     "junit",
     "node:test",
@@ -10,9 +10,13 @@
     "reporters"
   ],
   "scripts": {
-    "test": "echo ''"
+    "test": "../../prebuilt --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,26 @@
+module.exports = {
+  stdout: `<\\?xml version="1.0" encoding="utf-8"\\?>
+<testsuites>
+  <testsuite name="tests" time=".*" disabled="0" errors="0" tests="2" failures="1" skipped="0" hostname=".*">
+    <testcase name="is ok" time=".*" classname="test"></testcase>
+    <testcase name="fails" time=".*" 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; (.*)
+      .*
+      .*
+      .*
+      .*
+      .*
+      .*
+      .*
+  code: 'ERR_TEST_FAILURE'
+}
+      </failure>
+    </testcase>
+  </testsuite>
+</testsuites>
+`,
+};