Update tests to run with JUnit 5

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/Constants.java

@@ -11,7 +11,7 @@ public final class Constants {
    * packages which will be loaded on the bootstrap classloader
    *
    * <p>Updates should be mirrored in
-   * datadog.trace.agent.test.SpockRunner#BOOTSTRAP_PACKAGE_PREFIXES_COPY
+   * datadog.trace.agent.test.BootstrapClasspathSetup#BOOTSTRAP_PACKAGE_PREFIXES_COPY
    */
   public static final String[] BOOTSTRAP_PACKAGE_PREFIXES = {
     "datadog.slf4j",

dd-java-agent/agent-ci-visibility/build.gradle

@@ -27,7 +27,6 @@ buildscript {
 
 plugins {
   id 'com.gradleup.shadow'
-  id 'java-test-fixtures'
 }
 
 apply from: "$rootDir/gradle/java.gradle"
@@ -42,29 +41,24 @@ dependencies {
   api libs.slf4j
 
   implementation libs.bundles.asm
-  implementation group: 'org.jacoco', name: 'org.jacoco.core', version: '0.8.12'
-  implementation group: 'org.jacoco', name: 'org.jacoco.report', version: '0.8.12'
+  implementation group: 'org.jacoco', name: 'org.jacoco.core', version: '0.8.13'
+  implementation group: 'org.jacoco', name: 'org.jacoco.report', version: '0.8.13'
 
   implementation project(':communication')
   implementation project(':components:json')
   implementation project(':internal-api')
   implementation project(':internal-api:internal-api-9')
 
   testImplementation project(":utils:test-utils")
+  testImplementation project(':dd-java-agent:testing')
   testImplementation("com.google.jimfs:jimfs:1.1") // an in-memory file system for testing code that works with files
 
   testImplementation libs.scala
   testImplementation libs.kotlin
 
-  testFixturesApi project(':dd-java-agent:testing')
-  testFixturesApi project(':utils:test-utils')
-
-  testFixturesApi group: 'org.skyscreamer', name: 'jsonassert', version: '1.5.1'
-  testFixturesApi group: 'org.freemarker', name: 'freemarker', version: '2.3.31'
-  testFixturesApi group: 'com.jayway.jsonpath', name: 'json-path', version: '2.8.0'
-  testFixturesApi group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.16.0'
-  testFixturesApi group: 'org.msgpack', name: 'jackson-dataformat-msgpack', version: '0.9.6'
-  testFixturesApi group: 'org.xmlunit', name: 'xmlunit-core', version: '2.10.3'
+  testImplementation group: 'org.skyscreamer', name: 'jsonassert', version: '1.5.1'
+  testImplementation group: 'org.freemarker', name: 'freemarker', version: '2.3.31'
+  testImplementation group: 'org.msgpack', name: 'jackson-dataformat-msgpack', version: '0.9.6'
 
   testRuntimeOnly("org.junit.platform:junit-platform-launcher:1.9.2") // Required to update dependency lock files
 }

dd-java-agent/agent-ci-visibility/civisibility-instrumentation-testing/build.gradle

@@ -0,0 +1,8 @@
+apply from: "$rootDir/gradle/java.gradle"
+apply from: "$rootDir/gradle/version.gradle"
+
+dependencies {
+  api project(':dd-java-agent:instrumentation-testing')
+  api project(':dd-java-agent:agent-ci-visibility:civisibility-testing')
+}
+

dd-java-agent/agent-ci-visibility/src/testFixtures/groovy/datadog/trace/civisibility/CiVisibilityInstrumentationTest.groovy → dd-java-agent/agent-ci-visibility/civisibility-instrumentation-testing/src/main/groovy/datadog/trace/civisibility/CiVisibilityInstrumentationTest.groovy

@@ -50,6 +50,7 @@ import datadog.trace.civisibility.writer.ddintake.CiTestCycleMapperV1
 import datadog.trace.common.writer.ListWriter
 import datadog.trace.common.writer.RemoteMapper
 import datadog.trace.core.DDSpan
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
 import org.msgpack.jackson.dataformat.MessagePackFactory
 
 import java.lang.reflect.Method
@@ -288,6 +289,7 @@ abstract class CiVisibilityInstrumentationTest extends AgentTestRunner {
       return true
     }
 
+    @SuppressFBWarnings("UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS")
     boolean waitForSpan(Predicate<DDSpan> predicate, long timeoutMillis) {
       long deadline = System.currentTimeMillis() + timeoutMillis
       synchronized (lock) {

dd-java-agent/agent-ci-visibility/civisibility-testing/build.gradle

@@ -0,0 +1,16 @@
+apply from: "$rootDir/gradle/java.gradle"
+apply from: "$rootDir/gradle/version.gradle"
+
+dependencies {
+  api project(':dd-java-agent:agent-ci-visibility')
+  api project(':dd-java-agent:testing')
+  api project(':utils:test-utils')
+
+  api group: 'org.skyscreamer', name: 'jsonassert', version: '1.5.1'
+  api group: 'org.freemarker', name: 'freemarker', version: '2.3.31'
+  api group: 'com.jayway.jsonpath', name: 'json-path', version: '2.8.0'
+  api group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.16.0'
+  api group: 'org.msgpack', name: 'jackson-dataformat-msgpack', version: '0.9.6'
+  api group: 'org.xmlunit', name: 'xmlunit-core', version: '2.10.3'
+}
+

dd-java-agent/agent-ci-visibility/src/testFixtures/groovy/datadog/trace/civisibility/CiVisibilityTestUtils.groovy → dd-java-agent/agent-ci-visibility/civisibility-testing/src/main/groovy/datadog/trace/civisibility/CiVisibilityTestUtils.groovy

@@ -171,7 +171,7 @@ abstract class CiVisibilityTestUtils {
         println "Expected JSON: $expectedJson"
         println "Actual JSON: $actualJson"
       }
-      throw new AssertionFailedError("Coverage report events mismatch", expectedJson, actualJson, e)
+      throw new AssertionFailedError("Expected and actual JSON mismatch", expectedJson, actualJson, e)
     }
   }
 

dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/config/ConfigurationApiImplTest.groovy

@@ -11,7 +11,11 @@ import datadog.trace.api.civisibility.config.TestFQN
 import datadog.trace.api.civisibility.config.TestIdentifier
 import datadog.trace.api.civisibility.config.TestMetadata
 import datadog.trace.api.civisibility.telemetry.CiVisibilityMetricCollector
-import datadog.trace.civisibility.CiVisibilityTestUtils
+import freemarker.core.Environment
+import freemarker.core.InvalidReferenceException
+import freemarker.template.Template
+import freemarker.template.TemplateException
+import freemarker.template.TemplateExceptionHandler
 import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
 import org.apache.commons.io.IOUtils
@@ -233,7 +237,7 @@ class ConfigurationApiImplTest extends Specification {
     httpServer {
       handlers {
         prefix(path) {
-          def expectedRequestBody = CiVisibilityTestUtils.getFreemarkerTemplate(requestTemplate, requestData)
+          def expectedRequestBody = getFreemarkerTemplate(requestTemplate, requestData)
 
           def response = response
           try {
@@ -242,7 +246,7 @@ class ConfigurationApiImplTest extends Specification {
             response.status(400).send(error.getMessage().bytes)
           }
 
-          def responseBody = CiVisibilityTestUtils.getFreemarkerTemplate(responseTemplate, responseData).bytes
+          def responseBody = getFreemarkerTemplate(responseTemplate, responseData).bytes
           def header = request.getHeader("Accept-Encoding")
           def gzipSupported = header != null && header.contains("gzip")
           if (gzipSupported) {
@@ -315,4 +319,37 @@ class ConfigurationApiImplTest extends Specification {
     }
     return bitSet
   }
+
+  static final TemplateExceptionHandler SUPPRESS_EXCEPTION_HANDLER = new TemplateExceptionHandler() {
+    @Override
+    void handleTemplateException(TemplateException e, Environment environment, Writer writer) throws TemplateException {
+      if (e instanceof InvalidReferenceException) {
+        writer.write('"<VALUE_MISSING>"')
+      } else {
+        throw e
+      }
+    }
+  }
+
+  static final freemarker.template.Configuration FREEMARKER = new freemarker.template.Configuration(freemarker.template.Configuration.VERSION_2_3_30) { {
+      setClassLoaderForTemplateLoading(ConfigurationApiImplTest.classLoader, "")
+      setDefaultEncoding("UTF-8")
+      setTemplateExceptionHandler(SUPPRESS_EXCEPTION_HANDLER)
+      setLogTemplateExceptions(false)
+      setWrapUncheckedExceptions(true)
+      setFallbackOnNullLoopVariable(false)
+      setNumberFormat("0.######")
+    }
+  }
+
+  static String getFreemarkerTemplate(String templatePath, Map<String, Object> replacements, List<Map<?, ?>> replacementsSource = []) {
+    try {
+      Template coveragesTemplate = FREEMARKER.getTemplate(templatePath)
+      StringWriter coveragesOut = new StringWriter()
+      coveragesTemplate.process(replacements, coveragesOut)
+      return coveragesOut.toString()
+    } catch (Exception e) {
+      throw new RuntimeException("Could not get Freemarker template " + templatePath + "; replacements map: " + replacements + "; replacements source: " + replacementsSource, e)
+    }
+  }
 }

dd-java-agent/agent-iast/build.gradle

@@ -3,7 +3,6 @@ import net.ltgt.gradle.errorprone.CheckSeverity
 plugins {
   id 'com.gradleup.shadow'
   id 'me.champeau.jmh'
-  id 'java-test-fixtures'
   id 'com.google.protobuf' version '0.8.18'
   id 'net.ltgt.errorprone' version '3.1.0'
 }
@@ -52,8 +51,8 @@ dependencies {
   implementation libs.moshi
   implementation libs.bundles.asm
 
-  testFixturesApi project(':dd-java-agent:testing')
-  testFixturesApi project(':utils:test-utils')
+  testImplementation project(':utils:test-utils')
+  testImplementation project(':dd-java-agent:agent-bootstrap')
   testImplementation libs.bytebuddy
   testImplementation('org.skyscreamer:jsonassert:1.5.1')
   testImplementation libs.groovy.yaml

dd-java-agent/agent-iast/iast-testing/build.gradle

@@ -0,0 +1,8 @@
+apply from: "$rootDir/gradle/java.gradle"
+apply from: "$rootDir/gradle/version.gradle"
+
+dependencies {
+  api project(':dd-java-agent:agent-iast')
+  api project(':dd-java-agent:instrumentation-testing')
+  api project(':utils:test-utils')
+}

dd-java-agent/agent-iast/src/testFixtures/groovy/com/datadog/iast/test/IastRequestContextPreparationTrait.groovy → dd-java-agent/agent-iast/iast-testing/src/main/groovy/com/datadog/iast/test/IastRequestContextPreparationTrait.groovy

@@ -43,7 +43,7 @@ trait IastRequestContextPreparationTrait {
   }
 
   static void iastSystemCleanup() {
-    get().getSubscriptionService(RequestContextSlot.IAST).reset()
+    datadog.trace.bootstrap.instrumentation.api.AgentTracer.get().getSubscriptionService(RequestContextSlot.IAST).reset()
     InstrumentationBridge.clearIastModules()
   }
 
@@ -75,8 +75,8 @@ trait IastRequestContextPreparationTrait {
 
       private static Logger withLogger(final String name) {
         final logger = LoggerFactory.getLogger(name)
-        if (logger instanceof ch.qos.logback.classic.Logger) {
-          ((ch.qos.logback.classic.Logger) logger).level = ch.qos.logback.classic.Level.DEBUG
+        if (logger instanceof Logger) {
+          ((Logger) logger).level = ch.qos.logback.classic.Level.DEBUG
         }
         return logger
       }

dd-java-agent/agent-iast/src/testFixtures/groovy/com/datadog/iast/test/IastSourcesTest.groovy → dd-java-agent/agent-iast/iast-testing/src/main/groovy/com/datadog/iast/test/IastSourcesTest.groovy

@@ -1,10 +1,10 @@
 package com.datadog.iast.test
 
 import datadog.trace.api.iast.SourceTypes
-import okhttp3.FormBody
 import okhttp3.MediaType
 import okhttp3.Request
 import okhttp3.RequestBody
+import okhttp3.FormBody
 import org.hamcrest.Matchers
 import spock.lang.IgnoreIf
 

dd-java-agent/agent-iast/src/testFixtures/groovy/com/datadog/iast/test/TaintedObjectCollection.groovy → dd-java-agent/agent-iast/iast-testing/src/main/groovy/com/datadog/iast/test/TaintedObjectCollection.groovy

@@ -54,19 +54,19 @@ class TaintedObjectCollection {
       } else if (obj instanceof Pattern) {
         valueMatcher = Matchers.matchesPattern(obj)
       } else {
-        valueMatcher = equalTo(obj)
+        valueMatcher = org.hamcrest.Matchers.equalTo(obj)
       }
     }
 
     private static Matcher toMatcher(Object obj) {
       if (obj instanceof Matcher) {
         obj
       } else if (obj instanceof Pattern) {
-        matchesPattern(obj)
+        org.hamcrest.Matchers.matchesPattern(obj)
       } else if (obj == null) {
-        nullValue()
+        org.hamcrest.Matchers.nullValue()
       } else {
-        equalTo(obj)
+        org.hamcrest.Matchers.equalTo(obj)
       }
     }
 
@@ -79,15 +79,15 @@ class TaintedObjectCollection {
     }
 
     void range(int start, int length, SourceMatcher source) {
-      ranges << new RangeMatcher(start, equalTo(length), source)
+      ranges << new RangeMatcher(start, org.hamcrest.Matchers.equalTo(length), source)
     }
 
     void range(int start, Matcher<Integer> length, SourceMatcher source) {
       ranges << new RangeMatcher(start, length, source)
     }
 
     void range(SourceMatcher source) {
-      ranges << new RangeMatcher(0, greaterThan(0), source)
+      ranges << new RangeMatcher(0, org.hamcrest.Matchers.greaterThan(0), source)
     }
 
     @Override

dd-java-agent/appsec/appsec-testing/build.gradle

@@ -0,0 +1,12 @@
+apply from: "$rootDir/gradle/java.gradle"
+apply from: "$rootDir/gradle/version.gradle"
+
+dependencies {
+  api project(':dd-java-agent:appsec')
+  api project(':dd-java-agent:instrumentation-testing')
+  api project(':utils:test-utils')
+}
+
+configurations.api {
+  exclude group: 'org.eclipse.jetty', module: 'jetty-server'
+}

dd-java-agent/appsec/build.gradle

@@ -4,7 +4,6 @@ import groovy.json.JsonSlurper
 plugins {
   id 'com.gradleup.shadow'
   id 'me.champeau.jmh'
-  id 'java-test-fixtures'
 }
 
 apply from: "$rootDir/gradle/java.gradle"
@@ -26,11 +25,7 @@ dependencies {
   testImplementation libs.logback.classic
   testImplementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.16.0'
 
-  testFixturesApi project(':dd-java-agent:testing')
-}
-
-configurations.testFixturesApi {
-  exclude group: 'org.eclipse.jetty', module: 'jetty-server'
+  testImplementation project(':utils:test-utils')
 }
 
 shadowJar {

dd-java-agent/instrumentation-testing/build.gradle

@@ -0,0 +1,27 @@
+apply from: "$rootDir/gradle/java.gradle"
+
+dependencies {
+  api libs.bytebuddy
+  api libs.bytebuddyagent
+  api libs.slf4j
+  api libs.bundles.spock
+  api libs.bundles.test.logging
+  api libs.guava
+
+  api project(':dd-java-agent:testing')
+
+  implementation project(':dd-java-agent:agent-debugger')
+
+  implementation 'org.junit.platform:junit-platform-runner:1.9.0'
+
+  testImplementation project(':utils:test-utils')
+  testImplementation project(':dd-java-agent:instrumentation:trace-annotation')
+
+  testImplementation group: 'cglib', name: 'cglib', version: '3.2.5'
+  // test instrumenting java 1.1 bytecode
+  testImplementation group: 'net.sf.jt400', name: 'jt400', version: '6.1'
+
+  // We have autoservices defined in test subtree, looks like we need this to be able to properly rebuild this
+  testAnnotationProcessor libs.autoservice.processor
+  testCompileOnly libs.autoservice.annotation
+}

dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/AgentTestRunner.groovy → dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/AgentTestRunner.groovy

@@ -22,6 +22,7 @@ import datadog.trace.agent.test.datastreams.RecordingDatastreamsPayloadWriter
 import datadog.trace.agent.tooling.AgentInstaller
 import datadog.trace.agent.tooling.InstrumenterModule
 import datadog.trace.agent.tooling.TracerInstaller
+import datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers
 import datadog.trace.agent.tooling.bytebuddy.matcher.GlobalIgnores
 import datadog.trace.api.Config
 import datadog.trace.api.DDSpanId
@@ -66,7 +67,7 @@ import net.bytebuddy.dynamic.DynamicType
 import net.bytebuddy.utility.JavaModule
 import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
-import org.junit.runner.RunWith
+import org.junit.jupiter.api.extension.ExtendWith
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import org.spockframework.mock.MockUtil
@@ -107,7 +108,7 @@ import static datadog.trace.util.AgentThreadFactory.AgentThread.TASK_SCHEDULER
  */
 // CodeNarc incorrectly thinks ".class" is unnecessary in @RunWith
 @SuppressWarnings('UnnecessaryDotClass')
-@RunWith(SpockRunner.class)
+@ExtendWith(SpockExtension.class)
 abstract class AgentTestRunner extends DDSpecification implements AgentBuilder.Listener {
   private static final long TIMEOUT_MILLIS = TimeUnit.SECONDS.toMillis(20)
 
@@ -462,6 +463,10 @@ abstract class AgentTestRunner extends DDSpecification implements AgentBuilder.L
       spiedAgentSpan
     }
 
+    // if a test enables the instrumentation it verifies,
+    // the cache needs to be recomputed taking into account that instrumentation's matchers
+    ClassLoaderMatchers.resetState()
+
     assert ServiceLoader.load(InstrumenterModule, AgentTestRunner.getClassLoader())
     .iterator()
     .hasNext(): "No instrumentation found"