Passing options to Selenium Manager (#11866)

Author: diemol

dotnet/src/webdriver/Chromium/ChromiumDriver.cs

@@ -19,6 +19,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.IO;
 using OpenQA.Selenium.DevTools;
 using OpenQA.Selenium.Remote;
 
@@ -125,7 +126,7 @@ public class ChromiumDriver : WebDriver, ISupportsLogs, IDevTools
         /// <param name="options">The <see cref="ChromiumOptions"/> to be used with the ChromiumDriver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         protected ChromiumDriver(ChromiumDriverService service, ChromiumOptions options, TimeSpan commandTimeout)
-            : base(new DriverServiceCommandExecutor(service, commandTimeout), ConvertOptionsToCapabilities(options))
+            : base(new DriverServiceCommandExecutor(VerifyDriverServicePath(service, options), commandTimeout), ConvertOptionsToCapabilities(options))
         {
             this.optionsCapabilityName = options.CapabilityName;
         }
@@ -431,6 +432,15 @@ protected override void Dispose(bool disposing)
             base.Dispose(disposing);
         }
 
+        private static ChromiumDriverService VerifyDriverServicePath(ChromiumDriverService service, ChromiumOptions options)
+        {
+            string driverFullPath = DriverFinder.GetPath(service, options);
+            service.DriverServicePath = Path.GetDirectoryName(driverFullPath);
+            service.DriverServiceExecutableName = Path.GetFileName(driverFullPath);
+
+            return service;
+        }
+
         private static ICapabilities ConvertOptionsToCapabilities(ChromiumOptions options)
         {
             if (options == null)

dotnet/src/webdriver/DriverFinder.cs

@@ -0,0 +1,52 @@
+// <copyright file="SeleniumManager.cs" company="WebDriver Committers">
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using System.IO;
+
+namespace OpenQA.Selenium
+{
+    /// <summary>
+    /// Finds a driver, checks if the provided path exists, if not, Selenium Manager is used.
+    /// This implementation is still in beta, and may change.
+    /// </summary>
+    public static class DriverFinder
+    {
+        /// <summary>
+        /// Checks if the driver path exists, else uses Selenium Manager to return it.
+        /// </summary>
+        /// <param name="service">DriverService with the current path.</param>
+        /// <param name="options">DriverOptions with the current browser options.</param>
+        /// <returns>
+        /// The path of the driver.
+        /// </returns>
+        public static string GetPath(DriverService service, DriverOptions options)
+        {
+            string executablePath = Path.Combine(service.DriverServicePath, service.DriverServiceExecutableName);
+            if (File.Exists(executablePath)) return executablePath;
+            try
+            {
+                return SeleniumManager.DriverPath(options);
+            }
+            catch (Exception e)
+            {
+                throw new WebDriverException($"Unable to locate driver with path: {executablePath}, for more information on how to install drivers see https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/", e);
+            }
+        }
+    }
+}

dotnet/src/webdriver/DriverService.cs

@@ -58,33 +58,6 @@ public abstract class DriverService : ICommandServer
         /// </exception>
         protected DriverService(string servicePath, int port, string driverServiceExecutableName, Uri driverServiceDownloadUrl)
         {
-            if (string.IsNullOrEmpty(servicePath))
-            {
-                throw new ArgumentException("Path to locate driver executable cannot be null or empty.", nameof(servicePath));
-            }
-
-            string executablePath = Path.Combine(servicePath, driverServiceExecutableName);
-            if (!File.Exists(executablePath))
-            {
-                try
-                {
-                    executablePath = SeleniumManager.DriverPath(driverServiceExecutableName);
-                }
-                catch (Exception e)
-                {
-                  // No-op; entirely a fall-back feature
-                }
-
-                if (File.Exists(executablePath))
-                {
-                    servicePath = Path.GetDirectoryName(executablePath);
-                }
-                else
-                {
-                    throw new DriverServiceNotFoundException(string.Format(CultureInfo.InvariantCulture, "The file {0} does not exist. The driver can be downloaded at {1}", executablePath, driverServiceDownloadUrl));
-                }
-            }
-
             this.driverServicePath = servicePath;
             this.driverServiceExecutableName = driverServiceExecutableName;
             this.driverServicePort = port;
@@ -194,11 +167,21 @@ public TimeSpan InitializationTimeout
         }
 
         /// <summary>
-        /// Gets the executable file name of the driver service.
+        /// Gets or sets the executable file name of the driver service.
         /// </summary>
-        protected string DriverServiceExecutableName
+        public string DriverServiceExecutableName
         {
             get { return this.driverServiceExecutableName; }
+            set { this.driverServiceExecutableName = value; }
+        }
+
+        /// <summary>
+        /// Gets or sets the path of the driver service.
+        /// </summary>
+        public string DriverServicePath
+        {
+            get { return this.driverServicePath; }
+            set { this.driverServicePath = value; }
         }
 
         /// <summary>
@@ -312,28 +295,7 @@ public void Start()
         /// </exception>
         protected static string FindDriverServiceExecutable(string executableName, Uri downloadUrl)
         {
-            string serviceDirectory = FileUtilities.FindFile(executableName);
-
-            if (string.IsNullOrEmpty(serviceDirectory))
-            {
-                try
-                {
-                    serviceDirectory = Path.GetDirectoryName(SeleniumManager.DriverPath(executableName));
-                }
-                catch (Exception e)
-                {
-                    // No-op; entirely a fall-back feature
-                }
-
-                if (string.IsNullOrEmpty(serviceDirectory))
-                {
-                    throw new DriverServiceNotFoundException(string.Format(CultureInfo.InvariantCulture,
-                        "The {0} file does not exist in the current directory or in a directory on the PATH environment variable. The driver can be downloaded at {1}.",
-                        executableName, downloadUrl));
-                }
-            }
-
-            return serviceDirectory;
+            return FileUtilities.FindFile(executableName);
         }
 
         /// <summary>

dotnet/src/webdriver/Firefox/FirefoxDriver.cs

@@ -186,7 +186,7 @@ public FirefoxDriver(FirefoxDriverService service, FirefoxOptions options)
         /// <param name="options">The <see cref="FirefoxOptions"/> to be used with the Firefox driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public FirefoxDriver(FirefoxDriverService service, FirefoxOptions options, TimeSpan commandTimeout)
-            : base(new DriverServiceCommandExecutor(service, commandTimeout), ConvertOptionsToCapabilities(options))
+            : base(new DriverServiceCommandExecutor(VerifyDriverServicePath(service, options), commandTimeout), ConvertOptionsToCapabilities(options))
         {
             // Add the custom commands unique to Firefox
             this.AddCustomFirefoxCommands();
@@ -439,6 +439,15 @@ private static FirefoxDriverService CreateService(FirefoxOptions options)
             return FirefoxDriverService.CreateDefaultService();
         }
 
+        private static FirefoxDriverService VerifyDriverServicePath(FirefoxDriverService service, FirefoxOptions options)
+        {
+            string driverFullPath = DriverFinder.GetPath(service, options);
+            service.DriverServicePath = Path.GetDirectoryName(driverFullPath);
+            service.DriverServiceExecutableName = Path.GetFileName(driverFullPath);
+
+            return service;
+        }
+
         private void AddCustomFirefoxCommands()
         {
             foreach (KeyValuePair<string, CommandInfo> entry in CustomCommandDefinitions)

dotnet/src/webdriver/IE/InternetExplorerDriver.cs

@@ -17,8 +17,7 @@
 // </copyright>
 
 using System;
-using System.Collections.Generic;
-using OpenQA.Selenium.Internal;
+using System.IO;
 using OpenQA.Selenium.Remote;
 
 namespace OpenQA.Selenium.IE
@@ -142,7 +141,7 @@ public InternetExplorerDriver(InternetExplorerDriverService service, InternetExp
         /// <param name="options">The <see cref="InternetExplorerOptions"/> used to initialize the driver.</param>
         /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
         public InternetExplorerDriver(InternetExplorerDriverService service, InternetExplorerOptions options, TimeSpan commandTimeout)
-            : base(new DriverServiceCommandExecutor(service, commandTimeout), ConvertOptionsToCapabilities(options))
+            : base(new DriverServiceCommandExecutor(VerifyDriverServicePath(service, options), commandTimeout), ConvertOptionsToCapabilities(options))
         {
         }
 
@@ -162,6 +161,15 @@ public override IFileDetector FileDetector
             set { }
         }
 
+        private static InternetExplorerDriverService VerifyDriverServicePath(InternetExplorerDriverService service, InternetExplorerOptions options)
+        {
+            string driverFullPath = DriverFinder.GetPath(service, options);
+            service.DriverServicePath = Path.GetDirectoryName(driverFullPath);
+            service.DriverServiceExecutableName = Path.GetFileName(driverFullPath);
+
+            return service;
+        }
+
         private static ICapabilities ConvertOptionsToCapabilities(InternetExplorerOptions options)
         {
             if (options == null)

dotnet/src/webdriver/SeleniumManager.cs

@@ -37,12 +37,6 @@ namespace OpenQA.Selenium
     public static class SeleniumManager
     {
         private static string binary;
-        private static readonly List<string> KnownDrivers = new List<string>() {
-            "geckodriver",
-            "chromedriver",
-            "msedgedriver",
-            "IEDriverServer"
-        };
 
         /// <summary>
         /// Determines the location of the correct driver.
@@ -51,17 +45,12 @@ public static class SeleniumManager
         /// <returns>
         /// The location of the driver.
         /// </returns>
-        public static string DriverPath(string driverName)
+        public static string DriverPath(DriverOptions options)
         {
-            driverName = driverName.Replace(".exe", "");
-            if (!KnownDrivers.Contains(driverName))
-            {
-                throw new WebDriverException("Unable to locate driver with name: " + driverName);
-            }
             var binaryFile = Binary;
             if (binaryFile == null) return null;
 
-            var arguments = "--driver " + driverName + " --output json";
+            var arguments = "--browser " + options.BrowserName + " --output json";
             return RunCommand(binaryFile, arguments);
         }
 
@@ -143,7 +132,7 @@ private static string RunCommand(string fileName, string arguments)
             }
 
             string output = outputBuilder.ToString().Trim();
-            string result = "";
+            string result;
             try
             {
                 Dictionary<string, object> deserializedOutput = JsonConvert.DeserializeObject<Dictionary<string, object>>(output, new ResponseValueJsonConverter());

javascript/node/selenium-webdriver/chrome.js

@@ -130,7 +130,6 @@
 const io = require('./io')
 const { Browser } = require('./lib/capabilities')
 const chromium = require('./chromium')
-const { driverLocation } = require('./common/seleniumManager')
 
 /**
  * Name of the ChromeDriver executable.
@@ -158,23 +157,6 @@ class ServiceBuilder extends chromium.ServiceBuilder {
    */
   constructor(opt_exe) {
     let exe = opt_exe || locateSynchronously()
-
-    if (!exe) {
-      try {
-        exe = driverLocation(Browser.CHROME)
-      } catch (err) {
-        console.log(`Unable to obtain driver using Selenium Manager: ${err}`)
-      }
-    }
-
-    if (!exe) {
-      throw Error(
-        `ChromeDriver could not be found on the PATH.
-        For more information on how to install drivers see
-        https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/.`
-      )
-    }
-
     super(exe)
   }
 }

javascript/node/selenium-webdriver/chromium.js

@@ -83,6 +83,7 @@ const error = require('./lib/error')
 const Symbols = require('./lib/symbols')
 const webdriver = require('./lib/webdriver')
 const remote = require('./remote')
+const { getPath } = require('./common/driverFinder')
 
 /**
  * Custom command names supported by Chromium WebDriver.
@@ -684,6 +685,9 @@ class Driver extends webdriver.WebDriver {
       configureExecutor(executor, this.VENDOR_COMMAND_PREFIX)
     } else {
       let service = opt_serviceExecutor || this.getDefaultService()
+      if (!service.getExecutable()) {
+        service.setExecutable(getPath(service, caps))
+      }
       onQuit = () => service.kill()
       executor = createExecutor(service.start(), this.VENDOR_COMMAND_PREFIX)
     }

javascript/node/selenium-webdriver/common/driverFinder.js

@@ -0,0 +1,60 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+/**
+ *  This implementation is still in beta, and may change.
+ *
+ *  Utility to find if a given file is present and executable.
+ */
+
+const { driverLocation } = require('./seleniumManager')
+const fs = require('fs')
+
+/**
+ * Determines the path of the correct Selenium Manager binary
+ * @returns {string}
+ */
+function getPath(service, capabilities) {
+  try {
+    return pathExists(service.getExecutable()) ||
+           driverLocation(capabilities.getBrowserName())
+  } catch (e) {
+      throw Error(
+        `Unable to obtain browser driver.
+        For more information on how to install drivers see
+        https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/. ${e}`
+      )
+  }
+}
+
+/**
+ * _Synchronously_ attempts to locate the driver executable on the current
+ * system.
+ *
+ * @param {!string} driverPath
+ *
+ * @return {?string} the located executable, or `null`.
+ */
+function pathExists(driverPath) {
+  if (!driverPath || !fs.existsSync(driverPath)) {
+    return null
+  }
+  return driverPath
+}
+
+// PUBLIC API
+module.exports = { getPath }

javascript/node/selenium-webdriver/common/seleniumManager.js

@@ -30,7 +30,7 @@ const execSync = require('child_process').execSync
  * currently supported browsers for selenium-manager
  * @type {string[]}
  */
-const Browser = ['chrome', 'firefox', 'edge', 'iexplorer']
+const Browser = ['chrome', 'firefox', 'edge', 'MicrosoftEdge', 'iexplorer']
 
 /**
  * Determines the path of the correct Selenium Manager binary