Skip to content

test_runner: add classname hierarchy for JUnit reporter #60220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test_runner: add classname hierarchy for JUnit reporter #60220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions lib/internal/test_runner/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
const {
ArrayPrototypeJoin,
ArrayPrototypePush,
ArrayPrototypePushApply,
ArrayPrototypeShift,
Expand Down Expand Up @@ -1360,6 +1361,18 @@ class Test extends AsyncResource {
if (this.passedAttempt !== undefined) {
details.passed_on_attempt = this.passedAttempt;
}

// Generate classname from suite hierarchy for JUnit reporter
if (this.parent && this.parent !== this.root) {
const parts = [];
for (let t = this.parent; t !== t.root; t = t.parent) {
ArrayPrototypeUnshift(parts, t.name);
}
if (parts.length > 0) {
details.classname = ArrayPrototypeJoin(parts, '.');
}
}

return { __proto__: null, details, directive };
}

Expand Down
2 changes: 2 additions & 0 deletions lib/internal/test_runner/tests_stream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class TestsStream extends Readable {
nesting,
testNumber,
details,
...(details.classname && { __proto__: null, classname: details.classname }),
...loc,
...directive,
});
Expand All @@ -53,6 +54,7 @@ class TestsStream extends Readable {
nesting,
testNumber,
details,
...(details.classname && { __proto__: null, classname: details.classname }),
...loc,
...directive,
});
Expand Down
19 changes: 19 additions & 0 deletions test/fixtures/test-runner/output/junit_classname_hierarchy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
'use strict';
require('../../../common');
const { suite, test } = require('node:test');

suite('Math', () => {
suite('Addition', () => {
test('adds positive numbers', () => {});
});

suite('Multiplication', () => {
test('multiplies positive numbers', () => {});
});
});

suite('String', () => {
test('concatenates strings', () => {});
});

test('standalone test', () => {});
23 changes: 23 additions & 0 deletions test/fixtures/test-runner/output/junit_classname_hierarchy.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<testsuites>
<testsuite name="Math" time="*" disabled="0" errors="0" tests="2" failures="0" skipped="0" hostname="HOSTNAME">
<testsuite name="Addition" time="*" disabled="0" errors="0" tests="1" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="adds positive numbers" time="*" classname="Math.Addition" file="*"/>
</testsuite>
<testsuite name="Multiplication" time="*" disabled="0" errors="0" tests="1" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="multiplies positive numbers" time="*" classname="Math.Multiplication" file="*"/>
</testsuite>
</testsuite>
<testsuite name="String" time="*" disabled="0" errors="0" tests="1" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="concatenates strings" time="*" classname="String" file="*"/>
</testsuite>
<testcase name="standalone test" time="*" classname="test" file="*"/>
<!-- tests 4 -->
<!-- suites 4 -->
<!-- pass 4 -->
<!-- fail 0 -->
<!-- cancelled 0 -->
<!-- skipped 0 -->
<!-- todo 0 -->
<!-- duration_ms * -->
</testsuites>
24 changes: 12 additions & 12 deletions test/fixtures/test-runner/output/junit_reporter.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ true !== false
<testcase name="immediate reject - passes but warns" time="*" classname="test" file="*"/>
<testcase name="immediate resolve pass" time="*" classname="test" file="*"/>
<testsuite name="subtest sync throw fail" time="*" disabled="0" errors="0" tests="1" failures="1" skipped="0" hostname="HOSTNAME">
<testcase name="+sync throw fail" time="*" classname="test" file="*" failure="thrown from subtest sync throw fail">
<testcase name="+sync throw fail" time="*" classname="subtest sync throw fail" file="*" failure="thrown from subtest sync throw fail">
<failure type="testCodeFailure" message="thrown from subtest sync throw fail">
Error [ERR_TEST_FAILURE]: thrown from subtest sync throw fail
*
Expand Down Expand Up @@ -182,15 +182,15 @@ Error [ERR_TEST_FAILURE]: thrown from subtest sync throw fail
</failure>
</testcase>
<testsuite name="level 0a" time="*" disabled="0" errors="0" tests="4" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="level 1a" time="*" classname="test" file="*"/>
<testcase name="level 1b" time="*" classname="test" file="*"/>
<testcase name="level 1c" time="*" classname="test" file="*"/>
<testcase name="level 1d" time="*" classname="test" file="*"/>
<testcase name="level 1a" time="*" classname="level 0a" file="*"/>
<testcase name="level 1b" time="*" classname="level 0a" file="*"/>
<testcase name="level 1c" time="*" classname="level 0a" file="*"/>
<testcase name="level 1d" time="*" classname="level 0a" file="*"/>
</testsuite>
<testsuite name="top level" time="*" disabled="0" errors="0" tests="2" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="+long running" time="*" classname="test" file="*"/>
<testcase name="+long running" time="*" classname="top level" file="*"/>
<testsuite name="+short running" time="*" disabled="0" errors="0" tests="1" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="++short running" time="*" classname="test" file="*"/>
<testcase name="++short running" time="*" classname="top level.+short running" file="*"/>
</testsuite>
</testsuite>
<testcase name="invalid subtest - pass but subtest fails" time="*" classname="test" file="*"/>
Expand Down Expand Up @@ -307,9 +307,9 @@ Error [ERR_TEST_FAILURE]: thrown from callback async throw
</testcase>
<testcase name="callback async throw after done" time="*" classname="test" file="*"/>
<testsuite name="only is set on subtests but not in only mode" time="*" disabled="0" errors="0" tests="3" failures="0" skipped="0" hostname="HOSTNAME">
<testcase name="running subtest 1" time="*" classname="test" file="*"/>
<testcase name="running subtest 3" time="*" classname="test" file="*"/>
<testcase name="running subtest 4" time="*" classname="test" file="*"/>
<testcase name="running subtest 1" time="*" classname="only is set on subtests but not in only mode" file="*"/>
<testcase name="running subtest 3" time="*" classname="only is set on subtests but not in only mode" file="*"/>
<testcase name="running subtest 4" time="*" classname="only is set on subtests but not in only mode" file="*"/>
</testsuite>
<testcase name="custom inspect symbol fail" time="*" classname="test" file="*" failure="customized">
<failure type="testCodeFailure" message="customized">
Expand All @@ -329,7 +329,7 @@ Error [ERR_TEST_FAILURE]: thrown from callback async throw
</failure>
</testcase>
<testsuite name="subtest sync throw fails" time="*" disabled="0" errors="0" tests="2" failures="2" skipped="0" hostname="HOSTNAME">
<testcase name="sync throw fails at first" time="*" classname="test" file="*" failure="thrown from subtest sync throw fails at first">
<testcase name="sync throw fails at first" time="*" classname="subtest sync throw fails" file="*" failure="thrown from subtest sync throw fails at first">
<failure type="testCodeFailure" message="thrown from subtest sync throw fails at first">
Error [ERR_TEST_FAILURE]: thrown from subtest sync throw fails at first
*
Expand All @@ -350,7 +350,7 @@ Error [ERR_TEST_FAILURE]: thrown from subtest sync throw fails at first
}
</failure>
</testcase>
<testcase name="sync throw fails at second" time="*" classname="test" file="*" failure="thrown from subtest sync throw fails at second">
<testcase name="sync throw fails at second" time="*" classname="subtest sync throw fails" file="*" failure="thrown from subtest sync throw fails at second">
<failure type="testCodeFailure" message="thrown from subtest sync throw fails at second">
Error [ERR_TEST_FAILURE]: thrown from subtest sync throw fails at second
* {
Expand Down
5 changes: 5 additions & 0 deletions test/parallel/test-runner-output.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,11 @@ const tests = [
{ name: 'test-runner/output/only_tests.js', flags: ['--test-reporter=tap'] },
{ name: 'test-runner/output/dot_reporter.js', transform: specTransform },
{ name: 'test-runner/output/junit_reporter.js', transform: junitTransform },
{
name: 'test-runner/output/junit_classname_hierarchy.js',
flags: ['--test-reporter=junit'],
transform: junitTransform,
},
{ name: 'test-runner/output/spec_reporter_successful.js', transform: specTransform },
{ name: 'test-runner/output/spec_reporter.js', transform: specTransform },
{ name: 'test-runner/output/spec_reporter_cli.js', transform: specTransform },
Expand Down
2 changes: 1 addition & 1 deletion test/parallel/test-runner-reporters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ describe('node:test reporters', { concurrency: true }, () => {
const fileContents = fs.readFileSync(file, 'utf8');
assert.match(fileContents, /<testsuite .*name="nested".*tests="2".*failures="1".*skipped="0".*>/);
assert.match(fileContents, /<testcase .*name="failing".*>\s*<failure .*type="testCodeFailure".*message="error".*>/);
assert.match(fileContents, /<testcase .*name="ok".*classname="test".*\/>/);
assert.match(fileContents, /<testcase .*name="ok".*classname="nested".*\/>/);
assert.match(fileContents, /<testcase .*name="top level".*classname="test".*\/>/);
});
});