Merge pull request #225 from aquality-automation/feature/support-logging-preferences

aqualityAutomation · web-flow · commit 66b90741509b · 2023-01-11T16:23:12.000+03:00
Support logging preferences from settings.json +semver: feature
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj b/Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj
@@ -14,7 +14,7 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>selenium webdriver browser automation</PackageTags>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
-    <Copyright>Copyright 2022 Aquality Automation</Copyright>
+    <Copyright>Copyright 2023 Aquality Automation</Copyright>
     <IsPackable>true</IsPackable>
   </PropertyGroup>
 
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/ChromeSettings.cs
@@ -32,6 +32,7 @@ public override DriverOptions DriverOptions
                 SetChromeArguments(options);
                 SetChromeExcludedArguments(options);
                 SetPageLoadStrategy(options);
+                SetLoggingPreferences(options);
                 return options;
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/DriverSettings.cs
@@ -17,6 +17,7 @@ public abstract class DriverSettings : IDriverSettings
     {
         private IReadOnlyDictionary<string, object> options;
         private IReadOnlyDictionary<string, object> capabilities;
+        private IReadOnlyDictionary<string, LogLevel> loggingPreferences;
         private IReadOnlyList<string> startArguments;
         private IReadOnlyList<string> excludedArguments;
 
@@ -91,6 +92,24 @@ protected IReadOnlyDictionary<string, object> BrowserOptions
             }
         }
 
+        protected IReadOnlyDictionary<string, LogLevel> LoggingPreferences
+        {
+            get
+            {
+                if (loggingPreferences == null)
+                {
+                    loggingPreferences = SettingsFile.GetValueDictionaryOrEmpty<LogLevel>($"{DriverSettingsPath}.{nameof(loggingPreferences)}");
+                    if (loggingPreferences.Any())
+                    {
+                        AqualityServices.LocalizedLogger.Debug("loc.browser.loggingPreferences",
+                            args: string.Join(",", loggingPreferences.Select(opt => $"{Environment.NewLine}{opt.Key}: {opt.Value}")));
+                    }
+                }
+
+                return loggingPreferences;
+            }
+        }
+
         protected IReadOnlyList<string> BrowserExcludedArguments
         {
             get
@@ -159,6 +178,14 @@ protected void SetCapabilities(DriverOptions options, Action<string, object> add
             }
         }
 
+        protected void SetLoggingPreferences(DriverOptions options)
+        {
+            foreach (var preference in LoggingPreferences)
+            {
+                options.SetLoggingPreference(preference.Key, preference.Value);
+            }
+        }
+
         private void SetKnownProperty(DriverOptions options, KeyValuePair<string, object> capability, ArgumentException exception)
         {
             if (KnownCapabilitySetters.ContainsKey(capability.Key))
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/EdgeSettings.cs
@@ -32,6 +32,7 @@ public override DriverOptions DriverOptions
                 SetEdgeArguments(options);
                 SetEdgeExcludedArguments(options);
                 SetPageLoadStrategy(options);
+                SetLoggingPreferences(options);
                 return options;
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/FirefoxSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/FirefoxSettings.cs
@@ -42,6 +42,7 @@ public override DriverOptions DriverOptions
                 SetFirefoxPrefs(options);
                 SetFirefoxArguments(options);
                 SetPageLoadStrategy(options);
+                SetLoggingPreferences(options);
                 return options;
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/InternetExplorerSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/InternetExplorerSettings.cs
@@ -38,6 +38,7 @@ public override DriverOptions DriverOptions
                 SetCapabilities(options);
                 SetOptionsByPropertyNames(options);
                 SetPageLoadStrategy(options);
+                SetLoggingPreferences(options);
                 options.BrowserCommandLineArguments = string.Join(" ", BrowserStartArguments);
                 return options;
             }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/SafariSettings.cs b/Aquality.Selenium/src/Aquality.Selenium/Configurations/WebDriverSettings/SafariSettings.cs
@@ -28,6 +28,7 @@ public override DriverOptions DriverOptions
                 SetCapabilities(options);
                 SetOptionsByPropertyNames(options);
                 SetPageLoadStrategy(options);
+                SetLoggingPreferences(options);
                 return options;
             }
         }
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/be.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/be.json
@@ -5,6 +5,7 @@
   "loc.browser.forward": "Пераходзім да наступнай старонкі",
   "loc.browser.capabilities": "Атрымалі capabilities браўзэра з settings файла: {0}",
   "loc.browser.options": "Атрымалі опцыі профіля браўзэра з settings файла: {0}",
+  "loc.browser.loggingPreferences": "Атрымалі налады лагавання браўзэра з settings файла: {0}",
   "loc.browser.driver.quit": "Закрываем браўзэр",
   "loc.browser.getUrl": "Атрымліваем адрас бягучай старонкі",
   "loc.browser.url.value": "Адрас бягучай старонкі: [{0}]",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/en.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/en.json
@@ -5,6 +5,7 @@
   "loc.browser.forward": "Proceed to the next page",
   "loc.browser.capabilities": "Got browser capabilities from settings file: {0}",
   "loc.browser.options": "Got browser profile options from settings file: {0}",
+  "loc.browser.loggingPreferences": "Got browser logging preferences from settings file: {0}",
   "loc.browser.driver.quit": "Closing browser",
   "loc.browser.getUrl": "Getting current URL",
   "loc.browser.url.value": "Current URL: [{0}]",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/pl.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/pl.json
@@ -5,6 +5,7 @@
   "loc.browser.forward": "Przejście do następnej strony",
   "loc.browser.capabilities": "Pobrano możliwości przeglądarki z pliku ustawień: {0}",
   "loc.browser.options": "Pobrano opcje profilu przeglądarki z pliku ustawień: {0}",
+  "loc.browser.loggingPreferences": "Pobrano ustawienia logowania przeglądarki z pliku ustawień: {0}",
   "loc.browser.driver.quit": "Zamykanie przeglądarki",
   "loc.browser.getUrl": "Pobieranie aktualnego adresu URL",
   "loc.browser.url.value": "Aktualny adres URL: [{0}]",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/ru.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/ru.json
@@ -5,6 +5,7 @@
   "loc.browser.forward": "Перейти на следующую страницу",
   "loc.browser.capabilities": "Получили capabilities браузера из settings файла: {0}",
   "loc.browser.options": "Получили опции профиля браузера из settings файла: {0}",
+  "loc.browser.loggingPreferences": "Получили настройки логирования браузера из settings файла: {0}",
   "loc.browser.driver.quit": "Закрытие драйвера браузера",
   "loc.browser.getUrl": "Получение адреса текущей страницы",
   "loc.browser.url.value": "Адрес текущей страницы: [{0}]",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/uk.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/uk.json
@@ -5,6 +5,7 @@
   "loc.browser.forward": "Перехід до наступної сторінки",
   "loc.browser.capabilities": "Отримані можливості браузера з файлу налаштувань: {0}",
   "loc.browser.options": "Отримані параметри профілю браузера з файлу налаштувань: {0}",
+  "loc.browser.loggingPreferences": "Отримані налаштування логовання браузера з файлу налаштувань: {0}",
   "loc.browser.driver.quit": "Закриття браузера",
   "loc.browser.getUrl": "Отримання адреси поточної сторінки",
   "loc.browser.url.value": "Адреса поточної сторінки: [{0}]",
diff --git a/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json b/Aquality.Selenium/src/Aquality.Selenium/Resources/settings.json
@@ -19,6 +19,9 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "loggingPreferences": {
+          "Performance": "All"
+      },
       "excludedArguments": [ "enable-automation" ],
       "startArguments": [],
       "pageLoadStrategy": "Normal"
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Aquality.Selenium.Tests.csproj b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Aquality.Selenium.Tests.csproj
@@ -34,7 +34,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
   </ItemGroup>
 
   <ItemGroup>
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,6 +19,9 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "loggingPreferences": {
+          "Performance": "All"
+      },
       "excludedArguments": [ "enable-automation" ],
       "startArguments": [],
       "pageLoadStrategy": "Normal"
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,9 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "loggingPreferences": {
+          "Performance": "All"
+      },
       "excludedArguments": [ "enable-automation" ],
       "startArguments": [],
       "pageLoadStrategy": "Normal"
diff --git a/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.local.json b/Aquality.Selenium/tests/Aquality.Selenium.Tests/Resources/settings.local.json
@@ -18,6 +18,9 @@
         "download.prompt_for_download": "false",
         "download.default_directory": "./downloads"
       },
+      "loggingPreferences": {
+          "Performance": "All"
+      },
       "startArguments": [
         "--no-sandbox",
         "--headless",
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Aquality Automation
+   Copyright 2023 Aquality Automation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public override DriverOptions DriverOptions`
`32`	`32`	`SetChromeArguments(options);`
`33`	`33`	`SetChromeExcludedArguments(options);`
`34`	`34`	`SetPageLoadStrategy(options);`
	`35`	`+ SetLoggingPreferences(options);`
`35`	`36`	`return options;`
`36`	`37`	`}`
`37`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ public override DriverOptions DriverOptions`
`42`	`42`	`SetFirefoxPrefs(options);`
`43`	`43`	`SetFirefoxArguments(options);`
`44`	`44`	`SetPageLoadStrategy(options);`
	`45`	`+ SetLoggingPreferences(options);`
`45`	`46`	`return options;`
`46`	`47`	`}`
`47`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ public override DriverOptions DriverOptions`
`38`	`38`	`SetCapabilities(options);`
`39`	`39`	`SetOptionsByPropertyNames(options);`
`40`	`40`	`SetPageLoadStrategy(options);`
	`41`	`+ SetLoggingPreferences(options);`
`41`	`42`	`options.BrowserCommandLineArguments = string.Join(" ", BrowserStartArguments);`
`42`	`43`	`return options;`
`43`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ public override DriverOptions DriverOptions`
`28`	`28`	`SetCapabilities(options);`
`29`	`29`	`SetOptionsByPropertyNames(options);`
`30`	`30`	`SetPageLoadStrategy(options);`
	`31`	`+ SetLoggingPreferences(options);`
`31`	`32`	`return options;`
`32`	`33`	`}`
`33`	`34`	`}`