Skip to content

Add the ability to generate additional JUnit 5 test reports #432

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
amilbourne wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add the ability to generate additional JUnit 5 test reports #432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56aade7
Add the ability to generate additional JUnit 5 test reports
amilbourne Feb 20, 2026
7295602
Improve the tests for JUnit 5 reports
amilbourne Jun 30, 2026
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
20 changes: 10 additions & 10 deletions MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,16 +267,16 @@ dev_maven.install(
artifacts = [
# These can be versioned independently of the versions in `repositories.bzl`
# so long as the version numbers are higher.
"org.junit.jupiter:junit-jupiter-engine:5.8.2",
"org.junit.jupiter:junit-jupiter-api:5.8.2",
"org.junit.jupiter:junit-jupiter-params:5.8.2",
"org.junit.platform:junit-platform-launcher:1.8.2",
"org.junit.platform:junit-platform-reporting:1.8.2",
"org.junit.platform:junit-platform-suite:1.8.2",
"org.junit.platform:junit-platform-suite-api:1.8.2",
"org.junit.platform:junit-platform-suite-engine:1.8.2",
"org.junit.platform:junit-platform-testkit:1.8.2",
"org.junit.vintage:junit-vintage-engine:5.8.2",
"org.junit.jupiter:junit-jupiter-engine:5.9.3",
"org.junit.jupiter:junit-jupiter-api:5.9.3",
"org.junit.jupiter:junit-jupiter-params:5.9.3",
"org.junit.platform:junit-platform-launcher:1.9.3",
"org.junit.platform:junit-platform-reporting:1.9.3",
"org.junit.platform:junit-platform-suite:1.9.3",
"org.junit.platform:junit-platform-suite-api:1.9.3",
"org.junit.platform:junit-platform-suite-engine:1.9.3",
"org.junit.platform:junit-platform-testkit:1.9.3",
"org.junit.vintage:junit-vintage-engine:5.9.3",
"org.mockito:mockito-core:4.8.1",
],
fail_if_repin_required = True,
Expand Down
143 changes: 63 additions & 80 deletions contrib_rules_jvm_tests_install.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"__AUTOGENERATED_FILE_DO_NOT_MODIFY_THIS_FILE_MANUALLY": "THERE_IS_NO_DATA_ONLY_ZUUL",
"__INPUT_ARTIFACTS_HASH": -110331756,
"__RESOLVED_ARTIFACTS_HASH": 1220653889,
"__INPUT_ARTIFACTS_HASH": -1185159340,
"__RESOLVED_ARTIFACTS_HASH": 1981414694,
"artifacts": {
"junit:junit": {
"shasums": {
Expand Down Expand Up @@ -33,10 +33,10 @@
},
"org.assertj:assertj-core": {
"shasums": {
"jar": "d749db58c2bd353f1c03541d747b753931d4b84da8e48993ef51efe8694b4ed7",
"sources": "d0384d378df4391392bbdf06691aa48b3ac3bc5f37c223e6466a75a03d54fee4"
"jar": "36af798af9fc20537669e02618bd39f2c797f4813824ef222108cb686fa4c88e",
"sources": "985cb9f6be2851c381fe2836b196393d7df04cb29683ba2a11692c577a929525"
},
"version": "3.20.2"
"version": "3.23.1"
},
"org.hamcrest:hamcrest-core": {
"shasums": {
Expand All @@ -47,94 +47,94 @@
},
"org.junit.jupiter:junit-jupiter-api": {
"shasums": {
"jar": "1808ee87e0f718cd6e25f3b75afc17956ac8a3edc48c7e9bab9f19f9a79e3801",
"sources": "cb38569ae9005eb54c7cbc181b842e6eb01be57ae0d785f9167d9e019b44a670"
"jar": "d895e3eedf4fa1b10de31a91be55a301bb307bf18ef325b3fa5db3f80ee92d1c",
"sources": "f1cff40f527139595f61667e870c3c359f7b872ee82fbc91087299131d438cdc"
},
"version": "5.8.2"
"version": "5.9.3"
},
"org.junit.jupiter:junit-jupiter-engine": {
"shasums": {
"jar": "753b7726cdd158bb34cedb94c161e2291896f47832a1e9eda53d970020a8184e",
"sources": "9ed4edf417cbc6028c634a0b407061433327c9ef4235fca35b9183da855e2e8f"
"jar": "b55e304b1cd2e8f116c1ab77a5dc3eca8c4d9b46a69e084b63aca51cdeb55f0f",
"sources": "7ede3caeaf5816ee4cebc91ca6074ff6043d02583b55103e13276632bad141b6"
},
"version": "5.8.2"
"version": "5.9.3"
},
"org.junit.jupiter:junit-jupiter-params": {
"shasums": {
"jar": "d1c22d6fe5483568c08c8913f34abd2303490c3480ce6c18a2ea31c65e44102a",
"sources": "201cbc5237df584f762d33454573ccd0566653207f539f68ab7993d7145156b1"
"jar": "2af282fe91e56495c03b84e9cae702eaa212fc2f6a31fd9d79e31ccb64cd81fd",
"sources": "316d979ce4b5523a1a227027da3ac3ecba9730b1351d0b84c941843d0b89c06d"
},
"version": "5.8.2"
"version": "5.9.3"
},
"org.junit.platform:junit-platform-commons": {
"shasums": {
"jar": "d2e015fca7130e79af2f4608dc54415e4b10b592d77333decb4b1a274c185050",
"sources": "7ae3683c452ee4259b2d205d56c7172fd178180b02d20b4430368ef6ee501c3b"
"jar": "8519157df813c210e85fc1414b74109e3d85f43d7092563ed704c43c48f0d5e6",
"sources": "b6054d274ec4b9ca055581da91525bfc827cef3a2546f74ba0ddeec0cf34e14b"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-engine": {
"shasums": {
"jar": "0b7d000f8c3e8e5f7d6b819649936e7b9938314e87c8f983805218ea57567e59",
"sources": "4cfda26b1dc0812fcf0a14b0bb5612b7c697e50afd79819d2e07b1faef9c239b"
"jar": "0c39553d9a03510757227f5a1c6cc6530287b1a321ed6258450664874aa2a16a",
"sources": "31906715fb92e10b96da6cdcd1c75066bd275e961949fcd0ab61b7501c867eb9"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-launcher": {
"shasums": {
"jar": "822156409fd83e682e4c5199b3460054299b538a058c2c6d0f5c9b6a5bdb7594",
"sources": "ee8440e84c23e52519b57e77a30627f80d91ac148244162ee2eea1ba809c1bdc"
"jar": "8515e91808a09c8c9af5e359185b5991b5e76b8adcf185b9a3dab4ec8e5ba8ff",
"sources": "3cf6e39c88b59e63851ac1981ce567a24ab89f89f7eb738145ad72dcba105b4a"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-reporting": {
"shasums": {
"jar": "d28048333b378d166f9ad38c2a8e34ac0fa1a29cc016cb279df53c8b54628fc3",
"sources": "489df906d84675ba6d078e076a5ffd8c8feec62e390539d6d61938de98b269f4"
"jar": "ebcafcc2bc8bdc2191891a0dd5e69747a5d59aa8a4c490da7983a7617276b596",
"sources": "dbb606dc99a8a59a000bc37b06dbe97e7b62a1c6eee3ba0b27864decf1cc41c2"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-suite": {
"shasums": {
"jar": "31e6b625c870941fd5d57789d7d4eead0ad3e1fc1d64c54c82aa24de2b259b3e",
"jar": "976afaca37748552809280ea116468bdc3616b875fe43e265049c50e718fc42c",
"sources": "73308a5b8ed6f4cb15020baf41f8f226e141d1fd9dc99a2dc4fa2b3d1a616e98"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-suite-api": {
"shasums": {
"jar": "94ef343b05b875bb2e4ef94a7cc62e610e1b9cd78247e2b2ec43ed618a1ed0a7",
"sources": "53ce9bde5e3222355fa8deb17cb568629827ccedf57efce07ba1077e79feaaa0"
"jar": "827d8dfa5904840e139448016ff1d9535c2a9c63d10a3376d4e521ed1b478ff1",
"sources": "5d216f5308b1ce91d4d3d98211842e00ecba66a46b3a3eef3008019ee69ea206"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-suite-commons": {
"shasums": {
"jar": "7f690bc34916796ef0b84b6d63c9b3892d6f9d2e89b6ee774039771a08b159c4",
"sources": "eb7216b81dbdc24c633544c385f0d80e128e5339898e8c037046e87feb3780cd"
"jar": "bddbbd21382c0ed649425cffc2f34bbf0183d83afdb81d45a7666a5c616ec608",
"sources": "0c274158bffef277587e835777cf087ebe09dbd3ec39913998024fe48b071de8"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-suite-engine": {
"shasums": {
"jar": "69c81182c532024ffcceef6d8c0c98a49b555216d0ea65c7f45977185c4d7fdb",
"sources": "b075b0ecd1755fee39ca01e136aac11b38d44c0a741e95eb63b8a0ec6b680960"
"jar": "c5a7ee51cc3b79cd0dae9bb02ad1c8dd9dafd68da445b7c5841f4df0a7c00666",
"sources": "1e98c4bfed54fa992db942377b4d99cc1a156fdb3bcc4091f48cb09c05dfe5db"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.platform:junit-platform-testkit": {
"shasums": {
"jar": "94d6fb9b1d4e7bb3d6a967b21f1cf4f7cf84455d602cccf614a186d936929b08",
"sources": "485fac0cc55c14db0c10dff3e42351b10e0bfe5d337892efe8e5b5fcb672f752"
"jar": "0fce0449dc4fbeafbf90091a12947c200b550b9b3cbdda8cee3228cb99a88642",
"sources": "190f4d47d6af7f6abd896dc715d4252af13796c28b22f9738e2b9af588c176c1"
},
"version": "1.8.2"
"version": "1.9.3"
},
"org.junit.vintage:junit-vintage-engine": {
"shasums": {
"jar": "ebd567b84e380d5373c47de3c9616d84f7bef91f9f8a8e7fc925be68240c1ba4",
"sources": "f2873fcb606ad338934d11d7e7d005e7c08b373bf09c886f9b9d03d21423d63d"
"jar": "6bc1b42282aed8b9eccdb40631cf45001af8ab3ad9d0d85cff86c45e85fc59d0",
"sources": "20068f38816ff2835db0d65975e9ab71dae5e3916d1c26656e8b18f8290262ab"
},
"version": "5.8.2"
"version": "5.9.3"
},
"org.mockito:mockito-core": {
"shasums": {
Expand Down Expand Up @@ -162,6 +162,9 @@
"junit:junit": [
"org.hamcrest:hamcrest-core"
],
"org.assertj:assertj-core": [
"net.bytebuddy:byte-buddy"
],
"org.junit.jupiter:junit-jupiter-api": [
"org.apiguardian:apiguardian-api",
"org.junit.platform:junit-platform-commons",
Expand Down Expand Up @@ -333,42 +336,6 @@
"org.assertj.core.extractor",
"org.assertj.core.groups",
"org.assertj.core.internal",
"org.assertj.core.internal.bytebuddy",
"org.assertj.core.internal.bytebuddy.agent.builder",
"org.assertj.core.internal.bytebuddy.asm",
"org.assertj.core.internal.bytebuddy.build",
"org.assertj.core.internal.bytebuddy.description",
"org.assertj.core.internal.bytebuddy.description.annotation",
"org.assertj.core.internal.bytebuddy.description.enumeration",
"org.assertj.core.internal.bytebuddy.description.field",
"org.assertj.core.internal.bytebuddy.description.method",
"org.assertj.core.internal.bytebuddy.description.modifier",
"org.assertj.core.internal.bytebuddy.description.type",
"org.assertj.core.internal.bytebuddy.dynamic",
"org.assertj.core.internal.bytebuddy.dynamic.loading",
"org.assertj.core.internal.bytebuddy.dynamic.scaffold",
"org.assertj.core.internal.bytebuddy.dynamic.scaffold.inline",
"org.assertj.core.internal.bytebuddy.dynamic.scaffold.subclass",
"org.assertj.core.internal.bytebuddy.implementation",
"org.assertj.core.internal.bytebuddy.implementation.attribute",
"org.assertj.core.internal.bytebuddy.implementation.auxiliary",
"org.assertj.core.internal.bytebuddy.implementation.bind",
"org.assertj.core.internal.bytebuddy.implementation.bind.annotation",
"org.assertj.core.internal.bytebuddy.implementation.bytecode",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.assign",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.assign.primitive",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.assign.reference",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.collection",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.constant",
"org.assertj.core.internal.bytebuddy.implementation.bytecode.member",
"org.assertj.core.internal.bytebuddy.jar.asm",
"org.assertj.core.internal.bytebuddy.jar.asm.commons",
"org.assertj.core.internal.bytebuddy.jar.asm.signature",
"org.assertj.core.internal.bytebuddy.matcher",
"org.assertj.core.internal.bytebuddy.pool",
"org.assertj.core.internal.bytebuddy.utility",
"org.assertj.core.internal.bytebuddy.utility.privilege",
"org.assertj.core.internal.bytebuddy.utility.visitor",
"org.assertj.core.matcher",
"org.assertj.core.presentation",
"org.assertj.core.util",
Expand Down Expand Up @@ -452,7 +419,13 @@
],
"org.junit.platform:junit-platform-reporting": [
"org.junit.platform.reporting.legacy",
"org.junit.platform.reporting.legacy.xml"
"org.junit.platform.reporting.legacy.xml",
"org.junit.platform.reporting.open.xml",
"org.junit.platform.reporting.shadow.org.opentest4j.reporting.events.api",
"org.junit.platform.reporting.shadow.org.opentest4j.reporting.events.core",
"org.junit.platform.reporting.shadow.org.opentest4j.reporting.events.java",
"org.junit.platform.reporting.shadow.org.opentest4j.reporting.events.root",
"org.junit.platform.reporting.shadow.org.opentest4j.reporting.schema"
],
"org.junit.platform:junit-platform-suite-api": [
"org.junit.platform.suite.api"
Expand Down Expand Up @@ -624,6 +597,16 @@
"org.junit.platform.launcher.listeners.UniqueIdTrackingListener"
]
},
"org.junit.platform:junit-platform-reporting": {
"org.junit.platform.launcher.TestExecutionListener": [
"org.junit.platform.reporting.open.xml.OpenTestReportGeneratingListener"
]
},
"org.junit.platform:junit-platform-reporting:jar:sources": {
"org.junit.platform.launcher.TestExecutionListener": [
"org.junit.platform.reporting.open.xml.OpenTestReportGeneratingListener"
]
},
"org.junit.platform:junit-platform-suite-engine": {
"org.junit.platform.engine.TestEngine": [
"org.junit.platform.suite.engine.SuiteTestEngine"
Expand Down
2 changes: 2 additions & 0 deletions java/private/java_test_suite.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ def _define_junit5_test(name, **kwargs):
name = name,
include_engines = kwargs.pop("include_engines", None),
exclude_engines = kwargs.pop("exclude_engines", None),
report_generator = kwargs.pop("report_generator", None),
report_generator_deps = kwargs.pop("report_generator_deps", []),
**kwargs
)
return name
Expand Down
15 changes: 12 additions & 3 deletions java/private/junit5.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def junit5_vintage_deps(repository_name = DEFAULT_REPOSITORY_NAME):
artifact("org.junit.vintage:junit-vintage-engine", repository_name),
]

def junit5_jvm_flags(jvm_flags, include_tags = [], exclude_tags = [], include_engines = [], exclude_engines = []):
def junit5_jvm_flags(jvm_flags, include_tags = [], exclude_tags = [], include_engines = [], exclude_engines = [], report_generator = None):
if include_tags:
jvm_flags = jvm_flags + ["-DJUNIT5_INCLUDE_TAGS=" + ",".join(include_tags)]

Expand All @@ -33,6 +33,9 @@ def junit5_jvm_flags(jvm_flags, include_tags = [], exclude_tags = [], include_en
if exclude_engines:
jvm_flags = jvm_flags + ["-DJUNIT5_EXCLUDE_ENGINES=%s" % ",".join(exclude_engines)]

if report_generator:
jvm_flags = jvm_flags + ["-DJUNIT5_REPORT_GENERATOR=%s" % report_generator]

return jvm_flags

"""Dependencies typically required by JUnit 5 tests.
Expand All @@ -53,6 +56,8 @@ def java_junit5_test(
exclude_tags = [],
include_engines = [],
exclude_engines = [],
report_generator = None,
report_generator_deps = [],
**kwargs):
"""Run junit5 tests using Bazel.

Expand Down Expand Up @@ -88,13 +93,17 @@ def java_junit5_test(
exclude_tags: Junit tag expressions to exclude execution of tagged tests.
include_engines: A list of JUnit Platform test engine IDs to include.
exclude_engines: A list of JUnit Platform test engine IDs to exclude.
report_generator: The name of an additional report generator to use.
Can be 'legacy', 'open' or a class name.
report_generator_deps: A list of labels to add to the runtime dependencies
of the test, typically containing the report generator class.
"""
if test_class:
clazz = test_class
else:
clazz = get_package_name(package_prefixes) + name

jvm_flags = junit5_jvm_flags(jvm_flags, include_tags, exclude_tags, include_engines, exclude_engines)
jvm_flags = junit5_jvm_flags(jvm_flags, include_tags, exclude_tags, include_engines, exclude_engines, report_generator)

# Add the agent to prevent `System.exit` from being called
jvm_flags = ["-javaagent:$(location %s)=$(location %s)" % (_SYSTEM_EXIT_AGENT, _SYSTEM_EXIT_AGENT)] + jvm_flags
Expand All @@ -105,7 +114,7 @@ def java_junit5_test(
name = name,
main_class = "com.github.bazel_contrib.contrib_rules_jvm.junit5.JUnit5Runner",
test_class = clazz,
runtime_deps = runtime_deps + JUNIT5_RUNTIME_DEPS,
runtime_deps = runtime_deps + JUNIT5_RUNTIME_DEPS + report_generator_deps,
jvm_flags = jvm_flags,
data = data,
**kwargs
Expand Down
Loading