[CI Visibility] Test session logical names (DataDog#6050)

## Summary of changes

This PR implements a new CI Visibility feature called Test session
logical names. In this feature a new DD_TEST_SESSION_NAME environment
variable is introduced for customer to set their custom test session
name. This name is sent to the backend inside the `metadata` object in
the CI Visibility protocol.

PR to change the intake json:
DataDog/dd-go#150765

## Reason for change

New feature:
https://docs.google.com/document/d/1XPBDDIMUxzfkko66vXIEjoi4xbCamTz-Bv6ChSR8jys/edit

## Implementation details

- A new ConfigurationKey.CIVisibility environment variable
- A new CIVisibility.Settings property
- Changes to the `CIEventMessagePackFormatter` to include this new tag
inside the metadata object.

## Test coverage

Added a `metadata` validator in the EVP tests (CI Visibility protocol)

Author: tonyredondo

Diff for: shared/src/Datadog.Trace.ClrProfiler.Native/CMakeLists.txt

@@ -122,7 +122,7 @@ add_compile_options(-Wno-invalid-noreturn -Wno-macro-redefined)
 if (UNIVERSAL)
     add_compile_options(-stdlib=libc++ -DUNIVERSAL)
 elseif (ISMACOS)
-    add_compile_options(-stdlib=libc++ -DMACOS -Wno-pragma-pack -Wno-deprecated-declarations -fvisibility=hidden)
+    add_compile_options(-stdlib=libc++ -DMACOS -Wno-pragma-pack -Wno-deprecated-declarations -fvisibility=hidden -Wno-deprecated-this-capture)
 else()
     add_compile_options(-stdlib=libstdc++)
 endif()

Diff for: tracer/build/_build/Build.Steps.cs

@@ -2625,6 +2625,14 @@ string NormalizedPath(AbsolutePath ap)
            knownPatterns.Add(new(".*SingleStepGuardRails::ShouldForceInstrumentationOverride: Found incompatible runtime .NET Core 3.0 or lower", RegexOptions.Compiled));
            knownPatterns.Add(new(".*SingleStepGuardRails::ShouldForceInstrumentationOverride: Found incompatible runtime .NET 6.0.12 and earlier have known crashing bugs", RegexOptions.Compiled));
 
+           // CI Visibility known errors
+           knownPatterns.Add(new(@".*The Git repository couldn't be automatically extracted.*", RegexOptions.Compiled));
+           knownPatterns.Add(new(@".*DD_GIT_REPOSITORY_URL is set with.*", RegexOptions.Compiled));
+           knownPatterns.Add(new(@".*The Git commit sha couldn't be automatically extracted.*", RegexOptions.Compiled));
+           knownPatterns.Add(new(@".*DD_GIT_COMMIT_SHA must be a full-length git SHA.*", RegexOptions.Compiled));
+           knownPatterns.Add(new(@".*Timeout occurred when flushing spans.*", RegexOptions.Compiled));
+           knownPatterns.Add(new(@".*ITR: .*", RegexOptions.Compiled));
+
            CheckLogsForErrors(knownPatterns, allFilesMustExist: true, minLogLevel: LogLevel.Warning);
        });
 

Diff for: tracer/src/Datadog.Trace/Ci/Agent/MessagePack/CIEventMessagePackFormatter.cs

@@ -16,6 +16,7 @@ namespace Datadog.Trace.Ci.Agent.MessagePack
     internal class CIEventMessagePackFormatter : EventMessagePackFormatter<CIVisibilityProtocolPayload>
     {
         private readonly byte[] _metadataBytes = StringEncoding.UTF8.GetBytes("metadata");
+
         private readonly byte[] _asteriskBytes = StringEncoding.UTF8.GetBytes("*");
         private readonly byte[] _runtimeIdBytes = StringEncoding.UTF8.GetBytes(Trace.Tags.RuntimeId);
         private readonly byte[] _runtimeIdValueBytes = StringEncoding.UTF8.GetBytes(Tracer.RuntimeId);
@@ -25,6 +26,14 @@ internal class CIEventMessagePackFormatter : EventMessagePackFormatter<CIVisibil
         private readonly byte[] _libraryVersionValueBytes = StringEncoding.UTF8.GetBytes(TracerConstants.AssemblyVersion);
         private readonly byte[] _environmentBytes = StringEncoding.UTF8.GetBytes("env");
         private readonly byte[]? _environmentValueBytes;
+
+        private readonly byte[] _testBytes = StringEncoding.UTF8.GetBytes(SpanTypes.Test);
+        private readonly byte[] _testSuiteEndBytes = StringEncoding.UTF8.GetBytes(SpanTypes.TestSuite);
+        private readonly byte[] _testModuleEndBytes = StringEncoding.UTF8.GetBytes(SpanTypes.TestModule);
+        private readonly byte[] _testSessionEndBytes = StringEncoding.UTF8.GetBytes(SpanTypes.TestSession);
+        private readonly byte[] _testSessionNameBytes = StringEncoding.UTF8.GetBytes("test_session.name");
+        private readonly byte[]? _testSessionNameValueBytes;
+
         private readonly byte[] _eventsBytes = StringEncoding.UTF8.GetBytes("events");
 
         private readonly ArraySegment<byte> _envelopBytes;
@@ -36,6 +45,11 @@ public CIEventMessagePackFormatter(TracerSettings tracerSettings)
                 _environmentValueBytes = StringEncoding.UTF8.GetBytes(tracerSettings.EnvironmentInternal);
             }
 
+            if (!string.IsNullOrWhiteSpace(Ci.CIVisibility.Settings.TestSessionName))
+            {
+                _testSessionNameValueBytes = StringEncoding.UTF8.GetBytes(Ci.CIVisibility.Settings.TestSessionName);
+            }
+
             _envelopBytes = GetEnvelopeArraySegment();
         }
 
@@ -73,7 +87,8 @@ public override int Serialize(ref byte[] bytes, int offset, CIVisibilityProtocol
         private ArraySegment<byte> GetEnvelopeArraySegment()
         {
             var offset = 0;
-            var bytes = new byte[512];
+            // Default size o the array, in case we don't have enough space MessagePackBinary will resize it
+            var bytes = new byte[2048];
 
             offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 3);
 
@@ -90,7 +105,8 @@ private ArraySegment<byte> GetEnvelopeArraySegment()
             offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _metadataBytes);
 
             // Value
-            offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 1);
+            var metadataValuesCount = _testSessionNameValueBytes is not null ? 5 : 1;
+            offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, metadataValuesCount);
 
             // ->  * : {}
 
@@ -121,6 +137,37 @@ private ArraySegment<byte> GetEnvelopeArraySegment()
                 offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _environmentValueBytes);
             }
 
+            if (_testSessionNameValueBytes is not null)
+            {
+                // -> test : {}
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testBytes);
+                offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 1);
+                // -> test_session.name : "value"
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameBytes);
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameValueBytes);
+
+                // -> test_suite_end : {}
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSuiteEndBytes);
+                offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 1);
+                // -> test_session.name : "value"
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameBytes);
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameValueBytes);
+
+                // -> test_module_end : {}
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testModuleEndBytes);
+                offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 1);
+                // -> test_session.name : "value"
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameBytes);
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameValueBytes);
+
+                // -> test_session_end : {}
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionEndBytes);
+                offset += MessagePackBinary.WriteMapHeader(ref bytes, offset, 1);
+                // -> test_session.name : "value"
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameBytes);
+                offset += MessagePackBinary.WriteStringBytes(ref bytes, offset, _testSessionNameValueBytes);
+            }
+
             // # Events
 
             // Key

Diff for: tracer/src/Datadog.Trace/Ci/CIVisibility.cs

@@ -127,9 +127,9 @@ public static void Initialize()
             LifetimeManager.Instance.AddAsyncShutdownTask(ShutdownAsync);
 
             var tracerSettings = settings.TracerSettings;
+            Log.Debug("Setting up the test session name to: {TestSessionName}", settings.TestSessionName);
 
             // Set the service name if empty
-            Log.Debug("Setting up the service name");
             if (string.IsNullOrEmpty(tracerSettings.ServiceNameInternal))
             {
                 // Extract repository name from the git url and use it as a default service name.
@@ -138,6 +138,7 @@ public static void Initialize()
 
             // Normalize the service name
             tracerSettings.ServiceNameInternal = NormalizerTraceProcessor.NormalizeService(tracerSettings.ServiceNameInternal);
+            Log.Debug("Setting up the service name to: {ServiceName}", tracerSettings.ServiceNameInternal);
 
             // Initialize Tracer
             Log.Information("Initialize Test Tracer instance");
@@ -195,9 +196,9 @@ internal static void InitializeFromRunner(CIVisibilitySettings settings, IDiscov
             LifetimeManager.Instance.AddAsyncShutdownTask(ShutdownAsync);
 
             var tracerSettings = settings.TracerSettings;
+            Log.Debug("Setting up the test session name to: {TestSessionName}", settings.TestSessionName);
 
             // Set the service name if empty
-            Log.Debug("Setting up the service name");
             if (string.IsNullOrEmpty(tracerSettings.ServiceNameInternal))
             {
                 // Extract repository name from the git url and use it as a default service name.
@@ -206,6 +207,7 @@ internal static void InitializeFromRunner(CIVisibilitySettings settings, IDiscov
 
             // Normalize the service name
             tracerSettings.ServiceNameInternal = NormalizerTraceProcessor.NormalizeService(tracerSettings.ServiceNameInternal);
+            Log.Debug("Setting up the service name to: {ServiceName}", tracerSettings.ServiceNameInternal);
 
             // Initialize Tracer
             Log.Information("Initialize Test Tracer instance");

Diff for: tracer/src/Datadog.Trace/Ci/Configuration/CIVisibilitySettings.cs

@@ -6,10 +6,14 @@
 
 using System;
 using System.Collections.Specialized;
+using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Threading;
+using Datadog.Trace.Ci.Tags;
 using Datadog.Trace.Configuration;
 using Datadog.Trace.Configuration.ConfigurationSources.Telemetry;
 using Datadog.Trace.Configuration.Telemetry;
+using Datadog.Trace.ExtensionMethods;
 using Datadog.Trace.Telemetry;
 using Datadog.Trace.Util;
 
@@ -63,6 +67,39 @@ public CIVisibilitySettings(IConfigurationSource source, IConfigurationTelemetry
 
             // RUM flush milliseconds
             RumFlushWaitMillis = config.WithKeys(ConfigurationKeys.CIVisibility.RumFlushWaitMillis).AsInt32(500);
+
+            // Test session name
+            TestSessionName = config.WithKeys(ConfigurationKeys.CIVisibility.TestSessionName).AsString(
+                getDefaultValue: () =>
+                {
+                    // We try to get the command from the active test session or test module
+                    var command = TestSession.ActiveTestSessions.FirstOrDefault()?.Command ??
+                                  TestModule.ActiveTestModules.FirstOrDefault()?.Tags.Command ??
+                                  string.Empty;
+
+                    if (string.IsNullOrEmpty(command))
+                    {
+                        // If there's no active test session or test module we try to get the command from the environment (sent by dd-trace session)
+                        var environmentVariables = EnvironmentHelpers.GetEnvironmentVariables();
+                        if (environmentVariables.TryGetValue<string>(TestSuiteVisibilityTags.TestSessionCommandEnvironmentVariable, out var testSessionCommand) && !string.IsNullOrEmpty(testSessionCommand))
+                        {
+                            command = testSessionCommand;
+                        }
+                        else
+                        {
+                            // As last resort we use the command line that started this process
+                            command = Environment.CommandLine;
+                        }
+                    }
+
+                    if (CiEnvironment.CIEnvironmentValues.Instance.JobName is { } jobName)
+                    {
+                        return $"{jobName}-{command}";
+                    }
+
+                    return command;
+                },
+                validator: null);
         }
 
         /// <summary>
@@ -170,6 +207,11 @@ public CIVisibilitySettings(IConfigurationSource source, IConfigurationTelemetry
         /// </summary>
         public int RumFlushWaitMillis { get; }
 
+        /// <summary>
+        /// Gets the test session name
+        /// </summary>
+        public string TestSessionName { get; }
+
         /// <summary>
         /// Gets the tracer settings
         /// </summary>

Diff for: tracer/src/Datadog.Trace/Configuration/ConfigurationKeys.cs

@@ -548,6 +548,11 @@ public static class CIVisibility
             /// Configuration key for set the rum flushing wait in milliseconds
             /// </summary>
             public const string RumFlushWaitMillis = "DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS";
+
+            /// <summary>
+            /// Configuration key for set the test session name
+            /// </summary>
+            public const string TestSessionName = "DD_TEST_SESSION_NAME";
         }
 
         /// <summary>

Diff for: tracer/src/Datadog.Tracer.Native/CMakeLists.txt

@@ -119,7 +119,7 @@ add_compile_options(-std=c++20 -fPIC -fms-extensions -fvisibility=hidden -g)
 add_compile_options(-DPAL_STDCPP_COMPAT -DPLATFORM_UNIX -DUNICODE)
 add_compile_options(-Wno-invalid-noreturn -Wno-macro-redefined)
 if (ISMACOS)
-    add_compile_options(-stdlib=libc++ -DMACOS -Wno-pragma-pack -Wno-deprecated-declarations)
+    add_compile_options(-stdlib=libc++ -DMACOS -Wno-pragma-pack -Wno-deprecated-declarations -Wno-deprecated-this-capture)
 elseif(ISLINUX)
     add_compile_options(-stdlib=libstdc++ -DLINUX -Wno-pragmas)
 endif()

Diff for: tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/CI/MsTestV2EvpTests.cs

@@ -127,6 +127,7 @@ public async Task SubmitTraces(string packageVersion, string evpVersionToRemove,
                             e.Value.Headers["Content-Encoding"].Should().Be(expectedGzip ? "gzip" : null);
 
                             var payload = JsonConvert.DeserializeObject<MockCIVisibilityProtocol>(e.Value.BodyInJson);
+                            ValidateMetadata(payload.Metadata, sessionCommand);
                             if (payload.Events?.Length > 0)
                             {
                                 foreach (var @event in payload.Events)

Diff for: tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/CI/NUnitEvpTests.cs

@@ -148,6 +148,7 @@ public async Task SubmitTraces(string packageVersion, string evpVersionToRemove,
                             e.Value.Headers["Content-Encoding"].Should().Be(expectedGzip ? "gzip" : null);
 
                             var payload = JsonConvert.DeserializeObject<MockCIVisibilityProtocol>(e.Value.BodyInJson);
+                            ValidateMetadata(payload.Metadata, sessionCommand);
                             if (payload.Events?.Length > 0)
                             {
                                 foreach (var @event in payload.Events)

Diff for: tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/CI/TestingFrameworkEvpTest.cs

@@ -6,6 +6,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq.Expressions;
 using Datadog.Trace.Ci;
 using Datadog.Trace.Ci.CiEnvironment;
 using Datadog.Trace.Ci.Tags;
@@ -300,4 +301,32 @@ protected void SetCIEnvironmentValues()
 
         CIValues = CIEnvironmentValues.Create(ciDictionaryValues);
     }
+
+    protected void ValidateMetadata(Dictionary<string, Dictionary<string, object>>? metadata, string testCommand)
+    {
+        metadata.Should().NotBeNull();
+        metadata ??= new Dictionary<string, Dictionary<string, object>>();
+        metadata.Should().ContainKey("*");
+        metadata["*"].Should().ContainKeys(Trace.Tags.RuntimeId, "language", CommonTags.LibraryVersion, "env");
+
+        var jobName = ((CIEnvironmentValues?)CIValues)?.JobName;
+        var valueKey = string.IsNullOrEmpty(jobName) ? testCommand : $"{jobName}-{testCommand}";
+
+        Expression<Func<KeyValuePair<string, object>, bool>> selector =
+            kv =>
+                kv.Key == "test_session.name" &&
+                kv.Value.ToString() == valueKey;
+
+        metadata.Should().ContainKey(SpanTypes.Test);
+        metadata[SpanTypes.Test].Should().Contain(selector);
+
+        metadata.Should().ContainKey(SpanTypes.TestSuite);
+        metadata[SpanTypes.TestSuite].Should().Contain(selector);
+
+        metadata.Should().ContainKey(SpanTypes.TestModule);
+        metadata[SpanTypes.TestModule].Should().Contain(selector);
+
+        metadata.Should().ContainKey(SpanTypes.TestSession);
+        metadata[SpanTypes.TestSession].Should().Contain(selector);
+    }
 }

Diff for: tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/CI/XUnitEvpTests.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+using System.Linq.Expressions;
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using Datadog.Trace.Ci;
@@ -138,6 +139,7 @@ public virtual async Task SubmitTraces(string packageVersion, string evpVersionT
                 e.Value.Headers["Content-Encoding"].Should().Be(expectedGzip ? "gzip" : null);
 
                 var payload = JsonConvert.DeserializeObject<MockCIVisibilityProtocol>(e.Value.BodyInJson);
+                ValidateMetadata(payload.Metadata, sessionCommand);
                 if (payload.Events?.Length > 0)
                 {
                     foreach (var @event in payload.Events)

Diff for: tracer/test/Datadog.Trace.Tests/Telemetry/config_norm_rules.json

@@ -372,6 +372,7 @@
   "DD_CIVISIBILITY_EARLY_FLAKE_DETECTION_ENABLED": "ci_visibility_early_flake_detection_enabled",
   "DD_CIVISIBILITY_CODE_COVERAGE_COLLECTORPATH": "ci_visibility_code_coverage_collectorpath",
   "DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS": "ci_visibility_rum_flush_wait_millis",
+  "DD_TEST_SESSION_NAME": "test_session_name",
   "DD_PROXY_HTTPS": "proxy_https",
   "DD_PROXY_NO_PROXY": "proxy_no_proxy",
   "DD_TRACE_DEBUG_LOOKUP_MDTOKEN": "trace_lookup_mdtoken_enabled",