Start Maven builds with empty local repo to avoid flakiness

marcphilipp · marcphilipp · commit e087b474d53d · 2024-11-15T19:19:16.000+01:00
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/JavaVersionsTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/JavaVersionsTests.java
@@ -27,12 +27,16 @@
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
+import platform.tooling.support.tests.LocalMavenRepo.Directory;
 
 /**
  * @since 1.4
  */
 class JavaVersionsTests {
 
+	@LocalMavenRepo
+	Directory localMavenRepo;
+
 	@Test
 	void java_8() {
 		var java8Home = Helper.getJavaHome("8");
@@ -54,7 +58,7 @@ List<String> execute(String version, Path javaHome, Map<String, String> environm
 				.setTool(Request.maven()) //
 				.setProject(Projects.JAVA_VERSIONS) //
 				.setWorkspace("java-versions-" + version) //
-				.addArguments("-Dmaven.repo=" + MavenRepo.dir()) //
+				.addArguments(localMavenRepo.toCliArgument(), "-Dmaven.repo=" + MavenRepo.dir()) //
 				.addArguments("--update-snapshots", "--batch-mode", "verify") //
 				.setTimeout(TOOL_TIMEOUT) //
 				.setJavaHome(javaHome);
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/LocalMavenRepo.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/LocalMavenRepo.java
@@ -0,0 +1,112 @@
+/*
+ * 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 platform.tooling.support.tests;
+
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+import static org.junit.platform.commons.support.ReflectionSupport.streamFields;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Comparator;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
+import org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource;
+import org.junit.jupiter.api.extension.ParameterContext;
+import org.junit.jupiter.api.extension.ParameterResolutionException;
+import org.junit.jupiter.api.extension.ParameterResolver;
+import org.junit.jupiter.api.extension.TestInstancePostProcessor;
+import org.junit.platform.commons.support.AnnotationSupport;
+import org.junit.platform.commons.support.HierarchyTraversalMode;
+import org.junit.platform.commons.util.Preconditions;
+
+@Target({ ElementType.PARAMETER, ElementType.FIELD })
+@Retention(RUNTIME)
+@ExtendWith(LocalMavenRepo.Extension.class)
+public @interface LocalMavenRepo {
+
+	class Extension implements ParameterResolver, TestInstancePostProcessor {
+
+		@Override
+		public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
+				throws ParameterResolutionException {
+			return parameterContext.isAnnotated(LocalMavenRepo.class);
+		}
+
+		@Override
+		public Directory resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
+				throws ParameterResolutionException {
+			Preconditions.condition(Directory.class.equals(parameterContext.getParameter().getType()),
+				() -> "Parameter must be of type " + Directory.class + ": " + parameterContext.getParameter());
+			return getOrCreateDirectory(extensionContext);
+		}
+
+		@Override
+		public void postProcessTestInstance(Object testInstance, ExtensionContext context) {
+			streamFields(testInstance.getClass(), field -> AnnotationSupport.isAnnotated(field, LocalMavenRepo.class),
+				HierarchyTraversalMode.BOTTOM_UP) //
+						.forEach(field -> {
+							Preconditions.condition(Directory.class.equals(field.getType()),
+								() -> "Field must be of type " + Directory.class + ": " + field);
+							try {
+								field.set(testInstance, getOrCreateDirectory(context));
+							}
+							catch (IllegalAccessException e) {
+								throw new RuntimeException(e);
+							}
+						});
+		}
+
+		private Directory getOrCreateDirectory(ExtensionContext extensionContext) {
+			return extensionContext.getRoot().getStore(Namespace.GLOBAL) //
+					.getOrComputeIfAbsent(Directory.class, __ -> new Directory(), Directory.class);
+		}
+	}
+
+	class Directory implements CloseableResource {
+
+		private final Path tempDir;
+
+		private Directory() {
+			try {
+				tempDir = Files.createTempDirectory("local-maven-repo-");
+			}
+			catch (IOException e) {
+				throw new RuntimeException(e);
+			}
+		}
+
+		public String toCliArgument() {
+			return "-Dmaven.repo.local=" + tempDir;
+		}
+
+		@Override
+		public void close() throws Throwable {
+			try (var files = Files.walk(tempDir)) {
+				files.sorted(Comparator.<Path> naturalOrder().reversed()) //
+						.forEach(path -> {
+							try {
+								Files.delete(path);
+							}
+							catch (IOException e) {
+								throw new UncheckedIOException(e);
+							}
+						});
+			}
+		}
+	}
+}
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenStarterTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenStarterTests.java
@@ -24,6 +24,7 @@
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
+import platform.tooling.support.tests.LocalMavenRepo.Directory;
 
 /**
  * @since 1.3
@@ -32,11 +33,11 @@ class MavenStarterTests {
 
 	@ResourceLock(Projects.MAVEN_STARTER)
 	@Test
-	void verifyMavenStarterProject() {
+	void verifyMavenStarterProject(@LocalMavenRepo Directory localMavenRepo) {
 		var request = Request.builder() //
 				.setTool(Request.maven()) //
 				.setProject(Projects.MAVEN_STARTER) //
-				.addArguments("-Dmaven.repo=" + MavenRepo.dir()) //
+				.addArguments(localMavenRepo.toCliArgument(), "-Dmaven.repo=" + MavenRepo.dir()) //
 				.addArguments("--update-snapshots", "--batch-mode", "verify") //
 				.setTimeout(TOOL_TIMEOUT) //
 				.setJavaHome(Helper.getJavaHome("8").orElseThrow(TestAbortedException::new)) //
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenSurefireCompatibilityTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MavenSurefireCompatibilityTests.java
@@ -27,12 +27,16 @@
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
+import platform.tooling.support.tests.LocalMavenRepo.Directory;
 
 /**
  * @since 1.9.2
  */
 class MavenSurefireCompatibilityTests {
 
+	@LocalMavenRepo
+	Directory localMavenRepo;
+
 	@ResourceLock(Projects.MAVEN_SUREFIRE_COMPATIBILITY)
 	@ParameterizedTest
 	@CsvSource(delimiter = '|', nullValues = "<none>", textBlock = """
@@ -44,7 +48,7 @@ void testMavenSurefireCompatibilityProject(String surefireVersion, String extraA
 		var request = Request.builder() //
 				.setTool(Request.maven()) //
 				.setProject(Projects.MAVEN_SUREFIRE_COMPATIBILITY) //
-				.addArguments("-Dmaven.repo=" + MavenRepo.dir()) //
+				.addArguments(localMavenRepo.toCliArgument(), "-Dmaven.repo=" + MavenRepo.dir()) //
 				.addArguments("-Dsurefire.version=" + surefireVersion) //
 				.addArguments("--update-snapshots", "--batch-mode", "test") //
 				.addArguments(extraArgs) //
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MultiReleaseJarTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/MultiReleaseJarTests.java
@@ -28,12 +28,16 @@
 
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
+import platform.tooling.support.tests.LocalMavenRepo.Directory;
 
 /**
  * @since 1.4
  */
 class MultiReleaseJarTests {
 
+	@LocalMavenRepo
+	Directory localMavenRepo;
+
 	@ResourceLock(Projects.MULTI_RELEASE_JAR)
 	@Test
 	void checkDefault() throws Exception {
@@ -88,7 +92,7 @@ private Result mvn(String variant) {
 		var builder = Request.builder() //
 				.setTool(Request.maven()) //
 				.setProject(Projects.MULTI_RELEASE_JAR) //
-				.addArguments("-Dmaven.repo=" + MavenRepo.dir()) //
+				.addArguments(localMavenRepo.toCliArgument(), "-Dmaven.repo=" + MavenRepo.dir()) //
 				.addArguments("--update-snapshots", "--show-version", "--errors", "--batch-mode", "--file", variant,
 					"test") //
 				.setTimeout(TOOL_TIMEOUT);
diff --git a/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/VintageMavenIntegrationTests.java b/platform-tooling-support-tests/src/test/java/platform/tooling/support/tests/VintageMavenIntegrationTests.java
@@ -24,9 +24,13 @@
 import platform.tooling.support.Helper;
 import platform.tooling.support.MavenRepo;
 import platform.tooling.support.Request;
+import platform.tooling.support.tests.LocalMavenRepo.Directory;
 
 class VintageMavenIntegrationTests {
 
+	@LocalMavenRepo
+	Directory localMavenRepo;
+
 	@Test
 	void unsupportedVersion() {
 		var result = run("4.11");
@@ -61,7 +65,7 @@ private Result run(String version) {
 				.setProject(Projects.VINTAGE) //
 				.setWorkspace("vintage-maven-" + version) //
 				.addArguments("clean", "test", "--update-snapshots", "--batch-mode") //
-				.addArguments("-Dmaven.repo=" + MavenRepo.dir()) //
+				.addArguments(localMavenRepo.toCliArgument(), "-Dmaven.repo=" + MavenRepo.dir()) //
 				.addArguments("-Djunit4Version=" + version) //
 				.setTimeout(TOOL_TIMEOUT) //
 				.build() //
