add new instrumentation for junit4.13

Author: daniel-mohedano

dd-java-agent/instrumentation/junit-4.10/junit-4.13/build.gradle

@@ -0,0 +1,29 @@
+apply from: "$rootDir/gradle/java.gradle"
+
+muzzle {
+  pass {
+    group = 'junit'
+    module = 'junit'
+    versions = '[4.13,5)'
+    assertInverse = true
+  }
+}
+
+addTestSuiteForDir('latestDepTest', 'test')
+
+dependencies {
+  implementation project(':dd-java-agent:instrumentation:junit-4.10')
+  compileOnly group: 'junit', name: 'junit', version: '4.13'
+
+  testImplementation testFixtures(project(':dd-java-agent:agent-ci-visibility'))
+
+  // version used below is not the minimum one that we support,
+  // but the tests need to use it in order to be compliant with Spock 2.x
+  testImplementation(group: 'junit', name: 'junit') {
+    version {
+      strictly '4.13.2'
+    }
+  }
+
+  latestDepTestImplementation group: 'junit', name: 'junit', version: '4.+'
+}

dd-java-agent/instrumentation/junit-4.10/junit-4.13/gradle.lockfile

@@ -0,0 +1,33 @@
+package datadog.trace.instrumentation.junit4;
+
+import datadog.trace.bootstrap.instrumentation.api.AgentScope;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
+import datadog.trace.bootstrap.instrumentation.api.Tags;
+import java.lang.reflect.Method;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+
+public class BeforeAfterOperationsTracer {
+  public static AgentScope startTrace(final Method method) {
+    final AgentSpan span = AgentTracer.startSpan("junit", method.getName());
+    if (method.isAnnotationPresent(Before.class)) {
+      span.setTag(Tags.TEST_CALLBACK, "Before");
+    } else if (method.isAnnotationPresent(After.class)) {
+      span.setTag(Tags.TEST_CALLBACK, "After");
+    } else if (method.isAnnotationPresent(BeforeClass.class)) {
+      span.setTag(Tags.TEST_CALLBACK, "BeforeClass");
+    } else if (method.isAnnotationPresent(AfterClass.class)) {
+      span.setTag(Tags.TEST_CALLBACK, "AfterClass");
+    }
+    return AgentTracer.activateSpan(span);
+  }
+
+  public static void endTrace(final AgentScope scope) {
+    final AgentSpan span = scope.span();
+    scope.close();
+    span.finish();
+  }
+}

dd-java-agent/instrumentation/junit-4.10/junit-4.13/src/main/java/datadog/trace/instrumentation/junit4/BeforeAfterOperationsTracer.java

@@ -7,14 +7,7 @@
 import datadog.trace.agent.tooling.Instrumenter;
 import datadog.trace.agent.tooling.InstrumenterModule;
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
-import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
-import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
-import datadog.trace.bootstrap.instrumentation.api.Tags;
 import net.bytebuddy.asm.Advice;
-import org.junit.After;
-import org.junit.AfterClass;
-import org.junit.Before;
-import org.junit.BeforeClass;
 import org.junit.runners.model.FrameworkMethod;
 
 @AutoService(InstrumenterModule.class)
@@ -33,6 +26,13 @@ public String[] knownMatchingTypes() {
     };
   }
 
+  @Override
+  public String[] helperClassNames() {
+    return new String[] {
+      packageName + ".BeforeAfterOperationsTracer",
+    };
+  }
+
   @Override
   public void methodAdvice(MethodTransformer transformer) {
     transformer.applyAdvice(
@@ -44,24 +44,12 @@ public void methodAdvice(MethodTransformer transformer) {
   public static class RunBeforesAftersAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static AgentScope startCallSpan(@Advice.Argument(0) final FrameworkMethod method) {
-      final AgentSpan span = AgentTracer.startSpan("junit", method.getMethod().getName());
-      if (method.getMethod().isAnnotationPresent(Before.class)) {
-        span.setTag(Tags.TEST_CALLBACK, "Before");
-      } else if (method.getMethod().isAnnotationPresent(After.class)) {
-        span.setTag(Tags.TEST_CALLBACK, "After");
-      } else if (method.getMethod().isAnnotationPresent(BeforeClass.class)) {
-        span.setTag(Tags.TEST_CALLBACK, "BeforeClass");
-      } else if (method.getMethod().isAnnotationPresent(AfterClass.class)) {
-        span.setTag(Tags.TEST_CALLBACK, "AfterClass");
-      }
-      return AgentTracer.activateSpan(span);
+      return BeforeAfterOperationsTracer.startTrace(method.getMethod());
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
     public static void finishCallSpan(@Advice.Enter final AgentScope scope) {
-      AgentSpan span = scope.span();
-      scope.close();
-      span.finish();
+      BeforeAfterOperationsTracer.endTrace(scope);
     }
   }
 }

…t4/JUnit4BeforeAfterInstrumentation.java …t4/JUnit4BeforeAfterInstrumentation.javadd-java-agent/instrumentation/junit-4.10/src/main/java/datadog/trace/instrumentation/junit4/JUnit4BeforeAfterInstrumentation.java renamed to dd-java-agent/instrumentation/junit-4.10/junit-4.13/src/main/java/datadog/trace/instrumentation/junit4/JUnit4BeforeAfterInstrumentation.java dd-java-agent/instrumentation/junit-4.10/src/main/java/datadog/trace/instrumentation/junit4/JUnit4BeforeAfterInstrumentation.java renamed to dd-java-agent/instrumentation/junit-4.10/junit-4.13/src/main/java/datadog/trace/instrumentation/junit4/JUnit4BeforeAfterInstrumentation.java

@@ -0,0 +1,45 @@
+import datadog.trace.api.DisableTestTrace
+import datadog.trace.civisibility.CiVisibilityInstrumentationTest
+import datadog.trace.instrumentation.junit4.TestEventsHandlerHolder
+import junit.runner.Version
+import org.example.TestSucceedBeforeAfter
+import org.example.TestSucceedBeforeClassAfterClass
+import org.junit.runner.JUnitCore
+
+@DisableTestTrace(reason = "avoid self-tracing")
+class JUnit413Test extends CiVisibilityInstrumentationTest {
+
+  def runner = new JUnitCore()
+
+  def "test #testcaseName"() {
+    runTests(tests)
+
+    assertSpansData(testcaseName, expectedTracesCount)
+
+    where:
+    testcaseName                          | tests                              | expectedTracesCount
+    "test-succeed-before-after"           | [TestSucceedBeforeAfter]           | 2
+    "test-succeed-beforeclass-afterclass" | [TestSucceedBeforeClassAfterClass] | 2
+  }
+
+  private void runTests(Collection<Class<?>> tests) {
+    TestEventsHandlerHolder.start()
+    try {
+      Class[] array = tests.toArray(new Class[0])
+      runner.run(array)
+    } catch (Throwable ignored) {
+      // Ignored
+    }
+    TestEventsHandlerHolder.stop()
+  }
+
+  @Override
+  String instrumentedLibraryName() {
+    return "junit4"
+  }
+
+  @Override
+  String instrumentedLibraryVersion() {
+    return Version.id()
+  }
+}

dd-java-agent/instrumentation/junit-4.10/junit-4.13/src/test/groovy/JUnit413Test.groovy

@@ -20,8 +20,6 @@ import org.example.TestSkipped
 import org.example.TestSkippedClass
 import org.example.TestSucceed
 import org.example.TestSucceedAndSkipped
-import org.example.TestSucceedBeforeAfter
-import org.example.TestSucceedBeforeClassAfterClass
 import org.example.TestSucceedExpectedException
 import org.example.TestSucceedKotlin
 import org.example.TestSucceedLegacy
@@ -56,8 +54,6 @@ class JUnit4Test extends CiVisibilityInstrumentationTest {
     "test-success-and-failure"                           | [TestFailedAndSucceed]               | 4
     "test-suite-teardown-failure"                        | [TestFailedSuiteTearDown]            | 1
     "test-suite-setup-failure"                           | [TestFailedSuiteSetup]               | 1
-    "test-succeed-before-after"                          | [TestSucceedBeforeAfter]             | 2
-    "test-succeed-before-class-after-class"              | [TestSucceedBeforeClassAfterClass]   | 2
     "test-assumption-failure"                            | [TestAssumption]                     | 2
     "test-categories-are-included-in-spans"              | [TestSucceedWithCategories]          | 2
     "test-assumption-failure-during-suite-setup"         | [TestFailedSuiteSetUpAssumption]     | 2