Merge pull request #208 from aquality-automation/feature/custom-browser

runetsk-zz · web-flow · commit dbb0aba68540 · 2021-12-23T09:58:31.000+03:00
[Feature] Opera and Yandex browsers
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj b/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj
@@ -70,7 +70,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Edge.SeleniumTools" Version="3.141.2" />
     <PackageReference Include="Aquality.Selenium.Core" Version="1.6.1" />
-    <PackageReference Include="WebDriverManager" Version="2.11.1" />
+    <PackageReference Include="WebDriverManager" Version="2.12.3" />
   </ItemGroup>
 
 </Project>
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/Browser.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/Browser.cs
@@ -391,7 +391,10 @@ public enum BrowserName
         EdgeChromium,
         Firefox,
         IExplorer,
-        Safari
+        Opera,
+        Other,
+        Safari,
+        Yandex
     }
 
     /// <summary>
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs
@@ -18,6 +18,7 @@
 using EdgeChromiumService = Microsoft.Edge.SeleniumTools.EdgeDriverService;
 using EdgeChromiumDriver = Microsoft.Edge.SeleniumTools.EdgeDriver;
 using Aquality.Selenium.Core.Localization;
+using OpenQA.Selenium.Opera;
 
 namespace Aquality.Selenium.Browsers
 {
@@ -44,6 +45,7 @@ protected override RemoteWebDriver Driver
                 switch (browserName)
                 {
                     case BrowserName.Chrome:
+                    case BrowserName.Yandex:
                         SetUpDriver(new ChromeConfig(), driverSettings);
                         driver = GetDriver<ChromeDriver>(ChromeDriverService.CreateDefaultService(),
                             (ChromeOptions)driverSettings.DriverOptions, commandTimeout);
@@ -68,6 +70,11 @@ protected override RemoteWebDriver Driver
                         driver = GetDriver<EdgeChromiumDriver>(EdgeChromiumService.CreateChromiumService(),
                             (EdgeChromiumOptions)driverSettings.DriverOptions, commandTimeout);
                         break;
+                    case BrowserName.Opera:
+                        SetUpDriver(new OperaConfig(), driverSettings);
+                        driver = GetDriver<OperaDriver>(OperaDriverService.CreateDefaultService(),
+                            (OperaOptions)driverSettings.DriverOptions, commandTimeout);
+                        break;
                     case BrowserName.Safari:
                         driver = GetDriver<SafariDriver>(SafariDriverService.CreateDefaultService(),
                             (SafariOptions)driverSettings.DriverOptions, commandTimeout);
@@ -95,7 +102,7 @@ private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driv
             {
                 lock (WebDriverDownloadingLock)
                 {
-                    new DriverManager().SetUpDriver(url, binaryPath, driverConfig.GetBinaryName());
+                    new DriverManager().SetUpDriver(url, binaryPath);
                 }
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/BrowserProfile.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/BrowserProfile.cs
@@ -21,7 +21,17 @@ public BrowserProfile(ISettingsFile settingsFile)
             this.settingsFile = settingsFile;
         }
 
-        public BrowserName BrowserName => (BrowserName)Enum.Parse(typeof(BrowserName), settingsFile.GetValue<string>(".browserName"), ignoreCase: true);
+        public BrowserName BrowserName
+        {
+            get
+            {
+                if (!Enum.TryParse(settingsFile.GetValue<string>(".browserName"), ignoreCase: true, out BrowserName browserName))
+                {
+                    return BrowserName.Other;
+                }
+                return browserName;
+            }
+        }
 
         public bool IsElementHighlightEnabled => settingsFile.GetValue<bool>(".isElementHighlightEnabled");
 
@@ -39,14 +49,18 @@ public IDriverSettings DriverSettings
                         return new ChromeSettings(settingsFile);
                     case BrowserName.Edge:
                         return new EdgeSettings(settingsFile);
+                    case BrowserName.EdgeChromium:
+                        return new EdgeChromiumSettings(settingsFile);
                     case BrowserName.Firefox:
                         return new FirefoxSettings(settingsFile);
                     case BrowserName.IExplorer:
                         return new InternetExplorerSettings(settingsFile);
+                    case BrowserName.Opera:
+                        return new OperaSettings(settingsFile);
                     case BrowserName.Safari:
                         return new SafariSettings(settingsFile);
-                    case BrowserName.EdgeChromium:
-                        return new EdgeChromiumSettings(settingsFile);
+                    case BrowserName.Yandex:
+                        return new YandexSettings(settingsFile);
                     default:
                         throw new InvalidOperationException($"There is no assigned behaviour for retrieving DriverSettings for browser {BrowserName}");
                 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs
@@ -30,7 +30,7 @@ protected DriverSettings(ISettingsFile settingsFile)
 
         protected ISettingsFile SettingsFile { get; }
 
-        public string WebDriverVersion => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.webDriverVersion", "Latest");
+        public virtual string WebDriverVersion => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.webDriverVersion", "Latest");
 
         public Architecture SystemArchitecture => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.systemArchitecture", Architecture.Auto).ToEnum<Architecture>();
 
@@ -107,7 +107,7 @@ protected IReadOnlyList<string> BrowserStartArguments
             }
         }
 
-        private string DriverSettingsPath => $".driverSettings.{BrowserName.ToString().ToLowerInvariant()}";
+        protected virtual string DriverSettingsPath => $".driverSettings.{BrowserName.ToString().ToLowerInvariant()}";
 
         protected abstract BrowserName BrowserName { get; }
 
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs
@@ -0,0 +1,52 @@
+﻿using Aquality.Selenium.Browsers;
+using Aquality.Selenium.Core.Configurations;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Opera;
+using System;
+
+namespace Aquality.Selenium.Configurations.WebDriverSettings
+{
+    /// <summary>
+    /// Settings specific for Opera web driver.
+    /// </summary>
+    public class OperaSettings : DriverSettings
+    {
+        /// <summary>
+        /// Instantiates class using JSON file with general settings.
+        /// </summary>
+        /// <param name="settingsFile">JSON settings file.</param>
+        public OperaSettings(ISettingsFile settingsFile) : base(settingsFile)
+        {
+        }
+
+        protected override BrowserName BrowserName => BrowserName.Opera;
+
+        public override string DownloadDirCapabilityKey => throw new NotSupportedException("Download directory key for Opera profiles is not supported");
+
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = new OperaOptions();                
+                SetOperaPrefs(options);
+                SetCapabilities(options, (name, value) => options.AddAdditionalCapability(name, value, isGlobalCapability: true));
+                SetOperaArguments(options);
+                SetPageLoadStrategy(options);
+                return options;
+            }
+        }
+
+        private void SetOperaPrefs(OperaOptions options)
+        {
+            foreach (var option in BrowserOptions)
+            {
+                options.AddUserProfilePreference(option.Key, option.Value);                
+            }
+        }
+
+        private void SetOperaArguments(OperaOptions options)
+        {
+            options.AddArguments(BrowserStartArguments);
+        }
+    }
+}
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/YandexSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/YandexSettings.cs
@@ -0,0 +1,47 @@
+﻿using Aquality.Selenium.Browsers;
+using Aquality.Selenium.Core.Configurations;
+using Aquality.Selenium.Core.Utilities;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Chrome;
+using System;
+using System.IO;
+using WebDriverManager.Helpers;
+
+namespace Aquality.Selenium.Configurations.WebDriverSettings
+{
+    /// <summary>
+    /// Settings specific for Yandex web driver.
+    /// </summary>
+    public class YandexSettings : ChromeSettings
+    {
+        private const string DefaultBinaryLocation = "%USERPROFILE%\\AppData\\Local\\Yandex\\YandexBrowser\\Application\\browser.exe";
+        /// <summary>
+        /// Instantiates class using JSON file with general settings.
+        /// </summary>
+        /// <param name="settingsFile">JSON settings file.</param>
+        public YandexSettings(ISettingsFile settingsFile) : base(settingsFile)
+        {
+        }
+
+        public virtual string BinaryLocation
+        {
+            get
+            {
+                var pathInConfiguration = SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.binaryLocation", DefaultBinaryLocation);
+                return pathInConfiguration.StartsWith("%") ? Environment.ExpandEnvironmentVariables(pathInConfiguration) : Path.GetFullPath(pathInConfiguration);
+            }
+        }
+
+        protected override BrowserName BrowserName => BrowserName.Yandex;
+
+        public override DriverOptions DriverOptions
+        {
+            get
+            {
+                var options = (ChromeOptions) base.DriverOptions;
+                options.BinaryLocation = BinaryLocation;
+                return options;
+            }
+        }
+    }
+}
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json
@@ -17,7 +17,7 @@
         "profile.default_content_settings.popups": "0",
         "disable-popup-blocking": "true",
         "download.prompt_for_download": "false",
-        "download.default_directory": "//home//selenium//downloads"
+        "download.default_directory": "./downloads"
       },
       "startArguments": [],
       "pageLoadStrategy": "Normal"
@@ -30,7 +30,7 @@
       },
       "options": {
         "intl.accept_languages": "en",
-        "browser.download.dir": "//home//selenium//downloads",
+        "browser.download.dir": "./downloads",
         "browser.download.folderList": 2,
         "browser.helperApps.neverAsk.saveToDisk": "application/octet-stream, application/x-debian-package, application/x-www-form-urlencod, application/json, application/x-compressed, application/x-zip-compressed, application/zip, multipart/x-zip, text/plain, text/csv",
         "browser.helperApps.alwaysAsk.force": false,
@@ -85,6 +85,38 @@
         "safari.options.dataDir": "/Users/username/Downloads"
       },
       "startArguments": []
+    },
+    "opera": {
+      "webDriverVersion": "Latest",
+      "capabilities": {
+        "enableVNC": true,
+        "unhandledPromptBehavior": "ignore"
+      },
+      "options": {
+        "intl.accept_languages": "en",
+        "safebrowsing.enabled": "true",
+        "profile.default_content_settings.popups": "0",
+        "disable-popup-blocking": "true",
+        "download.prompt_for_download": "false"
+      },
+      "startArguments": []
+    },
+    "yandex": {
+      "webDriverVersion": "94.0.4606.41",
+      "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Yandex\\YandexBrowser\\Application\\browser.exe",
+      "capabilities": {
+        "enableVNC": true,
+        "unhandledPromptBehavior": "ignore"
+      },
+      "options": {
+        "intl.accept_languages": "en",
+        "safebrowsing.enabled": "true",
+        "profile.default_content_settings.popups": "0",
+        "disable-popup-blocking": "true",
+        "download.prompt_for_download": "false",
+        "download.default_directory": "./downloads"
+      },
+      "startArguments": []
     }
   },
   "timeouts": {
@@ -112,4 +144,4 @@
     "comparisonHeight": 16,
     "pathToDumps": "../../../Resources/VisualDumps/"
   }
-}
+}
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/TestApp/TheDemoSite/Forms/TheDemoSiteForm.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/TestApp/TheDemoSite/Forms/TheDemoSiteForm.cs
@@ -6,7 +6,7 @@ namespace Aquality.Selenium.Tests.Integration.TestApp.TheInternet.Forms
 {
     internal abstract class TheDemoSiteForm : Form
     {
-        private const string BaseUrl = "http://thedemosite.co.uk/";
+        private const string BaseUrl = "http://eprint.com.hr/demo/index.php";
 
         protected TheDemoSiteForm(By locator, string name) : base(locator, name)
         {
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json
@@ -19,7 +19,8 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
-      "startArguments": []
+      "startArguments": [],
+      "pageLoadStrategy": "Normal"
     },
     "firefox": {
       "webDriverVersion": "Latest",
@@ -84,6 +85,38 @@
       "options": {
         "safari.options.dataDir": "/Users/username/Downloads"
       }
+    },
+    "opera": {
+      "webDriverVersion": "Latest",
+      "capabilities": {
+        "enableVNC": true,
+        "unhandledPromptBehavior": "ignore"
+      },
+      "options": {
+        "intl.accept_languages": "en",
+        "safebrowsing.enabled": "true",
+        "profile.default_content_settings.popups": "0",
+        "disable-popup-blocking": "true",
+        "download.prompt_for_download": "false"
+      },
+      "startArguments": []
+    },
+    "yandex": {
+      "webDriverVersion": "94.0.4606.41",
+      "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Yandex\\YandexBrowser\\Application\\browser.exe",
+      "capabilities": {
+        "enableVNC": true,
+        "unhandledPromptBehavior": "ignore"
+      },
+      "options": {
+        "intl.accept_languages": "en",
+        "safebrowsing.enabled": "true",
+        "profile.default_content_settings.popups": "0",
+        "disable-popup-blocking": "true",
+        "download.prompt_for_download": "false",
+        "download.default_directory": "./downloads"
+      },
+      "startArguments": []
     }
   },
   "timeouts": {

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`using EdgeChromiumService = Microsoft.Edge.SeleniumTools.EdgeDriverService;`
`19`	`19`	`using EdgeChromiumDriver = Microsoft.Edge.SeleniumTools.EdgeDriver;`
`20`	`20`	`using Aquality.Selenium.Core.Localization;`
	`21`	`+using OpenQA.Selenium.Opera;`
`21`	`22`
`22`	`23`	`namespace Aquality.Selenium.Browsers`
`23`	`24`	`{`
`@@ -44,6 +45,7 @@ protected override RemoteWebDriver Driver`
`44`	`45`	`switch (browserName)`
`45`	`46`	`{`
`46`	`47`	`case BrowserName.Chrome:`
	`48`	`+ case BrowserName.Yandex:`
`47`	`49`	`SetUpDriver(new ChromeConfig(), driverSettings);`
`48`	`50`	`driver = GetDriver<ChromeDriver>(ChromeDriverService.CreateDefaultService(),`
`49`	`51`	`(ChromeOptions)driverSettings.DriverOptions, commandTimeout);`
`@@ -68,6 +70,11 @@ protected override RemoteWebDriver Driver`
`68`	`70`	`driver = GetDriver<EdgeChromiumDriver>(EdgeChromiumService.CreateChromiumService(),`
`69`	`71`	`(EdgeChromiumOptions)driverSettings.DriverOptions, commandTimeout);`
`70`	`72`	`break;`
	`73`	`+ case BrowserName.Opera:`
	`74`	`+ SetUpDriver(new OperaConfig(), driverSettings);`
	`75`	`+ driver = GetDriver<OperaDriver>(OperaDriverService.CreateDefaultService(),`
	`76`	`+ (OperaOptions)driverSettings.DriverOptions, commandTimeout);`
	`77`	`+ break;`
`71`	`78`	`case BrowserName.Safari:`
`72`	`79`	`driver = GetDriver<SafariDriver>(SafariDriverService.CreateDefaultService(),`
`73`	`80`	`(SafariOptions)driverSettings.DriverOptions, commandTimeout);`
`@@ -95,7 +102,7 @@ private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driv`
`95`	`102`	`{`
`96`	`103`	`lock (WebDriverDownloadingLock)`
`97`	`104`	`{`
`98`		`- new DriverManager().SetUpDriver(url, binaryPath, driverConfig.GetBinaryName());`
	`105`	`+ new DriverManager().SetUpDriver(url, binaryPath);`
`99`	`106`	`}`
`100`	`107`	`}`
`101`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ protected DriverSettings(ISettingsFile settingsFile)`
`30`	`30`
`31`	`31`	`protected ISettingsFile SettingsFile { get; }`
`32`	`32`
`33`		`- public string WebDriverVersion => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.webDriverVersion", "Latest");`
	`33`	`+ public virtual string WebDriverVersion => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.webDriverVersion", "Latest");`
`34`	`34`
`35`	`35`	`public Architecture SystemArchitecture => SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.systemArchitecture", Architecture.Auto).ToEnum<Architecture>();`
`36`	`36`
`@@ -107,7 +107,7 @@ protected IReadOnlyList<string> BrowserStartArguments`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`
`110`		`- private string DriverSettingsPath => $".driverSettings.{BrowserName.ToString().ToLowerInvariant()}";`
	`110`	`+ protected virtual string DriverSettingsPath => $".driverSettings.{BrowserName.ToString().ToLowerInvariant()}";`
`111`	`111`
`112`	`112`	`protected abstract BrowserName BrowserName { get; }`
`113`	`113`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Aquality.Selenium.Tests.Integration.TestApp.TheInternet.Forms`
`6`	`6`	`{`
`7`	`7`	`internal abstract class TheDemoSiteForm : Form`
`8`	`8`	`{`
`9`		`- private const string BaseUrl = "http://thedemosite.co.uk/";`
	`9`	`+ private const string BaseUrl = "http://eprint.com.hr/demo/index.php";`
`10`	`10`
`11`	`11`	`protected TheDemoSiteForm(By locator, string name) : base(locator, name)`
`12`	`12`	`{`