[dotnet] add ability to turn on driver logging in tests

titusfortner · titusfortner · commit e9c7082dcf8a · 2023-08-27T10:13:47.000-05:00
diff --git a/dotnet/test/common/CustomDriverConfigs/StableChannelChromeDriver.cs b/dotnet/test/common/CustomDriverConfigs/StableChannelChromeDriver.cs
@@ -20,7 +20,7 @@ public StableChannelChromeDriver(ChromeDriverService service, ChromeOptions opti
 
         public static ChromeOptions DefaultOptions
         {
-            get { return new ChromeOptions() { AcceptInsecureCertificates = true, BrowserVersion = "116" }; }
+            get { return new ChromeOptions() { BrowserVersion = "116" }; }
         }
     }
 }
diff --git a/dotnet/test/common/CustomDriverConfigs/StableChannelEdgeDriver.cs b/dotnet/test/common/CustomDriverConfigs/StableChannelEdgeDriver.cs
@@ -20,7 +20,7 @@ public StableChannelEdgeDriver(EdgeDriverService service, EdgeOptions options)
         }
         public static EdgeOptions DefaultOptions
         {
-            get { return new EdgeOptions() { AcceptInsecureCertificates = true }; }
+            get { return new EdgeOptions(); }
         }
     }
 }
diff --git a/dotnet/test/common/Environment/DriverConfig.cs b/dotnet/test/common/Environment/DriverConfig.cs
@@ -26,5 +26,8 @@ public class DriverConfig
 
         [JsonProperty]
         public bool AutoStartRemoteServer { get; set; }
+
+        [JsonProperty]
+        public bool Logging { get; set; }
     }
 }
diff --git a/dotnet/test/common/Environment/DriverFactory.cs b/dotnet/test/common/Environment/DriverFactory.cs
@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using OpenQA.Selenium.Chromium;
 
 namespace OpenQA.Selenium.Environment
 {
@@ -40,16 +41,17 @@ private void PopulateServiceTypes()
 
         public event EventHandler<DriverStartingEventArgs> DriverStarting;
 
-        public IWebDriver CreateDriver(Type driverType)
+        public IWebDriver CreateDriver(Type driverType, bool logging = false)
         {
-            return CreateDriverWithOptions(driverType, null);
+            return CreateDriverWithOptions(driverType, null, logging);
         }
 
-        public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverOptions)
+        public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverOptions, bool logging = false)
         {
             Browser browser = Browser.All;
             DriverService service = null;
             DriverOptions options = null;
+            bool enableLogging = logging;
 
             List<Type> constructorArgTypeList = new List<Type>();
             IWebDriver driver = null;
@@ -58,24 +60,40 @@ public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverO
                 browser = Browser.Chrome;
                 options = GetDriverOptions<ChromeOptions>(driverType, driverOptions);
                 service = CreateService<ChromeDriverService>();
+                if (enableLogging)
+                {
+                    ((ChromiumDriverService)service).EnableVerboseLogging = true;
+                }
             }
             else if (typeof(EdgeDriver).IsAssignableFrom(driverType))
             {
                 browser = Browser.Edge;
                 options = GetDriverOptions<EdgeOptions>(driverType, driverOptions);
                 service = CreateService<EdgeDriverService>();
+                if (enableLogging)
+                {
+                    ((ChromiumDriverService)service).EnableVerboseLogging = true;
+                }
             }
             else if (typeof(InternetExplorerDriver).IsAssignableFrom(driverType))
             {
                 browser = Browser.IE;
                 options = GetDriverOptions<InternetExplorerOptions>(driverType, driverOptions);
                 service = CreateService<InternetExplorerDriverService>();
+                if (enableLogging)
+                {
+                    ((InternetExplorerDriverService)service).LoggingLevel = InternetExplorerDriverLogLevel.Trace;
+                }
             }
             else if (typeof(FirefoxDriver).IsAssignableFrom(driverType))
             {
                 browser = Browser.Firefox;
                 options = GetDriverOptions<FirefoxOptions>(driverType, driverOptions);
                 service = CreateService<FirefoxDriverService>();
+                if (enableLogging)
+                {
+                    ((FirefoxDriverService)service).LogLevel = FirefoxDriverLogLevel.Trace;
+                }
             }
             else if (typeof(SafariDriver).IsAssignableFrom(driverType))
             {
diff --git a/dotnet/test/common/Environment/EnvironmentManager.cs b/dotnet/test/common/Environment/EnvironmentManager.cs
@@ -17,6 +17,7 @@ public class EnvironmentManager
         private DriverFactory driverFactory;
         private RemoteSeleniumServer remoteServer;
         private string remoteCapabilities;
+        private bool logging;
 
         private EnvironmentManager()
         {
@@ -52,6 +53,7 @@ private EnvironmentManager()
             driverType = driverAssembly.GetType(driverConfig.DriverTypeName);
             browser = driverConfig.BrowserValue;
             remoteCapabilities = driverConfig.RemoteCapabilities;
+            logging = driverConfig.Logging;
 
             urlBuilder = new UrlBuilder(websiteConfig);
 
@@ -190,6 +192,11 @@ public string RemoteCapabilities
             get { return remoteCapabilities; }
         }
 
+        public bool Logging
+        {
+            get { return logging; }
+        }
+
         public UrlBuilder UrlBuilder
         {
             get
@@ -210,12 +217,12 @@ public IWebDriver GetCurrentDriver()
 
         public IWebDriver CreateDriverInstance()
         {
-            return driverFactory.CreateDriver(driverType);
+            return driverFactory.CreateDriver(driverType, Logging);
         }
 
         public IWebDriver CreateDriverInstance(DriverOptions options)
         {
-            return driverFactory.CreateDriverWithOptions(driverType, options);
+            return driverFactory.CreateDriverWithOptions(driverType, options, Logging);
         }
 
         public IWebDriver CreateFreshDriver()
diff --git a/dotnet/test/common/appconfig.json b/dotnet/test/common/appconfig.json
@@ -27,71 +27,81 @@
       "DriverTypeName": "OpenQA.Selenium.Chrome.StableChannelChromeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Chrome",
-      "RemoteCapabilities": "chrome"
+      "RemoteCapabilities": "chrome",
+      "Logging": false
     },
 
     "ChromeDev": {
       "DriverTypeName": "OpenQA.Selenium.Chrome.DevChannelChromeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Chrome",
-      "RemoteCapabilities": "chrome"
+      "RemoteCapabilities": "chrome",
+      "Logging": false
     },
 
     "EdgeIEMode": {
       "DriverTypeName": "OpenQA.Selenium.IE.EdgeInternetExplorerModeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "IE",
-      "RemoteCapabilities": "internet explorer"
+      "RemoteCapabilities": "internet explorer",
+      "Logging": false
     },
 
     "Edge": {
       "DriverTypeName": "OpenQA.Selenium.Edge.StableChannelEdgeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Edge",
-      "RemoteCapabilities": "MicrosoftEdge"
+      "RemoteCapabilities": "MicrosoftEdge",
+      "Logging": false
     },
 
     "EdgeDev": {
       "DriverTypeName": "OpenQA.Selenium.Edge.DevChannelEdgeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Edge",
-      "RemoteCapabilities": "MicrosoftEdge"
+      "RemoteCapabilities": "MicrosoftEdge",
+      "Logging": false
     },
 
     "Firefox": {
       "DriverTypeName": "OpenQA.Selenium.Firefox.StableChannelFirefoxDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Firefox",
-      "RemoteCapabilities": "firefox"
+      "RemoteCapabilities": "firefox",
+      "Logging": false
     },
 
     "FirefoxNightly": {
       "DriverTypeName": "OpenQA.Selenium.Firefox.NightlyChannelFirefoxDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Firefox",
-      "RemoteCapabilities": "firefox"
+      "RemoteCapabilities": "firefox",
+      "Logging": false
     },
 
     "Safari": {
       "DriverTypeName": "OpenQA.Selenium.Safari.DefaultSafariDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Safari",
-      "RemoteCapabilities": "safari"
+      "RemoteCapabilities": "safari",
+      "Logging": false
     },
 
     "SafariTechPreview": {
       "DriverTypeName": "OpenQA.Selenium.Safari.SafariTechnologyPreviewDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Safari",
-      "RemoteCapabilities": "safari"
+      "RemoteCapabilities": "safari",
+      "Logging": false
     },
 
     "Remote": {
       "DriverTypeName": "OpenQA.Selenium.Remote.StableChannelRemoteChromeDriver",
       "AssemblyName": "WebDriver.Common.Tests",
       "BrowserValue": "Remote",
       "RemoteCapabilities": "chrome",
-      "AutoStartRemoteServer": true
+      "AutoStartRemoteServer": true,
+      "Logging": false
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public StableChannelChromeDriver(ChromeDriverService service, ChromeOptions opti`
`20`	`20`
`21`	`21`	`public static ChromeOptions DefaultOptions`
`22`	`22`	`{`
`23`		`- get { return new ChromeOptions() { AcceptInsecureCertificates = true, BrowserVersion = "116" }; }`
	`23`	`+ get { return new ChromeOptions() { BrowserVersion = "116" }; }`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public StableChannelEdgeDriver(EdgeDriverService service, EdgeOptions options)`
`20`	`20`	`}`
`21`	`21`	`public static EdgeOptions DefaultOptions`
`22`	`22`	`{`
`23`		`- get { return new EdgeOptions() { AcceptInsecureCertificates = true }; }`
	`23`	`+ get { return new EdgeOptions(); }`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,8 @@ public class DriverConfig`
`26`	`26`
`27`	`27`	`[JsonProperty]`
`28`	`28`	`public bool AutoStartRemoteServer { get; set; }`
	`29`	`+`
	`30`	`+ [JsonProperty]`
	`31`	`+ public bool Logging { get; set; }`
`29`	`32`	`}`
`30`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using System;`
`7`	`7`	`using System.Collections.Generic;`
`8`	`8`	`using System.Reflection;`
	`9`	`+using OpenQA.Selenium.Chromium;`
`9`	`10`
`10`	`11`	`namespace OpenQA.Selenium.Environment`
`11`	`12`	`{`
`@@ -40,16 +41,17 @@ private void PopulateServiceTypes()`
`40`	`41`
`41`	`42`	`public event EventHandler<DriverStartingEventArgs> DriverStarting;`
`42`	`43`
`43`		`- public IWebDriver CreateDriver(Type driverType)`
	`44`	`+ public IWebDriver CreateDriver(Type driverType, bool logging = false)`
`44`	`45`	`{`
`45`		`- return CreateDriverWithOptions(driverType, null);`
	`46`	`+ return CreateDriverWithOptions(driverType, null, logging);`
`46`	`47`	`}`
`47`	`48`
`48`		`- public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverOptions)`
	`49`	`+ public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverOptions, bool logging = false)`
`49`	`50`	`{`
`50`	`51`	`Browser browser = Browser.All;`
`51`	`52`	`DriverService service = null;`
`52`	`53`	`DriverOptions options = null;`
	`54`	`+ bool enableLogging = logging;`
`53`	`55`
`54`	`56`	`List<Type> constructorArgTypeList = new List<Type>();`
`55`	`57`	`IWebDriver driver = null;`
`@@ -58,24 +60,40 @@ public IWebDriver CreateDriverWithOptions(Type driverType, DriverOptions driverO`
`58`	`60`	`browser = Browser.Chrome;`
`59`	`61`	`options = GetDriverOptions<ChromeOptions>(driverType, driverOptions);`
`60`	`62`	`service = CreateService<ChromeDriverService>();`
	`63`	`+ if (enableLogging)`
	`64`	`+ {`
	`65`	`+ ((ChromiumDriverService)service).EnableVerboseLogging = true;`
	`66`	`+ }`
`61`	`67`	`}`
`62`	`68`	`else if (typeof(EdgeDriver).IsAssignableFrom(driverType))`
`63`	`69`	`{`
`64`	`70`	`browser = Browser.Edge;`
`65`	`71`	`options = GetDriverOptions<EdgeOptions>(driverType, driverOptions);`
`66`	`72`	`service = CreateService<EdgeDriverService>();`
	`73`	`+ if (enableLogging)`
	`74`	`+ {`
	`75`	`+ ((ChromiumDriverService)service).EnableVerboseLogging = true;`
	`76`	`+ }`
`67`	`77`	`}`
`68`	`78`	`else if (typeof(InternetExplorerDriver).IsAssignableFrom(driverType))`
`69`	`79`	`{`
`70`	`80`	`browser = Browser.IE;`
`71`	`81`	`options = GetDriverOptions<InternetExplorerOptions>(driverType, driverOptions);`
`72`	`82`	`service = CreateService<InternetExplorerDriverService>();`
	`83`	`+ if (enableLogging)`
	`84`	`+ {`
	`85`	`+ ((InternetExplorerDriverService)service).LoggingLevel = InternetExplorerDriverLogLevel.Trace;`
	`86`	`+ }`
`73`	`87`	`}`
`74`	`88`	`else if (typeof(FirefoxDriver).IsAssignableFrom(driverType))`
`75`	`89`	`{`
`76`	`90`	`browser = Browser.Firefox;`
`77`	`91`	`options = GetDriverOptions<FirefoxOptions>(driverType, driverOptions);`
`78`	`92`	`service = CreateService<FirefoxDriverService>();`
	`93`	`+ if (enableLogging)`
	`94`	`+ {`
	`95`	`+ ((FirefoxDriverService)service).LogLevel = FirefoxDriverLogLevel.Trace;`
	`96`	`+ }`
`79`	`97`	`}`
`80`	`98`	`else if (typeof(SafariDriver).IsAssignableFrom(driverType))`
`81`	`99`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ public class EnvironmentManager`
`17`	`17`	`private DriverFactory driverFactory;`
`18`	`18`	`private RemoteSeleniumServer remoteServer;`
`19`	`19`	`private string remoteCapabilities;`
	`20`	`+ private bool logging;`
`20`	`21`
`21`	`22`	`private EnvironmentManager()`
`22`	`23`	`{`
`@@ -52,6 +53,7 @@ private EnvironmentManager()`
`52`	`53`	`driverType = driverAssembly.GetType(driverConfig.DriverTypeName);`
`53`	`54`	`browser = driverConfig.BrowserValue;`
`54`	`55`	`remoteCapabilities = driverConfig.RemoteCapabilities;`
	`56`	`+ logging = driverConfig.Logging;`
`55`	`57`
`56`	`58`	`urlBuilder = new UrlBuilder(websiteConfig);`
`57`	`59`
`@@ -190,6 +192,11 @@ public string RemoteCapabilities`
`190`	`192`	`get { return remoteCapabilities; }`
`191`	`193`	`}`
`192`	`194`
	`195`	`+ public bool Logging`
	`196`	`+ {`
	`197`	`+ get { return logging; }`
	`198`	`+ }`
	`199`	`+`
`193`	`200`	`public UrlBuilder UrlBuilder`
`194`	`201`	`{`
`195`	`202`	`get`
`@@ -210,12 +217,12 @@ public IWebDriver GetCurrentDriver()`
`210`	`217`
`211`	`218`	`public IWebDriver CreateDriverInstance()`
`212`	`219`	`{`
`213`		`- return driverFactory.CreateDriver(driverType);`
	`220`	`+ return driverFactory.CreateDriver(driverType, Logging);`
`214`	`221`	`}`
`215`	`222`
`216`	`223`	`public IWebDriver CreateDriverInstance(DriverOptions options)`
`217`	`224`	`{`
`218`		`- return driverFactory.CreateDriverWithOptions(driverType, options);`
	`225`	`+ return driverFactory.CreateDriverWithOptions(driverType, options, Logging);`
`219`	`226`	`}`
`220`	`227`
`221`	`228`	`public IWebDriver CreateFreshDriver()`