Restore backward compatibility

Author: marcphilipp

documentation/src/docs/asciidoc/release-notes/release-notes-6.0.0-RC3.adoc

@@ -40,12 +40,10 @@ JUnit repository on GitHub.
 * Deprecate
   `EngineDiscoveryRequestResolver.Builder.addResourceContainerSelectorResolver(Predicate)`
   method in favor of `addResourceContainerSelectorResolver(ResourceFilter)`.
-* Change signature of `scanForResourcesInPackage` and `scanForResourcesInClasspathRoot`
-  in `org.junit.platform.commons.support.scanning.ClasspathScanner` methods to take a
-  `ResourceFilter` rather than a
-  `Predicate<org.junit.platform.commons.support.Resource>` and return
-  `List<org.junit.platform.commons.io.Resource>` rather than
-  `List<org.junit.platform.commons.support.Resource>`.
+* Deprecate `Resource`-related methods in `ClasspathScanner` in favor of new methods using
+  `org.junit.platform.commons.io.Resource` and `ResourceFilter`:
+  - `scanForResourcesInPackage(String, Predicate)`
+  - `scanForResourcesInClasspathRoot(URI, Predicate)`
 
 [[release-notes-6.0.0-RC3-junit-platform-new-features-and-improvements]]
 ==== New Features and Improvements

junit-platform-commons/src/main/java/org/junit/platform/commons/support/scanning/ClasspathScanner.java

@@ -10,10 +10,12 @@
 
 package org.junit.platform.commons.support.scanning;
 
+import static org.apiguardian.api.API.Status.DEPRECATED;
 import static org.apiguardian.api.API.Status.MAINTAINED;
 
 import java.net.URI;
 import java.util.List;
+import java.util.function.Predicate;
 
 import org.apiguardian.api.API;
 import org.junit.platform.commons.io.Resource;
@@ -62,6 +64,55 @@ public interface ClasspathScanner {
 	 */
 	List<Class<?>> scanForClassesInClasspathRoot(URI root, ClassFilter classFilter);
 
+	/**
+	 * Find all {@linkplain org.junit.platform.commons.support.Resource resources} in the supplied classpath {@code root}
+	 * that match the specified {@code resourceFilter} predicate.
+	 *
+	 * <p>The classpath scanning algorithm searches recursively in subpackages
+	 * beginning with the root of the classpath.
+	 *
+	 * @param basePackageName the name of the base package in which to start
+	 * scanning; must not be {@code null} and must be valid in terms of Java
+	 * syntax
+	 * @param resourceFilter the resource type filter; never {@code null}
+	 * @return a list of all such resources found; never {@code null}
+	 * but potentially empty
+	 * @deprecated Please implement
+	 * {@link #scanForResourcesInPackage(String, ResourceFilter)} instead
+	 */
+	@API(status = DEPRECATED, since = "6.0")
+	@Deprecated(since = "6.0", forRemoval = true)
+	@SuppressWarnings({ "removal", "unused" })
+	default List<org.junit.platform.commons.support.Resource> scanForResourcesInPackage(String basePackageName,
+			Predicate<org.junit.platform.commons.support.Resource> resourceFilter) {
+		throw new UnsupportedOperationException("Implement scanForResourcesInPackage(String, ResourceFilter) instead");
+	}
+
+	/**
+	 * Find all {@linkplain org.junit.platform.commons.support.Resource resources} in the supplied classpath {@code root}
+	 * that match the specified {@code resourceFilter} predicate.
+	 *
+	 * <p>The classpath scanning algorithm searches recursively in subpackages
+	 * beginning with the root of the classpath.
+	 *
+	 * @param root the URI for the classpath root in which to scan; never
+	 * {@code null}
+	 * @param resourceFilter the resource type filter; never {@code null}
+	 * @return a list of all such resources found; never {@code null}
+	 * but potentially empty
+	 * @deprecated Please implement
+	 * {@link #scanForResourcesInClasspathRoot(URI, ResourceFilter)} instead
+	 */
+	@API(status = DEPRECATED, since = "6.0")
+	@Deprecated(since = "6.0", forRemoval = true)
+	@SuppressWarnings("removal")
+	default List<org.junit.platform.commons.support.Resource> scanForResourcesInClasspathRoot(URI root,
+			Predicate<org.junit.platform.commons.support.Resource> resourceFilter) {
+		throw new UnsupportedOperationException(
+			"Implement scanForResourcesInClasspathRoot(URI, ResourceFilter) instead");
+
+	}
+
 	/**
 	 * Find all {@linkplain Resource resources} in the supplied classpath {@code root}
 	 * that match the specified {@code resourceFilter} predicate.
@@ -78,7 +129,12 @@ public interface ClasspathScanner {
 	 * @since 6.0
 	 */
 	@API(status = MAINTAINED, since = "6.0")
-	List<Resource> scanForResourcesInPackage(String basePackageName, ResourceFilter resourceFilter);
+	@SuppressWarnings("removal")
+	default List<Resource> scanForResourcesInPackage(String basePackageName, ResourceFilter resourceFilter) {
+		return scanForResourcesInPackage(basePackageName, resource -> resourceFilter.match(oldToNew(resource))).stream() //
+				.map(ClasspathScanner::oldToNew) //
+				.toList();
+	}
 
 	/**
 	 * Find all {@linkplain Resource resources} in the supplied classpath {@code root}
@@ -95,6 +151,16 @@ public interface ClasspathScanner {
 	 * @since 6.0
 	 */
 	@API(status = MAINTAINED, since = "6.0")
-	List<Resource> scanForResourcesInClasspathRoot(URI root, ResourceFilter resourceFilter);
+	@SuppressWarnings("removal")
+	default List<Resource> scanForResourcesInClasspathRoot(URI root, ResourceFilter resourceFilter) {
+		return scanForResourcesInClasspathRoot(root, r -> resourceFilter.match(oldToNew(r))).stream() //
+				.map(ClasspathScanner::oldToNew) //
+				.toList();
+	}
+
+	@SuppressWarnings("removal")
+	private static Resource oldToNew(org.junit.platform.commons.support.Resource oldResource) {
+		return Resource.of(oldResource.getName(), oldResource.getUri());
+	}
 
 }

platform-tooling-support-tests/src/archUnit/java/platform/tooling/support/tests/ArchUnitTests.java

@@ -65,6 +65,7 @@
 import org.junit.jupiter.api.extension.MediaType;
 import org.junit.jupiter.params.aggregator.ArgumentsAccessor;
 import org.junit.jupiter.params.support.ParameterInfo;
+import org.junit.platform.commons.support.scanning.ClasspathScanner;
 import org.junit.platform.engine.TestDescriptor;
 import org.junit.platform.engine.reporting.OutputDirectoryProvider;
 
@@ -153,13 +154,17 @@ void freeOfGroupCycles(JavaClasses classes) {
 		slices().matching("org.junit.(*)..").should().beFreeOfCycles().check(classes);
 	}
 
+	@SuppressWarnings("removal")
 	@ArchTest
 	void freeOfPackageCycles(JavaClasses classes) {
 		slices().matching("org.junit.(**)").should().beFreeOfCycles() //
 
 				// https://github.com/junit-team/junit-framework/issues/4886
 				.ignoreDependency(TestReporter.class, MediaType.class) //
 
+				// https://github.com/junit-team/junit-framework/issues/4885
+				.ignoreDependency(ClasspathScanner.class, org.junit.platform.commons.support.Resource.class) //
+
 				// Needs more investigation
 				.ignoreDependency(resideInAPackage("org.junit.platform.console.options"),
 					resideInAPackage("org.junit.platform.console.tasks"))