Merge branch 'main' into fix/document-test-type-consistency-requirements

Author: mpkorstanje

.github/workflows/zizmor-analysis.yml

@@ -26,4 +26,4 @@ jobs:
           persist-credentials: false
 
       - name: Run zizmor 🌈
-        uses: zizmorcore/zizmor-action@e673c3917a1aef3c65c972347ed84ccd013ecda4 # v0.2.0
+        uses: zizmorcore/zizmor-action@e639db99335bc9038abc0e066dfcd72e23d26fb4 # v0.3.0

documentation/src/docs/asciidoc/link-attributes.adoc

@@ -103,7 +103,6 @@ endif::[]
 :Events:                                     {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/Events.html[Events]
 :EventStatistics:                            {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/EventStatistics.html[EventStatistics]
 :EventType:                                  {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/EventType.html[EventType]
-:Execution:                                  {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/Execution.html[Execution]
 :Executions:                                 {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/Executions.html[Executions]
 :TerminationInfo:                            {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/TerminationInfo.html[TerminationInfo]
 :TestExecutionResultConditions:              {javadoc-root}/org.junit.platform.testkit/org/junit/platform/testkit/engine/TestExecutionResultConditions.html[TestExecutionResultConditions]

documentation/src/docs/asciidoc/release-notes/index.adoc

@@ -21,6 +21,8 @@ include::{basedir}/release-notes-6.1.0-M2.adoc[]
 
 include::{basedir}/release-notes-6.1.0-M1.adoc[]
 
+include::{basedir}/release-notes-6.0.2.adoc[]
+
 include::{basedir}/release-notes-6.0.1.adoc[]
 
 include::{basedir}/release-notes-6.0.0.adoc[]

documentation/src/docs/asciidoc/release-notes/release-notes-6.0.2.adoc

@@ -0,0 +1,67 @@
+[[release-notes-6.0.2]]
+== 6.0.2
+
+*Date of Release:* ❓
+
+*Scope:* ❓
+
+For a complete list of all _closed_ issues and pull requests for this release, consult the
+link:{junit-framework-repo}+/milestone/113?closed=1+[6.0.2] milestone page in the JUnit
+repository on GitHub.
+
+
+[[release-notes-6.0.2-junit-platform]]
+=== JUnit Platform
+
+[[release-notes-6.0.2-junit-platform-bug-fixes]]
+==== Bug Fixes
+
+* Make `ConsoleLauncher` compatible with JDK 26 by avoiding final field mutations.
+
+[[release-notes-6.0.2-junit-platform-deprecations-and-breaking-changes]]
+==== Deprecations and Breaking Changes
+
+* ❓
+
+[[release-notes-6.0.2-junit-platform-new-features-and-improvements]]
+==== New Features and Improvements
+
+* ❓
+
+
+[[release-notes-6.0.2-junit-jupiter]]
+=== JUnit Jupiter
+
+[[release-notes-6.0.2-junit-jupiter-bug-fixes]]
+==== Bug Fixes
+
+* ❓
+
+[[release-notes-6.0.2-junit-jupiter-deprecations-and-breaking-changes]]
+==== Deprecations and Breaking Changes
+
+* ❓
+
+[[release-notes-6.0.2-junit-jupiter-new-features-and-improvements]]
+==== New Features and Improvements
+
+* ❓
+
+
+[[release-notes-6.0.2-junit-vintage]]
+=== JUnit Vintage
+
+[[release-notes-6.0.2-junit-vintage-bug-fixes]]
+==== Bug Fixes
+
+* ❓
+
+[[release-notes-6.0.2-junit-vintage-deprecations-and-breaking-changes]]
+==== Deprecations and Breaking Changes
+
+* ❓
+
+[[release-notes-6.0.2-junit-vintage-new-features-and-improvements]]
+==== New Features and Improvements
+
+* ❓

documentation/src/docs/asciidoc/user-guide/extensions.adoc

@@ -1032,7 +1032,7 @@ code. User-supplied test and lifecycle methods are shown in orange, with callbac
 implemented by extensions shown in blue. The grey box denotes the execution of a single
 test method and will be repeated for every test method in the test class.
 
-[#extensions-execution-order-diagram]
+[[extensions-execution-order-diagram]]
 .User code and extension code
 image::extensions_lifecycle.png[]
 

documentation/src/docs/asciidoc/user-guide/writing-tests.adoc

@@ -1493,18 +1493,18 @@ display name can be configured for each repetition via the `name` attribute of t
 combination of static text and dynamic placeholders. The following placeholders are
 currently supported.
 
-- `{displayName}`: display name of the `@RepeatedTest` method
-- `{currentRepetition}`: the current repetition count
-- `{totalRepetitions}`: the total number of repetitions
+- `+{displayName}+`: display name of the `@RepeatedTest` method
+- `+{currentRepetition}+`: the current repetition count
+- `+{totalRepetitions}+`: the total number of repetitions
 
 The default display name for a given repetition is generated based on the following
-pattern: `"repetition {currentRepetition} of {totalRepetitions}"`. Thus, the display
+pattern: `"repetition +{currentRepetition}+ of +{totalRepetitions}+"`.Thus, the display
 names for individual repetitions of the previous `repeatedTest()` example would be:
-`repetition 1 of 10`, `repetition 2 of 10`, etc. If you would like the display name of
+`repetition 1 of 10`, `repetition 2 of 10`, etc.If you would like the display name of
 the `@RepeatedTest` method included in the name of each repetition, you can define your
-own custom pattern or use the predefined `RepeatedTest.LONG_DISPLAY_NAME` pattern. The
-latter is equal to `"{displayName} :: repetition {currentRepetition} of
-{totalRepetitions}"` which results in display names for individual repetitions like
+own custom pattern or use the predefined `RepeatedTest.LONG_DISPLAY_NAME` pattern.The
+latter is equal to `"+{displayName}+ :: repetition +{currentRepetition}+ of
++{totalRepetitions}+"` which results in display names for individual repetitions like
 `repeatedTest() :: repetition 1 of 10`, `repeatedTest() :: repetition 2 of 10`, etc.
 
 In order to retrieve information about the current repetition, the total number of
@@ -1524,15 +1524,15 @@ The `repeatedTest()` method is identical to the example from the previous sectio
 current repeated test.
 
 `repeatedTestWithFailureThreshold()` demonstrates how to set a failure threshold and
-simulates an unexpected failure for every second repetition. The resulting behavior can be
+simulates an unexpected failure for every second repetition.The resulting behavior can be
 viewed in the `ConsoleLauncher` output at the end of this section.
 
 The next two methods demonstrate how to include a custom `@DisplayName` for the
 `@RepeatedTest` method in the display name of each repetition. `customDisplayName()`
 combines a custom display name with a custom pattern and then uses `TestInfo` to verify
-the format of the generated display name. `Repeat!` is the `{displayName}` which comes
+the format of the generated display name. `Repeat!` is the `+{displayName}+` which comes
 from the `@DisplayName` declaration, and `1/1` comes from
-`{currentRepetition}/{totalRepetitions}`. In contrast,
+`+{currentRepetition}+/+{totalRepetitions}+`.In contrast,
 `customDisplayNameWithLongPattern()` uses the aforementioned predefined
 `RepeatedTest.LONG_DISPLAY_NAME` pattern.
 
@@ -1823,8 +1823,6 @@ Other extensions can access the parameters and resolved arguments of a parameter
 or class by retrieving a `{ParameterInfo}` object from the `{ExtensionContext_Store}`.
 Please refer to the Javadoc of `{ParameterInfo}` for details.
 
-[[writing-tests-parameterized-tests-argument-aggregation]]
-
 [[writing-tests-parameterized-tests-sources]]
 ==== Sources of Arguments
 

junit-platform-console/src/main/java/org/junit/platform/console/options/TestConsoleOutputOptionsMixin.java

@@ -41,11 +41,11 @@ public static class ConsoleOutputOptions {
 		@Option(names = "--details", paramLabel = "MODE", defaultValue = DEFAULT_DETAILS_NAME, description = "Select an output details mode for when tests are executed. " //
 				+ "Use one of: ${COMPLETION-CANDIDATES}. If 'none' is selected, " //
 				+ "then only the summary and test failures are shown. Default: ${DEFAULT-VALUE}.")
-		private final Details details = DEFAULT_DETAILS;
+		private Details details = DEFAULT_DETAILS;
 
 		@Option(names = "--details-theme", paramLabel = "THEME", description = "Select an output details tree theme for when tests are executed. "
 				+ "Use one of: ${COMPLETION-CANDIDATES}. Default is detected based on default character encoding.")
-		private final Theme theme = DEFAULT_THEME;
+		private Theme theme = DEFAULT_THEME;
 
 		@Option(names = "--redirect-stdout", paramLabel = "FILE", description = "Redirect test output to stdout to a file.")
 		private @Nullable Path stdout;

junit-platform-console/src/main/java/org/junit/platform/console/options/TestDiscoveryOptionsMixin.java

@@ -68,55 +68,55 @@ public static class SelectorOptions {
 
 		@Option(names = { "-u",
 				"--select-uri" }, paramLabel = "URI", arity = "1..*", converter = SelectorConverter.Uri.class, description = "Select a URI for test discovery. This option can be repeated.")
-		private final List<UriSelector> selectedUris = new ArrayList<>();
+		private List<UriSelector> selectedUris = new ArrayList<>();
 
 		@Option(names = { "-f",
 				"--select-file" }, paramLabel = "FILE", arity = "1..*", converter = SelectorConverter.File.class, //
 				description = "Select a file for test discovery. "
 						+ "The line and column numbers can be provided as URI query parameters (e.g. foo.txt?line=12&column=34). "
 						+ "This option can be repeated.")
-		private final List<FileSelector> selectedFiles = new ArrayList<>();
+		private List<FileSelector> selectedFiles = new ArrayList<>();
 
 		@Option(names = { "-d",
 				"--select-directory" }, paramLabel = "DIR", arity = "1..*", converter = SelectorConverter.Directory.class, description = "Select a directory for test discovery. This option can be repeated.")
-		private final List<DirectorySelector> selectedDirectories = new ArrayList<>();
+		private List<DirectorySelector> selectedDirectories = new ArrayList<>();
 
 		@Option(names = { "-o",
 				"--select-module" }, paramLabel = "NAME", arity = "1..*", converter = SelectorConverter.Module.class, description = "Select single module for test discovery. This option can be repeated.")
-		private final List<ModuleSelector> selectedModules = new ArrayList<>();
+		private List<ModuleSelector> selectedModules = new ArrayList<>();
 
 		@Option(names = { "-p",
 				"--select-package" }, paramLabel = "PKG", arity = "1..*", converter = SelectorConverter.Package.class, description = "Select a package for test discovery. This option can be repeated.")
-		private final List<PackageSelector> selectedPackages = new ArrayList<>();
+		private List<PackageSelector> selectedPackages = new ArrayList<>();
 
 		@Option(names = { "-c",
 				"--select-class" }, paramLabel = "CLASS", arity = "1..*", converter = SelectorConverter.Class.class, description = "Select a class for test discovery. This option can be repeated.")
-		private final List<ClassSelector> selectedClasses = new ArrayList<>();
+		private List<ClassSelector> selectedClasses = new ArrayList<>();
 
 		@Option(names = { "-m",
 				"--select-method" }, paramLabel = "NAME", arity = "1..*", converter = SelectorConverter.Method.class, description = "Select a method for test discovery. This option can be repeated.")
-		private final List<MethodSelector> selectedMethods = new ArrayList<>();
+		private List<MethodSelector> selectedMethods = new ArrayList<>();
 
 		@Option(names = { "-r",
 				"--select-resource" }, paramLabel = "RESOURCE", arity = "1..*", converter = SelectorConverter.ClasspathResource.class, description = "Select a classpath resource for test discovery. This option can be repeated.")
-		private final List<ClasspathResourceSelector> selectedClasspathResources = new ArrayList<>();
+		private List<ClasspathResourceSelector> selectedClasspathResources = new ArrayList<>();
 
 		@Option(names = { "-i",
 				"--select-iteration" }, paramLabel = "PREFIX:VALUE[INDEX(..INDEX)?(,INDEX(..INDEX)?)*]", arity = "1..*", converter = SelectorConverter.Iteration.class, //
 				description = "Select iterations for test discovery via a prefixed identifier and a list of indexes or index ranges "
 						+ "(e.g. method:com.acme.Foo#m()[1..2] selects the first and second iteration of the m() method in the com.acme.Foo class). "
 						+ "This option can be repeated.")
-		private final List<IterationSelector> selectedIterations = new ArrayList<>();
+		private List<IterationSelector> selectedIterations = new ArrayList<>();
 
 		@Option(names = { "--select-unique-id",
 				"--uid" }, paramLabel = "UNIQUE-ID", arity = "1..*", converter = SelectorConverter.UniqueId.class, //
 				description = "Select a unique id for test discovery. This option can be repeated.")
-		private final List<UniqueIdSelector> selectedUniqueIds = new ArrayList<>();
+		private List<UniqueIdSelector> selectedUniqueIds = new ArrayList<>();
 
 		@Option(names = "--select", paramLabel = "PREFIX:VALUE", arity = "1..*", converter = SelectorConverter.Identifier.class, //
 				description = "Select via a prefixed identifier (e.g. method:com.acme.Foo#m selects the m() method in the com.acme.Foo class). "
 						+ "This option can be repeated.")
-		private final List<DiscoverySelectorIdentifier> selectorIdentifiers = new ArrayList<>();
+		private List<DiscoverySelectorIdentifier> selectorIdentifiers = new ArrayList<>();
 
 		SelectorOptions() {
 		}
@@ -147,46 +147,46 @@ public static class FilterOptions {
 						+ "names that begin with \"Test\" or end with \"Test\" or \"Tests\". " //
 						+ "When this option is repeated, all patterns will be combined using OR semantics. " //
 						+ "Default: ${DEFAULT-VALUE}")
-		private final List<String> includeClassNamePatterns = new ArrayList<>();
+		private List<String> includeClassNamePatterns = new ArrayList<>();
 
 		@Option(names = { "-N",
 				"--exclude-classname" }, paramLabel = "PATTERN", arity = "1", description = "Provide a regular expression to exclude those classes whose fully qualified names match. " //
 						+ "When this option is repeated, all patterns will be combined using OR semantics.")
-		private final List<String> excludeClassNamePatterns = new ArrayList<>();
+		private List<String> excludeClassNamePatterns = new ArrayList<>();
 
 		@Option(names = "--include-package", paramLabel = "PKG", arity = "1", description = "?Provide a package to be included in the test run. This option can be repeated.")
-		private final List<String> includePackages = new ArrayList<>();
+		private List<String> includePackages = new ArrayList<>();
 
 		@Option(names = "--exclude-package", paramLabel = "PKG", arity = "1", description = "Provide a package to be excluded from the test run. This option can be repeated.")
-		private final List<String> excludePackages = new ArrayList<>();
+		private List<String> excludePackages = new ArrayList<>();
 
 		@Option(names = "--include-methodname", paramLabel = "PATTERN", arity = "1", description = "Provide a regular expression to include only methods whose fully qualified names without parameters match. " //
 				+ "When this option is repeated, all patterns will be combined using OR semantics.")
-		private final List<String> includeMethodNamePatterns = new ArrayList<>();
+		private List<String> includeMethodNamePatterns = new ArrayList<>();
 
 		@Option(names = "--exclude-methodname", paramLabel = "PATTERN", arity = "1", description = "Provide a regular expression to exclude those methods whose fully qualified names without parameters match. " //
 				+ "When this option is repeated, all patterns will be combined using OR semantics.")
-		private final List<String> excludeMethodNamePatterns = new ArrayList<>();
+		private List<String> excludeMethodNamePatterns = new ArrayList<>();
 
 		@Option(names = { "-t",
 				"--include-tag" }, paramLabel = "TAG", arity = "1", description = "Provide a tag or tag expression to include only tests whose tags match. "
 						+ //
 						"When this option is repeated, all patterns will be combined using OR semantics.")
-		private final List<String> includedTags = new ArrayList<>();
+		private List<String> includedTags = new ArrayList<>();
 
 		@Option(names = { "-T",
 				"--exclude-tag" }, paramLabel = "TAG", arity = "1", description = "Provide a tag or tag expression to exclude those tests whose tags match. "
 						+ //
 						"When this option is repeated, all patterns will be combined using OR semantics.")
-		private final List<String> excludedTags = new ArrayList<>();
+		private List<String> excludedTags = new ArrayList<>();
 
 		@Option(names = { "-e",
 				"--include-engine" }, paramLabel = "ID", arity = "1", description = "Provide the ID of an engine to be included in the test run. This option can be repeated.")
-		private final List<String> includedEngines = new ArrayList<>();
+		private List<String> includedEngines = new ArrayList<>();
 
 		@Option(names = { "-E",
 				"--exclude-engine" }, paramLabel = "ID", arity = "1", description = "Provide the ID of an engine to be excluded from the test run. This option can be repeated.")
-		private final List<String> excludedEngines = new ArrayList<>();
+		private List<String> excludedEngines = new ArrayList<>();
 
 		private void applyTo(TestDiscoveryOptions result) {
 			result.setIncludedClassNamePatterns(this.includeClassNamePatterns);
@@ -207,10 +207,10 @@ public static class RuntimeConfigurationOptions {
 		@Option(names = { "-" + CP_OPTION, "--classpath",
 				"--class-path" }, converter = ClasspathEntriesConverter.class, paramLabel = "PATH", arity = "1", description = "Provide additional classpath entries "
 						+ "-- for example, for adding engines and their dependencies. This option can be repeated.")
-		private final List<Path> additionalClasspathEntries = new ArrayList<>();
+		private List<Path> additionalClasspathEntries = new ArrayList<>();
 
 		// Implementation note: the @Option annotation is on a setter method to allow validation.
-		private final Map<String, String> configurationParameters = new LinkedHashMap<>();
+		private Map<String, String> configurationParameters = new LinkedHashMap<>();
 
 		@Option(names = "--config-resource", paramLabel = "PATH", arity = "1", description = "Set configuration parameters for test discovery and execution via a classpath resource. This option can be repeated.")
 		private List<String> configurationParametersResources = new ArrayList<>();

platform-tooling-support-tests/src/main/java/platform/tooling/support/ProcessStarters.java

@@ -50,10 +50,6 @@ public static ProcessStarter gradlew() {
 				.addArguments("-PjunitVersion=" + Helper.version());
 	}
 
-	public static ProcessStarter maven() {
-		return maven(currentJdkHome());
-	}
-
 	public static ProcessStarter maven(Path javaHome) {
 		return new ProcessStarter() //
 				.executable(Path.of(System.getProperty("mavenDistribution")).resolve("bin").resolve(

platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenEnvVars.java

@@ -10,19 +10,33 @@
 
 package platform.tooling.support.tests;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 
 import org.junit.jupiter.api.condition.JRE;
 
 final class MavenEnvVars {
 
-	private static final Map<String, String> FOR_JDK24_AND_LATER = Map.of("MAVEN_OPTS", String.join(" ", //
+	private static final List<String> FOR_JDK24_AND_LATER = List.of( //
 		"--enable-native-access=ALL-UNNAMED", // https://issues.apache.org/jira/browse/MNG-8248
 		"--sun-misc-unsafe-memory-access=allow" // https://issues.apache.org/jira/browse/MNG-8399
-	));
+	);
+	private static final List<String> FOR_JDK26_AND_LATER = List.of( //
+		"--enable-final-field-mutation=ALL-UNNAMED" // https://github.com/junit-team/junit-framework/issues/5173
+	);
 
 	static Map<String, String> forJre(JRE jre) {
-		return jre.compareTo(JRE.JAVA_24) >= 0 ? FOR_JDK24_AND_LATER : Map.of();
+		var list = new ArrayList<String>();
+		if (jre.compareTo(JRE.JAVA_24) >= 0)
+			list.addAll(FOR_JDK24_AND_LATER);
+		if (jre.compareTo(JRE.JAVA_26) >= 0) {
+			// exclude "leyden" and "valhalla" builds
+			if (Runtime.version().build().orElse(0) >= 25) {
+				list.addAll(FOR_JDK26_AND_LATER);
+			}
+		}
+		return list.isEmpty() ? Map.of() : Map.of("MAVEN_OPTS", String.join(" ", list));
 	}
 
 	private MavenEnvVars() {