Ensure build is shared across all test classes

visual-dotnet/SauceLabs.Visual.Tests/VisualApiTest.cs

@@ -12,7 +12,7 @@ namespace SauceLabs.Visual.Tests;
 
 public class VisualApiTest
 {
-    internal VisualApi<MockedWebDriver>? Api { get; set; }
+    internal VisualApi? Api { get; set; }
     internal MockedWebDriver? WdMock { get; set; }
     internal MockHttpMessageHandler? MockedHandler { get; set; }
 
@@ -27,7 +27,7 @@ public void Setup()
 
         var caps = new MockedCapabilities(new Dictionary<string, object> { { "jobUuid", _jobUuid } });
         WdMock = new MockedWebDriver(caps, _jobUuid);
-        Api = new VisualApi<MockedWebDriver>(WdMock, Region.Staging, _username, _accessKey, MockedHandler.ToHttpClient());
+        Api = new VisualApi(Region.Staging, _username, _accessKey, MockedHandler.ToHttpClient());
     }
 
     [Test]

visual-dotnet/SauceLabs.Visual/VisualApi.cs

@@ -7,26 +7,28 @@
 using GraphQL.Client.Http;
 using GraphQL.Client.Serializer.Newtonsoft;
 using Newtonsoft.Json;
-using OpenQA.Selenium;
 using SauceLabs.Visual.GraphQL;
 using SauceLabs.Visual.Utils;
 
 namespace SauceLabs.Visual
 {
-    internal class VisualApi<T> : IDisposable where T : IHasCapabilities, IHasSessionId
+    internal class VisualApi : IDisposable
     {
+        private readonly Region _region;
         private readonly string _username;
         private readonly string _accessKey;
         private readonly GraphQLHttpClient _graphQlClient;
 
-        public VisualApi(T webdriver, Region region, string username, string accessKey, HttpClient? httpClient = null)
+        public VisualApi(Region region, string username, string accessKey, HttpClient? httpClient = null)
         {
 
             if (StringUtils.IsNullOrEmpty(username) || StringUtils.IsNullOrEmpty(accessKey))
             {
                 throw new VisualClientException(
                     "Invalid SauceLabs credentials. Please check your SauceLabs username and access key at https://app.saucelabs.com/user-setting");
             }
+
+            _region = region;
             _username = username.Trim();
             _accessKey = accessKey.Trim();
 
@@ -117,5 +119,10 @@ public void Dispose()
         {
             _graphQlClient.Dispose();
         }
+
+        internal VisualApi Clone()
+        {
+            return new VisualApi(_region, _username, _accessKey);
+        }
     }
 }

visual-dotnet/SauceLabs.Visual/VisualBuild.cs

@@ -1,3 +1,5 @@
+using System;
+using System.Threading.Tasks;
 using SauceLabs.Visual.Models;
 
 namespace SauceLabs.Visual
@@ -12,6 +14,9 @@ public class VisualBuild
 
         public BuildMode Mode { get; internal set; }
 
+        internal bool IsExternal { get; set; } = false;
+        internal Func<Task>? Close;
+
         internal VisualBuild(string id, string url, BuildMode mode)
         {
             Id = id;

visual-dotnet/SauceLabs.Visual/VisualCheckOptions.cs

@@ -30,7 +30,7 @@ public class VisualCheckOptions
 
         internal void EnsureTestContextIsPopulated(string callerMemberName, string? previousSuiteName)
         {
-            if (string.IsNullOrEmpty(callerMemberName) || HasIncompleteTestContext())
+            if (string.IsNullOrEmpty(callerMemberName) || !HasIncompleteTestContext())
             {
                 return;
             }

visual-dotnet/SauceLabs.Visual/VisualClient.cs

@@ -17,13 +17,15 @@
     /// </summary>
     public class VisualClient : IDisposable
     {
-        private readonly VisualApi<WebDriver> _api;
+        private static VisualBuild? _sharedBuild;
+
+        private readonly VisualApi _api;
         private readonly string _sessionId;
         private readonly string _jobId;
         private string? _sessionMetadataBlob;
         private readonly List<string> _screenshotIds = new List<string>();
         public VisualBuild Build { get; private set; }
         private bool _externalBuild;
         public bool CaptureDom { get; set; } = false;
         private readonly ResiliencePipeline _retryPipeline;
 
@@ -79,10 +81,16 @@
 
         private async Task SetupBuild(CreateBuildOptions buildOptions)
         {
-            var response = await this._api.WebDriverSessionInfo(_jobId, _sessionId);
+            var response = await _api.WebDriverSessionInfo(_jobId, _sessionId);
             var metadata = response.EnsureValidResponse();
             _sessionMetadataBlob = metadata.Result.Blob;
 
+            if (_sharedBuild != null)
+            {
+                Build = _sharedBuild;
+                return;
+            }
+
             var build = await GetEffectiveBuild(EnvVars.BuildId, EnvVars.CustomId);
             if (build != null)
             {
@@ -91,15 +99,24 @@
                     throw new VisualClientException($"build {build.Id} is not RUNNING");
                 }
                 Build = build;
-                _externalBuild = true;
+                Build.IsExternal = true;
+                _sharedBuild = Build;
+                return;
             }
-            else
+
+            buildOptions.CustomId ??= EnvVars.CustomId;
+            var createBuildResponse = await CreateBuild(buildOptions);
+            Build = new VisualBuild(createBuildResponse.Id, createBuildResponse.Url, createBuildResponse.Mode)
             {
-                buildOptions.CustomId ??= EnvVars.CustomId;
-                var createBuildResponse = await CreateBuild(buildOptions);
-                Build = new VisualBuild(createBuildResponse.Id, createBuildResponse.Url, createBuildResponse.Mode);
-                _externalBuild = false;
-            }
+                IsExternal = false
+            };
+            var copiedApi = _api.Clone();
+            Build.Close = async () =>
+            {
+                await copiedApi.FinishBuild(Build.Id);
+                copiedApi.Dispose();
+            };
+            _sharedBuild = Build;
         }
 
         /// <summary>
@@ -109,14 +126,14 @@
         /// <param name="region">the Sauce Labs region to connect to</param>
         /// <param name="username">the Sauce Labs username</param>
         /// <param name="accessKey">the Sauce Labs access key</param>
         private VisualClient(WebDriver wd, Region region, string username, string accessKey)
         {
             if (StringUtils.IsNullOrEmpty(username) || StringUtils.IsNullOrEmpty(accessKey))
             {
                 throw new VisualClientException("Username or Access Key not set");
             }
 
-            _api = new VisualApi<WebDriver>(wd, region, username, accessKey);
+            _api = new VisualApi(region, username, accessKey);
             _sessionId = wd.SessionId.ToString();
             _jobId = wd.Capabilities.HasCapability("jobUuid") ? wd.Capabilities.GetCapability("jobUuid").ToString() : _sessionId;
 
@@ -258,11 +275,17 @@
         /// <summary>
         /// <c>Cleanup</c> set a correct status to the build. No action should be made after that calling <c>Cleanup</c>.
         /// </summary>
-        public async Task Cleanup()
+        public static async Task Cleanup()
         {
-            if (!_externalBuild)
+            if (_sharedBuild == null)
+            {
+                return;
+            }
+
+            if (_sharedBuild.Close != null)
             {
-                await FinishBuild(Build);
+                await _sharedBuild.Close();
+                _sharedBuild = null;
             }
         }