Add possibility to hide "<BrowserName> is being controlled by automated software" infobar (#212)

MikhailKalyn · Mikhail Kalyn · web-flow · commit a1a255ccc119 · 2022-02-18T13:09:29.000+01:00
* Add possibility to hide "Chrome is being controlled by automated software" infobar within Chrome

* Update settings

* Add ExcludedArguments into EdgeOptions and OperaOptions

* Add test with different excludedArguments

* Add logger localization messages

* Fix autotest

Co-authored-by: Mikhail Kalyn &lt;m.kalyn@a1qa.com&gt;
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs
@@ -30,11 +30,17 @@ public override DriverOptions DriverOptions
                 SetChromePrefs(options);
                 SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));
                 SetChromeArguments(options);
+                SetChromeExcludedArguments(options);
                 SetPageLoadStrategy(options);
                 return options;
             }
         }
 
+        private void SetChromeExcludedArguments(ChromeOptions options)
+        {
+            options.AddExcludedArguments(BrowserExcludedArguments);
+        }
+
         private void SetChromePrefs(ChromeOptions options)
         {
             foreach (var option in BrowserOptions)
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs
@@ -18,6 +18,7 @@ public abstract class DriverSettings : IDriverSettings
         private IReadOnlyDictionary<string, object> options;
         private IReadOnlyDictionary<string, object> capabilities;
         private IReadOnlyList<string> startArguments;
+        private IReadOnlyList<string> excludedArguments;
 
         /// <summary>
         /// Instantiates class using JSON file with general settings.
@@ -90,19 +91,36 @@ protected IReadOnlyDictionary<string, object> BrowserOptions
             }
         }
 
+        protected IReadOnlyList<string> BrowserExcludedArguments
+        {
+            get
+            {
+                if (excludedArguments == null)
+                {
+                    excludedArguments = SettingsFile.GetValueListOrEmpty<string>($"{DriverSettingsPath}.{nameof(excludedArguments)}");
+                    if (excludedArguments.Any())
+                    {
+                        AqualityServices.LocalizedLogger.Debug("loc.browser.excludedArguments", args: string.Join(" ", excludedArguments));
+                    }
+                }
+
+                return excludedArguments;
+            }
+        }
+
         protected IReadOnlyList<string> BrowserStartArguments
         {
             get
             {
                 if (startArguments == null)
                 {
                     startArguments = SettingsFile.GetValueListOrEmpty<string>($"{DriverSettingsPath}.{nameof(startArguments)}");
-
                     if (startArguments.Any())
                     {
                         AqualityServices.LocalizedLogger.Debug("loc.browser.arguments", args: string.Join(" ", startArguments));
                     }
                 }
+
                 return startArguments;
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs
@@ -30,11 +30,17 @@ public override DriverOptions DriverOptions
                 SetEdgePrefs(options);
                 SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));
                 SetEdgeArguments(options);
+                SetEdgeExcludedArguments(options);
                 SetPageLoadStrategy(options);
                 return options;
             }
         }
 
+        private void SetEdgeExcludedArguments(EdgeOptions options)
+        {
+            options.AddExcludedArguments(BrowserExcludedArguments);
+        }
+
         private void SetEdgePrefs(EdgeOptions options)
         {
             foreach (var option in BrowserOptions)
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/OperaSettings.cs
@@ -31,11 +31,17 @@ public override DriverOptions DriverOptions
                 SetOperaPrefs(options);
                 SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));
                 SetOperaArguments(options);
+                SetOperaExcludedArguments(options);
                 SetPageLoadStrategy(options);
                 return options;
             }
         }
 
+        private void SetOperaExcludedArguments(OperaOptions options)
+        {
+            options.AddExcludedArguments(BrowserExcludedArguments);
+        }
+
         private void SetOperaPrefs(OperaOptions options)
         {
             foreach (var option in BrowserOptions)
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/be.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/be.json
@@ -1,5 +1,6 @@
 {
   "loc.browser.arguments": "Атрымалі стартавыя аргументы браўзэра з settings файла: {0}",
+  "loc.browser.excludedArguments": "Выключэнне аргументаў браўзэра з settings файла: {0}",
   "loc.browser.back": "Вяртаемся да папярэдняй старонкі",
   "loc.browser.forward": "Пераходзім да наступнай старонкі",
   "loc.browser.capabilities": "Атрымалі capabilities браўзэра з settings файла: {0}",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/en.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/en.json
@@ -1,5 +1,6 @@
 {
   "loc.browser.arguments": "Got browser start arguments from settings file: {0}",
+  "loc.browser.excludedArguments": "Exclude browser arguments from settings file: {0}",
   "loc.browser.back": "Return to previous page",
   "loc.browser.forward": "Proceed to the next page",
   "loc.browser.capabilities": "Got browser capabilities from settings file: {0}",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/ru.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/ru.json
@@ -1,5 +1,6 @@
 {
   "loc.browser.arguments": "Получили стартовые аргументы браузера из settings файла: {0}",
+  "loc.browser.excludedArguments": "Исключение аргументов браузера из settings файла: {0}",
   "loc.browser.back": "Возврат на предыдущую страницу",
   "loc.browser.forward": "Перейти на следующую страницу",
   "loc.browser.capabilities": "Получили capabilities браузера из settings файла: {0}",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json
@@ -19,6 +19,7 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "excludedArguments": [ "enable-automation" ],
       "startArguments": [],
       "pageLoadStrategy": "Normal"
     },
@@ -69,6 +70,7 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "excludedArguments": ["enable-automation"],
       "startArguments": []
     },
     "safari": {
@@ -90,6 +92,7 @@
         "disable-popup-blocking": "true",
         "download.prompt_for_download": "false"
       },
+      "excludedArguments": ["enable-automation"],
       "startArguments": []
     },
     "yandex": {
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/Actions/JsActionsTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Integration/Actions/JsActionsTests.cs
@@ -157,11 +157,11 @@ public void Should_BePossibleTo_ScrollToTheCenter()
             const int accuracy = 1;
             var welcomeForm = new WelcomeForm();
             welcomeForm.Open();
-            welcomeForm.GetExampleLink(AvailableExample.Dropdown).JsActions.ScrollToTheCenter();
+            welcomeForm.GetExampleLink(AvailableExample.Hovers).JsActions.ScrollToTheCenter();
 
             var windowSize = AqualityServices.Browser.ExecuteScriptFromFile<object>("Resources.GetWindowSize.js").ToString();
             var currentY = AqualityServices.Browser.ExecuteScriptFromFile<object>("Resources.GetElementYCoordinate.js",
-                welcomeForm.GetExampleLink(AvailableExample.Dropdown).GetElement()).ToString();
+                welcomeForm.GetExampleLink(AvailableExample.Hovers).GetElement()).ToString();
             var coordinateRelatingWindowCenter = double.Parse(windowSize) / 2 - double.Parse(currentY);
             Assert.LessOrEqual(Math.Abs(coordinateRelatingWindowCenter), accuracy, "Upper bound of element should be in the center of the page");
         }
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.azure.json b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.azure.json
@@ -19,7 +19,9 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
-      "startArguments": []
+      "excludedArguments": [ "enable-automation" ],
+      "startArguments": [],
+      "pageLoadStrategy": "Normal"
     },
     "firefox": {
       "webDriverVersion": "0.24.0",
@@ -66,6 +68,7 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "excludedArguments": [ "enable-automation" ],
       "startArguments": []
     },
     "safari": {
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.json
@@ -19,6 +19,7 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "excludedArguments": [ "enable-automation" ],
       "startArguments": [],
       "pageLoadStrategy": "Normal"
     },
@@ -70,6 +71,7 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "excludedArguments": ["enable-automation"],
       "startArguments": []
     },
     "safari": {
@@ -90,6 +92,7 @@
         "disable-popup-blocking": "true",
         "download.prompt_for_download": "false"
       },
+      "excludedArguments": ["enable-automation"],
       "startArguments": []
     },
     "yandex": {
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Unit/AqualityServicesTests.cs b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Unit/AqualityServicesTests.cs
@@ -63,6 +63,16 @@ public void Should_BeAbleGetBrowser_WithStartArguments(string startArguments)
             Assert.DoesNotThrow(() => AqualityServices.Browser.WaitForPageToLoad());
         }
 
+        [TestCase(null)]
+        [TestCase("enable-automation")]
+        [TestCase("a")]
+        public void Should_BeAbleGetBrowser_WithExcludedArguments(string excludedArguments)
+        {
+            var currentBrowser = AqualityServices.Get<IBrowserProfile>().BrowserName;
+            Environment.SetEnvironmentVariable($"driverSettings.{currentBrowser.ToString().ToLowerInvariant()}.excludedArguments", excludedArguments);
+            Assert.DoesNotThrow(() => AqualityServices.Browser.WaitForPageToLoad());
+        }
+
         [Ignore("Not all browsers are supported in Azure CICD pipeline")]
         [TestCase(BrowserName.IExplorer)]
         [TestCase(BrowserName.Firefox)]

Original file line number	Diff line number	Diff line change
`@@ -30,11 +30,17 @@ public override DriverOptions DriverOptions`
`30`	`30`	`SetChromePrefs(options);`
`31`	`31`	`SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));`
`32`	`32`	`SetChromeArguments(options);`
	`33`	`+ SetChromeExcludedArguments(options);`
`33`	`34`	`SetPageLoadStrategy(options);`
`34`	`35`	`return options;`
`35`	`36`	`}`
`36`	`37`	`}`
`37`	`38`
	`39`	`+ private void SetChromeExcludedArguments(ChromeOptions options)`
	`40`	`+ {`
	`41`	`+ options.AddExcludedArguments(BrowserExcludedArguments);`
	`42`	`+ }`
	`43`	`+`
`38`	`44`	`private void SetChromePrefs(ChromeOptions options)`
`39`	`45`	`{`
`40`	`46`	`foreach (var option in BrowserOptions)`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ public abstract class DriverSettings : IDriverSettings`
`18`	`18`	`private IReadOnlyDictionary<string, object> options;`
`19`	`19`	`private IReadOnlyDictionary<string, object> capabilities;`
`20`	`20`	`private IReadOnlyList<string> startArguments;`
	`21`	`+ private IReadOnlyList<string> excludedArguments;`
`21`	`22`
`22`	`23`	`/// <summary>`
`23`	`24`	`/// Instantiates class using JSON file with general settings.`
`@@ -90,19 +91,36 @@ protected IReadOnlyDictionary<string, object> BrowserOptions`
`90`	`91`	`}`
`91`	`92`	`}`
`92`	`93`
	`94`	`+ protected IReadOnlyList<string> BrowserExcludedArguments`
	`95`	`+ {`
	`96`	`+ get`
	`97`	`+ {`
	`98`	`+ if (excludedArguments == null)`
	`99`	`+ {`
	`100`	`+ excludedArguments = SettingsFile.GetValueListOrEmpty<string>($"{DriverSettingsPath}.{nameof(excludedArguments)}");`
	`101`	`+ if (excludedArguments.Any())`
	`102`	`+ {`
	`103`	`+ AqualityServices.LocalizedLogger.Debug("loc.browser.excludedArguments", args: string.Join(" ", excludedArguments));`
	`104`	`+ }`
	`105`	`+ }`
	`106`	`+`
	`107`	`+ return excludedArguments;`
	`108`	`+ }`
	`109`	`+ }`
	`110`	`+`
`93`	`111`	`protected IReadOnlyList<string> BrowserStartArguments`
`94`	`112`	`{`
`95`	`113`	`get`
`96`	`114`	`{`
`97`	`115`	`if (startArguments == null)`
`98`	`116`	`{`
`99`	`117`	`startArguments = SettingsFile.GetValueListOrEmpty<string>($"{DriverSettingsPath}.{nameof(startArguments)}");`
`100`		`-`
`101`	`118`	`if (startArguments.Any())`
`102`	`119`	`{`
`103`	`120`	`AqualityServices.LocalizedLogger.Debug("loc.browser.arguments", args: string.Join(" ", startArguments));`
`104`	`121`	`}`
`105`	`122`	`}`
	`123`	`+`
`106`	`124`	`return startArguments;`
`107`	`125`	`}`
`108`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,17 @@ public override DriverOptions DriverOptions`
`31`	`31`	`SetOperaPrefs(options);`
`32`	`32`	`SetCapabilities(options, (name, value) => options.AddAdditionalOption(name, value));`
`33`	`33`	`SetOperaArguments(options);`
	`34`	`+ SetOperaExcludedArguments(options);`
`34`	`35`	`SetPageLoadStrategy(options);`
`35`	`36`	`return options;`
`36`	`37`	`}`
`37`	`38`	`}`
`38`	`39`
	`40`	`+ private void SetOperaExcludedArguments(OperaOptions options)`
	`41`	`+ {`
	`42`	`+ options.AddExcludedArguments(BrowserExcludedArguments);`
	`43`	`+ }`
	`44`	`+`
`39`	`45`	`private void SetOperaPrefs(OperaOptions options)`
`40`	`46`	`{`
`41`	`47`	`foreach (var option in BrowserOptions)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"loc.browser.arguments": "Атрымалі стартавыя аргументы браўзэра з settings файла: {0}",`
	`3`	`+ "loc.browser.excludedArguments": "Выключэнне аргументаў браўзэра з settings файла: {0}",`
`3`	`4`	`"loc.browser.back": "Вяртаемся да папярэдняй старонкі",`
`4`	`5`	`"loc.browser.forward": "Пераходзім да наступнай старонкі",`
`5`	`6`	`"loc.browser.capabilities": "Атрымалі capabilities браўзэра з settings файла: {0}",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"loc.browser.arguments": "Got browser start arguments from settings file: {0}",`
	`3`	`+ "loc.browser.excludedArguments": "Exclude browser arguments from settings file: {0}",`
`3`	`4`	`"loc.browser.back": "Return to previous page",`
`4`	`5`	`"loc.browser.forward": "Proceed to the next page",`
`5`	`6`	`"loc.browser.capabilities": "Got browser capabilities from settings file: {0}",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"loc.browser.arguments": "Получили стартовые аргументы браузера из settings файла: {0}",`
	`3`	`+ "loc.browser.excludedArguments": "Исключение аргументов браузера из settings файла: {0}",`
`3`	`4`	`"loc.browser.back": "Возврат на предыдущую страницу",`
`4`	`5`	`"loc.browser.forward": "Перейти на следующую страницу",`
`5`	`6`	`"loc.browser.capabilities": "Получили capabilities браузера из settings файла: {0}",`