From fa8c725a3d62439a80f1ad3ad99028e416e65492 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Fri, 21 Feb 2025 14:28:25 +0100 Subject: [PATCH 01/13] Back to snapshots for further development --- gradle.properties | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/gradle.properties b/gradle.properties index 23f0682e81cf..85e568f178ea 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,13 +1,13 @@ group = org.junit -version = 5.12.0 +version = 5.12.1-SNAPSHOT jupiterGroup = org.junit.jupiter platformGroup = org.junit.platform -platformVersion = 1.12.0 +platformVersion = 1.12.1-SNAPSHOT vintageGroup = org.junit.vintage -vintageVersion = 5.12.0 +vintageVersion = 5.12.1-SNAPSHOT # We need more metaspace due to apparent memory leak in Asciidoctor/JRuby # The exports are needed due to https://github.com/diffplug/spotless/issues/834 From f18554ef2cc85b42c50e6bb44a5ed54ea648fbeb Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Tue, 4 Mar 2025 11:47:55 +0100 Subject: [PATCH 02/13] Overhaul Gradle section regarding dependency alignment (#4358) Resolves #4343. --------- Co-authored-by: Sam Brannen <104798+sbrannen@users.noreply.github.com> (cherry picked from commit 0068c244f4607b35c4b330204f8632fe03ee9a25) --- .../asciidoc/user-guide/running-tests.adoc | 130 +++++++++++++----- 1 file changed, 95 insertions(+), 35 deletions(-) diff --git a/documentation/src/docs/asciidoc/user-guide/running-tests.adoc b/documentation/src/docs/asciidoc/user-guide/running-tests.adoc index dfd49d779a28..db03995cb078 100644 --- a/documentation/src/docs/asciidoc/user-guide/running-tests.adoc +++ b/documentation/src/docs/asciidoc/user-guide/running-tests.adoc @@ -13,11 +13,6 @@ however, that it is recommended to use IDEA 2017.3 or newer since more recent ve IDEA download the following JARs automatically based on the API version used in the project: `junit-platform-launcher`, `junit-jupiter-engine`, and `junit-vintage-engine`. -WARNING: IntelliJ IDEA releases prior to IDEA 2017.3 bundle specific versions of JUnit 5. -Thus, if you want to use a newer version of JUnit Jupiter, execution of tests within the -IDE might fail due to version conflicts. In such cases, please follow the instructions -below to use a newer version of JUnit 5 than the one bundled with IntelliJ IDEA. - In order to use a different JUnit 5 version (e.g., {jupiter-version}), you may need to include the corresponding versions of the `junit-platform-launcher`, `junit-jupiter-engine`, and `junit-vintage-engine` JARs in the classpath. @@ -27,9 +22,7 @@ include the corresponding versions of the `junit-platform-launcher`, [subs=attributes+] ---- testImplementation(platform("org.junit:junit-bom:{bom-version}")) -testRuntimeOnly("org.junit.platform:junit-platform-launcher") { - because("Only needed to run tests in a version of IntelliJ IDEA that bundles older versions") -} +testRuntimeOnly("org.junit.platform:junit-platform-launcher") testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine") testRuntimeOnly("org.junit.vintage:junit-vintage-engine") ---- @@ -40,7 +33,6 @@ testRuntimeOnly("org.junit.vintage:junit-vintage-engine") ---- - org.junit.platform junit-platform-launcher @@ -150,48 +142,63 @@ test { ---- Please refer to the -https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_test[official Gradle documentation] +https://docs.gradle.org/current/userguide/java_testing.html[official Gradle documentation] for a comprehensive list of options. [[running-tests-build-gradle-bom]] ===== Aligning dependency versions +TIP: See <> for details on how to override the version +of JUnit used in your Spring Boot application. + Unless you're using Spring Boot which defines its own way of managing dependencies, it is -recommended to use the JUnit Platform BOM to align the versions of all JUnit 5 artifacts. +recommended to use the JUnit Platform <> to align the +versions of all JUnit 5 artifacts. [source,groovy,indent=0] [subs=attributes+] +.Explicit platform dependency on the BOM ---- dependencies { testImplementation(platform("org.junit:junit-bom:{bom-version}")) + testImplementation("org.junit.jupiter:junit-jupiter") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") } ---- Using the BOM allows you to omit the version when declaring dependencies on all artifacts with the `org.junit.platform`, `org.junit.jupiter`, and `org.junit.vintage` group IDs. -TIP: See <> for details on how to override the version -of JUnit used in your Spring Boot application. - -[[running-tests-build-gradle-config-params]] -===== Configuration Parameters - -The standard Gradle `test` task currently does not provide a dedicated DSL to set JUnit -Platform <> to influence test -discovery and execution. However, you can provide configuration parameters within the -build script via system properties (as shown below) or via the -`junit-platform.properties` file. +Since all JUnit artifacts declare a +https://docs.gradle.org/current/userguide/platforms.html[platform] dependency on the BOM, +you usually don't need to declare an explicit dependency on it yourself. Instead, it's +sufficient to declare _one_ regular dependency that includes a version number. Gradle will +then pull in the BOM automatically so you can omit the version for all other JUnit 5 +artifacts. [source,groovy,indent=0] +[subs=attributes+] +.Implicit platform dependency on the BOM ---- -test { - // ... - systemProperty("junit.jupiter.conditions.deactivate", "*") - systemProperty("junit.jupiter.extensions.autodetection.enabled", true) - systemProperty("junit.jupiter.testinstance.lifecycle.default", "per_class") - // ... +dependencies { + testImplementation("org.junit.jupiter:junit-jupiter:{jupiter-version}") // <1> + testRuntimeOnly("org.junit.platform:junit-platform-launcher") // <2> } ---- +<1> Dependency declaration with explicit version. Pulls in the `junit-bom` automatically. +<2> Dependency declaration without version. The version is supplied by the `junit-bom`. + +[WARNING] +.Declaring a dependency on junit-platform-launcher +==== +Even though pre-8.0 versions of Gradle don't require declaring an explicit +dependency on `junit-platform-launcher`, it is recommended to do so to ensure the versions +of JUnit artifacts on the test runtime classpath are aligned. + +Moreover, doing so is recommended and in some cases even required when importing the +project into an IDE like <> or +<>. +==== [[running-tests-build-gradle-engines-configure]] ===== Configuring Test Engines @@ -205,7 +212,38 @@ on the dependency-aggregating JUnit Jupiter artifact similar to the following. [subs=attributes+] ---- dependencies { - testImplementation("org.junit.jupiter:junit-jupiter:{jupiter-version}") // version can be omitted when using the BOM + testImplementation("org.junit.jupiter:junit-jupiter:{jupiter-version}") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} +---- + +Alternatively, you can use Gradle's +https://docs.gradle.org/current/userguide/jvm_test_suite_plugin.html[JVM Test Suite] +support. + +[source,kotlin,indent=0] +[subs=attributes+] +.Kotlin DSL +---- +testing { + suites { + named("test") { + useJUnitJupiter("{jupiter-version}") + } + } +} +---- + +[source,groovy,indent=0] +[subs=attributes+] +.Groovy DSL +---- +testing { + suites { + test { + useJUnitJupiter("{jupiter-version}") + } + } } ---- @@ -218,7 +256,28 @@ implementation similar to the following. ---- dependencies { testImplementation("junit:junit:{junit4-version}") - testRuntimeOnly("org.junit.vintage:junit-vintage-engine:{vintage-version}") // version can be omitted when using the BOM + testRuntimeOnly("org.junit.vintage:junit-vintage-engine:{vintage-version}") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} +---- + +[[running-tests-build-gradle-config-params]] +===== Configuration Parameters + +The standard Gradle `test` task currently does not provide a dedicated DSL to set JUnit +Platform <> to influence test +discovery and execution. However, you can provide configuration parameters within the +build script via system properties (as shown below) or via the +`junit-platform.properties` file. + +[source,groovy,indent=0] +---- +test { + // ... + systemProperty("junit.jupiter.conditions.deactivate", "*") + systemProperty("junit.jupiter.extensions.autodetection.enabled", true) + systemProperty("junit.jupiter.testinstance.lifecycle.default", "per_class") + // ... } ---- @@ -248,8 +307,8 @@ test { Other logging frameworks provide different means to redirect messages logged using `java.util.logging`. For example, for {Logback} you can use the -https://www.slf4j.org/legacy.html#jul-to-slf4j[JUL to SLF4J Bridge] by adding an -additional dependency to the runtime classpath. +https://www.slf4j.org/legacy.html#jul-to-slf4j[JUL to SLF4J Bridge] by adding it as a +dependency to the test runtime classpath. [[running-tests-build-maven]] ==== Maven @@ -288,7 +347,8 @@ Maven build as follows. ===== Aligning dependency versions Unless you're using Spring Boot which defines its own way of managing dependencies, it is -recommended to use the JUnit Platform BOM to align the versions of all JUnit 5 artifacts. +recommended to use the JUnit Platform <> to align the +versions of all JUnit 5 artifacts. [source,xml,indent=0] [subs=attributes+] @@ -580,8 +640,8 @@ managing the version of JUnit used in your project. In addition, the Jupiter, AssertJ, Mockito, etc. If your build relies on dependency management support from Spring Boot, you should not -import the <> in your build script since that -will result in duplicate (and potentially conflicting) management of JUnit dependencies. +import JUnit's <> in your build script since that would +result in duplicate (and potentially conflicting) management of JUnit dependencies. If you need to override the version of a dependency used in your Spring Boot application, you have to override the exact name of the From 7030418723ad0f53a9ce4a09aac5fc30c914ed19 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Sat, 8 Mar 2025 12:14:49 +0100 Subject: [PATCH 03/13] Exclude shadowed packages from API reports (cherry picked from commit 1caca7dbb0fc9bf37622e160bd72cd8d4e00ab1a) --- .../src/tools/java/org/junit/api/tools/ApiReportGenerator.java | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java b/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java index 02b7baa3f47d..100593ceb93d 100644 --- a/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java +++ b/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java @@ -133,6 +133,7 @@ ApiReport generateReport(String... packages) { private static ScanResult scanClasspath(String[] packages) { var classGraph = new ClassGraph() // .acceptPackages(packages) // + .rejectPackages("*.shadow.*") // .disableNestedJarScanning() // .enableClassInfo() // .enableMethodInfo() // From 31d60b7751e415853b582a275fe626b0358ab939 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Sun, 9 Mar 2025 13:28:16 +0100 Subject: [PATCH 04/13] Split API reports by module and package --- documentation/documentation.gradle.kts | 1 + .../api/tools/AbstractApiReportWriter.java | 29 ++++-- .../junit/api/tools/ApiReportGenerator.java | 97 ++++++++++--------- .../api/tools/AsciidocApiReportWriter.java | 18 +++- .../java/org/junit/api/tools/Declaration.java | 30 +++++- .../junit/api/tools/HtmlApiReportWriter.java | 17 +++- .../api/tools/MarkdownApiReportWriter.java | 17 +++- 7 files changed, 142 insertions(+), 67 deletions(-) diff --git a/documentation/documentation.gradle.kts b/documentation/documentation.gradle.kts index 45095cdef845..77f40b0cca43 100644 --- a/documentation/documentation.gradle.kts +++ b/documentation/documentation.gradle.kts @@ -55,6 +55,7 @@ dependencies { // Pull in all "modular projects" to ensure that they are included // in reports generated by the ApiReportGenerator. modularProjects.forEach { apiReport(it) } + apiReport(libs.openTestReporting.tooling.spi) // Pull in all "mavenized projects" to ensure that they are included // in the generation of build provenance attestation. diff --git a/documentation/src/tools/java/org/junit/api/tools/AbstractApiReportWriter.java b/documentation/src/tools/java/org/junit/api/tools/AbstractApiReportWriter.java index 4e08a529fbe1..a35b60211bb4 100644 --- a/documentation/src/tools/java/org/junit/api/tools/AbstractApiReportWriter.java +++ b/documentation/src/tools/java/org/junit/api/tools/AbstractApiReportWriter.java @@ -11,10 +11,13 @@ package org.junit.api.tools; import static java.lang.String.format; +import static java.util.stream.Collectors.groupingBy; +import static java.util.stream.Collectors.toList; import java.io.PrintWriter; import java.util.List; import java.util.Set; +import java.util.TreeMap; import org.apiguardian.api.API.Status; @@ -49,12 +52,22 @@ public void printDeclarationInfo(PrintWriter out, Set statuses) { protected void printDeclarationSection(Set statuses, Status status, List declarations, PrintWriter out) { printDeclarationSectionHeader(statuses, status, declarations, out); - if (!declarations.isEmpty()) { - printDeclarationTableHeader(out); - declarations.forEach(it -> printDeclarationTableRow(it, out)); - printDeclarationTableFooter(out); - out.println(); - } + declarations.stream() // + .collect(groupingBy(Declaration::moduleName, TreeMap::new, toList())) // + .forEach((moduleName, moduleDeclarations) -> { + out.println(h4("Module " + moduleName)); + out.println(); + moduleDeclarations.stream() // + .collect(groupingBy(Declaration::packageName, TreeMap::new, toList())) // + .forEach((packageName, packageDeclarations) -> { + out.println(h5("Package " + packageName)); + out.println(); + printDeclarationTableHeader(out); + packageDeclarations.forEach(it -> printDeclarationTableRow(it, out)); + printDeclarationTableFooter(out); + out.println(); + }); + }); } protected void printDeclarationSectionHeader(Set statuses, Status status, List declarations, @@ -74,6 +87,10 @@ protected void printDeclarationSectionHeader(Set statuses, Status status protected abstract String h2(String header); + protected abstract String h4(String header); + + protected abstract String h5(String header); + protected abstract String code(String element); protected abstract String italic(String element); diff --git a/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java b/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java index 100593ceb93d..d256652de1b2 100644 --- a/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java +++ b/documentation/src/tools/java/org/junit/api/tools/ApiReportGenerator.java @@ -10,13 +10,16 @@ package org.junit.api.tools; +import static java.nio.charset.StandardCharsets.UTF_8; import static java.util.stream.Collectors.toCollection; import java.io.BufferedOutputStream; +import java.io.File; import java.io.IOException; import java.io.OutputStream; import java.io.PrintWriter; import java.io.UncheckedIOException; +import java.lang.module.ModuleFinder; import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; @@ -25,6 +28,7 @@ import java.util.EnumSet; import java.util.List; import java.util.Map; +import java.util.Set; import java.util.SortedSet; import java.util.TreeSet; import java.util.stream.Stream; @@ -52,30 +56,30 @@ public static void main(String... args) { // CAUTION: The output produced by this method is used to // generate a table in the User Guide. - var reportGenerator = new ApiReportGenerator(); + try (var scanResult = scanClasspath()) { - // scan all types below "org.junit" package - var apiReport = reportGenerator.generateReport("org.junit"); - - // ApiReportWriter reportWriter = new MarkdownApiReportWriter(apiReport); - ApiReportWriter reportWriter = new AsciidocApiReportWriter(apiReport); - // ApiReportWriter reportWriter = new HtmlApiReportWriter(apiReport); - - // reportWriter.printReportHeader(new PrintWriter(System.out, true)); - - // Print report for all Usage enum constants - // reportWriter.printDeclarationInfo(new PrintWriter(System.out, true), EnumSet.allOf(Status.class)); - - // Print report only for specific Status constants, defaults to only EXPERIMENTAL - parseArgs(args).forEach((status, opener) -> { - try (var stream = opener.openStream()) { - var writer = new PrintWriter(stream == null ? System.out : stream, true); - reportWriter.printDeclarationInfo(writer, EnumSet.of(status)); - } - catch (IOException e) { - throw new UncheckedIOException("Failed to write report", e); - } - }); + var apiReport = generateReport(scanResult); + + // ApiReportWriter reportWriter = new MarkdownApiReportWriter(apiReport); + ApiReportWriter reportWriter = new AsciidocApiReportWriter(apiReport); + // ApiReportWriter reportWriter = new HtmlApiReportWriter(apiReport); + + // reportWriter.printReportHeader(new PrintWriter(System.out, true)); + + // Print report for all Usage enum constants + // reportWriter.printDeclarationInfo(new PrintWriter(System.out, true), EnumSet.allOf(Status.class)); + + // Print report only for specific Status constants, defaults to only EXPERIMENTAL + parseArgs(args).forEach((status, opener) -> { + try (var stream = opener.openStream()) { + var writer = new PrintWriter(stream == null ? System.out : stream, true, UTF_8); + reportWriter.printDeclarationInfo(writer, EnumSet.of(status)); + } + catch (IOException e) { + throw new UncheckedIOException("Failed to write report", e); + } + }); + } } // ------------------------------------------------------------------------- @@ -102,45 +106,48 @@ private interface StreamOpener { OutputStream openStream() throws IOException; } - ApiReport generateReport(String... packages) { + private static ApiReport generateReport(ScanResult scanResult) { Map> declarations = new EnumMap<>(Status.class); for (var status : Status.values()) { declarations.put(status, new ArrayList<>()); } - try (var scanResult = scanClasspath(packages)) { - - var types = collectTypes(scanResult); - types.stream() // - .map(Declaration.Type::new) // - .forEach(type -> declarations.get(type.status()).add(type)); + var types = collectTypes(scanResult); + types.stream() // + .map(Declaration.Type::new) // + .forEach(type -> declarations.get(type.status()).add(type)); - collectMethods(scanResult) // - .map(Declaration.Method::new) // - .filter(method -> !declarations.get(method.status()) // - .contains(new Declaration.Type(method.classInfo()))) // - .forEach(method -> { - types.add(method.classInfo()); - declarations.get(method.status()).add(method); - }); + collectMethods(scanResult) // + .map(Declaration.Method::new) // + .filter(method -> !declarations.get(method.status()) // + .contains(new Declaration.Type(method.classInfo()))) // + .forEach(method -> { + types.add(method.classInfo()); + declarations.get(method.status()).add(method); + }); - declarations.values().forEach(list -> list.sort(null)); + declarations.values().forEach(list -> list.sort(null)); - return new ApiReport(types, declarations); - } + return new ApiReport(types, declarations); } - private static ScanResult scanClasspath(String[] packages) { + private static ScanResult scanClasspath() { + // scan all types below "org.junit" package var classGraph = new ClassGraph() // - .acceptPackages(packages) // - .rejectPackages("*.shadow.*") // + .acceptPackages("org.junit") // + .rejectPackages("*.shadow.*", "org.opentest4j.*") // .disableNestedJarScanning() // .enableClassInfo() // .enableMethodInfo() // .enableAnnotationInfo(); // var apiClasspath = System.getProperty("api.classpath"); if (apiClasspath != null) { - classGraph = classGraph.overrideClasspath(apiClasspath); + var paths = Arrays.stream(apiClasspath.split(File.pathSeparator)).map(Path::of).toArray(Path[]::new); + var bootLayer = ModuleLayer.boot(); + var configuration = bootLayer.configuration().resolveAndBind(ModuleFinder.of(), ModuleFinder.of(paths), + Set.of()); + var layer = bootLayer.defineModulesWithOneLoader(configuration, ClassLoader.getPlatformClassLoader()); + classGraph = classGraph.overrideModuleLayers(layer); } return classGraph.scan(); } diff --git a/documentation/src/tools/java/org/junit/api/tools/AsciidocApiReportWriter.java b/documentation/src/tools/java/org/junit/api/tools/AsciidocApiReportWriter.java index 24ff7b9eab1a..0a285d3ffdea 100644 --- a/documentation/src/tools/java/org/junit/api/tools/AsciidocApiReportWriter.java +++ b/documentation/src/tools/java/org/junit/api/tools/AsciidocApiReportWriter.java @@ -17,7 +17,7 @@ */ class AsciidocApiReportWriter extends AbstractApiReportWriter { - private static final String ASCIIDOC_FORMAT = "| %-52s | %-" + NAME_COLUMN_WIDTH + "s | %-12s%n"; + private static final String ASCIIDOC_FORMAT = "|%-" + NAME_COLUMN_WIDTH + "s | %-12s%n"; AsciidocApiReportWriter(ApiReport apiReport) { super(apiReport); @@ -33,6 +33,16 @@ protected String h2(String header) { return "== " + header; } + @Override + protected String h4(String header) { + return "[discrete]%n==== %s".formatted(header); + } + + @Override + protected String h5(String header) { + return "[discrete]%n===== %s".formatted(header); + } + @Override protected String code(String element) { return "`" + element + "`"; @@ -45,16 +55,16 @@ protected String italic(String element) { @Override protected void printDeclarationTableHeader(PrintWriter out) { + out.println("[cols=\"99,1\"]"); out.println("|==="); - out.printf(ASCIIDOC_FORMAT, "Package Name", "Name", "Since"); + out.printf(ASCIIDOC_FORMAT, "Name", "Since"); out.println(); } @Override protected void printDeclarationTableRow(Declaration declaration, PrintWriter out) { out.printf(ASCIIDOC_FORMAT, // - code(declaration.packageName()), // - code(declaration.name()) + " " + italic("(" + declaration.kind() + ")"), // + code(declaration.name().replace(".", ".")) + " " + italic("(" + declaration.kind() + ")"), // code(declaration.since()) // ); } diff --git a/documentation/src/tools/java/org/junit/api/tools/Declaration.java b/documentation/src/tools/java/org/junit/api/tools/Declaration.java index a6921cce8862..7e8fdd5d1cd9 100644 --- a/documentation/src/tools/java/org/junit/api/tools/Declaration.java +++ b/documentation/src/tools/java/org/junit/api/tools/Declaration.java @@ -24,6 +24,8 @@ sealed interface Declaration extends Comparable { + String moduleName(); + String packageName(); String fullName(); @@ -43,6 +45,11 @@ default int compareTo(Declaration o) { record Type(ClassInfo classInfo) implements Declaration { + @Override + public String moduleName() { + return classInfo.getModuleRef().getName(); + } + @Override public String packageName() { return classInfo.getPackageName(); @@ -55,7 +62,8 @@ public String fullName() { @Override public String name() { - return getShortClassName(classInfo); + var shortClassName = getShortClassName(classInfo); + return classInfo.isAnnotation() ? "@" + shortClassName : shortClassName; } @Override @@ -86,6 +94,11 @@ private AnnotationParameterValueList getParameterValues() { record Method(MethodInfo methodInfo) implements Declaration { + @Override + public String moduleName() { + return classInfo().getModuleRef().getName(); + } + @Override public String packageName() { return classInfo().getPackageName(); @@ -98,14 +111,23 @@ public String fullName() { @Override public String name() { + if (classInfo().isAnnotation()) { + return "@%s(%s=...)".formatted(getShortClassName(classInfo()), methodInfo.getName()); + } + if (methodInfo.isConstructor()) { + return "%s%s".formatted(getShortClassName(classInfo()), methodParameters()); + } return "%s.%s".formatted(getShortClassName(classInfo()), methodSignature()); } private String methodSignature() { - var parameters = Arrays.stream(methodInfo.getParameterInfo()) // + return methodInfo.getName() + methodParameters(); + } + + private String methodParameters() { + return Arrays.stream(methodInfo.getParameterInfo()) // .map(parameterInfo -> parameterInfo.getTypeSignatureOrTypeDescriptor().toStringWithSimpleNames()) // .collect(joining(", ", "(", ")")); - return methodInfo.getName() + parameters; } @Override @@ -152,6 +174,6 @@ private static String getShortClassName(ClassInfo classInfo) { if (typeName.startsWith(packageName + '.')) { typeName = typeName.substring(packageName.length() + 1); } - return typeName; + return typeName.replace('$', '.'); } } diff --git a/documentation/src/tools/java/org/junit/api/tools/HtmlApiReportWriter.java b/documentation/src/tools/java/org/junit/api/tools/HtmlApiReportWriter.java index 56020962d54a..c0f5a237b00a 100644 --- a/documentation/src/tools/java/org/junit/api/tools/HtmlApiReportWriter.java +++ b/documentation/src/tools/java/org/junit/api/tools/HtmlApiReportWriter.java @@ -17,8 +17,8 @@ */ class HtmlApiReportWriter extends AbstractApiReportWriter { - private static final String HTML_HEADER_FORMAT = "\t%s%s%s%n"; - private static final String HTML_ROW_FORMAT = "\t%s%s%s%n"; + private static final String HTML_HEADER_FORMAT = "\t%s%s%n"; + private static final String HTML_ROW_FORMAT = "\t%s%s%n"; HtmlApiReportWriter(ApiReport apiReport) { super(apiReport); @@ -34,6 +34,16 @@ protected String h2(String header) { return "

" + header + "

"; } + @Override + protected String h4(String header) { + return "

" + header + "

"; + } + + @Override + protected String h5(String header) { + return "

" + header + "

{@link Extension Extensions} are provided an instance of * {@code ExtensionContext} to perform their work. * + *

This interface is not intended to be implemented by clients. + * * @since 5.0 * @see Store * @see Namespace @@ -129,6 +131,31 @@ public interface ExtensionContext { */ Optional> getTestClass(); + /** + * Get the enclosing test classes of the current test or container. + * + *

This method is useful to look up annotations on nested test classes + * and their enclosing runtime types: + * + *

{@code
+	 * AnnotationSupport.findAnnotation(
+	 *     extensionContext.getRequiredTestClass(),
+	 *     MyAnnotation.class,
+	 *     extensionContext.getEnclosingTestClasses()
+	 * );
+	 * }

Note: The test descriptors in the discovery result can safely be used + * as non-root descriptors. Engine-test descriptor entries are pruned from * the returned result. As such execution by * {@link EngineExecutionOrchestrator#execute(LauncherDiscoveryResult, EngineExecutionListener)} * will not emit start or emit events for engines without tests. From 1044e2c63c435f735ab78dbbca09e78b13fb5f80 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Thu, 13 Mar 2025 10:03:31 +0100 Subject: [PATCH 11/13] Move entry to 5.12.1 release notes (cherry picked from commit 65827ea4aedf0080483ab219b11a87741ca9bc6a) --- .../src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc b/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc index 6a4303cd6e34..bbf7cb7bcabf 100644 --- a/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc +++ b/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc @@ -21,7 +21,9 @@ on GitHub. [[release-notes-5.12.1-junit-platform-deprecations-and-breaking-changes]] ==== Deprecations and Breaking Changes -* ❓ +* Set stable module name `org.junit.platform.console.standalone` for the + `junit-platform-console-standalone` artifact, superseding the unstable name generated + from the name of the JAR file when putting the artifact on the module path. [[release-notes-5.12.1-junit-platform-new-features-and-improvements]] ==== New Features and Improvements From e28ad4a89047da0aca6aca32b0e45ac8309954e1 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Thu, 13 Mar 2025 10:08:24 +0100 Subject: [PATCH 12/13] Finalize 5.12.1 release notes --- .../release-notes/release-notes-5.12.1.adoc | 39 ++----------------- 1 file changed, 3 insertions(+), 36 deletions(-) diff --git a/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc b/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc index bbf7cb7bcabf..f41490897fb5 100644 --- a/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc +++ b/documentation/src/docs/asciidoc/release-notes/release-notes-5.12.1.adoc @@ -1,9 +1,9 @@ [[release-notes-5.12.1]] == 5.12.1 -*Date of Release:* ❓ +*Date of Release:* March 14, 2025 -*Scope:* ❓ +*Scope:* Bug fixes and enhancements since 5.12.0 For a complete list of all _closed_ issues and pull requests for this release, consult the link:{junit5-repo}+/milestone/91?closed=1+[5.12.1] milestone page in the JUnit repository @@ -13,11 +13,6 @@ on GitHub. [[release-notes-5.12.1-junit-platform]] === JUnit Platform -[[release-notes-5.12.1-junit-platform-bug-fixes]] -==== Bug Fixes - -* ❓ - [[release-notes-5.12.1-junit-platform-deprecations-and-breaking-changes]] ==== Deprecations and Breaking Changes @@ -25,25 +20,10 @@ on GitHub. `junit-platform-console-standalone` artifact, superseding the unstable name generated from the name of the JAR file when putting the artifact on the module path. -[[release-notes-5.12.1-junit-platform-new-features-and-improvements]] -==== New Features and Improvements - -* ❓ - [[release-notes-5.12.1-junit-jupiter]] === JUnit Jupiter -[[release-notes-5.12.1-junit-jupiter-bug-fixes]] -==== Bug Fixes - -* ❓ - -[[release-notes-5.12.1-junit-jupiter-deprecations-and-breaking-changes]] -==== Deprecations and Breaking Changes - -* ❓ - [[release-notes-5.12.1-junit-jupiter-new-features-and-improvements]] ==== New Features and Improvements @@ -55,17 +35,4 @@ on GitHub. [[release-notes-5.12.1-junit-vintage]] === JUnit Vintage -[[release-notes-5.12.1-junit-vintage-bug-fixes]] -==== Bug Fixes - -* ❓ - -[[release-notes-5.12.1-junit-vintage-deprecations-and-breaking-changes]] -==== Deprecations and Breaking Changes - -* ❓ - -[[release-notes-5.12.1-junit-vintage-new-features-and-improvements]] -==== New Features and Improvements - -* ❓ +No changes. From ba9c9ae111f5f06645ebcda2bb831c8e093cc002 Mon Sep 17 00:00:00 2001 From: Marc Philipp Date: Fri, 14 Mar 2025 14:07:50 +0100 Subject: [PATCH 13/13] Release 5.12.1 --- README.md | 2 +- gradle.properties | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index be040f0b3e7c..5b61d030dd0a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This repository is the home of _JUnit 5_. ## Latest Releases -- General Availability (GA): [JUnit 5.12.0](https://github.com/junit-team/junit5/releases/tag/r5.12.0) (February 21, 2025) +- General Availability (GA): [JUnit 5.12.1](https://github.com/junit-team/junit5/releases/tag/r5.12.1) (March 14, 2025) - Preview (Milestone/Release Candidate): N/A ## Documentation diff --git a/gradle.properties b/gradle.properties index 85e568f178ea..493b1f3d62e5 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,13 +1,13 @@ group = org.junit -version = 5.12.1-SNAPSHOT +version = 5.12.1 jupiterGroup = org.junit.jupiter platformGroup = org.junit.platform -platformVersion = 1.12.1-SNAPSHOT +platformVersion = 1.12.1 vintageGroup = org.junit.vintage -vintageVersion = 5.12.1-SNAPSHOT +vintageVersion = 5.12.1 # We need more metaspace due to apparent memory leak in Asciidoctor/JRuby # The exports are needed due to https://github.com/diffplug/spotless/issues/834 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies: