[WIP] Add file attribute to JUnit reports

.circleci/upload_ciapp.sh

@@ -17,6 +17,18 @@ java_prop() {
     echo "$JAVA_PROPS" | grep "$PROP_NAME" | head -n1 | cut -d'=' -f2 | xargs
 }
 
+# Add the 'file' attribute to the JUnit XML file
+add_source_file_to_xml() {
+    local XML_FILE=$1
+    local ESCAPED_FILE
+
+    # Escape special characters in the filename (such as /, &, etc.)
+    ESCAPED_FILE=$(printf '%s' "$XML_FILE" | sed 's/[&/\]/\\&/g')
+
+    # Insert the 'file=ESCAPED_FILE' attribute in each <testcase>
+    sed -i '' "/<testcase/ s/\(<testcase[^>]*\)\(\/\)/\1 file=\"$ESCAPED_FILE\"\2/" "$XML_FILE"
+}
+
 # Upload test results to CI Visibility
 junit_upload() {
     # based on tracer implementation: https://github.com/DataDog/dd-trace-java/blob/master/dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/instrumentation/decorator/TestDecorator.java#L55-L77
@@ -36,6 +48,11 @@ junit_upload() {
 # Make sure we do not use DATADOG_API_KEY from the environment
 unset DATADOG_API_KEY
 
+# Modify the JUnit XML results by adding the 'file' attribute
+for XML_FILE in ./results/*.xml; do
+    add_source_file_to_xml "$XML_FILE"
+done
+
 # Upload test results to production environment like all other CI jobs
 junit_upload "$DATADOG_API_KEY_PROD"
 # And also upload to staging environment to benefit from the new features not yet released

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

@@ -20,6 +20,10 @@ addTestSuiteForDir('latestDepTest', 'test')
 addTestSuiteExtendingForDir('latestDepJava11Test', 'latestDepTest', 'test')
 
 dependencies {
+  // junit extension
+  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.x.x'
+  testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.x.x'
+
   compileOnly group: 'com.zaxxer', name: 'HikariCP', version: '2.4.0'
   testImplementation(testFixtures(project(':dd-java-agent:agent-iast')))
 

dd-java-agent/instrumentation/jdbc/src/test/groovy/JDBCInstrumentationTestBase.groovy

@@ -6,8 +6,10 @@ import datadog.trace.api.Config
 import datadog.trace.api.DDSpanTypes
 import datadog.trace.bootstrap.instrumentation.api.InstrumentationTags
 import datadog.trace.bootstrap.instrumentation.api.Tags
+import datadog.trace.test.util.TestSourceFileExtension
 import org.apache.derby.jdbc.EmbeddedDataSource
 import org.h2.jdbcx.JdbcDataSource
+import org.junit.jupiter.api.extension.ExtendWith
 import spock.lang.Shared
 import test.TestConnection
 import test.WrappedConnection
@@ -24,6 +26,7 @@ import static datadog.trace.agent.test.utils.TraceUtils.basicSpan
 import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace
 import static datadog.trace.api.config.TraceInstrumentationConfig.DB_CLIENT_HOST_SPLIT_BY_INSTANCE
 
+@ExtendWith(TestSourceFileExtension)
 abstract class JDBCInstrumentationTest extends VersionedNamingTestBase {
 
   @Shared
@@ -752,7 +755,7 @@ abstract class JDBCInstrumentationTest extends VersionedNamingTestBase {
     for (int i = 0; i < numQueries; ++i) {
       res[i] == 3
     }
-    assertTraces(5) {
+    assertTraces(6) {
       trace(1) {
         span {
           operationName this.operation(dbType)
@@ -849,6 +852,7 @@ abstract class JDBCInstrumentationTest extends VersionedNamingTestBase {
   protected abstract boolean dbmTraceInjected()
 }
 
+@ExtendWith(TestSourceFileExtension)
 class JDBCInstrumentationV0Test extends JDBCInstrumentationTest {
 
   @Override
@@ -872,6 +876,7 @@ class JDBCInstrumentationV0Test extends JDBCInstrumentationTest {
   }
 }
 
+TestSourceFileExtension
 class JDBCInstrumentationV1ForkedTest extends JDBCInstrumentationTest {
 
   @Override
@@ -895,6 +900,7 @@ class JDBCInstrumentationV1ForkedTest extends JDBCInstrumentationTest {
   }
 }
 
+@ExtendWith(TestSourceFileExtension)
 class JDBCInstrumentationDBMTraceInjectedForkedTest extends JDBCInstrumentationTest {
 
   @Override

utils/test-utils/src/main/groovy/datadog/trace/test/util/TestSourceFileExtension.groovy

@@ -0,0 +1,50 @@
+package datadog.trace.test.util
+
+import org.junit.jupiter.api.extension.ExtensionContext
+import org.junit.jupiter.api.extension.TestWatcher
+
+class TestSourceFileExtension implements TestWatcher {
+  TestSourceFileExtension() {
+    System.out.println("TestSourceFileExtension initialized!")
+  }
+
+  @Override
+  void testSuccessful(ExtensionContext context) {
+    System.out.println("test was successful!")
+    getTestData(context)
+  }
+
+  @Override
+  void testFailed(ExtensionContext context, Throwable cause) {
+    System.out.println("test failed!")
+    getTestData(context)
+  }
+
+  @Override
+  void testAborted(ExtensionContext context, Throwable cause) {
+    System.out.println("test aborted!")
+    getTestData(context)
+  }
+
+  @Override
+  void testDisabled(ExtensionContext context, Optional<String> reason) {
+    System.out.println("test disabled!")
+    getTestData(context)
+  }
+
+  private static void getTestData(ExtensionContext context) {
+    String testClassName = context.getTestClass().get().getSimpleName()
+    String testMethodName = context.getTestMethod().get().getName()
+    String className = context.getClass()
+    String requiredTestClassName = context.getRequiredTestClass().getName()
+    String requiredTestMethodName = context.getRequiredTestMethod().getName()
+
+    System.out.println("--------------------------")
+    System.out.println("testClassName: " + testClassName)
+    System.out.println("testMethodName: " + testMethodName)
+    System.out.println("className: " + className)
+    System.out.println("requiredTestClassName: " + requiredTestClassName)
+    System.out.println("requiredTestMethodName: " + requiredTestMethodName)
+    System.out.println("--------------------------")
+  }
+}