Mark JUnit 5 setup and teardown action spans as failed if there is an…

… error (#8033)
DataDog · Nov 28, 2024 · 3ad344d · 3ad344d
1 parent 1ef67e5
commit 3ad344d
Show file tree

Hide file tree

Showing 17 changed files with 985 additions and 14 deletions.
diff --git a/...src/testFixtures/groovy/datadog/trace/civisibility/CiVisibilityInstrumentationTest.groovy b/...src/testFixtures/groovy/datadog/trace/civisibility/CiVisibilityInstrumentationTest.groovy
@@ -263,15 +263,13 @@ abstract class CiVisibilityInstrumentationTest extends AgentTestRunner {
     ] + replacements
 
     // uncomment to generate expected data templates
-    //    def baseTemplatesPath = CiVisibilityInstrumentationTest.classLoader
-    //      .getResource("test-succeed")
-    //      .toURI()
-    //      .schemeSpecificPart
-    //      .replace('build/resources/test', 'src/test/resources')
-    //      .replace('build/resources/latestDepTest', 'src/test/resources')
-    //      .replace("test-succeed", testcaseName)
-    //    CiVisibilityTestUtils.generateTemplates(baseTemplatesPath, events, coverages, additionalReplacements)
-    //    return [:]
+    //      def clazz = this.getClass()
+    //      def resourceName = clazz.name.replace('.', '/') + ".class"
+    //      def classfilePath = clazz.getResource(resourceName).toURI().schemeSpecificPart
+    //      def modulePath = classfilePath.substring(0, classfilePath.indexOf("/build/classes"))
+    //      def baseTemplatesPath = modulePath + "/src/test/resources/" + testcaseName
+    //      CiVisibilityTestUtils.generateTemplates(baseTemplatesPath, events, coverages, additionalReplacements)
+    //      return [:]
 
     return CiVisibilityTestUtils.assertData(testcaseName, events, coverages, additionalReplacements)
   }

diff --git a/...t-5.8/src/main/java/datadog/trace/instrumentation/junit5/BeforeAfterOperationsTracer.java b/...t-5.8/src/main/java/datadog/trace/instrumentation/junit5/BeforeAfterOperationsTracer.java
@@ -53,6 +53,9 @@ private static void traceInvocation(
     agentSpan.setTag(Tags.TEST_CALLBACK, operationName);
     try (AgentScope agentScope = AgentTracer.activateSpan(agentSpan)) {
       invocation.proceed();
+    } catch (Throwable t) {
+      agentSpan.addThrowable(t);
+      throw t;
     } finally {
       agentSpan.finish();
     }

diff --git a/dd-java-agent/instrumentation/junit-5.3/junit-5.8/src/test/groovy/JUnit58Test.groovy b/dd-java-agent/instrumentation/junit-5.3/junit-5.8/src/test/groovy/JUnit58Test.groovy
@@ -22,6 +22,10 @@ class JUnit58Test extends CiVisibilityInstrumentationTest {
     testcaseName                  | tests                            | expectedTracesCount
     "test-before-each-after-each" | [TestSucceedBeforeEachAfterEach] | 2
     "test-before-all-after-all"   | [TestSucceedBeforeAllAfterAll]   | 2
+    "test-failed-before-all"      | [TestFailedBeforeAll]            | 2
+    "test-failed-after-all"       | [TestFailedAfterAll]             | 2
+    "test-failed-before-each"     | [TestFailedBeforeEach]           | 2
+    "test-failed-after-each"      | [TestFailedAfterEach]            | 2
   }
 
   private static void runTests(List<Class<?>> tests) {

diff --git a/...ent/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedAfterAll.java b/...ent/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedAfterAll.java
@@ -0,0 +1,24 @@
+package org.example;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.Test;
+
+public class TestFailedAfterAll {
+
+  @AfterAll
+  public static void tearDown() {
+    throw new RuntimeException("suite teardown failed");
+  }
+
+  @Test
+  public void test_succeed() {
+    assertTrue(true);
+  }
+
+  @Test
+  public void another_test_succeed() {
+    assertTrue(true);
+  }
+}
diff --git a/...nt/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedAfterEach.java b/...nt/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedAfterEach.java
@@ -0,0 +1,24 @@
+package org.example;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
+
+public class TestFailedAfterEach {
+
+  @AfterEach
+  public void tearDown() {
+    throw new RuntimeException("testcase teardown failed");
+  }
+
+  @Test
+  public void test_succeed() {
+    assertTrue(true);
+  }
+
+  @Test
+  public void another_test_succeed() {
+    assertTrue(true);
+  }
+}
diff --git a/...nt/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedBeforeAll.java b/...nt/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedBeforeAll.java
@@ -0,0 +1,24 @@
+package org.example;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+public class TestFailedBeforeAll {
+
+  @BeforeAll
+  public static void setUp() {
+    throw new RuntimeException("suite setup failed");
+  }
+
+  @Test
+  public void test_succeed() {
+    assertTrue(true);
+  }
+
+  @Test
+  public void another_test_succeed() {
+    assertTrue(true);
+  }
+}
diff --git a/...t/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedBeforeEach.java b/...t/instrumentation/junit-5.3/junit-5.8/src/test/java/org/example/TestFailedBeforeEach.java
@@ -0,0 +1,24 @@
+package org.example;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+public class TestFailedBeforeEach {
+
+  @BeforeEach
+  public void setUp() {
+    throw new RuntimeException("testcase setup failed");
+  }
+
+  @Test
+  public void test_succeed() {
+    assertTrue(true);
+  }
+
+  @Test
+  public void another_test_succeed() {
+    assertTrue(true);
+  }
+}
diff --git a/...strumentation/junit-5.3/junit-5.8/src/test/resources/test-before-all-after-all/events.ftl b/...strumentation/junit-5.3/junit-5.8/src/test/resources/test-before-all-after-all/events.ftl
@@ -16,6 +16,7 @@
       "_dd.trace_span_attribute_schema" : 0
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid},
       "test.type" : "test",
       "_dd.tracer_host" : ${content_meta__dd_tracer_host},
       "test.status" : "pass",
@@ -46,9 +47,10 @@
     "duration" : ${content_duration_2},
     "error" : 0,
     "metrics" : {
-      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count}
+      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_2}
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_2},
       "test.type" : "test",
       "test.module" : "junit-5.8",
       "test.status" : "pass",
@@ -76,16 +78,20 @@
     "duration" : ${content_duration_3},
     "error" : 0,
     "metrics" : {
-      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count}
+      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_3},
+      "test.source.end" : 19,
+      "test.source.start" : 11
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_3},
       "test.type" : "test",
       "test.source.file" : "dummy_source_path",
       "test.module" : "junit-5.8",
       "test.status" : "pass",
       "test_session.name" : "session-name",
       "env" : "none",
       "dummy_ci_tag" : "dummy_ci_tag_value",
+      "test.codeowners" : "[\"owner1\",\"owner2\"]",
       "library_version" : ${content_meta_library_version},
       "component" : "junit",
       "span.kind" : "test_suite_end",
@@ -114,7 +120,7 @@
       "process_id" : ${content_metrics_process_id},
       "_dd.profiling.enabled" : 0,
       "_dd.trace_span_attribute_schema" : 0,
-      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count},
+      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_4},
       "test.source.end" : 18,
       "test.source.start" : 12
     },
@@ -161,7 +167,7 @@
       "process_id" : ${content_metrics_process_id},
       "_dd.profiling.enabled" : 0,
       "_dd.trace_span_attribute_schema" : 0,
-      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count},
+      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_5},
       "test.source.end" : 18,
       "test.source.start" : 12
     },
@@ -203,6 +209,7 @@
     "error" : 0,
     "metrics" : { },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_4},
       "test.callback" : "BeforeAll",
       "library_version" : ${content_meta_library_version},
       "env" : "none"
@@ -223,6 +230,7 @@
     "error" : 0,
     "metrics" : { },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_5},
       "test.callback" : "AfterAll",
       "library_version" : ${content_meta_library_version},
       "env" : "none"

diff --git a/...rumentation/junit-5.3/junit-5.8/src/test/resources/test-before-each-after-each/events.ftl b/...rumentation/junit-5.3/junit-5.8/src/test/resources/test-before-each-after-each/events.ftl
@@ -16,6 +16,7 @@
       "_dd.trace_span_attribute_schema" : 0
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid},
       "test.type" : "test",
       "_dd.tracer_host" : ${content_meta__dd_tracer_host},
       "test.status" : "pass",
@@ -49,6 +50,7 @@
       "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_2}
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_2},
       "test.type" : "test",
       "test.module" : "junit-5.8",
       "test.status" : "pass",
@@ -76,16 +78,20 @@
     "duration" : ${content_duration_3},
     "error" : 0,
     "metrics" : {
-      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_3}
+      "_dd.host.vcpu_count" : ${content_metrics__dd_host_vcpu_count_3},
+      "test.source.end" : 19,
+      "test.source.start" : 11
     },
     "meta" : {
+      "_dd.p.tid" : ${content_meta__dd_p_tid_3},
       "test.type" : "test",
       "test.source.file" : "dummy_source_path",
       "test.module" : "junit-5.8",
       "test.status" : "pass",
       "test_session.name" : "session-name",
       "env" : "none",
       "dummy_ci_tag" : "dummy_ci_tag_value",
+      "test.codeowners" : "[\"owner1\",\"owner2\"]",
       "library_version" : ${content_meta_library_version},
       "component" : "junit",
       "span.kind" : "test_suite_end",

diff --git a/...nstrumentation/junit-5.3/junit-5.8/src/test/resources/test-failed-after-all/coverages.ftl b/...nstrumentation/junit-5.3/junit-5.8/src/test/resources/test-failed-after-all/coverages.ftl
@@ -0,0 +1 @@
+[ ]