Update Selenium to 4.4.0 to fix DevTools interactions +semver: feature (#220)

mialeska · web-flow · commit b015ccf48391 · 2022-08-19T20:45:04.000+02:00
* Update Selenium to 4.4.0
- attempt to rework Opera settings (not working yet)

* Workaround to start Opera browser

* Update Core library versions, remove direct dependency of Selenium

* Update Core version to fix log issue
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj b/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj
@@ -76,8 +76,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Aquality.Selenium.Core" Version="2.0.2" />
-    <PackageReference Include="WebDriverManager" Version="2.12.3" />
+    <PackageReference Include="Aquality.Selenium.Core" Version="2.0.4" />
+    <PackageReference Include="WebDriverManager" Version="2.15.0" />
   </ItemGroup>
 
 </Project>
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs b/Aquality.Selenium/src/Aquality.Selenium/Browsers/LocalBrowserFactory.cs
@@ -14,7 +14,6 @@
 using WebDriverManager.DriverConfigs.Impl;
 using WebDriverManager.Helpers;
 using Aquality.Selenium.Core.Localization;
-using OpenQA.Selenium.Opera;
 
 namespace Aquality.Selenium.Browsers
 {
@@ -64,9 +63,10 @@ protected override WebDriver Driver
                             (EdgeOptions)driverSettings.DriverOptions, commandTimeout);
                         break;
                     case BrowserName.Opera:
-                        SetUpDriver(new OperaConfig(), driverSettings);
-                        driver = GetDriver<OperaDriver>(OperaDriverService.CreateDefaultService(),
-                            (OperaOptions)driverSettings.DriverOptions, commandTimeout);
+                        var config = new OperaConfig();
+                        var driverPath = SetUpDriver(config, driverSettings);
+                        driver = GetDriver<ChromeDriver>(ChromeDriverService.CreateDefaultService(Path.GetDirectoryName(driverPath), config.GetBinaryName()),
+                            (ChromeOptions)driverSettings.DriverOptions, commandTimeout);
                         break;
                     case BrowserName.Safari:
                         driver = GetDriver<SafariDriver>(SafariDriverService.CreateDefaultService(),
@@ -84,7 +84,7 @@ private WebDriver GetDriver<T>(DriverService driverService, DriverOptions driver
             return (T)Activator.CreateInstance(typeof(T), driverService, driverOptions, commandTimeout);
         }
 
-        private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driverSettings)
+        private static string SetUpDriver(IDriverConfig driverConfig, IDriverSettings driverSettings)
         {
             var architecture = driverSettings.SystemArchitecture.Equals(Architecture.Auto) ? ArchitectureHelper.GetArchitecture() : driverSettings.SystemArchitecture;
             var version = driverSettings.WebDriverVersion.Equals(VersionResolveStrategy.Latest) ? driverConfig.GetLatestVersion() : driverSettings.WebDriverVersion;
@@ -95,9 +95,10 @@ private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driv
             {
                 lock (WebDriverDownloadingLock)
                 {
-                    new DriverManager().SetUpDriver(url, binaryPath);
+                    return new DriverManager().SetUpDriver(url, binaryPath);
                 }
             }
+            return binaryPath;
         }
     }
 }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs
@@ -1,16 +1,22 @@
 ﻿using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Core.Configurations;
+using Aquality.Selenium.Core.Utilities;
 using OpenQA.Selenium;
-using OpenQA.Selenium.Opera;
+using OpenQA.Selenium.Chrome;
+using OpenQA.Selenium.Chromium;
 using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Reflection;
 
 namespace Aquality.Selenium.Configurations.WebDriverSettings
 {
     /// <summary>
     /// Settings specific for Opera web driver.
     /// </summary>
-    public class OperaSettings : DriverSettings
+    public class OperaSettings : ChromeSettings
     {
+        private const string DefaultBinaryLocation = "%USERPROFILE%\\AppData\\Local\\Programs\\Opera\\launcher.exe";
         /// <summary>
         /// Instantiates class using JSON file with general settings.
         /// </summary>
@@ -19,40 +25,34 @@ 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
+        public virtual string BinaryLocation
         {
             get
             {
-                var options = new OperaOptions();                
-                SetOperaPrefs(options);
-                SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));
-                SetOperaArguments(options);
-                SetOperaExcludedArguments(options);
-                SetPageLoadStrategy(options);
-                return options;
+                var pathInConfiguration = SettingsFile.GetValueOrDefault($"{DriverSettingsPath}.binaryLocation", DefaultBinaryLocation);
+                return pathInConfiguration.StartsWith("%") ? Environment.ExpandEnvironmentVariables(pathInConfiguration) : Path.GetFullPath(pathInConfiguration);
             }
         }
 
-        private void SetOperaExcludedArguments(OperaOptions options)
-        {
-            options.AddExcludedArguments(BrowserExcludedArguments);
-        }
+        protected override BrowserName BrowserName => BrowserName.Opera;
 
-        private void SetOperaPrefs(OperaOptions options)
+        public override DriverOptions DriverOptions
         {
-            foreach (var option in BrowserOptions)
+            get
             {
-                options.AddUserProfilePreference(option.Key, option.Value);                
-            }
-        }
+                var options = (ChromeOptions) base.DriverOptions;
+#pragma warning disable S3011 // Reflection should not be used to increase accessibility of classes, methods, or fields
+                var field = typeof(ChromiumOptions).GetField("additionalChromeOptions", BindingFlags.NonPublic | BindingFlags.Instance);
+#pragma warning restore S3011 // Reflection should not be used to increase accessibility of classes, methods, or fields
+                if (field.GetValue(options) is Dictionary<string, object> optionsDictionary)
+                {
+                    optionsDictionary["w3c"] = true;
+                    field.SetValue(options, optionsDictionary);
+                }
 
-        private void SetOperaArguments(OperaOptions options)
-        {
-            options.AddArguments(BrowserStartArguments);
+                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
@@ -82,6 +82,7 @@
     },
     "opera": {
       "webDriverVersion": "Latest",
+      "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Programs\\Opera\\launcher.exe",
       "capabilities": {
         "enableVNC": true,
         "unhandledPromptBehavior": "ignore"
@@ -94,10 +95,10 @@
         "download.prompt_for_download": "false"
       },
       "excludedArguments": ["enable-automation"],
-      "startArguments": []
+      "startArguments": ["--remote-debugging-port=9222", "--no-sandbox", "--disable-dev-shm-usage"]
     },
     "yandex": {
-      "webDriverVersion": "94.0.4606.41",
+      "webDriverVersion": "102.0.5005.61",
       "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Yandex\\YandexBrowser\\Application\\browser.exe",
       "capabilities": {
         "enableVNC": true,
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Aquality.Selenium.Tests.csproj b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Aquality.Selenium.Tests.csproj
@@ -29,12 +29,12 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="nunit" Version="3.13.2" />
+    <PackageReference Include="nunit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.2.1">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/DevToolsEmulationTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/DevToolsEmulationTests.cs
@@ -58,11 +58,11 @@ public void Should_BePossibleTo_SetAndClearDeviceMetricsOverride_WithVersionSpec
         {
             void setAction(long width, long height, bool isMobile, double scaleFactor)
             {
-                var parameters = new OpenQA.Selenium.DevTools.V95.Emulation.SetDeviceMetricsOverrideCommandSettings
+                var parameters = new OpenQA.Selenium.DevTools.V104.Emulation.SetDeviceMetricsOverrideCommandSettings
                 {
-                    DisplayFeature = new OpenQA.Selenium.DevTools.V95.Emulation.DisplayFeature
+                    DisplayFeature = new OpenQA.Selenium.DevTools.V104.Emulation.DisplayFeature
                     {
-                        Orientation = OpenQA.Selenium.DevTools.V95.Emulation.DisplayFeatureOrientationValues.Horizontal
+                        Orientation = OpenQA.Selenium.DevTools.V104.Emulation.DisplayFeatureOrientationValues.Horizontal
                     },
                     Width = width,
                     Height = height,
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/NetworkHandlingTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/NetworkHandlingTests.cs
@@ -81,7 +81,7 @@ public void Should_BePossibleTo_SubscribeToRequestSentEvent_AndUnsubscribeFromIt
             var welcomeForm = new WelcomeForm();
             welcomeForm.Open();
             var counter = 0;
-            void eventHandler(object sender, NetworkRequestSentEventArgs args) => counter++;
+            void eventHandler(object sender, NetworkRequestSentEventArgs args) => ++counter;
             AqualityServices.Browser.Network.NetworkRequestSent += eventHandler;
             Assert.DoesNotThrowAsync(() => AqualityServices.Browser.Network.StartMonitoring());
             welcomeForm.Open();
@@ -98,7 +98,7 @@ public void Should_BePossibleTo_SubscribeToResponseReceivedEvent_AndUnsubscribeF
             var welcomeForm = new WelcomeForm();
             welcomeForm.Open();
             var counter = 0;
-            void eventHandler(object sender, NetworkResponseReceivedEventArgs args) => counter++;
+            void eventHandler(object sender, NetworkResponseReceivedEventArgs args) => ++counter;
             AqualityServices.Browser.Network.NetworkResponseReceived += eventHandler;
             Assert.DoesNotThrowAsync(() => AqualityServices.Browser.Network.StartMonitoring());
             welcomeForm.Open();
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json
@@ -81,6 +81,7 @@
     },
     "opera": {
       "webDriverVersion": "Latest",
+      "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Programs\\Opera\\launcher.exe",
       "capabilities": {
         "enableVNC": true,
         "unhandledPromptBehavior": "ignore"
@@ -93,10 +94,10 @@
         "download.prompt_for_download": "false"
       },
       "excludedArguments": ["enable-automation"],
-      "startArguments": []
+      "startArguments": ["--remote-debugging-port=9222", "--no-sandbox", "--disable-dev-shm-usage"]
     },
     "yandex": {
-      "webDriverVersion": "94.0.4606.41",
+      "webDriverVersion": "102.0.5005.61",
       "binaryLocation": "%USERPROFILE%\\AppData\\Local\\Yandex\\YandexBrowser\\Application\\browser.exe",
       "capabilities": {
         "enableVNC": true,

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`using WebDriverManager.DriverConfigs.Impl;`
`15`	`15`	`using WebDriverManager.Helpers;`
`16`	`16`	`using Aquality.Selenium.Core.Localization;`
`17`		`-using OpenQA.Selenium.Opera;`
`18`	`17`
`19`	`18`	`namespace Aquality.Selenium.Browsers`
`20`	`19`	`{`
`@@ -64,9 +63,10 @@ protected override WebDriver Driver`
`64`	`63`	`(EdgeOptions)driverSettings.DriverOptions, commandTimeout);`
`65`	`64`	`break;`
`66`	`65`	`case BrowserName.Opera:`
`67`		`- SetUpDriver(new OperaConfig(), driverSettings);`
`68`		`- driver = GetDriver<OperaDriver>(OperaDriverService.CreateDefaultService(),`
`69`		`- (OperaOptions)driverSettings.DriverOptions, commandTimeout);`
	`66`	`+ var config = new OperaConfig();`
	`67`	`+ var driverPath = SetUpDriver(config, driverSettings);`
	`68`	`+ driver = GetDriver<ChromeDriver>(ChromeDriverService.CreateDefaultService(Path.GetDirectoryName(driverPath), config.GetBinaryName()),`
	`69`	`+ (ChromeOptions)driverSettings.DriverOptions, commandTimeout);`
`70`	`70`	`break;`
`71`	`71`	`case BrowserName.Safari:`
`72`	`72`	`driver = GetDriver<SafariDriver>(SafariDriverService.CreateDefaultService(),`
`@@ -84,7 +84,7 @@ private WebDriver GetDriver<T>(DriverService driverService, DriverOptions driver`
`84`	`84`	`return (T)Activator.CreateInstance(typeof(T), driverService, driverOptions, commandTimeout);`
`85`	`85`	`}`
`86`	`86`
`87`		`- private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driverSettings)`
	`87`	`+ private static string SetUpDriver(IDriverConfig driverConfig, IDriverSettings driverSettings)`
`88`	`88`	`{`
`89`	`89`	`var architecture = driverSettings.SystemArchitecture.Equals(Architecture.Auto) ? ArchitectureHelper.GetArchitecture() : driverSettings.SystemArchitecture;`
`90`	`90`	`var version = driverSettings.WebDriverVersion.Equals(VersionResolveStrategy.Latest) ? driverConfig.GetLatestVersion() : driverSettings.WebDriverVersion;`
`@@ -95,9 +95,10 @@ private static void SetUpDriver(IDriverConfig driverConfig, IDriverSettings driv`
`95`	`95`	`{`
`96`	`96`	`lock (WebDriverDownloadingLock)`
`97`	`97`	`{`
`98`		`- new DriverManager().SetUpDriver(url, binaryPath);`
	`98`	`+ return new DriverManager().SetUpDriver(url, binaryPath);`
`99`	`99`	`}`
`100`	`100`	`}`
	`101`	`+ return binaryPath;`
`101`	`102`	`}`
`102`	`103`	`}`
`103`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,11 +58,11 @@ public void Should_BePossibleTo_SetAndClearDeviceMetricsOverride_WithVersionSpec`
`58`	`58`	`{`
`59`	`59`	`void setAction(long width, long height, bool isMobile, double scaleFactor)`
`60`	`60`	`{`
`61`		`- var parameters = new OpenQA.Selenium.DevTools.V95.Emulation.SetDeviceMetricsOverrideCommandSettings`
	`61`	`+ var parameters = new OpenQA.Selenium.DevTools.V104.Emulation.SetDeviceMetricsOverrideCommandSettings`
`62`	`62`	`{`
`63`		`- DisplayFeature = new OpenQA.Selenium.DevTools.V95.Emulation.DisplayFeature`
	`63`	`+ DisplayFeature = new OpenQA.Selenium.DevTools.V104.Emulation.DisplayFeature`
`64`	`64`	`{`
`65`		`- Orientation = OpenQA.Selenium.DevTools.V95.Emulation.DisplayFeatureOrientationValues.Horizontal`
	`65`	`+ Orientation = OpenQA.Selenium.DevTools.V104.Emulation.DisplayFeatureOrientationValues.Horizontal`
`66`	`66`	`},`
`67`	`67`	`Width = width,`
`68`	`68`	`Height = height,`