Move DefaultClasspathScanner to org.junit.platform.commons.util

...to avoid package cycle

Author: marcphilipp

junit-platform-commons/src/main/java/org/junit/platform/commons/support/scanning/ClasspathFileVisitor.java renamed to junit-platform-commons/src/main/java/org/junit/platform/commons/util/ClasspathFileVisitor.java

@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import static java.nio.file.FileVisitResult.CONTINUE;
 

junit-platform-commons/src/main/java/org/junit/platform/commons/support/scanning/ClasspathFilters.java renamed to junit-platform-commons/src/main/java/org/junit/platform/commons/util/ClasspathFilters.java

@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import java.nio.file.Path;
 import java.util.function.Predicate;

junit-platform-commons/src/main/java/org/junit/platform/commons/util/ClasspathScannerLoader.java

@@ -16,7 +16,6 @@
 
 import org.junit.platform.commons.JUnitException;
 import org.junit.platform.commons.support.scanning.ClasspathScanner;
-import org.junit.platform.commons.support.scanning.DefaultClasspathScanner;
 
 /**
  * @since 1.12

junit-platform-commons/src/main/java/org/junit/platform/commons/support/scanning/CloseablePath.java renamed to junit-platform-commons/src/main/java/org/junit/platform/commons/util/CloseablePath.java

@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import static java.util.Collections.emptyMap;
 

junit-platform-commons/src/main/java/org/junit/platform/commons/support/scanning/DefaultClasspathScanner.java renamed to junit-platform-commons/src/main/java/org/junit/platform/commons/util/DefaultClasspathScanner.java

@@ -8,11 +8,10 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import static java.util.stream.Collectors.joining;
-import static org.apiguardian.api.API.Status.INTERNAL;
-import static org.junit.platform.commons.support.scanning.ClasspathFilters.CLASS_FILE_SUFFIX;
+import static org.junit.platform.commons.util.ClasspathFilters.CLASS_FILE_SUFFIX;
 import static org.junit.platform.commons.util.StringUtils.isNotBlank;
 
 import java.io.IOException;
@@ -33,15 +32,13 @@
 import java.util.function.Supplier;
 import java.util.stream.Stream;
 
-import org.apiguardian.api.API;
 import org.junit.platform.commons.PreconditionViolationException;
 import org.junit.platform.commons.function.Try;
 import org.junit.platform.commons.logging.Logger;
 import org.junit.platform.commons.logging.LoggerFactory;
 import org.junit.platform.commons.support.Resource;
-import org.junit.platform.commons.util.PackageUtils;
-import org.junit.platform.commons.util.Preconditions;
-import org.junit.platform.commons.util.UnrecoverableExceptions;
+import org.junit.platform.commons.support.scanning.ClassFilter;
+import org.junit.platform.commons.support.scanning.ClasspathScanner;
 
 /**
  * <h2>DISCLAIMER</h2>
@@ -52,8 +49,7 @@
  *
  * @since 1.0
  */
-@API(status = INTERNAL, since = "1.12")
-public class DefaultClasspathScanner implements ClasspathScanner {
+class DefaultClasspathScanner implements ClasspathScanner {
 
 	private static final Logger logger = LoggerFactory.getLogger(DefaultClasspathScanner.class);
 
@@ -72,7 +68,7 @@ public class DefaultClasspathScanner implements ClasspathScanner {
 
 	private final BiFunction<String, ClassLoader, Try<Class<?>>> loadClass;
 
-	public DefaultClasspathScanner(Supplier<ClassLoader> classLoaderSupplier,
+	DefaultClasspathScanner(Supplier<ClassLoader> classLoaderSupplier,
 			BiFunction<String, ClassLoader, Try<Class<?>>> loadClass) {
 
 		this.classLoaderSupplier = classLoaderSupplier;

platform-tests/src/test/java/org/junit/platform/commons/support/scanning/CloseablePathTests.java renamed to platform-tests/src/test/java/org/junit/platform/commons/util/CloseablePathTests.java

@@ -8,11 +8,11 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.junit.platform.commons.support.scanning.CloseablePath.JAR_URI_SCHEME;
+import static org.junit.platform.commons.util.CloseablePath.JAR_URI_SCHEME;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.only;
@@ -31,8 +31,8 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.platform.commons.support.scanning.CloseablePath.FileSystemProvider;
 import org.junit.platform.commons.test.ConcurrencyTestingUtils;
+import org.junit.platform.commons.util.CloseablePath.FileSystemProvider;
 import org.junit.platform.engine.support.hierarchical.OpenTest4JAwareThrowableCollector;
 
 class CloseablePathTests {

platform-tests/src/test/java/org/junit/platform/commons/support/scanning/DefaultClasspathScannerTests.java renamed to platform-tests/src/test/java/org/junit/platform/commons/util/DefaultClasspathScannerTests.java

@@ -8,7 +8,7 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
-package org.junit.platform.commons.support.scanning;
+package org.junit.platform.commons.util;
 
 import static java.util.Objects.requireNonNull;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -49,8 +49,7 @@
 import org.junit.platform.commons.function.Try;
 import org.junit.platform.commons.logging.LogRecordListener;
 import org.junit.platform.commons.support.Resource;
-import org.junit.platform.commons.util.ClassLoaderUtils;
-import org.junit.platform.commons.util.ReflectionUtils;
+import org.junit.platform.commons.support.scanning.ClassFilter;
 
 /**
  * Unit tests for {@link DefaultClasspathScanner}.

platform-tests/src/test/resources/log4j2-test.xml

@@ -7,7 +7,7 @@
 	</Appenders>
 	<Loggers>
 		<Logger name="org.junit" level="warn" />
-		<Logger name="org.junit.platform.commons.support.scanning.DefaultClasspathScanner" level="error" />
+		<Logger name="org.junit.platform.commons.util.DefaultClasspathScanner" level="error" />
 		<Logger name="org.junit.platform.engine.support.descriptor.DemoClassTestDescriptor" level="error" />
 		<Logger name="org.junit.platform.launcher.core.CompositeEngineExecutionListener" level="error" />
 		<Logger name="org.junit.platform.launcher.core.CompositeTestExecutionListener" level="error" />

platform-tooling-support-tests/projects/graalvm-starter/build.gradle.kts

@@ -30,6 +30,7 @@ tasks.test {
 val initializeAtBuildTime = mapOf(
 	// These need to be added to native-build-tools
 	"6.0" to listOf(
+		"org.junit.platform.commons.util.DefaultClasspathScanner",
 		"org.junit.platform.commons.util.KotlinReflectionUtils",
 		"org.junit.platform.launcher.core.DiscoveryIssueNotifier\$1",
 	)

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

@@ -59,12 +59,8 @@
 import org.junit.jupiter.params.support.ParameterInfo;
 import org.junit.platform.commons.support.Resource;
 import org.junit.platform.commons.support.scanning.ClasspathScanner;
-import org.junit.platform.commons.support.scanning.DefaultClasspathScanner;
 import org.junit.platform.commons.util.ModuleUtils;
-import org.junit.platform.commons.util.Preconditions;
 import org.junit.platform.commons.util.ReflectionUtils;
-import org.junit.platform.commons.util.StringUtils;
-import org.junit.platform.commons.util.UnrecoverableExceptions;
 import org.junit.platform.engine.TestDescriptor;
 import org.junit.platform.engine.reporting.OutputDirectoryProvider;
 import org.junit.platform.engine.support.hierarchical.ThrowableCollector;
@@ -153,12 +149,8 @@ void freeOfPackageCycles(JavaClasses classes) throws Exception {
 					Resource.class) //
 				.ignoreDependency(ReflectionUtils.class, Resource.class) //
 				.ignoreDependency(ClasspathScanner.class, Resource.class) //
-				.ignoreDependency(DefaultClasspathScanner.class, Resource.class) //
-
-				// Move DefaultClasspathScanner to org.junit.platform.commons.util?
-				.ignoreDependency(DefaultClasspathScanner.class, Preconditions.class) //
-				.ignoreDependency(DefaultClasspathScanner.class, StringUtils.class) //
-				.ignoreDependency(DefaultClasspathScanner.class, UnrecoverableExceptions.class) //
+				.ignoreDependency(Class.forName("org.junit.platform.commons.util.DefaultClasspathScanner"),
+					Resource.class) //
 
 				// Needs more investigation
 				.ignoreDependency(resideInAPackage("org.junit.platform.console.options"),