Add support for tycho-surefire-plugin instrumentation in Maven builds (#5573)

Author: nikita-tkachenko-datadog

dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenExecutionListener.java

@@ -11,6 +11,7 @@
 import org.apache.maven.execution.ExecutionEvent;
 import org.apache.maven.execution.MavenExecutionResult;
 import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.Plugin;
 import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
@@ -23,6 +24,7 @@ public class MavenExecutionListener extends AbstractExecutionListener {
 
   private static final String FORK_COUNT_CONFIG = "forkCount";
   private static final String SYSTEM_PROPERTY_VARIABLES_CONFIG = "systemPropertyVariables";
+  private static final String SYSTEM_PROPERTIES_CONFIG = "systemProperties";
 
   private final BuildEventsHandler<MavenSession> buildEventsHandler;
 
@@ -46,8 +48,7 @@ public void sessionEnded(ExecutionEvent event) {
   @Override
   public void mojoSkipped(ExecutionEvent event) {
     MojoExecution mojoExecution = event.getMojoExecution();
-    if (MavenUtils.isMavenSurefireTest(mojoExecution)
-        || MavenUtils.isMavenFailsafeTest(mojoExecution)) {
+    if (MavenUtils.isTestExecution(mojoExecution)) {
       MavenSession session = event.getSession();
       MavenProject project = event.getProject();
       String projectName = project.getName();
@@ -63,9 +64,7 @@ public void mojoSkipped(ExecutionEvent event) {
   @Override
   public void mojoStarted(ExecutionEvent event) {
     MojoExecution mojoExecution = event.getMojoExecution();
-    if (MavenUtils.isMavenSurefireTest(mojoExecution)
-        || MavenUtils.isMavenFailsafeTest(mojoExecution)) {
-
+    if (MavenUtils.isTestExecution(mojoExecution)) {
       MavenSession session = event.getSession();
       MavenProject project = event.getProject();
       String projectName = project.getName();
@@ -104,23 +103,27 @@ public void mojoStarted(ExecutionEvent event) {
       if (forkTestVm) {
         configuration =
             setForkedVmSystemProperty(
+                mojoExecution.getPlugin(),
                 configuration,
                 Strings.propertyNameToSystemPropertyName(
                     CiVisibilityConfig.CIVISIBILITY_SESSION_ID),
                 moduleInfo.sessionId);
         configuration =
             setForkedVmSystemProperty(
+                mojoExecution.getPlugin(),
                 configuration,
                 Strings.propertyNameToSystemPropertyName(CiVisibilityConfig.CIVISIBILITY_MODULE_ID),
                 moduleInfo.moduleId);
         configuration =
             setForkedVmSystemProperty(
+                mojoExecution.getPlugin(),
                 configuration,
                 Strings.propertyNameToSystemPropertyName(
                     CiVisibilityConfig.CIVISIBILITY_SIGNAL_SERVER_HOST),
                 moduleInfo.signalServerHost);
         configuration =
             setForkedVmSystemProperty(
+                mojoExecution.getPlugin(),
                 configuration,
                 Strings.propertyNameToSystemPropertyName(
                     CiVisibilityConfig.CIVISIBILITY_SIGNAL_SERVER_PORT),
@@ -141,19 +144,19 @@ public void mojoStarted(ExecutionEvent event) {
   }
 
   private static Xpp3Dom setForkedVmSystemProperty(
-      Xpp3Dom configuration, String propertyName, Object propertyValue) {
+      Plugin plugin, Xpp3Dom configuration, String propertyName, Object propertyValue) {
+    String configTag =
+        !"tycho-surefire-plugin".equals(plugin.getArtifactId())
+            ? SYSTEM_PROPERTY_VARIABLES_CONFIG
+            : SYSTEM_PROPERTIES_CONFIG;
     return MavenUtils.setConfigurationValue(
-        String.valueOf(propertyValue),
-        configuration,
-        SYSTEM_PROPERTY_VARIABLES_CONFIG,
-        propertyName);
+        String.valueOf(propertyValue), configuration, configTag, propertyName);
   }
 
   @Override
   public void mojoSucceeded(ExecutionEvent event) {
     MojoExecution mojoExecution = event.getMojoExecution();
-    if (MavenUtils.isMavenSurefireTest(mojoExecution)
-        || MavenUtils.isMavenFailsafeTest(mojoExecution)) {
+    if (MavenUtils.isTestExecution(mojoExecution)) {
       MavenSession session = event.getSession();
       MavenProject project = event.getProject();
 
@@ -172,8 +175,7 @@ public void mojoSucceeded(ExecutionEvent event) {
   @Override
   public void mojoFailed(ExecutionEvent event) {
     MojoExecution mojoExecution = event.getMojoExecution();
-    if (MavenUtils.isMavenSurefireTest(mojoExecution)
-        || MavenUtils.isMavenFailsafeTest(mojoExecution)) {
+    if (MavenUtils.isTestExecution(mojoExecution)) {
       MavenSession session = event.getSession();
       MavenProject project = event.getProject();
 

dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenLifecycleParticipant.java

@@ -47,11 +47,6 @@ public class MavenLifecycleParticipant extends AbstractMavenLifecycleParticipant
 
   private static final Logger LOGGER = LoggerFactory.getLogger(MavenLifecycleParticipant.class);
 
-  private static final String MAVEN_SUREFIRE_PLUGIN_KEY =
-      "org.apache.maven.plugins:maven-surefire-plugin";
-  private static final String MAVEN_FAILSAFE_PLUGIN_KEY =
-      "org.apache.maven.plugins:maven-failsafe-plugin";
-
   private final BuildEventsHandler<MavenSession> buildEventsHandler =
       InstrumentationBridge.createBuildEventsHandler();
 
@@ -200,9 +195,7 @@ private Map<Path, Collection<TestsExecution>> getTestExecutionsByJvmPath(
         Plugin plugin = mojoExecution.getPlugin();
         String pluginKey = plugin.getKey();
 
-        if (MAVEN_SUREFIRE_PLUGIN_KEY.equals(pluginKey)
-            || MAVEN_FAILSAFE_PLUGIN_KEY.equals(pluginKey)) {
-
+        if (MavenUtils.isTestExecution(mojoExecution)) {
           MojoDescriptor mojoDescriptor = mojoExecution.getMojoDescriptor();
           PluginDescriptor pluginDescriptor = mojoDescriptor.getPluginDescriptor();
           // ensure plugin realm is loaded in container

dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenUtils.java

@@ -214,18 +214,20 @@ public static Throwable getException(MavenExecutionResult result) {
     }
   }
 
-  public static boolean isMavenSurefireTest(MojoExecution mojoExecution) {
+  public static boolean isTestExecution(MojoExecution mojoExecution) {
     Plugin plugin = mojoExecution.getPlugin();
-    return "maven-surefire-plugin".equals(plugin.getArtifactId())
-        && "org.apache.maven.plugins".equals(plugin.getGroupId())
-        && "test".equals(mojoExecution.getGoal());
-  }
-
-  public static boolean isMavenFailsafeTest(MojoExecution mojoExecution) {
-    Plugin plugin = mojoExecution.getPlugin();
-    return "maven-failsafe-plugin".equals(plugin.getArtifactId())
-        && "org.apache.maven.plugins".equals(plugin.getGroupId())
-        && "integration-test".equals(mojoExecution.getGoal());
+    String artifactId = plugin.getArtifactId();
+    String groupId = plugin.getGroupId();
+    String goal = mojoExecution.getGoal();
+    return "maven-surefire-plugin".equals(artifactId)
+            && "org.apache.maven.plugins".equals(groupId)
+            && "test".equals(goal)
+        || "maven-failsafe-plugin".equals(artifactId)
+            && "org.apache.maven.plugins".equals(groupId)
+            && "integration-test".equals(goal)
+        || "tycho-surefire-plugin".equals(artifactId)
+            && "org.eclipse.tycho".equals(groupId)
+            && ("test".equals(goal) || "plugin-test".equals(goal) || "bnd-test".equals(goal));
   }
 
   public static String getConfigurationValue(Xpp3Dom configuration, String... path) {