feat: log invalid search path roots (#4772)

Author: currenjin

junit-platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

@@ -24,14 +24,18 @@
 import static org.junit.platform.launcher.TagFilter.includeTags;
 import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
 
+import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.HashSet;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
+import org.junit.platform.commons.logging.Logger;
+import org.junit.platform.commons.logging.LoggerFactory;
 import org.junit.platform.commons.util.ModuleUtils;
 import org.junit.platform.commons.util.Preconditions;
 import org.junit.platform.commons.util.ReflectionUtils;
@@ -49,6 +53,8 @@
  */
 class DiscoveryRequestCreator {
 
+	private static final Logger logger = LoggerFactory.getLogger(DiscoveryRequestCreator.class);
+
 	static LauncherDiscoveryRequestBuilder toDiscoveryRequestBuilder(TestDiscoveryOptions options) {
 		LauncherDiscoveryRequestBuilder requestBuilder = request();
 		List<? extends DiscoverySelector> selectors = createDiscoverySelectors(options);
@@ -87,9 +93,37 @@ private static Set<Path> determineClasspathRoots(TestDiscoveryOptions options) {
 		if (selectedClasspathEntries.isEmpty()) {
 			Set<Path> rootDirs = new LinkedHashSet<>(ReflectionUtils.getAllClasspathRootDirectories());
 			rootDirs.addAll(options.getExistingAdditionalClasspathEntries());
-			return rootDirs;
+			return validateAndLogInvalidRoots(rootDirs);
+		}
+		return validateAndLogInvalidRoots(new LinkedHashSet<>(selectedClasspathEntries));
+	}
+
+	private static Set<Path> validateAndLogInvalidRoots(Set<Path> roots) {
+		LinkedHashSet<Path> valid = new LinkedHashSet<>();
+		HashSet<Path> seen = new HashSet<>();
+
+		for (Path root : roots) {
+			if (!seen.add(root))
+				continue;
+
+			boolean exists = Files.exists(root);
+			boolean readable = Files.isReadable(root);
+			boolean dirOrJar = isDirOrJar(root);
+
+			if (!exists || !readable || !dirOrJar) {
+				logger.info(
+					() -> "Ignoring invalid search path root: %s (exists=%s, readable=%s, dirOrJar=%s)".formatted(root,
+						exists, readable, dirOrJar));
+				continue;
+			}
+			valid.add(root);
 		}
-		return new LinkedHashSet<>(selectedClasspathEntries);
+
+		return valid;
+	}
+
+	private static boolean isDirOrJar(Path root) {
+		return Files.isDirectory(root) || root.toString().endsWith(".jar");
 	}
 
 	private static void addFilters(LauncherDiscoveryRequestBuilder requestBuilder, TestDiscoveryOptions options,

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java

@@ -28,13 +28,16 @@
 import java.io.File;
 import java.net.URI;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.stream.Stream;
 
 import org.junit.jupiter.api.Test;
 import org.junit.platform.commons.PreconditionViolationException;
+import org.junit.platform.commons.logging.LogRecordListener;
+import org.junit.platform.commons.logging.LoggerFactory;
 import org.junit.platform.console.options.TestDiscoveryOptions;
 import org.junit.platform.engine.Filter;
 import org.junit.platform.engine.UniqueId;
@@ -372,6 +375,27 @@ void convertsConfigurationParametersResources() {
 		assertThat(configurationParameters.get("com.example.prop.second")).contains("second value");
 	}
 
+	@Test
+	void logs_when_invalid_search_path_present() {
+		LogRecordListener listener = new LogRecordListener();
+		LoggerFactory.addListener(listener);
+		try {
+			var opts = new TestDiscoveryOptions();
+			opts.setScanClasspath(true);
+			opts.setSelectedClasspathEntries(List.of(Paths.get("/does/not/exist")));
+
+			DiscoveryRequestCreator.toDiscoveryRequestBuilder(opts);
+
+			boolean saw = listener.stream(DiscoveryRequestCreator.class).anyMatch(
+				r -> String.valueOf(r.getMessage()).contains("/does/not/exist"));
+
+			assertThat(saw).as("should log about invalid search path root").isTrue();
+		}
+		finally {
+			LoggerFactory.removeListener(listener);
+		}
+	}
+
 	private LauncherDiscoveryRequest convert() {
 		return DiscoveryRequestCreator.toDiscoveryRequestBuilder(options).build();
 	}