Generate configuration parameters overview by mpkorstanje · Pull Request #5932 · junit-team/junit-framework

mpkorstanje · 2026-07-30T20:55:39Z

See: https://docs.spring.io/spring-boot/specification/configuration-metadata/format.html

Closes: #4330

I hereby agree to the terms of the JUnit Contributor License Agreement.

Definition of Done

There are no TODOs left in the code
Method preconditions are checked and documented in the method's Javadoc
Coding conventions (e.g. for logging) have been followed
Change is covered by automated tests including corner cases, errors, and exception handling
Public API has Javadoc and @API annotations
Change is documented in the User Guide and Release Notes

marcphilipp · 2026-07-31T06:57:58Z

I think we should build this as a fat/shadowed jar to make it easy to put it on the annotation processor classpath. No need to do that now, but let's discuss it.

marcphilipp · 2026-07-31T06:58:41Z

+
+dependencies {
+	api(platform(projects.junitBom))
+	api(projects.junitPlatformCommons)


Does it need that?

No, but the way OSGI is setup makes it a requirement for every module.

marcphilipp · 2026-07-31T06:59:48Z

 tasks {
 	compileJava {
-		options.compilerArgs.add("-Xlint:-module") // due to qualified exports
+		options.compilerArgs.add("-Xlint:-module,-processing") // -module: due to qualified exports, -processing: not all annotations need to be processed


What warnings does this emit without -processing?

Complain about all present annotations that weren't claimed by a processor.

Similar too:

https://stackoverflow.com/questions/69439506/no-processor-claimed-any-of-these-annotations

testlens-app · 2026-08-05T14:24:48Z

🚨 TestLens detected 37 failed tests 🚨

Here is what you can do:

Inspect the test failures carefully.
If you are convinced that some of the tests are flaky, you can mute them below.
Finally, trigger a rerun by checking the rerun checkbox.

Test Summary

CI / Build / Linux > :platform-tooling-support-tests:test

Test	Runs	Flakiness
JUnitStartTests > junitRun(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunClass(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunModule(OutputFiles)	❌	0% 🟢
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Build / Windows > :platform-tooling-support-tests:test

Test	Runs	Flakiness
JUnitStartTests > junitRun(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunClass(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunModule(OutputFiles)	❌	0% 🟢
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Build / macOS > :platform-tooling-support-tests:test

Test	Runs	Flakiness
JUnitStartTests > junitRun(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunClass(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunModule(OutputFiles)	❌	0% 🟢
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Cross-Version / OpenJ9 25 > :platform-tooling-support-tests:test

Test	Runs	Flakiness
JUnitStartTests > junitRun(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunClass(OutputFiles)	❌	0% 🟢
JUnitStartTests > junitRunModule(OutputFiles)	❌	0% 🟢
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢

CI / Cross-Version / OpenJDK 26 (ga) > :platform-tooling-support-tests:test

Test	Runs	Flakiness
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Cross-Version / OpenJDK 26 (leyden) > :platform-tooling-support-tests:test

Test	Runs	Flakiness
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Cross-Version / OpenJDK 27 (ea) > :platform-tooling-support-tests:test

Test	Runs	Flakiness
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Cross-Version / OpenJDK 27 (valhalla) > :platform-tooling-support-tests:test

Test	Runs	Flakiness
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

CI / Cross-Version / OpenJDK 28 (ea) > :platform-tooling-support-tests:test

Test	Runs	Flakiness
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)	❌	0% 🟢
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)	❌	0% 🟢
ToolProviderTests > findAndRunJUnitOnTheModulePath()	❌	0% 🟢

🏷️ Commit: 3b011f7
▶️ Tests: 37623 executed
⚪️ Checks: 17/17 completed

Test Failures (first 10 of 111)

JUnitStartTests > junitRun(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRun(JUnitStartTests.java:87)

expected	actual
0	1

JUnitStartTests > junitRun(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRun(JUnitStartTests.java:87)

expected	actual
0	1

JUnitStartTests > junitRun(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRun(JUnitStartTests.java:87)

expected	actual
0	1

JUnitStartTests > junitRunClass(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunClass(JUnitStartTests.java:102)

expected	actual
0	1

JUnitStartTests > junitRunClass(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunClass(JUnitStartTests.java:102)

expected	actual
0	1

JUnitStartTests > junitRunClass(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunClass(JUnitStartTests.java:102)

expected	actual
0	1

JUnitStartTests > junitRunModule(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunModule(JUnitStartTests.java:117)

expected	actual
0	1

JUnitStartTests > junitRunModule(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunModule(JUnitStartTests.java:117)

expected	actual
0	1

JUnitStartTests > junitRunModule(OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.JUnitStartTests.junitRunModule(JUnitStartTests.java:117)

expected	actual
0	1

ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles) (:platform-tooling-support-tests:test in CI / Build / Linux)

java.lang.RuntimeException: First 20 lines from javac-stderr.txt:
/home/runner/work/junit-framework/junit-framework/junit-platform-configuration-processor/src/main/java/module-info.java:18: error: module not found: tools.jackson.databind
	requires tools.jackson.databind;
	                      ^
1 error
	at platform.tooling.support.OutputAttachingExtension.handleTestExecutionException(OutputAttachingExtension.java:78)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1090)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:614)
	at java.base/java.lang.Thread.run(Thread.java:1474)
Caused by: org.opentest4j.AssertionFailedError: expected: <0> but was: <1>
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:569)
	at platform.tooling.support.tests.ModularCompilationTests.compileAllJUnitModules(ModularCompilationTests.java:65)

Muted Tests (first 20 of 37)

Select tests to mute in this pull request:

JUnitStartTests > junitRun(OutputFiles)
JUnitStartTests > junitRunClass(OutputFiles)
JUnitStartTests > junitRunModule(OutputFiles)
ModularCompilationTests > compileAllJUnitModules(Path, OutputFiles)
ModularUserGuideTests > runTestsFromUserGuideWithinModularBoundaries(Path, OutputFiles)
ToolProviderTests > findAndRunJUnitOnTheModulePath()

Reuse successful test results:

♻️ Only rerun the tests that failed or were muted before

Click the checkbox to trigger a rerun:

Rerun jobs

Learn more about TestLens at testlens.app.

mpkorstanje · 2026-08-05T14:27:14Z

+	compileOnlyApi(libs.jspecify)
+
+	// TODO: Shade, but it's non trivial.
+	implementation(libs.jackson.databind)


@marcphilipp I'm having my doubts about picking Jackson.

It is a CVE magnet, so we'd have to backport dependency updates quite frequently. Though not many people would actually use the processor.

Is overkill for what we need.

Shading Jackson is quite complicated because of various service descriptors and miscellaneous junk in the jar files.

The spring-boot-configuration-processor` resolves this by copying a minimal json implementation. But that implementation is Apache licensed.

There is https://github.com/stleary/JSON-java but the "vibes" are off. No clear license, calendar based versioning, ect.

github-actions Bot added component: Platform theme: documentation type: new feature labels Jul 30, 2026

mpkorstanje added 3 commits July 30, 2026 23:07

Setup project skeleton

827df2b

Enable annotation processor for ConfigurationParameter

ed2e1ee

Output minimal junit-platform-configuration-metadata.json

14ffed5

mpkorstanje force-pushed the feature/generate-configuration-parameters-overview branch from c73e0df to 14ffed5 Compare July 30, 2026 21:38

mpkorstanje added 5 commits July 30, 2026 23:49

Fix workaround for Javadoc

63dd21b

Fix verifyOSGi

578bdca

Fix describe module tests

2d7547d

Fix allPublicTopLevelTypesHaveApiAnnotations test

6bc410b

Explain why processing linting is supressed

e06d4c1

mpkorstanje commented Jul 30, 2026

View reviewed changes

Comment thread .../plugins/backward-compatibility/src/main/kotlin/junitbuild.backward-compatibility.gradle.kts Outdated

mpkorstanje added 3 commits July 31, 2026 00:35

Output junit-platform-configuration-metadata for platform-launcher

ccea87e

Fix checkBackwardCompatibility

fd1baf1

Fix JarDescribeModuleTests

3295a99

mpkorstanje force-pushed the feature/generate-configuration-parameters-overview branch from f02ff2f to 3295a99 Compare July 30, 2026 22:58

marcphilipp reviewed Jul 31, 2026

View reviewed changes

mpkorstanje force-pushed the feature/generate-configuration-parameters-overview branch 2 times, most recently from 6c063a1 to e6ab635 Compare July 31, 2026 08:52

mpkorstanje added 2 commits July 31, 2026 11:57

Reduce scope to compileOnly

3b5624f

Process annotations for Vintage

314e8fd

mpkorstanje force-pushed the feature/generate-configuration-parameters-overview branch from e6ab635 to 314e8fd Compare July 31, 2026 09:57

mpkorstanje added 7 commits August 4, 2026 00:57

Setup minimal unit test

a3aa4e5

Add Eclipse IDE compatibility note

b155836

Extract TestCompiler

149556b

Write output with platform independent newline

72d715b

Require annotated fields to be static with a constant value string

c1789d6

Add Property.sourceType

9a1f897

Add deprecation and refactor

7c3df1f

mpkorstanje added 2 commits August 5, 2026 15:01

Remove redundant local variable

d764e3f

Generate some json output

3b011f7

mpkorstanje commented Aug 5, 2026

View reviewed changes

Navigation Menu

Uh oh!

Uh oh!

Generate configuration parameters overview - #5932

Generate configuration parameters overview #5932
mpkorstanje wants to merge 22 commits into
mainfrom
feature/generate-configuration-parameters-overview

mpkorstanje commented Jul 30, 2026 •

edited

Loading

Uh oh!

Uh oh!

marcphilipp Jul 31, 2026

Uh oh!

marcphilipp Jul 31, 2026

Uh oh!

mpkorstanje Jul 31, 2026

Uh oh!

marcphilipp Jul 31, 2026

Uh oh!

mpkorstanje Jul 31, 2026

Uh oh!

Uh oh!

testlens-app Bot commented Aug 5, 2026 •

edited

Loading

Uh oh!

mpkorstanje Aug 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

mpkorstanje commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Definition of Done

Uh oh!

Uh oh!

marcphilipp Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

marcphilipp Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

marcphilipp Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

testlens-app Bot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 TestLens detected 37 failed tests 🚨

Test Summary

CI / Build / Linux > :platform-tooling-support-tests:test

CI / Build / Windows > :platform-tooling-support-tests:test

CI / Build / macOS > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJ9 25 > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJDK 26 (ga) > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJDK 26 (leyden) > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJDK 27 (ea) > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJDK 27 (valhalla) > :platform-tooling-support-tests:test

CI / Cross-Version / OpenJDK 28 (ea) > :platform-tooling-support-tests:test

Test Failures (first 10 of 111)

Muted Tests (first 20 of 37)

Uh oh!

mpkorstanje Aug 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mpkorstanje commented Jul 30, 2026 •

edited

Loading

testlens-app Bot commented Aug 5, 2026 •

edited

Loading