feat(playwrighttesting): Added runName feature (#47062)

* feat(playwrighttesting): Added runName feature

* update

* update

* update

* ran script

* added test

---------

Co-authored-by: guptakashish <[email protected]>

Author: kashish2508

sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger/api/Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.netstandard2.0.cs

@@ -35,6 +35,7 @@ public partial class RunSettingKey
         public static readonly string NumberOfTestWorkers;
         public static readonly string Os;
         public static readonly string RunId;
+        public static readonly string RunName;
         public static readonly string ServiceAuthType;
         public static readonly string UseCloudHostedBrowsers;
         public RunSettingKey() { }

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

@@ -184,6 +184,11 @@ public class RunSettingKey
     /// Number of NUnit test workers.
     /// </summary>
     public static readonly string NumberOfTestWorkers = "NumberOfTestWorkers";
+
+    /// <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

@@ -101,6 +101,8 @@ internal void InitializePlaywrightReporter(string xmlSettings)
         runParameters.TryGetValue(RunSettingKey.Os, out var osType);
         runParameters.TryGetValue(RunSettingKey.ExposeNetwork, out var exposeNetwork);
         nunitParameters.TryGetValue(RunSettingKey.NumberOfTestWorkers, out var numberOfTestWorkers);
+        runParameters.TryGetValue(RunSettingKey.RunName, out var runName);
+
         string? enableGithubSummaryString = enableGithubSummary?.ToString();
         string? enableResultPublishString = enableResultPublish?.ToString();
 
@@ -148,6 +150,7 @@ internal 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,19 @@ 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))
+            {
+                runName = _cloudRunMetadata.RunName!;
+            }
+            else if (!string.IsNullOrEmpty(gitBasedRunName))
+            {
+                runName = gitBasedRunName!;
+            }
+            else
+            {
+                runName = _cloudRunMetadata.RunId!;
+            }
             var run = new TestRunDto
             {
                 TestRunId = _cloudRunMetadata.RunId!,

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

@@ -5,6 +5,7 @@
 using Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.Processor;
 using Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.Utility;
 using Microsoft.VisualStudio.TestPlatform.ObjectModel;
+using Moq;
 
 namespace Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.Tests.Processor
 {
@@ -68,6 +69,32 @@ 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 GetTestRunShard_ReturnsTestRunShardDto()
@@ -151,7 +178,58 @@ public void GetTestCaseResultData_WithNonNullTestResult_ReturnsTestResults()
             Assert.AreEqual(TestCaseResultStatus.s_iNCONCLUSIVE, result.ResultsSummary.Status);
             Assert.AreEqual(TestCaseResultStatus.s_iNCONCLUSIVE, result.Status);
         }
-
+        [Test]
+        [Ignore("Need to mock GetRunName response")]
+        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]
+        [Ignore("Need to mock GetRunName response")]
+        public void GetTestRun_ShouldUseRunId_WhenRunNameAndGitBasedRunNameAreEmpty()
+        {
+            var cloudRunMetadata = new CloudRunMetadata
+            {
+                RunName = "",
+                WorkspaceId = "workspaceId",
+                RunId = "runId",
+                AccessTokenDetails = new()
+                {
+                    oid = "oid",
+                    userName = "  userName  "
+                }
+            };
+            var cIInfo = new CIInfo
+            {
+            };
+            var reporterUtilsMock = new Mock<ReporterUtils>();
+            reporterUtilsMock.Setup(r => ReporterUtils.GetRunName(cIInfo)).Returns(string.Empty);
+            var dataProcessor = new DataProcessor(cloudRunMetadata, cIInfo);
+            TestRunDto result = dataProcessor.GetTestRun();
+            Assert.AreEqual("runId", result.DisplayName);
+        }
         [Test]
         public void GetRawResultObject_WithNullTestResult_ReturnsRawTestResultWithEmptyErrorsAndStdErr()
         {