Improve finding tests (1) (#1420)

wind57 · web-flow · commit 078fba15b5bb · 2023-08-30T10:06:16.000-04:00
diff --git a/.github/workflows/composites/maven-build-with-dry-run-for-tests/action.yaml b/.github/workflows/composites/maven-build-with-dry-run-for-tests/action.yaml
@@ -3,14 +3,26 @@ description: maven-build-with-dry-run-for-tests
 runs:
   using: "composite"
   steps:
-    - name: maven-build-with-dry-run-for-tests
+
+    - name: run 'package' on the project
+      shell: bash
+      run: |
+        ./mvnw install -B  \
+              -Dskip.build.image=true \
+              -DskipTests -DskipITs \
+              -T 1C -q
+
+    - name: find all classpath entries
+      shell: bash
+      run: |
+        ./mvnw -q exec:exec -Dexec.classpathScope="test" -Dexec.executable="echo" -Dexec.args="%classpath" | tr : "\n" > /tmp/deps.txt
+
+    - name: find all tests
       shell: bash
       run: |
-          # find all the tests that are supposed to be run, but don't actually run them.
-          # this is achieved via: 'spring.cloud.k8s.skip.tests=true' in DisabledTestsCondition
-          ./mvnw test -B -Dskip.build.image=true -Dspring.cloud.k8s.skip.tests=true \
-                -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=error \
-                -T 1C -q > /tmp/tests.txt
+        cd spring-cloud-kubernetes-test-support
+        .././mvnw -q exec:java -Dexec.mainClass="org.springframework.cloud.kubernetes.tests.discovery.TestsDiscovery" > /tmp/tests.txt
+        cd ..
 
     - name: show result
       if: always()
diff --git a/.github/workflows/composites/run-and-save-test-times-when-cache-present/action.yaml b/.github/workflows/composites/run-and-save-test-times-when-cache-present/action.yaml
@@ -8,8 +8,8 @@ runs:
       uses: actions/cache/restore@v3
       with:
         path: /tmp/sorted.txt
-        key: ${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-${{ github.run_id }}
-        restore-keys: ${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-
+        key: ${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-${{ github.run_id }}
+        restore-keys: ${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-
 
     - name: show cached test times
       shell: bash
@@ -138,7 +138,7 @@ runs:
               # the previous cache will contain more tests then we currently have, so some 
               # matrix instances will have no tests to run
               if [[ "$sum" -eq "0" ]]; then
-                echo "no tests to run in current index, most probably this PR removed some tests"
+                echo "no tests (with known times) to run in current index"
                 tests_to_run_in_current_index='none'
               fi
               
diff --git a/.github/workflows/composites/test-times/action.yaml b/.github/workflows/composites/test-times/action.yaml
@@ -47,12 +47,12 @@ runs:
 
     # save with the current run_id, but restore it without it. This means two things:
     # 1) if we re-run, cache will be available
-    # 2) if there is a new run, we restore as '${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-'
+    # 2) if there is a new run, we restore as '${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-'
     #    meaning there could be many of them already present and this is not an exact match
     #    github in this case will pick up the latest one, exactly what we want.
     - name: save test times in cache
       uses: actions/cache/save@v3
       if: env.BASE_BRANCH != '2.1.x'
       with:
         path: /tmp/sorted.txt
-        key: ${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-${{ github.run_id }}
+        key: ${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-${{ github.run_id }}
diff --git a/.github/workflows/maven.yaml b/.github/workflows/maven.yaml
@@ -67,8 +67,8 @@ jobs:
         uses: actions/cache/restore@v3
         with:
           path: /tmp/sorted.txt
-          key: ${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-${{ github.run_id }}
-          restore-keys: ${{ runner.os }}-spring-cloud-kubernetes-existing-test-times-cache-
+          key: ${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-${{ github.run_id }}
+          restore-keys: ${{ runner.os }}-spring-cloud-k8s-existing-test-times-cache-
 
       - name: check test times cache exists
         id: check_files
diff --git a/spring-cloud-kubernetes-client-discovery/pom.xml b/spring-cloud-kubernetes-client-discovery/pom.xml
@@ -50,11 +50,6 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-		<dependency>
-			<groupId>org.junit.vintage</groupId>
-			<artifactId>junit-vintage-engine</artifactId>
-			<scope>test</scope>
-		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
diff --git a/spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/profile/KubernetesProfileEnvironmentPostProcessorTest.java b/spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/profile/KubernetesProfileEnvironmentPostProcessorTest.java
@@ -39,7 +39,7 @@
 /**
  * @author wind57
  */
-public class AbstractKubernetesProfileEnvironmentPostProcessorTest {
+public class KubernetesProfileEnvironmentPostProcessorTest {
 
 	private static final String FOUNT_IT = "foundIt";
 
diff --git a/spring-cloud-kubernetes-controllers/spring-cloud-kubernetes-configuration-watcher/pom.xml b/spring-cloud-kubernetes-controllers/spring-cloud-kubernetes-configuration-watcher/pom.xml
@@ -66,11 +66,6 @@
 			<artifactId>spring-rabbit-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-		<dependency>
-			<groupId>org.junit.vintage</groupId>
-			<artifactId>junit-vintage-engine</artifactId>
-			<scope>test</scope>
-		</dependency>
 		<dependency>
 			<groupId>org.mockito</groupId>
 			<artifactId>mockito-inline</artifactId>
diff --git a/spring-cloud-kubernetes-examples/kubernetes-leader-election-example/pom.xml b/spring-cloud-kubernetes-examples/kubernetes-leader-election-example/pom.xml
@@ -49,11 +49,6 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-		<dependency>
-			<groupId>org.junit.vintage</groupId>
-			<artifactId>junit-vintage-engine</artifactId>
-			<scope>test</scope>
-		</dependency>
 	</dependencies>
 
 	<build>
diff --git a/spring-cloud-kubernetes-fabric8-config/pom.xml b/spring-cloud-kubernetes-fabric8-config/pom.xml
@@ -97,11 +97,6 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
-		<dependency>
-			<groupId>org.junit.vintage</groupId>
-			<artifactId>junit-vintage-engine</artifactId>
-			<scope>test</scope>
-		</dependency>
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
 			<artifactId>spring-cloud-test-support</artifactId>
diff --git a/spring-cloud-kubernetes-fabric8-discovery/pom.xml b/spring-cloud-kubernetes-fabric8-discovery/pom.xml
@@ -68,12 +68,6 @@
 			<scope>test</scope>
 		</dependency>
 
-		<dependency>
-			<groupId>org.junit.vintage</groupId>
-			<artifactId>junit-vintage-engine</artifactId>
-			<scope>test</scope>
-		</dependency>
-
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
diff --git a/spring-cloud-kubernetes-test-support/pom.xml b/spring-cloud-kubernetes-test-support/pom.xml
@@ -13,9 +13,15 @@
 
 	<properties>
 		<awaitility.version>4.0.3</awaitility.version>
-		<testcontainers.version>1.18.0</testcontainers.version>
+		<testcontainers.version>1.19.0</testcontainers.version>
 	</properties>
 	<dependencies>
+
+		<dependency>
+			<groupId>org.junit.platform</groupId>
+			<artifactId>junit-platform-launcher</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
@@ -43,4 +49,24 @@
 
 	</dependencies>
 
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>exec-maven-plugin</artifactId>
+				<version>3.1.0</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>java</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<mainClass>org.springframework.cloud.kubernetes.tests.discovery.TestsDiscovery</mainClass>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
 </project>
diff --git a/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/K8SUtils.java b/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/K8SUtils.java
@@ -69,7 +69,7 @@
 import org.springframework.util.StringUtils;
 
 import static org.awaitility.Awaitility.await;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  * @author Ryan Baxter
diff --git a/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/fabric8_client/Util.java b/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/fabric8_client/Util.java
@@ -50,7 +50,7 @@
 import org.springframework.cloud.kubernetes.integration.tests.commons.Phase;
 
 import static org.awaitility.Awaitility.await;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.fail;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.loadImage;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.pomVersion;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.pullImage;
diff --git a/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/native_client/Util.java b/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/integration/tests/commons/native_client/Util.java
@@ -60,7 +60,7 @@
 import org.springframework.cloud.kubernetes.integration.tests.commons.Phase;
 
 import static org.awaitility.Awaitility.await;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.fail;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.loadImage;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.pomVersion;
 import static org.springframework.cloud.kubernetes.integration.tests.commons.Commons.pullImage;
diff --git a/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/tests/commons/junit_extension/DisabledTestsCondition.java b/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/tests/commons/junit_extension/DisabledTestsCondition.java
@@ -35,6 +35,7 @@
  *
  * @author wind57
  */
+@Deprecated
 public class DisabledTestsCondition implements ExecutionCondition {
 
 	private static final boolean SKIP_RUNNING_TESTS = "true".equals(System.getProperty("spring.cloud.k8s.skip.tests"));
diff --git a/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/tests/discovery/TestsDiscovery.java b/spring-cloud-kubernetes-test-support/src/main/java/org/springframework/cloud/kubernetes/tests/discovery/TestsDiscovery.java
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2013-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.kubernetes.tests.discovery;
+
+import java.io.File;
+import java.net.URI;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import org.junit.platform.engine.discovery.DiscoverySelectors;
+import org.junit.platform.launcher.Launcher;
+import org.junit.platform.launcher.LauncherDiscoveryRequest;
+import org.junit.platform.launcher.TestIdentifier;
+import org.junit.platform.launcher.TestPlan;
+import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
+import org.junit.platform.launcher.core.LauncherFactory;
+
+/**
+ * @author wind57
+ */
+public class TestsDiscovery {
+
+	public static void main(String[] args) throws Exception {
+		List<String> targetClasses = entireClasspath().stream().filter(x -> x.contains("target/classes")).toList();
+		List<String> targetTestClasses = targetClasses.stream().map(x -> x.replace("classes", "test-classes")).toList();
+		List<String> jars = entireClasspath().stream().filter(x -> x.contains(".jar")).toList();
+
+		List<URL> urls = Stream.of(targetClasses, targetTestClasses, jars).flatMap(List::stream)
+				.map(x -> toURL(new File(x).toPath().toUri())).toList();
+
+		Set<Path> paths = Stream.of(targetClasses, targetTestClasses, jars).flatMap(List::stream).map(Paths::get)
+				.collect(Collectors.toSet());
+
+		replaceClassloader(urls);
+
+		LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request()
+				.selectors(DiscoverySelectors.selectClasspathRoots(paths)).build();
+
+		Launcher launcher = LauncherFactory.openSession().getLauncher();
+		TestPlan testPlan = launcher.discover(request);
+		testPlan.getRoots().stream().flatMap(x -> testPlan.getChildren(x).stream())
+				.map(TestIdentifier::getLegacyReportingName).sorted().forEach(test -> {
+					System.out.println("spring.cloud.k8s.test.to.run -> " + test);
+				});
+	}
+
+	private static void replaceClassloader(List<URL> classpathURLs) {
+		ClassLoader parentClassLoader = Thread.currentThread().getContextClassLoader();
+		URLClassLoader classLoader = URLClassLoader.newInstance(classpathURLs.toArray(new URL[0]), parentClassLoader);
+		Thread.currentThread().setContextClassLoader(classLoader);
+	}
+
+	// /tmp/deps.txt are created by the pipeline
+	private static List<String> entireClasspath() throws Exception {
+		return Files.lines(Paths.get("/tmp/deps.txt")).distinct().collect(Collectors.toList());
+	}
+
+	private static URL toURL(URI uri) {
+		try {
+			return uri.toURL();
+		}
+		catch (Exception e) {
+			throw new RuntimeException(e);
+		}
+	}
+
+}
diff --git a/spring-cloud-kubernetes-test-support/src/main/resources/junit-platform.properties b/spring-cloud-kubernetes-test-support/src/main/resources/junit-platform.properties
diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml
@@ -16,4 +16,5 @@
 	<suppress files=".*DiscoveryServerApplication\.java" checks="HideUtilityClassConstructor"/>
 	<suppress files=".*KubernetesConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
 	<suppress files=".*Fabric8ConfigContext\.java" checks="WhitespaceAround" />
+	<suppress files=".*TestsDiscovery\.java" checks="HideUtilityClassConstructor" />
 </suppressions>
