Merge pull request #1426 from hcoles/feature/auto_add_engines

auto add junit engines when missing from classpath

Author: hcoles

pitest-maven-verification/src/test/java/org/pitest/PitMojoIT.java

@@ -350,7 +350,7 @@ public void shouldCorrectlyHandleOverrides() throws Exception {
 
   @Test
   public void shouldReadExclusionsFromSurefireConfig() throws Exception {
-    // Note this test also tests the argline parsing concern
+    // Note this test also tests the argline parsing concern and junit5 classpath resolution
 
     File testDir = prepare("/pit-surefire-excludes");
     verifier.executeGoal("test");

pitest-maven-verification/src/test/resources/pit-surefire-excludes/pom.xml

@@ -7,12 +7,13 @@
 	<version>1.0-SNAPSHOT</version>
 	<name>surefire-excludes</name>
 	<dependencies>
-            <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.1</version>
-            <scope>test</scope>
-            </dependency>
+		<!-- include api only, other dependencies should auto add -->
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-api</artifactId>
+			<version>5.13.4</version>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 	<properties>
 		<a.value>isSet</a.value>
@@ -24,16 +25,16 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-compiler-plugin</artifactId>
-				<version>2.4</version>
+				<version>3.10.1</version>
 				<configuration>
-					<source>1.8</source>
-					<target>1.8</target>
+					<source>11</source>
+					<target>11</target>
 				</configuration>
 			</plugin>
 		       <plugin>
 		  	<groupId>org.apache.maven.plugins</groupId>
 			<artifactId>maven-surefire-plugin</artifactId>
-			<version>2.18.1</version>
+			<version>3.1.2</version>
 			<configuration>
 			  <excludes>
 			    <exclude>**/FailingTest.java</exclude>
@@ -58,6 +59,14 @@
                     </mutators>
                     <verbose>true</verbose>
                 </configuration>
+				<dependencies>
+					<dependency>
+						<groupId>org.pitest</groupId>
+						<artifactId>pitest-junit5-plugin</artifactId>
+						<version>1.2.3</version>
+					</dependency>
+				</dependencies>
+
 			</plugin>
 		</plugins>
 	</build>

pitest-maven-verification/src/test/resources/pit-surefire-excludes/src/test/java/com/example/AnotherTest.java

@@ -2,9 +2,9 @@
 
 import java.util.Arrays;
 import java.util.Collection;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class AnotherTest {
 

pitest-maven-verification/src/test/resources/pit-surefire-excludes/src/test/java/com/example/BadTest.java

@@ -2,9 +2,9 @@
 
 import java.util.Arrays;
 import java.util.Collection;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class BadTest {
 

pitest-maven/src/main/java/org/pitest/maven/MojoToReportOptionsConverter.java

@@ -22,9 +22,13 @@
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.eclipse.aether.artifact.DefaultArtifact;
+import org.eclipse.aether.graph.DefaultDependencyNode;
 import org.eclipse.aether.resolution.ArtifactRequest;
 import org.eclipse.aether.resolution.ArtifactResolutionException;
 import org.eclipse.aether.resolution.ArtifactResult;
+import org.eclipse.aether.resolution.DependencyRequest;
+import org.eclipse.aether.resolution.DependencyResolutionException;
+import org.eclipse.aether.resolution.DependencyResult;
 import org.pitest.classinfo.ClassName;
 import org.pitest.classpath.DirectoryClassPathRoot;
 import org.pitest.functional.FCollection;
@@ -86,7 +90,9 @@ public ReportOptions convert() {
 
     classPath.addAll(this.mojo.getAdditionalClasspathElements());
 
-    autoAddJUnitPlatform(classPath);
+    autoAddJUnitPlatformLauncher(classPath);
+    autoAddJUnitPlatformEngine(classPath);
+    autoAddJupiterEngine(classPath);
     removeExcludedDependencies(classPath);
 
     addCrossModuleDirsToClasspath(classPath);
@@ -125,13 +131,22 @@ private void addCrossModuleDirsToClasspath(List<String> classPath) {
    *
    * @param classPath classpath to modify
    */
-  private void autoAddJUnitPlatform(List<String> classPath) {
+  private void autoAddJUnitPlatformLauncher(List<String> classPath) {
+    autoAddJUnitPlatformArtifact(classPath, "junit-platform-launcher");
+  }
+
+  private void autoAddJUnitPlatformEngine(List<String> classPath) {
+    autoAddJUnitPlatformArtifact(classPath, "junit-platform-engine");
+  }
+
+
+  private void autoAddJUnitPlatformArtifact(List<String> classPath, String artifactId) {
     List<Artifact> junitDependencies = this.mojo.getProject().getArtifacts().stream()
             .filter(a -> a.getGroupId().equals("org.junit.platform"))
             .collect(Collectors.toList());
 
-    // If the launcher has been manually added to the dependencies, there is nothing to do
-    if (junitDependencies.stream().anyMatch(a -> a.getArtifactId().equals("junit-platform-launcher"))) {
+    // If the artifact has been manually added to the dependencies, there is nothing to do
+    if (junitDependencies.stream().anyMatch(a -> a.getArtifactId().equals(artifactId))) {
       return;
     }
 
@@ -144,24 +159,67 @@ private void autoAddJUnitPlatform(List<String> classPath) {
     // Look for platform engine or platform commons on classpath
     Artifact toMatch = maybeJUnitPlatform.get();
 
-    // Assume that platform launcher has been released with same version number as engine and commons
-    DefaultArtifact platformLauncher = new DefaultArtifact(toMatch.getGroupId(), "junit-platform-launcher", "jar",
+    // Assume that artifact has been released with same version number as engine and commons
+    DefaultArtifact platformLauncher = new DefaultArtifact(toMatch.getGroupId(), artifactId, "jar",
             toMatch.getVersion());
 
+    addArtifact(classPath, platformLauncher);
+  }
+
+  private void autoAddJupiterEngine(List<String> classPath) {
+    List<Artifact> junitDependencies = this.mojo.getProject().getArtifacts().stream()
+            .filter(a -> a.getGroupId().equals("org.junit.jupiter"))
+            .collect(Collectors.toList());
+
+    // If the engine has been manually added to the dependencies, there is nothing to do
+    if (junitDependencies.stream().anyMatch(a -> a.getArtifactId().equals("junit-jupiter-engine"))) {
+      return;
+    }
+
+    Optional<Artifact> maybeApi = this.mojo.getProject().getArtifacts().stream()
+            .filter(a -> a.getArtifactId().equals("junit-jupiter-api"))
+            .findFirst();
+
+    if (maybeApi.isEmpty()) {
+      return;
+    }
+
+    // Look for platform engine or platform commons on classpath
+    Artifact toMatch = maybeApi.get();
+
+    // Assume that engine has been released with same version number as api
+    DefaultArtifact platformLauncher = new DefaultArtifact(toMatch.getGroupId(), "junit-jupiter-engine", "jar",
+            toMatch.getVersion());
+
+    addArtifact(classPath, platformLauncher);
+
+  }
+
+  private void addArtifact(List<String> classPath, DefaultArtifact platformLauncher) {
     try {
+
       ArtifactRequest r = new ArtifactRequest();
       r.setArtifact(platformLauncher);
-      
+
       r.setRepositories(this.mojo.getProject().getRemotePluginRepositories());
       ArtifactResult resolved = this.mojo.repositorySystem().resolveArtifact(mojo.session().getRepositorySession(), r);
 
       this.log.info("Auto adding " + resolved + " to classpath.");
       classPath.add(resolved.getArtifact().getFile().getAbsolutePath());
-    } catch (ArtifactResolutionException e) {
+
+      // get any transitive dependencies,
+      // although this doesn't seem to be neccesary for current releases of junit
+      DependencyRequest dependencyRequest = new DependencyRequest(new DefaultDependencyNode(platformLauncher), null);
+      DependencyResult transitive = this.mojo.repositorySystem().resolveDependencies(mojo.session().getRepositorySession(), dependencyRequest);
+      for (ArtifactResult result : transitive.getArtifactResults()) {
+        this.log.info("Auto adding " + result + " to classpath.");
+        classPath.add(result.getArtifact().getFile().getAbsolutePath());
+      }
+
+    } catch (DependencyResolutionException | ArtifactResolutionException e) {
       this.log.error("Could not resolve " + platformLauncher);
       throw new RuntimeException(e);
     }
-
   }
 
   private static Optional<Artifact> findJUnitArtifact(List<Artifact> junitDependencies) {
@@ -460,8 +518,9 @@ private Collection<String> findOccupiedTestPackages() {
   }
 
   private Collection<Artifact> filteredDependencies() {
-    return FCollection.filter(this.mojo.getPluginArtifactMap().values(),
-        this.dependencyFilter);
+    return this.mojo.getPluginArtifactMap().values().stream()
+            .filter(this.dependencyFilter)
+            .collect(Collectors.toList());
   }
 
   private Collection<String> determineMutators() {