[dotnet] Do not warn when passing in null driver paths to driver service (#15328)

RenderMichael · web-flow · commit 4134f70a925e · 2025-02-25T14:09:53.000-05:00
* [dotnet] Do not warn when passing in null driver paths to driver service

* Clarify functionality of CreateDriverService

* fix XML comment for `EdgeDriverService`
diff --git a/dotnet/src/webdriver/Chrome/ChromeDriverService.cs b/dotnet/src/webdriver/Chrome/ChromeDriverService.cs
@@ -63,20 +63,22 @@ public static ChromeDriverService CreateDefaultService()
         /// </summary>
         /// <param name="driverPath">The path to the executable or the directory containing the ChromeDriver executable.</param>
         /// <returns>A ChromeDriverService using a random port.</returns>
-        public static ChromeDriverService CreateDefaultService(string driverPath)
+        public static ChromeDriverService CreateDefaultService(string? driverPath)
         {
-            string fileName;
             if (File.Exists(driverPath))
             {
-                fileName = Path.GetFileName(driverPath);
-                driverPath = Path.GetDirectoryName(driverPath)!;
+                string fileName = Path.GetFileName(driverPath);
+                string driverFolder = Path.GetDirectoryName(driverPath)!;
+
+                return CreateDefaultService(driverFolder, fileName);
             }
             else
             {
-                fileName = ChromiumDriverServiceFileName(DefaultChromeDriverServiceExecutableName);
-            }
+                string fileName = ChromiumDriverServiceFileName(DefaultChromeDriverServiceExecutableName);
+                string? driverFolder = driverPath;
 
-            return CreateDefaultService(driverPath, fileName);
+                return CreateDefaultService(driverFolder, fileName);
+            }
         }
 
         /// <summary>
@@ -85,7 +87,7 @@ public static ChromeDriverService CreateDefaultService(string driverPath)
         /// <param name="driverPath">The directory containing the ChromeDriver executable.</param>
         /// <param name="driverExecutableFileName">The name of the ChromeDriver executable file.</param>
         /// <returns>A ChromeDriverService using a random port.</returns>
-        public static ChromeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)
+        public static ChromeDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)
         {
             return new ChromeDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());
         }
diff --git a/dotnet/src/webdriver/Edge/EdgeDriverService.cs b/dotnet/src/webdriver/Edge/EdgeDriverService.cs
@@ -72,22 +72,24 @@ public static EdgeDriverService CreateDefaultService()
         /// <summary>
         /// Creates a default instance of the EdgeDriverService using a specified path to the EdgeDriver executable.
         /// </summary>
-        /// <param name="driverPath">The directory containing the EdgeDriver executable.</param>
+        /// <param name="driverPath">The path to the executable or the directory containing the EdgeDriver executable.</param>
         /// <returns>An EdgeDriverService using a random port.</returns>
-        public static EdgeDriverService CreateDefaultService(string driverPath)
+        public static EdgeDriverService CreateDefaultService(string? driverPath)
         {
-            string fileName;
             if (File.Exists(driverPath))
             {
-                fileName = Path.GetFileName(driverPath);
-                driverPath = Path.GetDirectoryName(driverPath)!;
+                string fileName = Path.GetFileName(driverPath);
+                string driverFolder = Path.GetDirectoryName(driverPath)!;
+
+                return CreateDefaultService(driverFolder, fileName);
             }
             else
             {
-                fileName = ChromiumDriverServiceFileName(MSEdgeDriverServiceFileName);
-            }
+                string fileName = ChromiumDriverServiceFileName(MSEdgeDriverServiceFileName);
+                string? driverFolder = driverPath;
 
-            return CreateDefaultService(driverPath, fileName);
+                return CreateDefaultService(driverFolder, fileName);
+            }
         }
 
         /// <summary>
@@ -96,7 +98,7 @@ public static EdgeDriverService CreateDefaultService(string driverPath)
         /// <param name="driverPath">The directory containing the EdgeDriver executable.</param>
         /// <param name="driverExecutableFileName">The name of the EdgeDriver executable file.</param>
         /// <returns>A EdgeDriverService using a random port.</returns>
-        public static EdgeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)
+        public static EdgeDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)
         {
             return new EdgeDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());
         }
diff --git a/dotnet/src/webdriver/Firefox/FirefoxDriverService.cs b/dotnet/src/webdriver/Firefox/FirefoxDriverService.cs
@@ -194,20 +194,22 @@ public static FirefoxDriverService CreateDefaultService()
         /// </summary>
         /// <param name="driverPath">The path to the executable or the directory containing the Firefox driver executable.</param>
         /// <returns>A FirefoxDriverService using a random port.</returns>
-        public static FirefoxDriverService CreateDefaultService(string driverPath)
+        public static FirefoxDriverService CreateDefaultService(string? driverPath)
         {
-            string fileName;
             if (File.Exists(driverPath))
             {
-                fileName = Path.GetFileName(driverPath);
-                driverPath = Path.GetDirectoryName(driverPath)!;
+                string fileName = Path.GetFileName(driverPath);
+                string driverFolder = Path.GetDirectoryName(driverPath)!;
+
+                return CreateDefaultService(driverFolder, fileName);
             }
             else
             {
-                fileName = FirefoxDriverServiceFileName();
-            }
+                string fileName = FirefoxDriverServiceFileName();
+                string? driverFolder = driverPath;
 
-            return CreateDefaultService(driverPath, fileName);
+                return CreateDefaultService(driverFolder, fileName);
+            }
         }
 
         /// <summary>
@@ -216,7 +218,7 @@ public static FirefoxDriverService CreateDefaultService(string driverPath)
         /// <param name="driverPath">The directory containing the Firefox driver executable.</param>
         /// <param name="driverExecutableFileName">The name of the Firefox driver executable file.</param>
         /// <returns>A FirefoxDriverService using a random port.</returns>
-        public static FirefoxDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)
+        public static FirefoxDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)
         {
             return new FirefoxDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());
         }
diff --git a/dotnet/src/webdriver/IE/InternetExplorerDriverService.cs b/dotnet/src/webdriver/IE/InternetExplorerDriverService.cs
@@ -138,20 +138,22 @@ public static InternetExplorerDriverService CreateDefaultService()
         /// </summary>
         /// <param name="driverPath">The path to the executable or the directory containing the <c>IEDriverServer</c> executable.</param>
         /// <returns>A InternetExplorerDriverService using a random port.</returns>
-        public static InternetExplorerDriverService CreateDefaultService(string driverPath)
+        public static InternetExplorerDriverService CreateDefaultService(string? driverPath)
         {
-            string fileName;
             if (File.Exists(driverPath))
             {
-                fileName = Path.GetFileName(driverPath);
-                driverPath = Path.GetDirectoryName(driverPath)!;
+                string fileName = Path.GetFileName(driverPath);
+                string driverFolder = Path.GetDirectoryName(driverPath)!;
+
+                return CreateDefaultService(driverFolder, fileName);
             }
             else
             {
-                fileName = InternetExplorerDriverServiceFileName;
-            }
+                string fileName = InternetExplorerDriverServiceFileName;
+                string? driverFolder = driverPath;
 
-            return CreateDefaultService(driverPath, fileName);
+                return CreateDefaultService(driverFolder, fileName);
+            }
         }
 
         /// <summary>
@@ -160,7 +162,7 @@ public static InternetExplorerDriverService CreateDefaultService(string driverPa
         /// <param name="driverPath">The directory containing the <c>IEDriverServer</c> executable.</param>
         /// <param name="driverExecutableFileName">The name of the <c>IEDriverServer</c> executable file.</param>
         /// <returns>A InternetExplorerDriverService using a random port.</returns>
-        public static InternetExplorerDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)
+        public static InternetExplorerDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)
         {
             return new InternetExplorerDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());
         }
diff --git a/dotnet/src/webdriver/Safari/SafariDriverService.cs b/dotnet/src/webdriver/Safari/SafariDriverService.cs
@@ -103,20 +103,22 @@ public static SafariDriverService CreateDefaultService()
         /// </summary>
         /// <param name="driverPath">The path to the executable or the directory containing the SafariDriver executable.</param>
         /// <returns>A SafariDriverService using a random port.</returns>
-        public static SafariDriverService CreateDefaultService(string driverPath)
+        public static SafariDriverService CreateDefaultService(string? driverPath)
         {
-            string fileName;
             if (File.Exists(driverPath))
             {
-                fileName = Path.GetFileName(driverPath);
-                driverPath = Path.GetDirectoryName(driverPath)!;
+                string fileName = Path.GetFileName(driverPath);
+                string driverFolder = Path.GetDirectoryName(driverPath)!;
+
+                return CreateDefaultService(driverFolder, fileName);
             }
             else
             {
-                fileName = DefaultSafariDriverServiceExecutableName;
-            }
+                string fileName = DefaultSafariDriverServiceExecutableName;
+                string? driverFolder = driverPath;
 
-            return CreateDefaultService(driverPath, fileName);
+                return CreateDefaultService(driverFolder, fileName);
+            }
         }
 
         /// <summary>
@@ -125,7 +127,7 @@ public static SafariDriverService CreateDefaultService(string driverPath)
         /// <param name="driverPath">The directory containing the SafariDriver executable.</param>
         /// <param name="driverExecutableFileName">The name of the SafariDriver executable file.</param>
         /// <returns>A SafariDriverService using a random port.</returns>
-        public static SafariDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)
+        public static SafariDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)
         {
             return new SafariDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());
         }

Original file line number	Diff line number	Diff line change
`@@ -63,20 +63,22 @@ public static ChromeDriverService CreateDefaultService()`
`63`	`63`	`/// </summary>`
`64`	`64`	`/// <param name="driverPath">The path to the executable or the directory containing the ChromeDriver executable.</param>`
`65`	`65`	`/// <returns>A ChromeDriverService using a random port.</returns>`
`66`		`- public static ChromeDriverService CreateDefaultService(string driverPath)`
	`66`	`+ public static ChromeDriverService CreateDefaultService(string? driverPath)`
`67`	`67`	`{`
`68`		`- string fileName;`
`69`	`68`	`if (File.Exists(driverPath))`
`70`	`69`	`{`
`71`		`- fileName = Path.GetFileName(driverPath);`
`72`		`- driverPath = Path.GetDirectoryName(driverPath)!;`
	`70`	`+ string fileName = Path.GetFileName(driverPath);`
	`71`	`+ string driverFolder = Path.GetDirectoryName(driverPath)!;`
	`72`	`+`
	`73`	`+ return CreateDefaultService(driverFolder, fileName);`
`73`	`74`	`}`
`74`	`75`	`else`
`75`	`76`	`{`
`76`		`- fileName = ChromiumDriverServiceFileName(DefaultChromeDriverServiceExecutableName);`
`77`		`- }`
	`77`	`+ string fileName = ChromiumDriverServiceFileName(DefaultChromeDriverServiceExecutableName);`
	`78`	`+ string? driverFolder = driverPath;`
`78`	`79`
`79`		`- return CreateDefaultService(driverPath, fileName);`
	`80`	`+ return CreateDefaultService(driverFolder, fileName);`
	`81`	`+ }`
`80`	`82`	`}`
`81`	`83`
`82`	`84`	`/// <summary>`
`@@ -85,7 +87,7 @@ public static ChromeDriverService CreateDefaultService(string driverPath)`
`85`	`87`	`/// <param name="driverPath">The directory containing the ChromeDriver executable.</param>`
`86`	`88`	`/// <param name="driverExecutableFileName">The name of the ChromeDriver executable file.</param>`
`87`	`89`	`/// <returns>A ChromeDriverService using a random port.</returns>`
`88`		`- public static ChromeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)`
	`90`	`+ public static ChromeDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)`
`89`	`91`	`{`
`90`	`92`	`return new ChromeDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());`
`91`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,22 +72,24 @@ public static EdgeDriverService CreateDefaultService()`
`72`	`72`	`/// <summary>`
`73`	`73`	`/// Creates a default instance of the EdgeDriverService using a specified path to the EdgeDriver executable.`
`74`	`74`	`/// </summary>`
`75`		`- /// <param name="driverPath">The directory containing the EdgeDriver executable.</param>`
	`75`	`+ /// <param name="driverPath">The path to the executable or the directory containing the EdgeDriver executable.</param>`
`76`	`76`	`/// <returns>An EdgeDriverService using a random port.</returns>`
`77`		`- public static EdgeDriverService CreateDefaultService(string driverPath)`
	`77`	`+ public static EdgeDriverService CreateDefaultService(string? driverPath)`
`78`	`78`	`{`
`79`		`- string fileName;`
`80`	`79`	`if (File.Exists(driverPath))`
`81`	`80`	`{`
`82`		`- fileName = Path.GetFileName(driverPath);`
`83`		`- driverPath = Path.GetDirectoryName(driverPath)!;`
	`81`	`+ string fileName = Path.GetFileName(driverPath);`
	`82`	`+ string driverFolder = Path.GetDirectoryName(driverPath)!;`
	`83`	`+`
	`84`	`+ return CreateDefaultService(driverFolder, fileName);`
`84`	`85`	`}`
`85`	`86`	`else`
`86`	`87`	`{`
`87`		`- fileName = ChromiumDriverServiceFileName(MSEdgeDriverServiceFileName);`
`88`		`- }`
	`88`	`+ string fileName = ChromiumDriverServiceFileName(MSEdgeDriverServiceFileName);`
	`89`	`+ string? driverFolder = driverPath;`
`89`	`90`
`90`		`- return CreateDefaultService(driverPath, fileName);`
	`91`	`+ return CreateDefaultService(driverFolder, fileName);`
	`92`	`+ }`
`91`	`93`	`}`
`92`	`94`
`93`	`95`	`/// <summary>`
`@@ -96,7 +98,7 @@ public static EdgeDriverService CreateDefaultService(string driverPath)`
`96`	`98`	`/// <param name="driverPath">The directory containing the EdgeDriver executable.</param>`
`97`	`99`	`/// <param name="driverExecutableFileName">The name of the EdgeDriver executable file.</param>`
`98`	`100`	`/// <returns>A EdgeDriverService using a random port.</returns>`
`99`		`- public static EdgeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)`
	`101`	`+ public static EdgeDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)`
`100`	`102`	`{`
`101`	`103`	`return new EdgeDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());`
`102`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -194,20 +194,22 @@ public static FirefoxDriverService CreateDefaultService()`
`194`	`194`	`/// </summary>`
`195`	`195`	`/// <param name="driverPath">The path to the executable or the directory containing the Firefox driver executable.</param>`
`196`	`196`	`/// <returns>A FirefoxDriverService using a random port.</returns>`
`197`		`- public static FirefoxDriverService CreateDefaultService(string driverPath)`
	`197`	`+ public static FirefoxDriverService CreateDefaultService(string? driverPath)`
`198`	`198`	`{`
`199`		`- string fileName;`
`200`	`199`	`if (File.Exists(driverPath))`
`201`	`200`	`{`
`202`		`- fileName = Path.GetFileName(driverPath);`
`203`		`- driverPath = Path.GetDirectoryName(driverPath)!;`
	`201`	`+ string fileName = Path.GetFileName(driverPath);`
	`202`	`+ string driverFolder = Path.GetDirectoryName(driverPath)!;`
	`203`	`+`
	`204`	`+ return CreateDefaultService(driverFolder, fileName);`
`204`	`205`	`}`
`205`	`206`	`else`
`206`	`207`	`{`
`207`		`- fileName = FirefoxDriverServiceFileName();`
`208`		`- }`
	`208`	`+ string fileName = FirefoxDriverServiceFileName();`
	`209`	`+ string? driverFolder = driverPath;`
`209`	`210`
`210`		`- return CreateDefaultService(driverPath, fileName);`
	`211`	`+ return CreateDefaultService(driverFolder, fileName);`
	`212`	`+ }`
`211`	`213`	`}`
`212`	`214`
`213`	`215`	`/// <summary>`
`@@ -216,7 +218,7 @@ public static FirefoxDriverService CreateDefaultService(string driverPath)`
`216`	`218`	`/// <param name="driverPath">The directory containing the Firefox driver executable.</param>`
`217`	`219`	`/// <param name="driverExecutableFileName">The name of the Firefox driver executable file.</param>`
`218`	`220`	`/// <returns>A FirefoxDriverService using a random port.</returns>`
`219`		`- public static FirefoxDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)`
	`221`	`+ public static FirefoxDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)`
`220`	`222`	`{`
`221`	`223`	`return new FirefoxDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());`
`222`	`224`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,20 +138,22 @@ public static InternetExplorerDriverService CreateDefaultService()`
`138`	`138`	`/// </summary>`
`139`	`139`	`/// <param name="driverPath">The path to the executable or the directory containing the <c>IEDriverServer</c> executable.</param>`
`140`	`140`	`/// <returns>A InternetExplorerDriverService using a random port.</returns>`
`141`		`- public static InternetExplorerDriverService CreateDefaultService(string driverPath)`
	`141`	`+ public static InternetExplorerDriverService CreateDefaultService(string? driverPath)`
`142`	`142`	`{`
`143`		`- string fileName;`
`144`	`143`	`if (File.Exists(driverPath))`
`145`	`144`	`{`
`146`		`- fileName = Path.GetFileName(driverPath);`
`147`		`- driverPath = Path.GetDirectoryName(driverPath)!;`
	`145`	`+ string fileName = Path.GetFileName(driverPath);`
	`146`	`+ string driverFolder = Path.GetDirectoryName(driverPath)!;`
	`147`	`+`
	`148`	`+ return CreateDefaultService(driverFolder, fileName);`
`148`	`149`	`}`
`149`	`150`	`else`
`150`	`151`	`{`
`151`		`- fileName = InternetExplorerDriverServiceFileName;`
`152`		`- }`
	`152`	`+ string fileName = InternetExplorerDriverServiceFileName;`
	`153`	`+ string? driverFolder = driverPath;`
`153`	`154`
`154`		`- return CreateDefaultService(driverPath, fileName);`
	`155`	`+ return CreateDefaultService(driverFolder, fileName);`
	`156`	`+ }`
`155`	`157`	`}`
`156`	`158`
`157`	`159`	`/// <summary>`
`@@ -160,7 +162,7 @@ public static InternetExplorerDriverService CreateDefaultService(string driverPa`
`160`	`162`	`/// <param name="driverPath">The directory containing the <c>IEDriverServer</c> executable.</param>`
`161`	`163`	`/// <param name="driverExecutableFileName">The name of the <c>IEDriverServer</c> executable file.</param>`
`162`	`164`	`/// <returns>A InternetExplorerDriverService using a random port.</returns>`
`163`		`- public static InternetExplorerDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)`
	`165`	`+ public static InternetExplorerDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)`
`164`	`166`	`{`
`165`	`167`	`return new InternetExplorerDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());`
`166`	`168`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,20 +103,22 @@ public static SafariDriverService CreateDefaultService()`
`103`	`103`	`/// </summary>`
`104`	`104`	`/// <param name="driverPath">The path to the executable or the directory containing the SafariDriver executable.</param>`
`105`	`105`	`/// <returns>A SafariDriverService using a random port.</returns>`
`106`		`- public static SafariDriverService CreateDefaultService(string driverPath)`
	`106`	`+ public static SafariDriverService CreateDefaultService(string? driverPath)`
`107`	`107`	`{`
`108`		`- string fileName;`
`109`	`108`	`if (File.Exists(driverPath))`
`110`	`109`	`{`
`111`		`- fileName = Path.GetFileName(driverPath);`
`112`		`- driverPath = Path.GetDirectoryName(driverPath)!;`
	`110`	`+ string fileName = Path.GetFileName(driverPath);`
	`111`	`+ string driverFolder = Path.GetDirectoryName(driverPath)!;`
	`112`	`+`
	`113`	`+ return CreateDefaultService(driverFolder, fileName);`
`113`	`114`	`}`
`114`	`115`	`else`
`115`	`116`	`{`
`116`		`- fileName = DefaultSafariDriverServiceExecutableName;`
`117`		`- }`
	`117`	`+ string fileName = DefaultSafariDriverServiceExecutableName;`
	`118`	`+ string? driverFolder = driverPath;`
`118`	`119`
`119`		`- return CreateDefaultService(driverPath, fileName);`
	`120`	`+ return CreateDefaultService(driverFolder, fileName);`
	`121`	`+ }`
`120`	`122`	`}`
`121`	`123`
`122`	`124`	`/// <summary>`
`@@ -125,7 +127,7 @@ public static SafariDriverService CreateDefaultService(string driverPath)`
`125`	`127`	`/// <param name="driverPath">The directory containing the SafariDriver executable.</param>`
`126`	`128`	`/// <param name="driverExecutableFileName">The name of the SafariDriver executable file.</param>`
`127`	`129`	`/// <returns>A SafariDriverService using a random port.</returns>`
`128`		`- public static SafariDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)`
	`130`	`+ public static SafariDriverService CreateDefaultService(string? driverPath, string? driverExecutableFileName)`
`129`	`131`	`{`
`130`	`132`	`return new SafariDriverService(driverPath, driverExecutableFileName, PortUtilities.FindFreePort());`
`131`	`133`	`}`