refactor: add a session span (#644)

Author: jd

mergify_cli/ci/junit.py

@@ -48,8 +48,6 @@ async def junit_to_spans(
         msg = "no testsuite tag found"
         raise InvalidJunitXMLError(msg)
 
-    spans = []
-
     now = time.time_ns()
 
     common_attributes = {}
@@ -86,6 +84,29 @@ async def junit_to_spans(
 
     trace_id = ID_GENERATOR.generate_trace_id()
 
+    session_context = opentelemetry.trace.span.SpanContext(
+        trace_id=trace_id,
+        span_id=ID_GENERATOR.generate_span_id(),
+        is_remote=False,
+    )
+
+    session_span = ReadableSpan(
+        name="test session",
+        context=session_context,
+        parent=None,
+        # We'll compute start_time later
+        end_time=now,
+        resource=resource,
+        attributes={
+            "test.scope": "session",
+        }
+        | common_attributes,
+    )
+
+    session_start_time = now
+
+    spans = [session_span]
+
     for testsuite in testsuites:
         min_start_time = now
         suite_name = testsuite.get("name", "unnamed testsuite")
@@ -99,7 +120,7 @@ async def junit_to_spans(
         testsuite_span = ReadableSpan(
             name=suite_name,
             context=testsuite_context,
-            parent=None,
+            parent=session_context,
             # We'll compute start_time later
             end_time=now,
             resource=resource,
@@ -184,5 +205,8 @@ async def junit_to_spans(
             spans.append(span)
 
         testsuite_span._start_time = min_start_time  # noqa: SLF001
+        session_start_time = min(session_start_time, min_start_time)
+
+    session_span._start_time = session_start_time  # noqa: SLF001
 
     return spans

mergify_cli/tests/ci/test_junit.py

@@ -57,6 +57,32 @@ async def test_parse(
         "telemetry.sdk.version": anys.ANY_STR,
     }
     assert dictified_spans == [
+        {
+            "attributes": {
+                "test.framework": "unittest",
+                "test.language": "python",
+                "test.scope": "session",
+            },
+            "context": {
+                "span_id": anys.ANY_STR,
+                "trace_id": trace_id,
+                "trace_state": "[]",
+            },
+            "end_time": anys.ANY_DATETIME_STR,
+            "events": [],
+            "kind": "SpanKind.INTERNAL",
+            "links": [],
+            "name": "test session",
+            "parent_id": None,
+            "resource": {
+                "attributes": resource_attributes,
+                "schema_url": "",
+            },
+            "start_time": anys.ANY_DATETIME_STR,
+            "status": {
+                "status_code": "UNSET",
+            },
+        },
         {
             "attributes": {
                 "test.case.name": "Tests.Registration",
@@ -74,7 +100,7 @@ async def test_parse(
             "kind": "SpanKind.INTERNAL",
             "links": [],
             "name": "Tests.Registration",
-            "parent_id": None,
+            "parent_id": anys.ANY_STR,
             "resource": {
                 "attributes": resource_attributes,
                 "schema_url": "",
@@ -188,7 +214,7 @@ async def test_parse(
             "kind": "SpanKind.INTERNAL",
             "links": [],
             "name": "Tests.Authentication",
-            "parent_id": None,
+            "parent_id": anys.ANY_STR,
             "resource": {
                 "attributes": resource_attributes,
                 "schema_url": "",
@@ -334,7 +360,7 @@ async def test_parse(
             "kind": "SpanKind.INTERNAL",
             "links": [],
             "name": "Tests.Authentication.Login",
-            "parent_id": None,
+            "parent_id": anys.ANY_STR,
             "resource": {
                 "attributes": resource_attributes,
                 "schema_url": "",