Improve message of discovery issues for ineffective @Order annotations (#4718)

Resolves #4713.

(cherry picked from commit 9549b59)

Author: marcphilipp

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

@@ -59,6 +59,7 @@ repository on GitHub.
   that both `null` and _blank_ values are supported for reason strings and that such
   values will result in an _empty_ `Optional` returned from
   `ConditionEvaluationResult.getReason()`.
+* Improve message of discovery issues reported for ineffective `@Order` annotations.
 
 
 [[release-notes-5.13.3-junit-vintage]]

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

@@ -28,7 +28,6 @@
 import org.junit.platform.engine.DiscoveryIssue;
 import org.junit.platform.engine.DiscoveryIssue.Severity;
 import org.junit.platform.engine.TestDescriptor;
-import org.junit.platform.engine.support.descriptor.ClassSource;
 import org.junit.platform.engine.support.discovery.DiscoveryIssueReporter;
 import org.junit.platform.engine.support.discovery.DiscoveryIssueReporter.Condition;
 
@@ -49,11 +48,12 @@ class ClassOrderingVisitor extends AbstractOrderingVisitor {
 		this.globalOrderer = createGlobalOrderer(configuration);
 		this.noOrderAnnotation = issueReporter.createReportingCondition(
 			testDescriptor -> !isAnnotated(testDescriptor.getTestClass(), Order.class), testDescriptor -> {
-				String message = String.format(
-					"Ineffective @Order annotation on class '%s'. It will not be applied because ClassOrderer.OrderAnnotation is not in use.",
-					testDescriptor.getTestClass().getName());
+				String message = String.format("Ineffective @Order annotation on class '%s'. ",
+					testDescriptor.getTestClass().getName())
+						+ "It will not be applied because ClassOrderer.OrderAnnotation is not in use. "
+						+ "Note that the annotation may be either directly present or meta-present on the class.";
 				return DiscoveryIssue.builder(Severity.INFO, message) //
-						.source(ClassSource.from(testDescriptor.getTestClass())) //
+						.source(testDescriptor.getSource()) //
 						.build();
 			});
 	}

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

@@ -31,7 +31,6 @@
 import org.junit.platform.engine.DiscoveryIssue;
 import org.junit.platform.engine.DiscoveryIssue.Severity;
 import org.junit.platform.engine.TestDescriptor;
-import org.junit.platform.engine.support.descriptor.MethodSource;
 import org.junit.platform.engine.support.discovery.DiscoveryIssueReporter;
 import org.junit.platform.engine.support.discovery.DiscoveryIssueReporter.Condition;
 
@@ -51,11 +50,12 @@ class MethodOrderingVisitor extends AbstractOrderingVisitor {
 		this.configuration = configuration;
 		this.noOrderAnnotation = issueReporter.createReportingCondition(
 			testDescriptor -> !isAnnotated(testDescriptor.getTestMethod(), Order.class), testDescriptor -> {
-				String message = String.format(
-					"Ineffective @Order annotation on method '%s'. It will not be applied because MethodOrderer.OrderAnnotation is not in use.",
-					testDescriptor.getTestMethod().toGenericString());
+				String message = String.format("Ineffective @Order annotation on method '%s'. ",
+					testDescriptor.getTestMethod().toGenericString())
+						+ "It will not be applied because MethodOrderer.OrderAnnotation is not in use. "
+						+ "Note that the annotation may be either directly present or meta-present on the method.";
 				return DiscoveryIssue.builder(Severity.INFO, message) //
-						.source(MethodSource.from(testDescriptor.getTestMethod())) //
+						.source(testDescriptor.getSource()) //
 						.build();
 			});
 		this.methodsBeforeNestedClassesOrderer = createMethodsBeforeNestedClassesOrderer();

jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/OrderedClassTests.java

@@ -204,7 +204,9 @@ private static void assertIneffectiveOrderAnnotationIssues(List<DiscoveryIssue>
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::severity).containsOnly(Severity.INFO);
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::message) //
 				.allMatch(it -> it.startsWith("Ineffective @Order annotation on class")
-						&& it.endsWith("It will not be applied because ClassOrderer.OrderAnnotation is not in use."));
+						&& it.contains("It will not be applied because ClassOrderer.OrderAnnotation is not in use.")
+						&& it.endsWith(
+							"Note that the annotation may be either directly present or meta-present on the class."));
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::source).extracting(Optional::orElseThrow) //
 				.containsExactlyInAnyOrder(ClassSource.from(A_TestCase.class), ClassSource.from(C_TestCase.class));
 	}

jupiter-tests/src/test/java/org/junit/jupiter/engine/extension/OrderedMethodTests.java

@@ -394,7 +394,9 @@ private static void assertIneffectiveOrderAnnotationIssues(List<DiscoveryIssue>
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::severity).containsOnly(Severity.INFO);
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::message) //
 				.allMatch(it -> it.startsWith("Ineffective @Order annotation on method")
-						&& it.endsWith("It will not be applied because MethodOrderer.OrderAnnotation is not in use."));
+						&& it.contains("It will not be applied because MethodOrderer.OrderAnnotation is not in use.")
+						&& it.endsWith(
+							"Note that the annotation may be either directly present or meta-present on the method."));
 		var testClass = WithoutTestMethodOrderTestCase.class;
 		assertThat(discoveryIssues).extracting(DiscoveryIssue::source).extracting(Optional::orElseThrow) //
 				.containsExactlyInAnyOrder(MethodSource.from(testClass.getDeclaredMethod("test1")),