Merge branch 'main' into marc/4610-fix-annotation-arguments-provider-regression

Author: marcphilipp

.editorconfig

@@ -1,3 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.bat]
+end_of_line = crlf
+
+[*.md]
+# Trailing whitespace is important in Markdown (they distinguish a new line from a new paragraph)
+trim_trailing_whitespace = false
+
 [*.{kt,kts}]
 ij_kotlin_allow_trailing_comma = false
 ij_kotlin_allow_trailing_comma_on_call_site = false

.github/workflows/codeql-analysis.yml

@@ -34,7 +34,7 @@ jobs:
     - name: Check out repository
       uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
+      uses: github/codeql-action/init@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19
       with:
         languages: ${{ matrix.language }}
         tools: linked
@@ -47,4 +47,4 @@ jobs:
           -Dscan.tag.CodeQL \
           classes
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
+      uses: github/codeql-action/analyze@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19

.github/workflows/ossf-scorecard.yml

@@ -57,6 +57,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
+        uses: github/codeql-action/upload-sarif@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19
         with:
           sarif_file: results.sarif

documentation/documentation.gradle.kts

@@ -165,7 +165,7 @@ tasks {
 		args.addAll("--config=junit.platform.reporting.open.xml.enabled=true")
 		args.addAll("--config=junit.platform.output.capture.stdout=true")
 		args.addAll("--config=junit.platform.output.capture.stderr=true")
-		args.addAll("--config=junit.platform.discovery.issue.severity.critical=warn")
+		args.addAll("--config=junit.platform.discovery.issue.severity.critical=warning")
 		outputs.dir(consoleLauncherTestReportsDir)
 		argumentProviders.add(CommandLineArgumentProvider {
 			listOf(
@@ -202,7 +202,7 @@ tasks {
 		(options as JUnitPlatformOptions).apply {
 			includeEngines("junit-vintage")
 			includeTags("timeout")
-			systemProperty("junit.platform.discovery.issue.severity.critical", "warn")
+			systemProperty("junit.platform.discovery.issue.severity.critical", "warning")
 		}
 	}
 

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

@@ -35,6 +35,13 @@ on GitHub.
 [[release-notes-5.13.1-junit-jupiter-bug-fixes]]
 ==== Bug Fixes
 
+* The 5.13.0 release introduced a regression regarding the execution order in test classes
+  containing both test methods and `@Nested` test classes. When classpath scanning was
+  used during test discovery -- for example, when resolving a package selector for a
+  `@Suite` class -- test methods in `@Nested` classes were executed _before_ test methods
+  in their enclosing class. This undesired change in behavior has now been reverted so
+  that tests in `@Nested` test classes are always executed _after_ tests in enclosing test
+  classes again.
 * Fix support for `AnnotationBasedArgumentsProvider` implementations that override the
   deprecated `provideArguments(ExtensionContext, Annotation)` method.
 

gradle/libs.versions.toml

@@ -53,7 +53,7 @@ junit4 = { module = "junit:junit", version = { require = "[4.12,)", prefer = "4.
 kotlinx-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version = "1.10.2" }
 log4j-core = { module = "org.apache.logging.log4j:log4j-core", version.ref = "log4j" }
 log4j-jul = { module = "org.apache.logging.log4j:log4j-jul", version.ref = "log4j" }
-maven = { module = "org.apache.maven:apache-maven", version = "3.9.9" }
+maven = { module = "org.apache.maven:apache-maven", version = "3.9.10" }
 mavenSurefirePlugin = { module = "org.apache.maven.plugins:maven-surefire-plugin", version.ref = "surefire" }
 memoryfilesystem = { module = "com.github.marschall:memoryfilesystem", version = "2.8.1" }
 mockito-bom = { module = "org.mockito:mockito-bom", version = "5.18.0" }
@@ -96,7 +96,7 @@ asciidoctorConvert = { id = "org.asciidoctor.jvm.convert", version.ref = "asciid
 asciidoctorPdf = { id = "org.asciidoctor.jvm.pdf", version.ref = "asciidoctor-plugins" }
 bnd = { id = "biz.aQute.bnd", version.ref = "bnd" }
 buildParameters = { id = "org.gradlex.build-parameters", version = "1.4.4" }
-commonCustomUserData = { id = "com.gradle.common-custom-user-data-gradle-plugin", version = "2.2.1" }
+commonCustomUserData = { id = "com.gradle.common-custom-user-data-gradle-plugin", version = "2.3" }
 develocity = { id = "com.gradle.develocity", version = "4.0.2" }
 errorProne = { id = "net.ltgt.errorprone", version = "4.2.0" }
 extraJavaModuleInfo = { id = "org.gradlex.extra-java-module-info", version = "1.12" }
@@ -105,7 +105,7 @@ gitPublish = { id = "org.ajoberstar.git-publish", version = "5.1.1" }
 jmh = { id = "me.champeau.jmh", version = "0.7.3" }
 jreleaser = { id = "org.jreleaser", version = "1.18.0" }
 # check if workaround in gradle.properties can be removed when updating
-kotlin = { id = "org.jetbrains.kotlin.jvm", version = "2.2.0-RC" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version = "2.2.0-RC2" }
 nullaway = { id = "net.ltgt.nullaway", version = "2.2.0" }
 openrewrite = { id = "org.openrewrite.rewrite", version = "7.7.0" }
 plantuml = { id = "io.freefair.plantuml", version = "8.13.1" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=845952a9d6afa783db70bb3b0effaae45ae5542ca2bb7929619e8af49cb634cf
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.1-bin.zip
+distributionSha256Sum=7197a12f450794931532469d4ff21a59ea2c1cd59a3ec3f89c035c3c420a6999
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/AbstractJreCondition.java

@@ -33,21 +33,20 @@ abstract class AbstractJreCondition<A extends Annotation> extends BooleanExecuti
 	static final String DISABLED_ON_CURRENT_JRE = //
 		"Disabled on JRE version: " + System.getProperty("java.version");
 
-	private final String annotationName;
-
 	AbstractJreCondition(Class<A> annotationType, Function<A, String> customDisabledReason) {
 		super(annotationType, ENABLED_ON_CURRENT_JRE, DISABLED_ON_CURRENT_JRE, customDisabledReason);
-		this.annotationName = annotationType.getSimpleName();
 	}
 
 	protected final IntStream validatedVersions(JRE[] jres, int[] versions) {
+		String annotationName = super.annotationType.getSimpleName();
+
 		Preconditions.condition(jres.length > 0 || versions.length > 0,
-			() -> "You must declare at least one JRE or version in @" + this.annotationName);
+			() -> "You must declare at least one JRE or version in @" + annotationName);
 
 		Preconditions.condition(Arrays.stream(jres).noneMatch(isEqual(JRE.UNDEFINED)),
-			() -> "JRE.UNDEFINED is not supported in @" + this.annotationName);
+			() -> "JRE.UNDEFINED is not supported in @" + annotationName);
 		Arrays.stream(versions).min().ifPresent(version -> Preconditions.condition(version >= JRE.MINIMUM_VERSION,
-			() -> "Version [%d] in @%s must be greater than or equal to %d".formatted(version, this.annotationName,
+			() -> "Version [%d] in @%s must be greater than or equal to %d".formatted(version, annotationName,
 				JRE.MINIMUM_VERSION)));
 
 		return IntStream.concat(//

junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/AbstractJreRangeCondition.java

@@ -29,14 +29,13 @@ abstract class AbstractJreRangeCondition<A extends Annotation> extends BooleanEx
 	private static final JRE DEFAULT_MINIMUM_JRE = JRE.JAVA_17;
 	private static final JRE DEFAULT_MAXIMUM_JRE = JRE.OTHER;
 
-	private final String annotationName;
-
 	AbstractJreRangeCondition(Class<A> annotationType, Function<A, String> customDisabledReason) {
 		super(annotationType, ENABLED_ON_CURRENT_JRE, DISABLED_ON_CURRENT_JRE, customDisabledReason);
-		this.annotationName = annotationType.getSimpleName();
 	}
 
 	protected final boolean isCurrentVersionWithinRange(JRE minJre, JRE maxJre, int minVersion, int maxVersion) {
+		String annotationName = super.annotationType.getSimpleName();
+
 		boolean minJreSet = minJre != JRE.UNDEFINED;
 		boolean maxJreSet = maxJre != JRE.UNDEFINED;
 		boolean minVersionSet = minVersion != JRE.UNDEFINED_VERSION;
@@ -45,17 +44,17 @@ protected final boolean isCurrentVersionWithinRange(JRE minJre, JRE maxJre, int
 		// Users must choose between JRE enum constants and version numbers.
 		Preconditions.condition(!minJreSet || !minVersionSet,
 			() -> "@%s's minimum value must be configured with either a JRE enum constant or numeric version, but not both".formatted(
-				this.annotationName));
+				annotationName));
 		Preconditions.condition(!maxJreSet || !maxVersionSet,
 			() -> "@%s's maximum value must be configured with either a JRE enum constant or numeric version, but not both".formatted(
-				this.annotationName));
+				annotationName));
 
 		// Users must supply valid values for minVersion and maxVersion.
 		Preconditions.condition(!minVersionSet || (minVersion >= JRE.MINIMUM_VERSION),
-			() -> "@%s's minVersion [%d] must be greater than or equal to %d".formatted(this.annotationName, minVersion,
+			() -> "@%s's minVersion [%d] must be greater than or equal to %d".formatted(annotationName, minVersion,
 				JRE.MINIMUM_VERSION));
 		Preconditions.condition(!maxVersionSet || (maxVersion >= JRE.MINIMUM_VERSION),
-			() -> "@%s's maxVersion [%d] must be greater than or equal to %d".formatted(this.annotationName, maxVersion,
+			() -> "@%s's maxVersion [%d] must be greater than or equal to %d".formatted(annotationName, maxVersion,
 				JRE.MINIMUM_VERSION));
 
 		// Now that we have checked the basic preconditions, we need to ensure that we are
@@ -72,10 +71,10 @@ protected final boolean isCurrentVersionWithinRange(JRE minJre, JRE maxJre, int
 
 		// Finally, we need to validate the effective minimum and maximum values.
 		Preconditions.condition((min != DEFAULT_MINIMUM_JRE.version() || max != DEFAULT_MAXIMUM_JRE.version()),
-			() -> "You must declare a non-default value for the minimum or maximum value in @" + this.annotationName);
+			() -> "You must declare a non-default value for the minimum or maximum value in @" + annotationName);
 		Preconditions.condition(min <= max,
 			() -> "@%s's minimum value [%d] must be less than or equal to its maximum value [%d]".formatted(
-				this.annotationName, min, max));
+				annotationName, min, max));
 
 		return JRE.isCurrentVersionWithinRange(min, max);
 	}

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/discovery/MethodOrderingVisitor.java

@@ -10,12 +10,14 @@
 
 package org.junit.jupiter.engine.discovery;
 
+import static java.util.Comparator.comparing;
 import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;
 import static org.junit.platform.commons.support.AnnotationSupport.isAnnotated;
 
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Consumer;
+import java.util.function.UnaryOperator;
 
 import org.junit.jupiter.api.MethodOrderer;
 import org.junit.jupiter.api.Order;
@@ -40,6 +42,9 @@ class MethodOrderingVisitor extends AbstractOrderingVisitor {
 	private final JupiterConfiguration configuration;
 	private final Condition<MethodBasedTestDescriptor> noOrderAnnotation;
 
+	// Not a static field to avoid initialization at build time for GraalVM
+	private final UnaryOperator<List<TestDescriptor>> methodsBeforeNestedClassesOrderer;
+
 	MethodOrderingVisitor(JupiterConfiguration configuration, DiscoveryIssueReporter issueReporter) {
 		super(issueReporter);
 		this.configuration = configuration;
@@ -51,6 +56,7 @@ class MethodOrderingVisitor extends AbstractOrderingVisitor {
 						.source(MethodSource.from(testDescriptor.getTestMethod())) //
 						.build();
 			});
+		this.methodsBeforeNestedClassesOrderer = createMethodsBeforeNestedClassesOrderer();
 	}
 
 	@Override
@@ -80,6 +86,7 @@ private void orderContainedMethods(ClassBasedTestDescriptor classBasedTestDescri
 
 	private void orderContainedMethods(ClassBasedTestDescriptor classBasedTestDescriptor, Class<?> testClass,
 			Optional<MethodOrderer> methodOrderer) {
+
 		DescriptorWrapperOrderer<?, DefaultMethodDescriptor> descriptorWrapperOrderer = createDescriptorWrapperOrderer(
 			testClass, methodOrderer);
 
@@ -89,6 +96,11 @@ private void orderContainedMethods(ClassBasedTestDescriptor classBasedTestDescri
 			DefaultMethodDescriptor::new, //
 			descriptorWrapperOrderer);
 
+		if (methodOrderer.isEmpty()) {
+			// If there is an orderer, this is ensured by the call above
+			classBasedTestDescriptor.orderChildren(methodsBeforeNestedClassesOrderer);
+		}
+
 		// Note: MethodOrderer#getDefaultExecutionMode() is guaranteed
 		// to be invoked after MethodOrderer#orderMethods().
 		methodOrderer //
@@ -126,4 +138,12 @@ private Optional<Consumer<MethodBasedTestDescriptor>> toValidationAction(Optiona
 		return Optional.of(noOrderAnnotation::check);
 	}
 
+	private static UnaryOperator<List<TestDescriptor>> createMethodsBeforeNestedClassesOrderer() {
+		var methodsFirst = comparing(MethodBasedTestDescriptor.class::isInstance).reversed();
+		return children -> {
+			children.sort(methodsFirst);
+			return children;
+		};
+	}
+
 }