add support for remote web driver with raw capabilities

Author: gravity-api

src/Gravity.Abstraction.Tests/Base/TestSuite.cs

@@ -3,7 +3,6 @@
 
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-using OpenQA.Selenium;
 using OpenQA.Selenium.Remote;
 
 using System.Net.Http;

src/Gravity.Abstraction/Contracts/CapabilitiesModel.cs

@@ -0,0 +1,15 @@
+using System.Collections.Generic;
+
+namespace Gravity.Abstraction.Contracts
+{
+    public class CapabilitiesModel
+    {
+        public IDictionary<string, object> DesiredCapabilities { get; set; }
+        public W3Capabilites Capabilities { get; set; }
+
+        public class W3Capabilites
+        {
+            public IEnumerable<IDictionary<string, object>> FirstMatch { get; set; }
+        }
+    }
+}

src/Gravity.Abstraction/Extensions/WebDriverExtension.cs

@@ -0,0 +1,52 @@
+using OpenQA.Selenium.Remote;
+using OpenQA.Selenium;
+
+using System;
+using System.Reflection;
+
+namespace Gravity.Abstraction.Extensions
+{
+    internal static class WebDriverExtension
+    {
+        public static string GetSession(this IWebDriver driver)
+        {
+            return driver is IHasSessionId id ? $"{id.SessionId}" : $"{Guid.NewGuid()}";
+        }
+
+        public static Uri GetEndpoint(this IWebDriver driver)
+        {
+            // setup
+            const BindingFlags Flags = BindingFlags.Instance | BindingFlags.NonPublic;
+
+            // get RemoteWebDriver type
+            var remoteWebDriver = GetRemoteWebDriver(driver.GetType());
+
+            // get this instance executor > get this instance internalExecutor
+            var executor = remoteWebDriver.GetField("executor", Flags).GetValue(driver) as ICommandExecutor;
+
+            // get URL
+            var endpoint = executor.GetType().GetField("service", Flags).GetValue(executor) as DriverService;
+
+            // result
+            return endpoint.ServiceUrl;
+        }
+
+        private static Type GetRemoteWebDriver(Type type)
+        {
+            // if not a remote web driver, return the type used for the call
+            if (!typeof(RemoteWebDriver).IsAssignableFrom(type))
+            {
+                return type;
+            }
+
+            // iterate until gets the RemoteWebDriver type
+            while (type != typeof(RemoteWebDriver))
+            {
+                type = type.BaseType;
+            }
+
+            // gets RemoteWebDriver to use for extracting internal information
+            return type;
+        }
+    }
+}

src/Gravity.Abstraction/WebDriver/DriverFactory.cs

@@ -28,6 +28,8 @@
 using System.Diagnostics.CodeAnalysis;
 using OpenQA.Selenium.Uia;
 using Gravity.Abstraction.Uia;
+using System.Net.Http;
+using System.Text;
 
 namespace Gravity.Abstraction.WebDriver
 {
@@ -94,9 +96,9 @@ public IWebDriver Create()
             }
             catch (Exception e)
             {
-
+                Trace.TraceError($"{e.GetBaseException()}");
                 throw;
-            }            
+            }
         }
         #endregion
 
@@ -210,7 +212,7 @@ private IWebDriver GetRemoteAndroid(string driverBinaries)
         [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "Used by reflection.")]
         private IWebDriver GetRemoteIos(string driverBinaries)
         {
-            return GetMobile<AppiumOptions, AppiumOptionsParams, IOSDriver<IWebElement>>(driverBinaries, "iOS");
+            return GetMobile<AppiumOptions, AppiumOptionsParams, IOSDriver<IWebElement>>(driverBinaries, string.Empty);
         }
 
         [DriverMethod(Driver = Driver.Safari, RemoteDriver = true)]
@@ -229,13 +231,65 @@ private IWebDriver GetRemoteDriver(string driverBinaries)
             var capabilities = GetCapabilities(options, _capabilities);
             options.BrowserVersion = string.IsNullOrEmpty(options.BrowserVersion) ? "1.0" : options.BrowserVersion;
 
-
             // factor web driver
             var executor = _commandTimeout == 0
                 ? new UiaCommandExecutor(new Uri(driverBinaries), TimeSpan.FromSeconds(60))
                 : new UiaCommandExecutor(new Uri(driverBinaries), TimeSpan.FromSeconds(_commandTimeout));
             return new UiaDriver(executor, capabilities);
         }
+
+        [DriverMethod(Driver = "RemoteWebDriver", RemoteDriver = true)]
+        [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "Used by reflection.")]
+        private IWebDriver GetRemoteUiaDriver(string driverBinaries)
+        {
+            // setup
+            var capabilities = new CapabilitiesModel
+            {
+                DesiredCapabilities = _capabilities,
+                Capabilities = new()
+                {
+                    FirstMatch = new[]
+                    {
+                        _capabilities
+                    }
+                }
+            };
+
+            // build
+            using var client = new HttpClient();
+            var requestBody = JsonSerializer.Serialize(capabilities, new JsonSerializerOptions
+            {
+                PropertyNamingPolicy = JsonNamingPolicy.CamelCase
+            });
+            var content = new StringContent(requestBody, Encoding.UTF8, "application/json");
+            var request = new HttpRequestMessage(HttpMethod.Post, $"{driverBinaries}/session")
+            {
+                Content = content
+            };
+
+            // invoke
+            var response = client.SendAsync(request).Result;
+
+            // internal server error
+            if (!response.IsSuccessStatusCode)
+            {
+                throw new WebDriverException(response.ReasonPhrase);
+            }
+
+            // extract id
+            var responseContent = response.Content.ReadAsStringAsync().Result;
+            var responseObject = JsonSerializer.Deserialize<IDictionary<string, object>>(responseContent);
+            var sessionId = ((JsonElement)responseObject["value"]).GetProperty("sessionId").GetString();
+
+            // setup: get information to initialize driver two
+            var addressOfRemoteServer = new Uri(driverBinaries);
+            var timeout = TimeSpan.FromSeconds(60);
+            var commandExecutor = new LocalExecutor(sessionId, addressOfRemoteServer, timeout);
+            var localCapabilities = new Dictionary<string, object>(_capabilities);
+
+            // get
+            return new RemoteWebDriver(commandExecutor, new DesiredCapabilities(localCapabilities));
+        }
         #endregion
 
         // TODO: add default constructor options when there are no binaries to load
@@ -291,14 +345,14 @@ private DriverOptions GetOptions<TOptions, TParams>(string platformName)
             where TParams : DriverOptionsParams, IOptionable<TOptions>
         {
             // parse token
-            var isOptions = this._options.Keys.Count > 0;
+            var isOptions = _options.Keys.Count > 0;
 
             // null validation
             if (!isOptions)
             {
                 return new TOptions
                 {
-                    PlatformName = platformName
+                    PlatformName = string.IsNullOrEmpty(platformName) ? null : platformName
                 };
             }
 
@@ -309,7 +363,7 @@ private DriverOptions GetOptions<TOptions, TParams>(string platformName)
             var options = paramsObj.ToDriverOptions();
             if (!string.IsNullOrEmpty(platformName))
             {
-                options.PlatformName = platformName;
+                options.PlatformName = string.IsNullOrEmpty(platformName) ? null : platformName;
             }
             return options;
         }

src/Gravity.Abstraction/WebDriver/LocalExecutor.cs

@@ -0,0 +1,45 @@
+using OpenQA.Selenium.Remote;
+using OpenQA.Selenium;
+
+using System;
+
+namespace Gravity.Abstraction.WebDriver
+{
+    public class LocalExecutor : HttpCommandExecutor
+    {
+        public LocalExecutor(string sessionId, Uri addressOfRemoteServer, TimeSpan timeout)
+            : this(sessionId, addressOfRemoteServer, timeout, false)
+        { }
+
+        public LocalExecutor(string sessionId, Uri addressOfRemoteServer, TimeSpan timeout, bool enableKeepAlive)
+            : this(addressOfRemoteServer, timeout, enableKeepAlive)
+        {
+            SessionId = sessionId;
+        }
+
+        public LocalExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool enableKeepAlive)
+            : base(addressOfRemoteServer, timeout, enableKeepAlive)
+        { }
+
+        // expose the "Session ID" used to build this executor
+        public string SessionId { get; }
+
+        public override Response Execute(Command commandToExecute)
+        {
+            // invoke selenium command using the original driver executor
+            if (!commandToExecute.Name.Equals("newSession"))
+            {
+                return base.Execute(commandToExecute);
+            }
+
+            // returns a success result, if the command is "newSession"
+            // this prevents a shadow browser from opening
+            return new Response
+            {
+                Status = WebDriverResult.Success,
+                SessionId = SessionId,
+                Value = null
+            };
+        }
+    }
+}

src/dotnet-client

@@ -0,0 +1 @@
+Subproject commit a0489643ec4bde504b17eca4c8eee49634bb7cd6