implement DriverSettings to resolve #4

mialeska · mialeska · commit 6dc2cd27755d · 2019-08-06T19:33:43.000+03:00
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs
@@ -1,6 +1,8 @@
-﻿using System;
+﻿using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Utilities;
 using OpenQA.Selenium;
+using OpenQA.Selenium.Chrome;
+using System.Linq;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
@@ -17,10 +19,39 @@ public ChromeSettings(JsonFile settingsFile) : base(settingsFile)
         {
         }
 
-        public override DriverOptions DriverOptions => throw new NotImplementedException();
+        public override string DownloadDirCapabilityKey => "download.default_directory";
 
-        public override string DownloadDir => throw new NotImplementedException();
+        protected override BrowserName BrowserName => BrowserName.Chrome;
 
-        public override string DownloadDirCapabilityKey => throw new NotImplementedException();
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new ChromeOptions();
+                SetChromePrefs(options);
+                SetGlobalCapabilities(options);
+                SetChromeArguments(options);
+                return options;
+            }
+        }
+
+        private void SetChromePrefs(ChromeOptions options)
+        {
+            foreach(var option in BrowserOptions)
+            {
+                var value = option.Key == DownloadDirCapabilityKey ? DownloadDir : option.Value;
+                options.AddUserProfilePreference(option.Key, value);                
+            }
+        }
+
+        private void SetChromeArguments(ChromeOptions options)
+        {
+            options.AddArguments(BrowserStartArguments);
+        }
+
+        private void SetGlobalCapabilities(ChromeOptions options)
+        {
+            BrowserCapabilities.ToList().ForEach(capability => options.AddAdditionalCapability(capability.Key, capability.Value, isGlobalCapability: true));
+        }
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs
@@ -31,11 +31,11 @@ private string DriverSettingsPath
             }
         }
 
-        private IDictionary<string, object> BrowserCapabilities
+        protected IDictionary<string, object> BrowserCapabilities
         {
             get
             {
-                return SettingsFile.GetObject<IDictionary<string, object>>($"{DriverSettingsPath}.driversettings");
+                return SettingsFile.GetObject<IDictionary<string, object>>($"{DriverSettingsPath}.capabilities");
             }
         }
 
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs
@@ -1,6 +1,8 @@
 ﻿using System;
+using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Utilities;
 using OpenQA.Selenium;
+using OpenQA.Selenium.Edge;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
@@ -17,10 +19,18 @@ public EdgeSettings(JsonFile settingsFile) : base(settingsFile)
         {
         }
 
-        public override DriverOptions DriverOptions => throw new NotImplementedException();
-
-        public override string DownloadDir => throw new NotImplementedException();
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new EdgeOptions();
+                SetCapabilities(options);
+                return options;
+            }
+        }
+        
+        public override string DownloadDirCapabilityKey => throw new NotSupportedException("Download directory key for Edge profiles is not supported");
 
-        public override string DownloadDirCapabilityKey => throw new NotImplementedException();
+        protected override BrowserName BrowserName => BrowserName.Edge;
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/FirefoxSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/FirefoxSettings.cs
@@ -1,6 +1,8 @@
-﻿using System;
+﻿using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Utilities;
 using OpenQA.Selenium;
+using OpenQA.Selenium.Firefox;
+using System.Linq;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
@@ -17,10 +19,57 @@ public FirefoxSettings(JsonFile settingsFile) : base(settingsFile)
         {
         }
 
-        public override DriverOptions DriverOptions => throw new NotImplementedException();
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new FirefoxOptions();
+                SetGlobalCapabilities(options);
+                SetFirefoxPrefs(options);
+                SetFirefoxArguments(options);
+                return options;
+            }
+        }
+        private void SetFirefoxPrefs(FirefoxOptions options)
+        {
+            foreach (var option in BrowserOptions)
+            {
+                var value = option.Key == DownloadDirCapabilityKey ? DownloadDir : option.Value;
+                if(option.Key == DownloadDirCapabilityKey)
+                {
+                    options.SetPreference(option.Key, DownloadDir);
+                }
+                else if(value is bool)
+                {
+                    options.SetPreference(option.Key, (bool) value);
+                }
+                else if(value is int)
+                {
+                    options.SetPreference(option.Key, (int) value);
+                }
+                else if(value is float)
+                {
+                    options.SetPreference(option.Key, (float) value);
+                }
+                else if (value is string)
+                {
+                    options.SetPreference(option.Key, value as string);
+                }
+            }
+        }
+
+        private void SetFirefoxArguments(FirefoxOptions options)
+        {
+            options.AddArguments(BrowserStartArguments);
+        }
+
+        private void SetGlobalCapabilities(FirefoxOptions options)
+        {
+            BrowserCapabilities.ToList().ForEach(capability => options.AddAdditionalCapability(capability.Key, capability.Value, isGlobalCapability: true));
+        }
 
-        public override string DownloadDir => throw new NotImplementedException();
+        public override string DownloadDirCapabilityKey => "browser.download.dir";
 
-        public override string DownloadDirCapabilityKey => throw new NotImplementedException();
+        protected override BrowserName BrowserName => BrowserName.Firefox;
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/InternetExplorerSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/InternetExplorerSettings.cs
@@ -1,6 +1,8 @@
 ﻿using System;
+using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Utilities;
 using OpenQA.Selenium;
+using OpenQA.Selenium.IE;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
@@ -17,10 +19,18 @@ public InternetExplorerSettings(JsonFile settingsFile) : base(settingsFile)
         {
         }
 
-        public override DriverOptions DriverOptions => throw new NotImplementedException();
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new InternetExplorerOptions();
+                SetCapabilities(options);
+                return options;
+            }
+        }
 
-        public override string DownloadDir => throw new NotImplementedException();
+        public override string DownloadDirCapabilityKey => throw new NotSupportedException("Download directory key for Internet Explorer profiles is not supported");
 
-        public override string DownloadDirCapabilityKey => throw new NotImplementedException();
+        protected override BrowserName BrowserName => BrowserName.InternetExplorer;
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/SafariSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/SafariSettings.cs
@@ -1,6 +1,7 @@
-﻿using System;
+﻿using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Utilities;
 using OpenQA.Selenium;
+using OpenQA.Selenium.Safari;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
@@ -17,10 +18,17 @@ public SafariSettings(JsonFile settingsFile) : base(settingsFile)
         {
         }
 
-        public override DriverOptions DriverOptions => throw new NotImplementedException();
-
-        public override string DownloadDir => throw new NotImplementedException();
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new SafariOptions();
+                SetCapabilities(options);
+                return options;
+            }
+        }
+        public override string DownloadDirCapabilityKey => "safari.options.dataDir";
 
-        public override string DownloadDirCapabilityKey => throw new NotImplementedException();
+        protected override BrowserName BrowserName => BrowserName.Safari;
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json
@@ -6,7 +6,7 @@
 
   "driverSettings": {
     "chrome": {
-      "webDriverVersion": "latest",
+      "webDriverVersion": "Latest",
       "capabilities": {
         "enableVNC": true
       },
@@ -21,7 +21,7 @@
       "startArguments": []
     },
     "firefox": {
-      "webDriverVersion": "latest",
+      "webDriverVersion": "Latest",
       "capabilities": {
         "enableVNC": true
       },
@@ -43,7 +43,7 @@
       "startArguments": []
     },
     "iexplorer": {
-      "webDriverVersion": "latest",
+      "webDriverVersion": "Latest",
       "systemArchitecture": "X32",
       "capabilities": {
         "ignoreProtectedModeSettings": true
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Utilities/JsonFile.cs b/Aquality.Selenium/src/Aquality.Selenium/Utilities/JsonFile.cs
@@ -1,6 +1,7 @@
 ﻿using Aquality.Selenium.Logging;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
+using System.ComponentModel;
 using System.IO;
 
 namespace Aquality.Selenium.Utilities
@@ -43,7 +44,13 @@ public JsonFile(string resourceFileName)
         /// <returns>Object from JSON by JsonPath.</returns>
         public T GetObject<T>(string jsonPath)
         {
-            return (T) GetValue(jsonPath);
+            var envValue = GetEnvironmentValue(jsonPath);
+            if (envValue != null)
+            {
+                return (T) TypeDescriptor.GetConverter(typeof(T)).ConvertFrom(envValue);
+            }
+
+            return GetJsonNode(jsonPath).ToObject<T>();
         }
 
         /// <summary>
@@ -84,10 +91,16 @@ private object GetEnvironmentValueOrDefault(string jsonPath)
                 {
                     return node.ToObject<int>();
                 }
-                else
+                else if (node.Type == JTokenType.Float)
+                {
+                    return node.ToObject<float>();
+                }
+                else if (node.Type == JTokenType.String)
                 {
-                    return node.ToString();
+                    return node.ToObject<string>();
                 }
+                
+                return node.ToObject<object>();
             }
             else
             {
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Unit/BrowserManager/BrowserManagerTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Unit/BrowserManager/BrowserManagerTests.cs
@@ -10,7 +10,7 @@ public class BrowserManagerTests
         [Test]
         public void Should_BeAbleGetBrowser()
         {
-            Assert.Throws<NotImplementedException>(() => BrowserManager.Browser.WaitForPageToLoad());
+            Assert.DoesNotThrow(() => BrowserManager.Browser.WaitForPageToLoad());
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,11 @@ private string DriverSettingsPath`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`- private IDictionary<string, object> BrowserCapabilities`
	`34`	`+ protected IDictionary<string, object> BrowserCapabilities`
`35`	`35`	`{`
`36`	`36`	`get`
`37`	`37`	`{`
`38`		`- return SettingsFile.GetObject<IDictionary<string, object>>($"{DriverSettingsPath}.driversettings");`
	`38`	`+ return SettingsFile.GetObject<IDictionary<string, object>>($"{DriverSettingsPath}.capabilities");`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`using System;`
	`2`	`+using Aquality.Selenium.Browsers;`
`2`	`3`	`using Aquality.Selenium.Utilities;`
`3`	`4`	`using OpenQA.Selenium;`
	`5`	`+using OpenQA.Selenium.Edge;`
`4`	`6`
`5`	`7`	`namespace Aquality.Selenium.Configurations.WebDriverSettings`
`6`	`8`	`{`
`@@ -17,10 +19,18 @@ public EdgeSettings(JsonFile settingsFile) : base(settingsFile)`
`17`	`19`	`{`
`18`	`20`	`}`
`19`	`21`
`20`		`- public override DriverOptions DriverOptions => throw new NotImplementedException();`
`21`		`-`
`22`		`- public override string DownloadDir => throw new NotImplementedException();`
	`22`	`+ public override DriverOptions DriverOptions`
	`23`	`+ {`
	`24`	`+ get`
	`25`	`+ {`
	`26`	`+ var options = new EdgeOptions();`
	`27`	`+ SetCapabilities(options);`
	`28`	`+ return options;`
	`29`	`+ }`
	`30`	`+ }`
	`31`	`+`
	`32`	`+ public override string DownloadDirCapabilityKey => throw new NotSupportedException("Download directory key for Edge profiles is not supported");`
`23`	`33`
`24`		`- public override string DownloadDirCapabilityKey => throw new NotImplementedException();`
	`34`	`+ protected override BrowserName BrowserName => BrowserName.Edge;`
`25`	`35`	`}`
`26`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`		`-using System;`
	`1`	`+using Aquality.Selenium.Browsers;`
`2`	`2`	`using Aquality.Selenium.Utilities;`
`3`	`3`	`using OpenQA.Selenium;`
	`4`	`+using OpenQA.Selenium.Safari;`
`4`	`5`
`5`	`6`	`namespace Aquality.Selenium.Configurations.WebDriverSettings`
`6`	`7`	`{`
`@@ -17,10 +18,17 @@ public SafariSettings(JsonFile settingsFile) : base(settingsFile)`
`17`	`18`	`{`
`18`	`19`	`}`
`19`	`20`
`20`		`- public override DriverOptions DriverOptions => throw new NotImplementedException();`
`21`		`-`
`22`		`- public override string DownloadDir => throw new NotImplementedException();`
	`21`	`+ public override DriverOptions DriverOptions`
	`22`	`+ {`
	`23`	`+ get`
	`24`	`+ {`
	`25`	`+ var options = new SafariOptions();`
	`26`	`+ SetCapabilities(options);`
	`27`	`+ return options;`
	`28`	`+ }`
	`29`	`+ }`
	`30`	`+ public override string DownloadDirCapabilityKey => "safari.options.dataDir";`
`23`	`31`
`24`		`- public override string DownloadDirCapabilityKey => throw new NotImplementedException();`
	`32`	`+ protected override BrowserName BrowserName => BrowserName.Safari;`
`25`	`33`	`}`
`26`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using Aquality.Selenium.Logging;`
`2`	`2`	`using Newtonsoft.Json;`
`3`	`3`	`using Newtonsoft.Json.Linq;`
	`4`	`+using System.ComponentModel;`
`4`	`5`	`using System.IO;`
`5`	`6`
`6`	`7`	`namespace Aquality.Selenium.Utilities`
`@@ -43,7 +44,13 @@ public JsonFile(string resourceFileName)`
`43`	`44`	`/// <returns>Object from JSON by JsonPath.</returns>`
`44`	`45`	`public T GetObject<T>(string jsonPath)`
`45`	`46`	`{`
`46`		`- return (T) GetValue(jsonPath);`
	`47`	`+ var envValue = GetEnvironmentValue(jsonPath);`
	`48`	`+ if (envValue != null)`
	`49`	`+ {`
	`50`	`+ return (T) TypeDescriptor.GetConverter(typeof(T)).ConvertFrom(envValue);`
	`51`	`+ }`
	`52`	`+`
	`53`	`+ return GetJsonNode(jsonPath).ToObject<T>();`
`47`	`54`	`}`
`48`	`55`
`49`	`56`	`/// <summary>`
`@@ -84,10 +91,16 @@ private object GetEnvironmentValueOrDefault(string jsonPath)`
`84`	`91`	`{`
`85`	`92`	`return node.ToObject<int>();`
`86`	`93`	`}`
`87`		`- else`
	`94`	`+ else if (node.Type == JTokenType.Float)`
	`95`	`+ {`
	`96`	`+ return node.ToObject<float>();`
	`97`	`+ }`
	`98`	`+ else if (node.Type == JTokenType.String)`
`88`	`99`	`{`
`89`		`- return node.ToString();`
	`100`	`+ return node.ToObject<string>();`
`90`	`101`	`}`
	`102`	`+`
	`103`	`+ return node.ToObject<object>();`
`91`	`104`	`}`
`92`	`105`	`else`
`93`	`106`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class BrowserManagerTests`
`10`	`10`	`[Test]`
`11`	`11`	`public void Should_BeAbleGetBrowser()`
`12`	`12`	`{`
`13`		`- Assert.Throws<NotImplementedException>(() => BrowserManager.Browser.WaitForPageToLoad());`
	`13`	`+ Assert.DoesNotThrow(() => BrowserManager.Browser.WaitForPageToLoad());`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`