Allow disabling discovery issues reported by the Vintage engine (#5049)

Whether the Vintage engine should report discovery issues such as
deprecation notices is now configurable via the new
`junit.vintage.discovery.issue.reporting.enabled` configuration
parameter.

Resolves #5030.

(cherry picked from commit 4041234)

Author: marcphilipp

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

@@ -64,4 +64,6 @@ repository on GitHub.
 [[release-notes-6.0.1-junit-vintage-new-features-and-improvements]]
 ==== New Features and Improvements
 
-* ❓
+* Allow disabling the reporting of discovery issues by the JUnit Vintage engine (including
+  the one reported for its deprecation) by setting the new
+  `junit.vintage.discovery.issue.reporting.enabled` configuration parameter to `false`.

documentation/src/docs/asciidoc/user-guide/migration-from-junit4.adoc

@@ -19,10 +19,19 @@ classpath does not lead to any conflicts. It is therefore safe to maintain exist
 [[migrating-from-junit4-running]]
 === Running JUnit 4 Tests on the JUnit Platform
 
-WARNING: The JUnit Vintage engine is deprecated and should only be used temporarily while
+[WARNING]
+====
+The JUnit Vintage engine is deprecated and should only be used temporarily while
 migrating tests to JUnit Jupiter or another testing framework with native JUnit Platform
 support.
 
+By default, if the JUnit Vintage engine is registered and discovers at least one test
+class, it reports a <<running-tests-discovery-issues, discovery issue>> of INFO severity.
+You can prevent this discovery issue from being reported by setting the
+`junit.vintage.discovery.issue.reporting.enabled`
+<<running-tests-config-params, configuration parameter>> to `false`.
+====
+
 Make sure that the `junit-vintage-engine` artifact is in your test runtime path. In that
 case JUnit 3 and JUnit 4 tests will automatically be picked up by the JUnit Platform
 launcher.

junit-vintage-engine/src/main/java/org/junit/vintage/engine/Constants.java

@@ -72,6 +72,18 @@ public final class Constants {
 	@API(status = MAINTAINED, since = "5.13.3")
 	public static final String PARALLEL_METHOD_EXECUTION = "junit.vintage.execution.parallel.methods";
 
+	/**
+	 * Property name used to configure whether the JUnit Vintage engine should
+	 * report discovery issues such as deprecation notices.
+	 *
+	 * <p>Set this property to {@code false} to disable reporting of discovery
+	 * issues. Defaults to {@code true}.
+	 *
+	 * @since 6.0.1
+	 */
+	@API(status = MAINTAINED, since = "6.0.1")
+	public static final String DISCOVERY_ISSUE_REPORTING_ENABLED_PROPERTY_NAME = "junit.vintage.discovery.issue.reporting.enabled";
+
 	private Constants() {
 		/* no-op */
 	}

junit-vintage-engine/src/main/java/org/junit/vintage/engine/discovery/VintageDiscoverer.java

@@ -19,6 +19,7 @@
 import org.junit.platform.engine.TestDescriptor;
 import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.support.discovery.EngineDiscoveryRequestResolver;
+import org.junit.vintage.engine.Constants;
 import org.junit.vintage.engine.descriptor.RunnerTestDescriptor;
 import org.junit.vintage.engine.descriptor.VintageEngineDescriptor;
 
@@ -46,7 +47,7 @@ public VintageEngineDescriptor discover(EngineDiscoveryRequest discoveryRequest,
 			RunnerTestDescriptor runnerTestDescriptor = (RunnerTestDescriptor) testDescriptor;
 			postProcessor.applyFiltersAndCreateDescendants(runnerTestDescriptor);
 		}
-		if (!engineDescriptor.getChildren().isEmpty()) {
+		if (isDiscoveryIssueReportingEnabled(discoveryRequest) && !engineDescriptor.getChildren().isEmpty()) {
 			var issue = DiscoveryIssue.create(DiscoveryIssue.Severity.INFO, //
 				"The JUnit Vintage engine is deprecated and should only be " //
 						+ "used temporarily while migrating tests to JUnit Jupiter or another testing " //
@@ -56,4 +57,11 @@ public VintageEngineDescriptor discover(EngineDiscoveryRequest discoveryRequest,
 		return engineDescriptor;
 	}
 
+	@SuppressWarnings("deprecation")
+	private static boolean isDiscoveryIssueReportingEnabled(EngineDiscoveryRequest discoveryRequest) {
+		return discoveryRequest.getConfigurationParameters() //
+				.getBoolean(Constants.DISCOVERY_ISSUE_REPORTING_ENABLED_PROPERTY_NAME) //
+				.orElse(true);
+	}
+
 }

junit-vintage-engine/src/test/java/org/junit/vintage/engine/VintageTestEngineDiscoveryTests.java

@@ -713,7 +713,7 @@ void reportsNoDiscoveryIssuesWhenNoTestsAreFound() {
 	}
 
 	@Test
-	void reportDiscoveryIssueWhenTestsAreFound() {
+	void reportDiscoveryIssueWhenTestsAreFoundByDefault() {
 		var request = discoveryRequestForClass(PlainJUnit4TestCaseWithSingleTestWhichFails.class);
 
 		var results = discover(request);
@@ -725,6 +725,18 @@ void reportDiscoveryIssueWhenTestsAreFound() {
 		assertThat(issue.message()).contains("JUnit Vintage engine is deprecated");
 	}
 
+	@SuppressWarnings("deprecation")
+	@Test
+	void reportNoDiscoveryIssueWhenTestsAreFoundButConfigurationParameterIsSet() {
+		var request = request() //
+				.selectors(selectClass(PlainJUnit4TestCaseWithSingleTestWhichFails.class)) //
+				.configurationParameter(Constants.DISCOVERY_ISSUE_REPORTING_ENABLED_PROPERTY_NAME, "false").build();
+
+		var results = discover(request);
+
+		assertThat(results.getDiscoveryIssues()).isEmpty();
+	}
+
 	private TestDescriptor findChildByDisplayName(TestDescriptor runnerDescriptor, String displayName) {
 		// @formatter:off
 		var children = runnerDescriptor.getChildren();