Set capabilities from config (#54)

* Added a custom dictionary parser for Config.NET. * Allows supporting adding capabilities via config * Implement the custom parser * Allow configuring acceptance of insecure certs. Allow configuring capabilties * Add CreateDriver overload with no args * Rename base options/service map classes Add SetCapability() and AcceptsInsecureCerts() * Implement SetCapabilities() method * Throw error if page key does not exist * Move Selenoid and Docker stuff to their own folder * Fix check for null dictionary
tnypxl · Jul 27, 2020 · 620e1d2 · 620e1d2
1 parent f3b8404
commit 620e1d2
Show file tree

Hide file tree

Showing 19 changed files with 177 additions and 68 deletions.
diff --git a/Basin.Tests/Steps/StepsBase.cs b/Basin.Tests/Steps/StepsBase.cs
@@ -1,4 +1,3 @@
-using System;
 using System.IO;
 using Basin.PageObjects;
 using Basin.Selenium;
@@ -22,7 +21,6 @@ public static void BeforeFeatureHook()
         [BeforeScenario]
         public void BeforeScenarioHook()
         {
-            // BasinEnv.UseBrowser("Chrome");
             BrowserSession.Init();
         }
 

diff --git a/Basin/BasinEnv.cs b/Basin/BasinEnv.cs
@@ -3,6 +3,7 @@
 using Basin.Config.Interfaces;
 using Config.Net;
 using Basin.PageObjects.Interfaces;
+using Basin.Config.Extensions;
 
 namespace Basin
 {
@@ -22,7 +23,9 @@ public static class BasinEnv
 
         public static void SetConfig(string configPath)
         {
-            _config = new CurrentConfig(GetConfig.UseJsonFile(configPath).Build());
+            _config = new CurrentConfig(GetConfig.UseJsonFile(configPath)
+                                                 .UseTypeParser(new DictionaryParser())
+                                                 .Build());
             Site = _config.Site;
             Browser = _config.Browser;
             Pages = _config.Pages;

diff --git a/Basin/Config/Extensions/DictionaryParser.cs b/Basin/Config/Extensions/DictionaryParser.cs
@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using Config.Net;
+using Newtonsoft.Json;
+
+namespace Basin.Config.Extensions
+{
+    public class DictionaryParser : ITypeParser
+    {
+        public IEnumerable<Type> SupportedTypes => new[] { typeof(Dictionary<string, object>) };
+
+        public bool TryParse(string value, Type t, out object result)
+        {
+            if (value == null)
+            {
+                result = null;
+                return false;
+            }
+
+            result = JsonConvert.DeserializeObject(value, t);
+
+            return true;
+        }
+
+        public string ToRawString(object value)
+        {
+            if (value == null) return null;
+            return JsonConvert.SerializeObject(value);
+        }
+    }
+}
diff --git a/Basin/Config/Interfaces/IBrowserConfig.cs b/Basin/Config/Interfaces/IBrowserConfig.cs
@@ -25,11 +25,16 @@ public interface IBrowserConfig
         [Option(DefaultValue = false)]
         bool Headless { get; set; }
 
+        [Option(DefaultValue = false)]
+        bool AcceptsInsecureCerts { get; set; }
+
         string PathToDriverBinary { get; set; }
 
         string PathToBrowserExecutable { get; set; }
 
         Uri Host { get; set; }
+
+        Dictionary<string, object> Capabilities { get; }
     }
 
     public class BrowserConfig : IBrowserConfig
@@ -55,5 +60,9 @@ public class BrowserConfig : IBrowserConfig
         public string PathToBrowserExecutable { get; set; }
 
         public Uri Host { get; set; }
+
+        public bool AcceptsInsecureCerts { get; set; }
+
+        public Dictionary<string, object> Capabilities { get; }
     }
 }
diff --git a/Basin/Core/Browsers/ChromeBrowser.cs b/Basin/Core/Browsers/ChromeBrowser.cs
@@ -24,9 +24,9 @@ public ChromeBrowser(IBrowserConfig config)
 
         public IWebDriver Driver { get; set; }
 
-        // public void CreateDriver() => Driver = new ChromeDriver(Service, Options);
+        public void CreateDriver() => CreateDriver(null);
 
-        public void CreateDriver(Uri host = null)
+        public void CreateDriver(Uri host)
         {
             Driver = (host == null)
                 ? new ChromeDriver(Service, Options)

diff --git a/Basin/Core/Browsers/FirefoxBrowser.cs b/Basin/Core/Browsers/FirefoxBrowser.cs
@@ -28,6 +28,8 @@ public FirefoxBrowser(IBrowserConfig config)
 
         public IWebDriver Driver { get; set; }
 
+        public void CreateDriver() => CreateDriver(null);
+
         public void CreateDriver(Uri host = null)
         {
             Driver = host == null

diff --git a/Basin/Core/Browsers/InternetExplorerBrowser.cs b/Basin/Core/Browsers/InternetExplorerBrowser.cs
@@ -24,8 +24,11 @@ public InternetExplorerBrowser(IBrowserConfig config)
 
         public IWebDriver Driver { get; set; }
 
+        public void CreateDriver() => CreateDriver(null);
+
         public void CreateDriver(Uri host)
         {
+
             Driver = (host == null)
                 ? new InternetExplorerDriver(Service, Options)
                 : new RemoteWebDriver(host, Options);

diff --git a/Basin/Core/Browsers/Mappers/ChromeOptionsMapper.cs b/Basin/Core/Browsers/Mappers/ChromeOptionsMapper.cs
@@ -1,23 +1,25 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Basin.Config.Interfaces;
 using OpenQA.Selenium.Chrome;
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class ChromeOptionsMapper : BrowserOptionsMapper<ChromeOptions>
+    public class ChromeOptionsMapper : DriverOptionsMap<ChromeOptions>
     {
-        public ChromeOptionsMapper() : base(new ChromeOptions())
+        public ChromeOptionsMapper()
         {
         }
 
-        public ChromeOptionsMapper(IBrowserConfig config) : base(new ChromeOptions())
+        public ChromeOptionsMapper(IBrowserConfig config)
         {
             PathToBrowserBinary = config.PathToBrowserExecutable;
             BrowserVersion = config.Version;
             PlatformName = config.PlatformName;
             Arguments = config.Arguments;
             EnableHeadlessMode = config.Headless;
+            AcceptsInsecureCerts = config.AcceptsInsecureCerts;
+
+            SetCapabilities(config.Capabilities);
         }
 
         public override string PathToBrowserBinary
@@ -40,6 +42,11 @@ public override IEnumerable<string> Arguments
             set => Options.AddArguments(value);
         }
 
+        public override bool AcceptsInsecureCerts
+        {
+            set => Options.AcceptInsecureCertificates = value;
+        }
+
         public override bool EnableHeadlessMode
         {
             set
@@ -48,5 +55,12 @@ public override bool EnableHeadlessMode
                     Options.AddArguments("--headless", "--disable-gpu");
             }
         }
+
+        public override void SetCapabilities(Dictionary<string, object> caps = null)
+        {
+            if (caps == null || caps.Count == 0) return;
+
+            foreach (var cap in caps) Options.AddAdditionalCapability(cap.Key, cap.Value, true);
+        }
     }
 }
diff --git a/Basin/Core/Browsers/Mappers/ChromeServiceMapper.cs b/Basin/Core/Browsers/Mappers/ChromeServiceMapper.cs
@@ -4,7 +4,7 @@
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class ChromeServiceMapper : BrowserServiceMapper<ChromeDriverService>
+    public class ChromeServiceMapper : DriverServiceMap<ChromeDriverService>
     {
         public override string PathToDriverBinary { get; set; }
 

diff --git a/.../Browsers/Mappers/BrowserOptionsMapper.cs → ...Core/Browsers/Mappers/DriverOptionsMap.cs b/.../Browsers/Mappers/BrowserOptionsMapper.cs → ...Core/Browsers/Mappers/DriverOptionsMap.cs
@@ -3,12 +3,9 @@
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public abstract class BrowserOptionsMapper<TDriverOptions> where TDriverOptions : new()
+    public abstract class DriverOptionsMap<TDriverOptions> where TDriverOptions : new()
     {
-        protected BrowserOptionsMapper(TDriverOptions options)
-        {
-            Options = options;
-        }
+        protected DriverOptionsMap() => Options = new TDriverOptions();
 
         public abstract string PathToBrowserBinary { set; }
 
@@ -20,6 +17,10 @@ protected BrowserOptionsMapper(TDriverOptions options)
 
         public abstract bool EnableHeadlessMode { set; }
 
+        public abstract bool AcceptsInsecureCerts { set; }
+
+        public abstract void SetCapabilities(Dictionary<string, object> value);
+
         public TDriverOptions Options { get; }
     }
 }
diff --git a/.../Browsers/Mappers/BrowserServiceMapper.cs → ...Core/Browsers/Mappers/DriverServiceMap.cs b/.../Browsers/Mappers/BrowserServiceMapper.cs → ...Core/Browsers/Mappers/DriverServiceMap.cs
@@ -1,9 +1,9 @@
-using Basin.Config.Interfaces;
+using Basin.Config.Interfaces;
 using OpenQA.Selenium;
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public abstract class BrowserServiceMapper<TDriverService>
+    public abstract class DriverServiceMap<TDriverService>
     {
         public abstract string PathToDriverBinary { get; set; }
 

diff --git a/Basin/Core/Browsers/Mappers/FirefoxOptionsMapper.cs b/Basin/Core/Browsers/Mappers/FirefoxOptionsMapper.cs
@@ -4,18 +4,22 @@
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class FirefoxOptionsMapper : BrowserOptionsMapper<FirefoxOptions>
+    public class FirefoxOptionsMapper : DriverOptionsMap<FirefoxOptions>
     {
-        private readonly IBrowserConfig _config;
+        public FirefoxOptionsMapper()
+        {
+        }
 
-        public FirefoxOptionsMapper(IBrowserConfig config) : base(new FirefoxOptions())
+        public FirefoxOptionsMapper(IBrowserConfig config)
         {
-            _config = config;
-            PathToBrowserBinary = _config.PathToBrowserExecutable;
-            BrowserVersion = _config.Version;
-            PlatformName = _config.PlatformName;
-            Arguments = _config.Arguments;
-            EnableHeadlessMode = _config.Headless;
+            PathToBrowserBinary = config.PathToBrowserExecutable;
+            BrowserVersion = config.Version;
+            PlatformName = config.PlatformName;
+            Arguments = config.Arguments;
+            EnableHeadlessMode = config.Headless;
+            AcceptsInsecureCerts = config.AcceptsInsecureCerts;
+
+            SetCapabilities(config.Capabilities);
         }
 
         public override string PathToBrowserBinary
@@ -35,16 +39,31 @@ public override string PlatformName
 
         public override IEnumerable<string> Arguments
         {
-            set => Options.AddArguments(value);
+            set
+            {
+                if (value == null) return;
+                Options.AddArguments(value);
+            }
+        }
+
+        public override bool AcceptsInsecureCerts
+        {
+            set => Options.AcceptInsecureCertificates = value;
         }
 
         public override bool EnableHeadlessMode
         {
             set
             {
-                if (value)
-                    Options.AddArgument("-headless");
+                if (value) Options.AddArgument("-headless");
             }
         }
+
+        public override void SetCapabilities(Dictionary<string, object> caps)
+        {
+            if (caps == null || caps.Count == 0) return;
+
+            foreach (var cap in caps) Options.AddAdditionalCapability(cap.Key, cap.Value, true);
+        }
     }
 }
diff --git a/Basin/Core/Browsers/Mappers/FirefoxServiceMapper.cs b/Basin/Core/Browsers/Mappers/FirefoxServiceMapper.cs
@@ -1,12 +1,10 @@
 using System;
-using System.IO;
 using Basin.Config.Interfaces;
-using OpenQA.Selenium.Chrome;
 using OpenQA.Selenium.Firefox;
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class FirefoxServiceMapper : BrowserServiceMapper<FirefoxDriverService>
+    public class FirefoxServiceMapper : DriverServiceMap<FirefoxDriverService>
     {
         public override string PathToDriverBinary { get; set; }
 

diff --git a/Basin/Core/Browsers/Mappers/InternetExplorerOptionsMapper.cs b/Basin/Core/Browsers/Mappers/InternetExplorerOptionsMapper.cs
@@ -6,22 +6,22 @@
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class InternetExplorerOptionsMapper : BrowserOptionsMapper<InternetExplorerOptions>
+    public class InternetExplorerOptionsMapper : DriverOptionsMap<InternetExplorerOptions>
     {
-        private readonly IBrowserConfig _config;
-
-        public InternetExplorerOptionsMapper() : base(new InternetExplorerOptions())
+        public InternetExplorerOptionsMapper()
         {
         }
 
-        public InternetExplorerOptionsMapper(IBrowserConfig config) : base(new InternetExplorerOptions())
+        public InternetExplorerOptionsMapper(IBrowserConfig config)
         {
-            _config = config;
-            PathToBrowserBinary = _config.PathToBrowserExecutable;
-            BrowserVersion = _config.Version;
-            PlatformName = _config.PlatformName;
-            Arguments = _config.Arguments;
-            EnableHeadlessMode = _config.Headless;
+            PathToBrowserBinary = config.PathToBrowserExecutable;
+            BrowserVersion = config.Version;
+            PlatformName = config.PlatformName;
+            Arguments = config.Arguments;
+            EnableHeadlessMode = config.Headless;
+            AcceptsInsecureCerts = config.AcceptsInsecureCerts;
+
+            SetCapabilities(config.Capabilities);
         }
 
         public override string PathToBrowserBinary
@@ -48,12 +48,24 @@ public override IEnumerable<string> Arguments
             }
         }
 
+        public override bool AcceptsInsecureCerts
+        {
+            set => Options.AcceptInsecureCertificates = value;
+        }
+
         public override bool EnableHeadlessMode
         {
             set
             {
                 if (value) throw new NotSupportedException("Internet Explorer does not support headless execution.");
             }
         }
+
+        public override void SetCapabilities(Dictionary<string, object> caps)
+        {
+            if (caps == null || caps.Count == 0) return;
+
+            foreach (var cap in caps) Options.AddAdditionalCapability(cap.Key, cap.Value, true);
+        }
     }
 }
diff --git a/Basin/Core/Browsers/Mappers/InternetExplorerServiceMapper.cs b/Basin/Core/Browsers/Mappers/InternetExplorerServiceMapper.cs
@@ -4,7 +4,7 @@
 
 namespace Basin.Core.Browsers.Mappers
 {
-    public class InternetExplorerServiceMapper : BrowserServiceMapper<InternetExplorerDriverService>
+    public class InternetExplorerServiceMapper : DriverServiceMap<InternetExplorerDriverService>
     {
         public override string PathToDriverBinary { get; set; }
 

diff --git a/Basin/PageObjects/PageCollection.cs b/Basin/PageObjects/PageCollection.cs
@@ -27,9 +27,12 @@ public TPage Get<TPage>()
         {
             var pageKey = typeof(TPage).ToString();
 
+            if (!Pages.ContainsKey(pageKey))
+                throw new NullReferenceException($"Collection does not contain a page with key `{pageKey}`."); ;
+
             Pages.TryGetValue(pageKey, out object page);
 
-            return (TPage)page ?? throw new NullReferenceException($"Collection does not contain a page with key `{pageKey}`.");
+            return (TPage)page;
         }
 
         public IDictionary<string, object> Pages { get; }