feat(playwrighttesting): Added runName feature

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/src/Constants.cs

@@ -180,6 +180,11 @@ public class RunSettingKey
     /// Enable Result publish.
     /// </summary>
     public static readonly string EnableResultPublish = "EnableResultPublish";
+
+    /// <summary>
+    /// The run name setting key.
+    /// </summary>
+    public static readonly string RunName = "RunName";
 }
 
 internal class Constants

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/src/Model/CloudRunMetadata.cs

@@ -9,6 +9,7 @@ internal class CloudRunMetadata
     {
         internal string? WorkspaceId { get; set; }
         internal string? RunId { get; set; }
+        internal string? RunName { get; set; }
         internal Uri? BaseUri { get; set; }
         internal string? PortalUrl
         {

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/src/PlaywrightReporter.cs

@@ -89,6 +89,8 @@ private void InitializePlaywrightReporter(string xmlSettings)
         runParameters.TryGetValue(RunSettingKey.ManagedIdentityClientId, out var managedIdentityClientId);
         runParameters.TryGetValue(RunSettingKey.EnableGitHubSummary, out var enableGithubSummary);
         runParameters.TryGetValue(RunSettingKey.EnableResultPublish, out var enableResultPublish);
+        runParameters.TryGetValue(RunSettingKey.RunName, out var runName);
+
         string? enableGithubSummaryString = enableGithubSummary?.ToString();
         string? enableResultPublishString = enableResultPublish?.ToString();
 
@@ -134,6 +136,7 @@ private void InitializePlaywrightReporter(string xmlSettings)
         var cloudRunMetadata = new CloudRunMetadata
         {
             RunId = cloudRunId,
+            RunName = runName.ToString(),
             WorkspaceId = workspaceId,
             BaseUri = baseUri,
             EnableResultPublish = _enableResultPublish,

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/src/Processor/DataProcessor.cs

@@ -29,7 +29,23 @@ public TestRunDto GetTestRun()
         {
             var startTime = _cloudRunMetadata.TestRunStartTime.ToString("yyyy-MM-ddTHH:mm:ssZ");
             var gitBasedRunName = ReporterUtils.GetRunName(CiInfoProvider.GetCIInfo())?.Trim();
-            string runName = string.IsNullOrEmpty(gitBasedRunName) ? _cloudRunMetadata.RunId! : gitBasedRunName!;
+            string runName;
+            if (string.IsNullOrEmpty(_cloudRunMetadata.RunName))
+            {
+                if (string.IsNullOrEmpty(gitBasedRunName))
+                {
+                    runName = _cloudRunMetadata.RunId!;
+                }
+                else
+                {
+                    runName = gitBasedRunName!;
+                }
+            }
+            else
+            {
+                runName = _cloudRunMetadata.RunName!;
+            }
+
             var run = new TestRunDto
             {
                 TestRunId = _cloudRunMetadata.RunId!,

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/tests/Processor/DataProcessorTests.cs

@@ -67,6 +67,60 @@ public void GetTestRun_ReturnsTestRunDto()
             Assert.IsNotNull(result.TestRunConfig!.Shards);
             Assert.AreEqual(1, result.TestRunConfig!.Shards!.Total);
         }
+        [Test]
+        public void GetTestRun_ShouldUseRunName_WhenRunNameIsNotEmpty()
+        {
+            var cloudRunMetadata = new CloudRunMetadata
+            {
+                RunName = "runName",
+                WorkspaceId = "workspaceId",
+                RunId = "runId",
+                AccessTokenDetails = new()
+                {
+                    oid = "oid",
+                    userName = "  userName  "
+                }
+            };
+            var cIInfo = new CIInfo
+            {
+                Branch = "branch_name",
+                Author = "author",
+                CommitId = "commitId",
+                RevisionUrl = "revisionUrl",
+                Provider = CIConstants.s_gITHUB_ACTIONS
+            };
+            var dataProcessor = new DataProcessor(cloudRunMetadata, cIInfo);
+            TestRunDto result = dataProcessor.GetTestRun();
+            Assert.AreEqual("runName", result.DisplayName);
+        }
+
+        [Test]
+        public void GetTestRun_ShouldUseGitBasedRunName_WhenRunNameIsEmptyAndGitBasedRunNameIsNotEmpty()
+        {
+            var cloudRunMetadata = new CloudRunMetadata
+            {
+                RunName = "",
+                WorkspaceId = "workspaceId",
+                RunId = "runId",
+                AccessTokenDetails = new()
+                {
+                    oid = "oid",
+                    userName = "  userName  "
+                }
+            };
+            var cIInfo = new CIInfo
+            {
+                Branch = "branch_name",
+                Author = "author",
+                CommitId = "commitId",
+                RevisionUrl = "revisionUrl",
+                Provider = CIConstants.s_gITHUB_ACTIONS
+            };
+            var gitBasedRunName = ReporterUtils.GetRunName(cIInfo);
+            var dataProcessor = new DataProcessor(cloudRunMetadata, cIInfo);
+            TestRunDto result = dataProcessor.GetTestRun();
+            Assert.AreEqual(gitBasedRunName, result.DisplayName);
+        }
 
         [Test]
         public void GetTestRunShard_ReturnsTestRunShardDto()