Add Current Test/Class elements (#10)

saucelabs · Mar 22, 2024 · 22568ea · 22568ea
1 parent 3c26824
commit 22568ea
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 10 deletions.
diff --git a/visual-dotnet/SauceLabs.Visual.Tests/VisualApiTest.cs b/visual-dotnet/SauceLabs.Visual.Tests/VisualApiTest.cs
@@ -3,7 +3,6 @@
 using System.Net.Http;
 using System.Text;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 using NUnit.Framework;
 using RichardSzalay.MockHttp;
 using SauceLabs.Visual.GraphQL;

diff --git a/visual-dotnet/SauceLabs.Visual/GraphQL/CreateSnapshotFromWebDriverIn.cs b/visual-dotnet/SauceLabs.Visual/GraphQL/CreateSnapshotFromWebDriverIn.cs
@@ -38,7 +38,9 @@ public CreateSnapshotFromWebDriverIn(
             DiffingMethod diffingMethod,
             RegionIn[] regions,
             bool captureDom,
-            string? clipSelector
+            string? clipSelector,
+            string? suiteName,
+            string? testName
         )
         {
             BuildUuid = buildUuid;
@@ -50,6 +52,8 @@ public CreateSnapshotFromWebDriverIn(
             SessionId = sessionId;
             CaptureDom = captureDom;
             ClipSelector = clipSelector;
+            SuiteName = suiteName;
+            TestName = testName;
         }
     }
 }
diff --git a/visual-dotnet/SauceLabs.Visual/Utils/GraphQLResponseExtension.cs b/visual-dotnet/SauceLabs.Visual/Utils/GraphQLResponseExtension.cs
@@ -3,7 +3,7 @@
 
 namespace SauceLabs.Visual.Utils
 {
-    public static class GraphQLResponseExtension
+    internal static class GraphQLResponseExtension
     {
         public static T EnsureValidResponse<T>(this GraphQLResponse<T> response)
         {

diff --git a/visual-dotnet/SauceLabs.Visual/Utils/StringUtils.cs b/visual-dotnet/SauceLabs.Visual/Utils/StringUtils.cs
@@ -1,6 +1,6 @@
 namespace SauceLabs.Visual.Utils
 {
-    public static class StringUtils
+    internal static class StringUtils
     {
         /// <summary>
         /// <c>IsNullOrEmpty</c> checks that the string null, empty or contains only whitespaces.

diff --git a/visual-dotnet/SauceLabs.Visual/VisualCheckOptions.cs b/visual-dotnet/SauceLabs.Visual/VisualCheckOptions.cs
@@ -1,3 +1,5 @@
+using System.Diagnostics;
+using System.Linq;
 using OpenQA.Selenium;
 using SauceLabs.Visual.Models;
 
@@ -14,5 +16,29 @@ public class VisualCheckOptions
         public IWebElement[]? IgnoreElements { get; set; }
         public bool? CaptureDom { get; set; }
         public string? ClipSelector { get; set; }
+
+        /// <summary>
+        /// <c>SuiteName</c> manually set the SuiteName of the Test.
+        /// </summary>
+        public string? SuiteName { get; set; }
+        /// <summary>
+        /// <c>TestName</c> manually set the TestName of the Test.
+        /// </summary>
+        public string? TestName { get; set; }
+
+        private bool HasIncompleteTestContext() => string.IsNullOrEmpty(SuiteName) || string.IsNullOrEmpty(TestName);
+
+        internal void EnsureTestContextIsPopulated(string callerMemberName, string? previousSuiteName)
+        {
+            if (string.IsNullOrEmpty(callerMemberName) || HasIncompleteTestContext())
+            {
+                return;
+            }
+
+            var stack = new StackTrace();
+            var frame = stack.GetFrames()?.FirstOrDefault(f => f.GetMethod().Name == callerMemberName);
+            SuiteName ??= frame?.GetMethod().DeclaringType?.FullName ?? previousSuiteName;
+            TestName ??= callerMemberName;
+        }
     }
 }
diff --git a/visual-dotnet/SauceLabs.Visual/VisualClient.cs b/visual-dotnet/SauceLabs.Visual/VisualClient.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using OpenQA.Selenium;
 using Polly;
@@ -26,6 +27,8 @@ public class VisualClient : IDisposable
         public bool CaptureDom { get; set; } = false;
         private readonly ResiliencePipeline _retryPipeline;
 
+        private string? _previousSuiteName = null;
+
         /// <summary>
         /// Creates a new instance of <c>VisualClient</c>
         /// </summary>
@@ -220,22 +223,33 @@ private async Task FinishBuild(VisualBuild build)
         /// <param name="name">the name of the screenshot</param>
         /// <param name="options">the configuration for the screenshot capture and comparison</param>
         /// <returns></returns>
-        public async Task<string> VisualCheck(string name, VisualCheckOptions? options = null)
+        public Task<string> VisualCheck(string name, VisualCheckOptions? options = null,
+            [CallerMemberName] string callerMemberName = "")
+        {
+            options ??= new VisualCheckOptions();
+            options.EnsureTestContextIsPopulated(callerMemberName, _previousSuiteName);
+            _previousSuiteName = options.SuiteName;
+            return VisualCheckAsync(name, options);
+        }
+
+        private async Task<string> VisualCheckAsync(string name, VisualCheckOptions options)
         {
             var ignored = new List<RegionIn>();
-            ignored.AddRange(options?.IgnoreRegions?.Select(r => new RegionIn(r)) ?? new List<RegionIn>());
-            ignored.AddRange(options?.IgnoreElements?.Select(r => new RegionIn(r)) ?? new List<RegionIn>());
+            ignored.AddRange(options.IgnoreRegions?.Select(r => new RegionIn(r)) ?? new List<RegionIn>());
+            ignored.AddRange(options.IgnoreElements?.Select(r => new RegionIn(r)) ?? new List<RegionIn>());
 
             var result = (await _api.CreateSnapshotFromWebDriver(new CreateSnapshotFromWebDriverIn(
                 buildUuid: Build.Id,
                 name: name,
                 jobId: _jobId,
-                diffingMethod: options?.DiffingMethod ?? DiffingMethod.Simple,
+                diffingMethod: options.DiffingMethod ?? DiffingMethod.Simple,
                 regions: ignored.ToArray(),
                 sessionId: _sessionId,
                 sessionMetadata: _sessionMetadataBlob ?? "",
-                captureDom: options?.CaptureDom ?? CaptureDom,
-                clipSelector: options?.ClipSelector
+                captureDom: options.CaptureDom ?? CaptureDom,
+                clipSelector: options.ClipSelector,
+                suiteName: options.SuiteName,
+                testName: options.TestName
             ))).EnsureValidResponse();
             result.Result.Diffs.Nodes.ToList().ForEach(d => _screenshotIds.Add(d.Id));
             return result.Result.Id;