Modify xml report in extension

Author: sarahchen6

.circleci/collect_results.sh

@@ -27,11 +27,11 @@ do
   echo -n " as $AGGREGATED_FILE_NAME"
   cp "$RESULT_XML_FILE" "$TEST_RESULTS_DIR/$AGGREGATED_FILE_NAME"
   # Extract source file from system-out and use as the file attribute for each test case
-  path=$(grep -oP '(?<=path: ).*' "$RESULT_XML_FILE" | tail -n 1)
-  testClassName=$(grep -oP '(?<=testClassName: ).*' "$RESULT_XML_FILE" | tail -n 1)
-  escapedPath=$(echo "$path" | sed 's/[\/&]/\\&/g')
-  escapedClassName=$(echo "$testClassName" | sed 's/[\/&]/\\&/g')
-  sed -i "/<testcase/ s/\(classname=\"$escapedClassName\".*\)/\1 file=\"$escapedPath\"/" "$TEST_RESULTS_DIR/$AGGREGATED_FILE_NAME"
+#  path=$(grep -oP '(?<=path: ).*' "$RESULT_XML_FILE" | tail -n 1)
+#  testClassName=$(grep -oP '(?<=testClassName: ).*' "$RESULT_XML_FILE" | tail -n 1)
+#  escapedPath=$(echo "$path" | sed 's/[\/&]/\\&/g')
+#  escapedClassName=$(echo "$testClassName" | sed 's/[\/&]/\\&/g')
+#  sed -i "/<testcase/ s/\(classname=\"$escapedClassName\".*\)/\1 file=\"$escapedPath\"/" "$TEST_RESULTS_DIR/$AGGREGATED_FILE_NAME"
   # sed -i '/<system-out>/,/<\/system-out>/d' "$TEST_RESULTS_DIR/$AGGREGATED_FILE_NAME"
   # Replace Java Object hashCode by marker in testcase XML nodes to get stable test names
   sed -i '/<testcase/ s/@[0-9a-f]\{5,\}/@HASHCODE/g' "$TEST_RESULTS_DIR/$AGGREGATED_FILE_NAME"

…launcher.listeners.TestExecutionListener ….platform.launcher.TestExecutionListenercomponents/context/src/main/resources/META-INF/services/org.junit.platform.launcher.listeners.TestExecutionListener renamed to components/context/src/main/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener components/context/src/main/resources/META-INF/services/org.junit.platform.launcher.listeners.TestExecutionListener renamed to components/context/src/main/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener

@@ -1,5 +1,11 @@
 package datadog.context;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.launcher.TestExecutionListener;
 import org.junit.platform.launcher.TestIdentifier;
@@ -16,8 +22,55 @@ public void testPlanExecutionStarted(TestPlan testPlan) {
 
   public void executionFinished(
       TestIdentifier testIdentifier, TestExecutionResult testExecutionResult) {
-    System.out.println("EXECUTIONFINISHED.");
-    // get test source file info here
+    // this should happen in testPlanExecutionFinished after all tests are run, but this method is
+    // easier to test locally for now
+
+    Map<String, String> sourceFiles = TestSourceFileExtension.getSourceFiles();
+
+    // hard coded for now
+    // get xml report file
+    Path path =
+        Paths.get(
+            "/Users/sarah.chen/Source/github.com/DataDog/dd-trace-java/components/context/build/test-results/test/TEST-datadog.context.ContextKeyTest.xml");
+    try {
+      String content = new String(Files.readAllBytes(path));
+
+      // modify report with test source file info
+      // use regex pattern to get class name
+      Pattern pattern = Pattern.compile("<testcase(.*?)classname=\"(.*?)\"(.*?)>");
+      Matcher matcher = pattern.matcher(content);
+      StringBuffer result = new StringBuffer();
+      while (matcher.find()) {
+        String attributes = matcher.group(1);
+        String className = matcher.group(2);
+        String timeAttribute = matcher.group(3);
+
+        // add source file attribute
+        String fileAttribute = "";
+        if (sourceFiles.containsKey(className)) {
+          fileAttribute = " file=\"" + sourceFiles.get(className) + "\"";
+        }
+        String newTestCase =
+            "<testcase"
+                + attributes
+                + "classname=\""
+                + className
+                + "\""
+                + fileAttribute
+                + timeAttribute
+                + ">";
+        matcher.appendReplacement(result, newTestCase);
+      }
+      // add the rest
+      matcher.appendTail(result);
+
+      // set old path to new xml result
+      // System.out.println("result: " + result); shows that result is correct, but haven't figured
+      // out a way to overwrite the original path yet
+
+    } catch (Exception e) {
+      System.out.println("didnt work.");
+    }
   }
 
   public void testPlanExecutionFinished(TestPlan testPlan) {

components/context/src/test/java/datadog/context/SourceFileExtension.java

@@ -1,33 +1,40 @@
 package datadog.context;
 
 import java.net.URL;
+import java.util.HashMap;
+import java.util.Map;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.TestInstancePostProcessor;
 
 public class TestSourceFileExtension implements TestInstancePostProcessor {
+  private static Map<String, String> sourceFiles = new HashMap<String, String>();
+
   @Override
   public void postProcessTestInstance(Object testInstance, ExtensionContext context) {
     getTestData(context);
   }
 
-  private static void getTestData(ExtensionContext context) {
-    System.out.println("----------------------------------");
+  public static Map<String, String> getSourceFiles() {
+    return sourceFiles;
+  }
 
+  private static void getTestData(ExtensionContext context) {
+    // get test class and test class name
     Class<?> testClass = context.getTestClass().get();
     String testClassName = testClass.getName();
-    System.out.println("testClassName: " + testClassName);
+    // get URL of test class file
     URL resource = testClass.getResource(testClass.getSimpleName() + ".class");
     if (resource != null) {
+      // get path after "dd-trace-java" and before the final "/"
       String absolutePath = resource.getPath();
       String subPath =
           absolutePath.substring(
               absolutePath.indexOf("dd-trace-java") + "dd-trace-java".length(),
               absolutePath.lastIndexOf("/"));
-      System.out.println("path: " + subPath);
+      // add the test class name and source file to sourceFiles
+      sourceFiles.put(testClassName, subPath);
     } else {
-      System.out.println("no path.");
+      sourceFiles.put(testClassName, "");
     }
-
-    System.out.println("----------------------------------");
   }
 }