Introduce id-based line probe source matching

line probe in unit tests are created by searching probe id (UUID)
inside the targeted source file.
uuid are added as comment on the line we want to put a line probe.
Add helper method to search a uuid inside the targeted source file
and returns the line number used to create the line probe

Author: jpbempel

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/agent/CapturedSnapshotTest.java

@@ -337,7 +337,6 @@ public static LogProbe.Builder createProbeBuilder(
   public static LogProbe.Builder createProbeBuilder(ProbeId id, String sourceFile, int line) {
     return createProbeBuilder(id)
         .captureSnapshot(true)
-        .where(typeName, methodName, signature, lines)
         .where(sourceFile, line)
         // Increase sampling limit to avoid being sampled during tests
         .sampling(new LogProbe.Sampling(100));

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/agent/CapturingTestBase.java

@@ -20,6 +20,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import static utils.InstrumentationTestHelper.compileAndLoadClass;
+import static utils.InstrumentationTestHelper.getLineForLineProbe;
 
 import com.datadog.debugger.el.DSL;
 import com.datadog.debugger.el.ProbeCondition;
@@ -60,6 +61,8 @@ public class SpanDecorationProbeInstrumentationTest extends ProbeInstrumentation
   private static final ProbeId PROBE_ID2 = new ProbeId("beae1807-f3b0-4ea8-a74f-826790c5e6f7", 0);
   private static final ProbeId PROBE_ID3 = new ProbeId("beae1807-f3b0-4ea8-a74f-826790c5e6f8", 0);
   private static final ProbeId PROBE_ID4 = new ProbeId("beae1807-f3b0-4ea8-a74f-826790c5e6f9", 0);
+  private static final ProbeId LINE_PROBE_ID1 =
+      new ProbeId("beae1817-f3b0-4ea8-a74f-000000000001", 0);
 
   private TestTraceInterceptor traceInterceptor = new TestTraceInterceptor();
 
@@ -259,14 +262,16 @@ public void methodActiveSpanSynthException() throws IOException, URISyntaxExcept
   public void lineActiveSpanSimpleTag() throws IOException, URISyntaxException {
     final String CLASS_NAME = "com.datadog.debugger.CapturedSnapshot20";
     SpanDecorationProbe.Decoration decoration = createDecoration("tag1", "{arg}");
-    installSingleSpanDecoration(CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", 47);
+    int line = getLineForLineProbe(CLASS_NAME, LINE_PROBE_ID1);
+    installSingleSpanDecoration(
+        LINE_PROBE_ID1, CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", line);
     Class<?> testClass = compileAndLoadClass(CLASS_NAME);
     int result = Reflect.on(testClass).call("main", "1").get();
     assertEquals(84, result);
     MutableSpan span = traceInterceptor.getFirstSpan();
     assertEquals("1", span.getTags().get("tag1"));
-    assertEquals(PROBE_ID.getId(), span.getTags().get("_dd.di.tag1.probe_id"));
-    verify(probeStatusSink).addEmitting(ArgumentMatchers.eq(PROBE_ID));
+    assertEquals(LINE_PROBE_ID1.getId(), span.getTags().get("_dd.di.tag1.probe_id"));
+    verify(probeStatusSink).addEmitting(ArgumentMatchers.eq(LINE_PROBE_ID1));
   }
 
   @Test
@@ -275,8 +280,14 @@ public void lineRootSpanTagList() throws IOException, URISyntaxException {
     SpanDecorationProbe.Decoration deco1 = createDecoration("tag1", "{arg}");
     SpanDecorationProbe.Decoration deco2 = createDecoration("tag2", "{this.intField}");
     SpanDecorationProbe.Decoration deco3 = createDecoration("tag3", "{strField}");
+    int line = getLineForLineProbe(CLASS_NAME, LINE_PROBE_ID1);
     installSingleSpanDecoration(
-        CLASS_NAME, ROOT, asList(deco1, deco2, deco3), "CapturedSnapshot21.java", 67);
+        LINE_PROBE_ID1,
+        CLASS_NAME,
+        ROOT,
+        asList(deco1, deco2, deco3),
+        "CapturedSnapshot21.java",
+        line);
     Class<?> testClass = compileAndLoadClass(CLASS_NAME);
     int result = Reflect.on(testClass).call("main", "1").get();
     assertEquals(45, result);
@@ -292,7 +303,9 @@ public void lineActiveSpanCondition() throws IOException, URISyntaxException {
     final String CLASS_NAME = "com.datadog.debugger.CapturedSnapshot20";
     SpanDecorationProbe.Decoration decoration =
         createDecoration(eq(ref("arg"), value("5")), "arg == '5'", "tag1", "{arg}");
-    installSingleSpanDecoration(CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", 47);
+    int line = getLineForLineProbe(CLASS_NAME, LINE_PROBE_ID1);
+    installSingleSpanDecoration(
+        LINE_PROBE_ID1, CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", line);
     Class<?> testClass = compileAndLoadClass(CLASS_NAME);
     for (int i = 0; i < 10; i++) {
       int result = Reflect.on(testClass).call("main", String.valueOf(i)).get();
@@ -308,7 +321,9 @@ public void lineActiveSpanInvalidCondition() throws IOException, URISyntaxExcept
     final String CLASS_NAME = "com.datadog.debugger.CapturedSnapshot20";
     SpanDecorationProbe.Decoration decoration =
         createDecoration(eq(ref("noarg"), value("5")), "arg == '5'", "tag1", "{arg}");
-    installSingleSpanDecoration(CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", 47);
+    int line = getLineForLineProbe(CLASS_NAME, LINE_PROBE_ID1);
+    installSingleSpanDecoration(
+        LINE_PROBE_ID1, CLASS_NAME, ACTIVE, decoration, "CapturedSnapshot20.java", line);
     Class<?> testClass = compileAndLoadClass(CLASS_NAME);
     int result = Reflect.on(testClass).call("main", "5").get();
     assertEquals(84, result);
@@ -338,24 +353,12 @@ public void mixedWithLogProbes() throws IOException, URISyntaxException {
     SpanDecorationProbe.Decoration decoration2 = createDecoration("tag2", "{arg}");
     SpanDecorationProbe spanDecoProbe1 =
         createProbeBuilder(
-                PROBE_ID1,
-                ACTIVE,
-                singletonList(decoration1),
-                CLASS_NAME,
-                "process",
-                null,
-                (String[]) null)
+                PROBE_ID1, ACTIVE, singletonList(decoration1), CLASS_NAME, "process", null)
             .evaluateAt(MethodLocation.EXIT)
             .build();
     SpanDecorationProbe spanDecoProbe2 =
         createProbeBuilder(
-                PROBE_ID2,
-                ACTIVE,
-                singletonList(decoration2),
-                CLASS_NAME,
-                "process",
-                null,
-                (String[]) null)
+                PROBE_ID2, ACTIVE, singletonList(decoration2), CLASS_NAME, "process", null)
             .evaluateAt(MethodLocation.ENTRY)
             .build();
     LogProbe logProbe1 =
@@ -403,24 +406,12 @@ public void mixedEntryExit() throws IOException, URISyntaxException {
     SpanDecorationProbe.Decoration decoration2 = createDecoration("tag2", "{arg}");
     SpanDecorationProbe spanDecoProbe1 =
         createProbeBuilder(
-                PROBE_ID1,
-                ACTIVE,
-                singletonList(decoration1),
-                CLASS_NAME,
-                "process",
-                null,
-                (String[]) null)
+                PROBE_ID1, ACTIVE, singletonList(decoration1), CLASS_NAME, "process", null)
             .evaluateAt(MethodLocation.EXIT)
             .build();
     SpanDecorationProbe spanDecoProbe2 =
         createProbeBuilder(
-                PROBE_ID2,
-                ACTIVE,
-                singletonList(decoration2),
-                CLASS_NAME,
-                "process",
-                null,
-                (String[]) null)
+                PROBE_ID2, ACTIVE, singletonList(decoration2), CLASS_NAME, "process", null)
             .evaluateAt(MethodLocation.ENTRY)
             .build();
     Configuration configuration =
@@ -624,12 +615,14 @@ private void installSingleSpanDecoration(
   }
 
   private void installSingleSpanDecoration(
+      ProbeId probeId,
       String typeName,
       SpanDecorationProbe.TargetSpan targetSpan,
       SpanDecorationProbe.Decoration decoration,
       String sourceFile,
       int line) {
-    installSingleSpanDecoration(typeName, targetSpan, asList(decoration), sourceFile, line);
+    installSingleSpanDecoration(
+        probeId, typeName, targetSpan, asList(decoration), sourceFile, line);
   }
 
   private void installSingleSpanDecoration(
@@ -645,12 +638,13 @@ private void installSingleSpanDecoration(
   }
 
   private void installSingleSpanDecoration(
+      ProbeId probeId,
       String typeName,
       SpanDecorationProbe.TargetSpan targetSpan,
       List<SpanDecorationProbe.Decoration> decorations,
       String sourceFile,
       int line) {
-    SpanDecorationProbe probe = createProbe(PROBE_ID, targetSpan, decorations, sourceFile, line);
+    SpanDecorationProbe probe = createProbe(probeId, targetSpan, decorations, sourceFile, line);
     installSpanDecorationProbes(
         typeName, Configuration.builder().setService(SERVICE_NAME).add(probe).build());
   }
@@ -661,10 +655,8 @@ private static SpanDecorationProbe createProbe(
       List<SpanDecorationProbe.Decoration> decorationList,
       String typeName,
       String methodName,
-      String signature,
-      String... lines) {
-    return createProbeBuilder(
-            id, targetSpan, decorationList, typeName, methodName, signature, lines)
+      String signature) {
+    return createProbeBuilder(id, targetSpan, decorationList, typeName, methodName, signature)
         .evaluateAt(MethodLocation.EXIT)
         .build();
   }
@@ -684,12 +676,11 @@ private static SpanDecorationProbe.Builder createProbeBuilder(
       List<SpanDecorationProbe.Decoration> decorationList,
       String typeName,
       String methodName,
-      String signature,
-      String... lines) {
+      String signature) {
     return SpanDecorationProbe.builder()
         .language(LANGUAGE)
         .probeId(id)
-        .where(typeName, methodName, signature, lines)
+        .where(typeName, methodName, signature)
         .evaluateAt(MethodLocation.EXIT)
         .targetSpan(targetSpan)
         .decorate(decorationList);

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/agent/LogProbesInstrumentationTest.java

@@ -173,9 +173,8 @@ public static TriggerProbe createTriggerProbe(
       String methodName,
       String signature,
       ProbeCondition probeCondition,
-      Sampling sampling,
-      String... lines) {
-    return new TriggerProbe(id, Where.of(typeName, methodName, signature, lines))
+      Sampling sampling) {
+    return new TriggerProbe(id, Where.of(typeName, methodName, signature))
         .setSessionId(sessionId)
         .setProbeCondition(probeCondition)
         .setSampling(sampling);

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/agent/MetricProbesInstrumentationTest.java

@@ -5,7 +5,6 @@
 
 import com.datadog.debugger.agent.CapturedSnapshotTest;
 import datadog.trace.bootstrap.debugger.ProbeId;
-
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URISyntaxException;
@@ -71,11 +70,20 @@ public static Class<?> loadClassFromJar(String className, String jarFileName)
     return jarClassLoader.loadClass(className);
   }
 
-  public static int getLineForLineProbe(String className, ProbeId lineProbeId) throws IOException, URISyntaxException {
-    List<String> lines = getFixtureLines("/" + className.replace('.', '/') + ".java");
-
-    return 0;
+  public static int getLineForLineProbe(String className, ProbeId lineProbeId)
+      throws IOException, URISyntaxException {
+    return getLineForLineProbe(className, ".java", lineProbeId);
   }
 
-
+  public static int getLineForLineProbe(String className, String ext, ProbeId lineProbeId)
+      throws IOException, URISyntaxException {
+    List<String> lines = getFixtureLines("/" + className.replace('.', '/') + ext);
+    for (int i = 0; i < lines.size(); i++) {
+      String line = lines.get(i);
+      if (line.contains("//") && line.contains(lineProbeId.getId())) {
+        return i + 1;
+      }
+    }
+    return -1;
+  }
 }

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/agent/SpanDecorationProbeInstrumentationTest.java

@@ -11,7 +11,8 @@ public static String getFixtureContent(String fixture) throws IOException, URISy
     return new String(Files.readAllBytes(Paths.get(TestHelper.class.getResource(fixture).toURI())));
   }
 
-  public static List<String> getFixtureLines(String fixture) throws IOException, URISyntaxException {
+  public static List<String> getFixtureLines(String fixture)
+      throws IOException, URISyntaxException {
     return Files.readAllLines(Paths.get(TestHelper.class.getResource(fixture).toURI()));
   }
 }

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/trigger/TriggerProbeTest.java

@@ -5,7 +5,7 @@ public static int main(String arg) {
       var1 = 2;
       return var1;
     }
-    var1 = 3;
-    return var1;
+    var1 = 3; // beae1817-f3b0-4ea8-a74f-000000000001
+    return var1; // beae1817-f3b0-4ea8-a74f-000000000002
   }
 }

dd-java-agent/agent-debugger/src/test/java/utils/InstrumentationTestHelper.java

@@ -43,7 +43,7 @@ void f() {
   int synchronizedBlock(int input) {
     int count = input;
     synchronized (this) {
-      for (int i = 0; i < 10; i++) {
+      for (int i = 0; i < 10; i++) { // beae1817-f3b0-4ea8-a74f-000000000001
         count += i;
       }
     }