Add functions for finding build

visual-dotnet/SauceLabs.Visual/GraphQL/Build.cs

@@ -1,4 +1,5 @@
 using Newtonsoft.Json;
+using SauceLabs.Visual.Models;
 
 namespace SauceLabs.Visual.GraphQL
 {
@@ -10,15 +11,15 @@ internal class Build
         public string Name { get; }
         [JsonProperty("url")]
         public string Url { get; }
-        [JsonProperty("status")]
-        public string Status { get; }
+        [JsonProperty("mode")]
+        public BuildMode Mode { get; }
 
-        public Build(string id, string name, string url, string status)
+        public Build(string id, string name, string url, BuildMode mode)
         {
             Id = id;
             Name = name;
             Url = url;
-            Status = status;
+            Mode = mode;
         }
     }
 }

visual-dotnet/SauceLabs.Visual/GraphQL/BuildByCustomIdQuery.cs

@@ -0,0 +1,18 @@
+namespace SauceLabs.Visual.GraphQL
+{
+    internal static class BuildByCustomIdQuery
+    {
+        public const string OperationName = "buildByCustomId";
+
+        public const string OperationDocument = @"
+            query buildByCustomId($input: UUID!) {
+                result: buildByCustomId(customId: $input) {
+                    id,
+                    url,
+                    name,
+                    mode
+                }
+            }
+        ";
+    }
+}

visual-dotnet/SauceLabs.Visual/GraphQL/BuildQuery.cs

@@ -10,7 +10,7 @@ query build($input: UUID!) {
                     id,
                     url,
                     name,
-                    status
+                    mode
                 }
             }
         ";

visual-dotnet/SauceLabs.Visual/Models/BuildMode.cs

@@ -0,0 +1,8 @@
+namespace SauceLabs.Visual.Models
+{
+    public enum BuildMode
+    {
+        Running,
+        Completed
+    }
+}

visual-dotnet/SauceLabs.Visual/VisualApi.cs

@@ -73,6 +73,15 @@ public async Task<GraphQLResponse<ServerResponse<Build>>> Build(string buildId)
             return await _graphQlClient.SendQueryAsync<ServerResponse<Build>>(request);
         }
 
+        public async Task<GraphQLResponse<ServerResponse<Build>>> BuildByCustomId(string customId)
+        {
+            var request = CreateAuthenticatedRequest(BuildByCustomIdQuery.OperationDocument, BuildByCustomIdQuery.OperationName, new
+            {
+                input = customId
+            });
+            return await _graphQlClient.SendQueryAsync<ServerResponse<Build>>(request);
+        }
+
         public async Task<GraphQLResponse<ServerResponse<WebDriverSessionInfo>>> WebDriverSessionInfo(string jobId, string sessionId)
         {
             var request = CreateAuthenticatedRequest(WebDriverSessionInfoQuery.OperationDocument, WebDriverSessionInfoQuery.OperationName, new { jobId, sessionId });

visual-dotnet/SauceLabs.Visual/VisualClient.cs

@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using GraphQL;
+using GraphQL.Client.Http;
 using OpenQA.Selenium;
 using Polly;
 using Polly.Retry;
@@ -78,9 +80,20 @@ public VisualClient(WebDriver wd, Region region, string username, string accessK
             var metadata = response.EnsureValidResponse();
             _sessionMetadataBlob = metadata.Result.Blob;
 
-            var createBuildResponse = CreateBuild(buildOptions).Result;
-            Build = new VisualBuild(createBuildResponse.Id, createBuildResponse.Url);
-            _externalBuild = false;
+
+
+            var build = GetEffectiveBuild(Environment.GetEnvironmentVariable("SAUCE_VISUAL_BUILD_ID"), Environment.GetEnvironmentVariable("SAUCE_VISUAL_CUSTOM_ID")).Result;
+            if (build != null)
+            {
+                Build = build;
+                _externalBuild = true;
+            }
+            else
+            {
+                var createBuildResponse = CreateBuild(buildOptions).Result;
+                Build = new VisualBuild(createBuildResponse.Id, createBuildResponse.Url);
+                _externalBuild = false;
+            }
 
             _retryPipeline = new ResiliencePipelineBuilder()
                 .AddRetry(new RetryStrategyOptions()
@@ -93,6 +106,70 @@ public VisualClient(WebDriver wd, Region region, string username, string accessK
                 .Build();
         }
 
+        /// <summary>
+        /// <c>FindBuildById</c> returns the build identified by <c>buildId</c>
+        /// </summary>
+        /// <param name="buildId"></param>
+        /// <returns>the matching build</returns>
+        /// <exception cref="VisualClientException">when build is not existing or has an invalid state</exception>
+        private async Task<VisualBuild> FindBuildById(string buildId)
+        {
+            var response = await _api.Build(buildId);
+            if (response.Data?.Result == null)
+            {
+                throw new VisualClientException($@"build {buildId} was not found");
+            }
+
+            var build = response.Data.Result;
+            if (build.Mode != BuildMode.Running)
+            {
+                throw new VisualClientException($"build {build.Id} is not RUNNING");
+            }
+            return new VisualBuild(build.Id, build.Url);
+        }
+
+        /// <summary>
+        /// <c>TryFindBuildByCustomId</c> returns the build identified by <c>customId</c> or null if not found
+        /// </summary>
+        /// <param name="customId"></param>
+        /// <returns>the matching build or null</returns>
+        /// <exception cref="VisualClientException">when build has an invalid state</exception>
+        private async Task<VisualBuild?> TryFindBuildByCustomId(string customId)
+        {
+            var response = await _api.BuildByCustomId(customId);
+            if (response.Data?.Result == null)
+            {
+                return null;
+            }
+
+            var build = response.Data.Result;
+            if (build.Mode != BuildMode.Running)
+            {
+                throw new VisualClientException($"build {build.Id} is not RUNNING");
+            }
+            return new VisualBuild(build.Id, build.Url);
+        }
+
+        /// <summary>
+        /// <c>GetEffectiveBuild</c> tries to find the build matching the criterion provided by the user.
+        /// </summary>
+        /// <param name="buildId"></param>
+        /// <param name="customId"></param>
+        /// <returns></returns>
+        private async Task<VisualBuild?> GetEffectiveBuild(string? buildId, string? customId)
+        {
+            if (!string.IsNullOrEmpty(buildId))
+            {
+                return await FindBuildById(buildId);
+            }
+
+            if (!string.IsNullOrEmpty(customId))
+            {
+                return await TryFindBuildByCustomId(customId);
+            }
+            return null;
+        }
+
         /// <summary>
         /// <c>CreateBuild</c> creates a new Visual build.
         /// </summary>