Introduce utility method for finding files in tests

Author: marcphilipp

junit-platform-reporting/src/testFixtures/java/org/junit/platform/reporting/testutil/FileUtils.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2015-2024 the original author or authors.
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License v2.0 which
+ * accompanies this distribution and is available at
+ *
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+
+package org.junit.platform.reporting.testutil;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+public class FileUtils {
+
+	public static Path findPath(Path rootDir, String syntaxAndPattern) {
+		var matcher = rootDir.getFileSystem().getPathMatcher(syntaxAndPattern);
+		try (var files = Files.walk(rootDir)) {
+			return files.filter(matcher::matches).findFirst() //
+					.orElseThrow(() -> new AssertionError(
+						"Failed to find file matching '%s' in %s".formatted(syntaxAndPattern, rootDir)));
+		}
+		catch (IOException e) {
+			throw new UncheckedIOException(e);
+		}
+	}
+}

platform-tests/src/test/java/org/junit/platform/jfr/FlightRecordingExecutionListenerIntegrationTests.java

@@ -13,11 +13,10 @@
 import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
 import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
 import static org.junit.platform.launcher.core.OutputDirectoryProviders.hierarchicalOutputDirectoryProvider;
+import static org.junit.platform.reporting.testutil.FileUtils.findPath;
 import static org.moditect.jfrunit.ExpectedEvent.event;
 import static org.moditect.jfrunit.JfrEventsAssert.assertThat;
 
-import java.io.IOException;
-import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 
@@ -77,16 +76,6 @@ void reportsEvents(@TempDir Path tempDir) {
 						.with("reason", "for demonstration purposes"));
 	}
 
-	private static Path findPath(Path rootDir, @SuppressWarnings("SameParameterValue") String syntaxAndPattern) {
-		var matcher = rootDir.getFileSystem().getPathMatcher(syntaxAndPattern);
-		try (var files = Files.walk(rootDir)) {
-			return files.filter(matcher::matches).findFirst().orElseThrow();
-		}
-		catch (IOException e) {
-			throw new UncheckedIOException(e);
-		}
-	}
-
 	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 		@Test

platform-tests/src/test/java/org/junit/platform/reporting/open/xml/OpenTestReportGeneratingListenerTests.java

@@ -14,16 +14,14 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.fail;
 import static org.junit.jupiter.api.io.CleanupMode.ON_SUCCESS;
-import static org.junit.platform.commons.util.CollectionUtils.getOnlyElement;
 import static org.junit.platform.engine.discovery.DiscoverySelectors.selectUniqueId;
 import static org.junit.platform.launcher.LauncherConstants.OUTPUT_DIR_PROPERTY_NAME;
 import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
 import static org.junit.platform.launcher.core.LauncherFactoryForTestingPurposesOnly.createLauncher;
 import static org.junit.platform.reporting.open.xml.OpenTestReportGeneratingListener.ENABLED_PROPERTY_NAME;
+import static org.junit.platform.reporting.testutil.FileUtils.findPath;
 
-import java.io.IOException;
 import java.net.URISyntaxException;
-import java.nio.file.Files;
 import java.nio.file.Path;
 
 import org.junit.jupiter.api.Test;
@@ -58,7 +56,7 @@ void writesValidXmlReport() throws Exception {
 
 		executeTests(engine);
 
-		var xmlFile = findXmlReport();
+		var xmlFile = findPath(tempDirectory, "glob:**/open-test-report.xml");
 		assertThat(tempDirectory.relativize(xmlFile).toString()) //
 				.matches("junit-\\d+[/\\\\]open-test-report.xml");
 		assertThat(validate(xmlFile)).isEmpty();
@@ -138,13 +136,4 @@ private void executeTests(TestEngine engine) {
 		createLauncher(engine).execute(build, new OpenTestReportGeneratingListener());
 	}
 
-	private Path findXmlReport() throws IOException {
-		try ( //
-				var topLevel = Files.list(tempDirectory); //
-				var nested = Files.list(getOnlyElement(topLevel.toList())) //
-		) {
-			return getOnlyElement(nested.toList());
-		}
-	}
-
 }

platform-tooling-support-tests/platform-tooling-support-tests.gradle.kts

@@ -71,6 +71,7 @@ dependencies {
 	}
 	testImplementation(libs.bundles.xmlunit)
 	testImplementation(testFixtures(projects.junitJupiterApi))
+	testImplementation(testFixtures(projects.junitPlatformReporting))
 
 	thirdPartyJars(libs.junit4)
 	thirdPartyJars(libs.assertj)

platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/XmlAssertions.java

@@ -10,11 +10,8 @@
 
 package platform.tooling.support.tests;
 
-import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.platform.reporting.testutil.FileUtils.findPath;
 
-import java.io.IOException;
-import java.io.UncheckedIOException;
-import java.nio.file.Files;
 import java.nio.file.Path;
 
 import org.xmlunit.assertj3.XmlAssert;
@@ -23,25 +20,10 @@
 class XmlAssertions {
 
 	static void verifyContainsExpectedStartedOpenTestReport(Path testResultsDir) {
-		var xmlFile = findOpenTestReport(testResultsDir);
+		var xmlFile = findPath(testResultsDir, "glob:**/open-test-report.xml");
 		verifyContent(xmlFile);
 	}
 
-	private static Path findOpenTestReport(Path testResultsDir) {
-		try (var files = Files.list(testResultsDir)) {
-			var outputDir = files.filter(
-				it -> Files.isDirectory(it) && it.getFileName().toString().startsWith("junit-")) //
-					.findAny() //
-					.orElseThrow(() -> new AssertionError("Missing JUnit output dir in " + testResultsDir));
-			var xmlFile = outputDir.resolve("open-test-report.xml");
-			assertThat(xmlFile).exists();
-			return xmlFile;
-		}
-		catch (IOException e) {
-			throw new UncheckedIOException(e);
-		}
-	}
-
 	private static void verifyContent(Path xmlFile) {
 		var expected = """
 				        <e:events xmlns="https://schemas.opentest4j.org/reporting/core/0.2.0"