[py] use Selenium Manager to locate drivers on PATH (#12356)

titusfortner · diemol · web-flow · commit 6176d7ec6541 · 2023-07-13T11:10:12.000+02:00
Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/py/selenium/webdriver/chrome/service.py b/py/selenium/webdriver/chrome/service.py
@@ -19,8 +19,6 @@
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.chromium import service
 
-DEFAULT_EXECUTABLE_PATH = "chromedriver"
-
 
 class Service(service.ChromiumService):
     """A Service class that is responsible for the starting and stopping of
@@ -35,7 +33,7 @@ class Service(service.ChromiumService):
 
     def __init__(
         self,
-        executable_path: str = DEFAULT_EXECUTABLE_PATH,
+        executable_path=None,
         port: int = 0,
         service_args: typing.Optional[typing.List[str]] = None,
         log_path: typing.Optional[str] = None,
diff --git a/py/selenium/webdriver/chrome/webdriver.py b/py/selenium/webdriver/chrome/webdriver.py
@@ -17,7 +17,6 @@
 
 from selenium.webdriver.chromium.webdriver import ChromiumDriver
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
-from selenium.webdriver.common.driver_finder import DriverFinder
 
 from .options import Options
 from .service import Service
@@ -40,16 +39,13 @@ def __init__(
          - service - Service object for handling the browser driver if you need to pass extra details
          - keep_alive - Whether to configure ChromeRemoteConnection to use HTTP keep-alive.
         """
-        self.service = service if service else Service()
-        self.options = options if options else Options()
-        self.keep_alive = keep_alive
-
-        self.service.path = DriverFinder.get_path(self.service, self.options)
+        service = service if service else Service()
+        options = options if options else Options()
 
         super().__init__(
             DesiredCapabilities.CHROME["browserName"],
             "goog",
-            self.options,
-            self.service,
-            self.keep_alive,
+            options,
+            service,
+            keep_alive,
         )
diff --git a/py/selenium/webdriver/chromium/service.py b/py/selenium/webdriver/chromium/service.py
@@ -37,7 +37,7 @@ class ChromiumService(service.Service):
 
     def __init__(
         self,
-        executable_path: str,
+        executable_path: str = None,
         port: int = 0,
         service_args: typing.Optional[typing.List[str]] = None,
         log_path: typing.Optional[str] = None,
diff --git a/py/selenium/webdriver/chromium/webdriver.py b/py/selenium/webdriver/chromium/webdriver.py
@@ -16,6 +16,7 @@
 # under the License.
 
 from selenium.webdriver.chromium.remote_connection import ChromiumRemoteConnection
+from selenium.webdriver.common.driver_finder import DriverFinder
 from selenium.webdriver.common.options import ArgOptions
 from selenium.webdriver.common.service import Service
 from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
@@ -46,7 +47,8 @@ def __init__(
         self.vendor_prefix = vendor_prefix
 
         self.service = service
-        self.options = options
+
+        self.service.path = DriverFinder.get_path(self.service, options)
 
         self.service.start()
 
@@ -57,9 +59,9 @@ def __init__(
                     browser_name=browser_name,
                     vendor_prefix=vendor_prefix,
                     keep_alive=keep_alive,
-                    ignore_proxy=self.options._ignore_local_proxy,
+                    ignore_proxy=options._ignore_local_proxy,
                 ),
-                options=self.options,
+                options=options,
             )
         except Exception:
             self.quit()
diff --git a/py/selenium/webdriver/common/driver_finder.py b/py/selenium/webdriver/common/driver_finder.py
@@ -15,7 +15,6 @@
 # specific language governing permissions and limitations
 # under the License.
 import logging
-import shutil
 from pathlib import Path
 
 from selenium.common.exceptions import NoSuchDriverException
@@ -34,13 +33,14 @@ class DriverFinder:
 
     @staticmethod
     def get_path(service: Service, options: BaseOptions) -> str:
-        path = shutil.which(service.path)
+        path = service.path
         try:
             path = SeleniumManager().driver_location(options) if path is None else path
         except Exception as err:
-            raise NoSuchDriverException(f"Unable to obtain {service.path} using Selenium Manager; {err}")
+            msg = f"Unable to obtain driver for {options.capabilities['browserName']} using Selenium Manager; {err}"
+            raise NoSuchDriverException(msg)
 
         if path is None or not Path(path).is_file():
-            raise NoSuchDriverException(f"Unable to locate or obtain {service.path}")
+            raise NoSuchDriverException(f"Unable to locate or obtain driver for {options.capabilities['browserName']}")
 
         return path
diff --git a/py/selenium/webdriver/common/service.py b/py/selenium/webdriver/common/service.py
@@ -50,7 +50,7 @@ class Service(ABC):
 
     def __init__(
         self,
-        executable: str,
+        executable: str = None,
         port: int = 0,
         log_file: SubprocessStdAlias = None,
         log_output: SubprocessStdAlias = None,
diff --git a/py/selenium/webdriver/edge/service.py b/py/selenium/webdriver/edge/service.py
@@ -20,8 +20,6 @@
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.chromium import service
 
-DEFAULT_EXECUTABLE_PATH = "msedgedriver"
-
 
 class Service(service.ChromiumService):
     """A Service class that is responsible for the starting and stopping of
@@ -38,7 +36,7 @@ class Service(service.ChromiumService):
 
     def __init__(
         self,
-        executable_path: str = DEFAULT_EXECUTABLE_PATH,
+        executable_path: str = None,
         port: int = 0,
         verbose: bool = False,
         log_path: typing.Optional[str] = None,
diff --git a/py/selenium/webdriver/edge/webdriver.py b/py/selenium/webdriver/edge/webdriver.py
@@ -17,7 +17,6 @@
 
 from selenium.webdriver.chromium.webdriver import ChromiumDriver
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
-from selenium.webdriver.common.driver_finder import DriverFinder
 
 from .options import Options
 from .service import Service
@@ -40,16 +39,13 @@ def __init__(
          - service - Service object for handling the browser driver if you need to pass extra details
          - keep_alive - Whether to configure EdgeRemoteConnection to use HTTP keep-alive.
         """
-        self.service = service if service else Service()
-        self.options = options if options else Options()
-        self.keep_alive = keep_alive
-
-        self.service.path = DriverFinder.get_path(self.service, self.options)
+        service = service if service else Service()
+        options = options if options else Options()
 
         super().__init__(
             DesiredCapabilities.EDGE["browserName"],
             "ms",
-            self.options,
-            self.service,
-            self.keep_alive,
+            options,
+            service,
+            keep_alive,
         )
diff --git a/py/selenium/webdriver/firefox/service.py b/py/selenium/webdriver/firefox/service.py
@@ -22,8 +22,6 @@
 from selenium.webdriver.common import service
 from selenium.webdriver.common import utils
 
-DEFAULT_EXECUTABLE_PATH = "geckodriver"
-
 
 class Service(service.Service):
     """A Service class that is responsible for the starting and stopping of
@@ -39,7 +37,7 @@ class Service(service.Service):
 
     def __init__(
         self,
-        executable_path: str = DEFAULT_EXECUTABLE_PATH,
+        executable_path: str = None,
         port: int = 0,
         service_args: typing.Optional[typing.List[str]] = None,
         log_path: typing.Optional[str] = None,
diff --git a/py/selenium/webdriver/firefox/webdriver.py b/py/selenium/webdriver/firefox/webdriver.py
@@ -54,18 +54,17 @@ def __init__(
         """
 
         self.service = service if service else Service()
-        self.options = options if options else Options()
-        self.keep_alive = keep_alive
+        options = options if options else Options()
 
-        self.service.path = DriverFinder.get_path(self.service, self.options)
+        self.service.path = DriverFinder.get_path(self.service, options)
         self.service.start()
 
         executor = FirefoxRemoteConnection(
             remote_server_addr=self.service.service_url,
-            ignore_proxy=self.options._ignore_local_proxy,
-            keep_alive=self.keep_alive,
+            ignore_proxy=options._ignore_local_proxy,
+            keep_alive=keep_alive,
         )
-        super().__init__(command_executor=executor, options=self.options)
+        super().__init__(command_executor=executor, options=options)
 
         self._is_remote = False
 
diff --git a/py/selenium/webdriver/ie/service.py b/py/selenium/webdriver/ie/service.py
@@ -21,15 +21,13 @@
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.common import service
 
-DEFAULT_EXECUTABLE_PATH = "IEDriverServer.exe"
-
 
 class Service(service.Service):
     """Object that manages the starting and stopping of the IEDriver."""
 
     def __init__(
         self,
-        executable_path: str = DEFAULT_EXECUTABLE_PATH,
+        executable_path: str = None,
         port: int = 0,
         host: typing.Optional[str] = None,
         service_args: typing.Optional[typing.List[str]] = None,
diff --git a/py/selenium/webdriver/ie/webdriver.py b/py/selenium/webdriver/ie/webdriver.py
@@ -43,25 +43,21 @@ def __init__(
          - keep_alive - Deprecated: Whether to configure RemoteConnection to use HTTP keep-alive.
         """
 
-        self.iedriver = service if service else Service()
-        self.options = options if options else Options()
-        self.keep_alive = keep_alive
+        self.service = service if service else Service()
+        options = options if options else Options()
 
-        self.iedriver.path = DriverFinder.get_path(self.iedriver, self.options)
-        self.iedriver.start()
+        self.service.path = DriverFinder.get_path(self.service, options)
+        self.service.start()
 
         executor = RemoteConnection(
-            remote_server_addr=self.iedriver.service_url,
-            keep_alive=self.keep_alive,
-            ignore_proxy=self.options._ignore_local_proxy,
+            remote_server_addr=self.service.service_url,
+            keep_alive=keep_alive,
+            ignore_proxy=options._ignore_local_proxy,
         )
 
-        super().__init__(command_executor=executor, options=self.options)
+        super().__init__(command_executor=executor, options=options)
         self._is_remote = False
 
     def quit(self) -> None:
         super().quit()
-        self.iedriver.stop()
-
-    def create_options(self) -> Options:
-        return Options()
+        self.service.stop()
diff --git a/py/selenium/webdriver/safari/service.py b/py/selenium/webdriver/safari/service.py
@@ -15,14 +15,11 @@
 # specific language governing permissions and limitations
 # under the License.
 
-import os
 import typing
 import warnings
 
 from selenium.webdriver.common import service
 
-DEFAULT_EXECUTABLE_PATH: str = "/usr/bin/safaridriver"
-
 
 class Service(service.Service):
     """A Service class that is responsible for the starting and stopping of
@@ -37,15 +34,14 @@ class Service(service.Service):
 
     def __init__(
         self,
-        executable_path: str = DEFAULT_EXECUTABLE_PATH,
+        executable_path: str = None,
         port: int = 0,
         quiet: bool = None,
         service_args: typing.Optional[typing.List[str]] = None,
         env: typing.Optional[typing.Mapping[str, str]] = None,
         reuse_service=False,
         **kwargs,
     ) -> None:
-        self._check_executable(executable_path)
         self.service_args = service_args or []
         if quiet is not None:
             warnings.warn("quiet is no longer needed to supress output", DeprecationWarning, stacklevel=2)
@@ -58,15 +54,6 @@ def __init__(
             **kwargs,
         )
 
-    @staticmethod
-    def _check_executable(executable_path) -> None:
-        if not os.path.exists(executable_path):
-            if "Safari Technology Preview" in executable_path:
-                message = "Safari Technology Preview does not seem to be installed. You can download it at https://developer.apple.com/safari/download/."
-            else:
-                message = "SafariDriver was not found; are you running Safari 10 or later? You can download Safari at https://developer.apple.com/safari/download/."
-            raise Exception(message)
-
     def command_line_args(self) -> typing.List[str]:
         return ["-p", f"{self.port}"] + self.service_args
 
diff --git a/py/selenium/webdriver/safari/webdriver.py b/py/selenium/webdriver/safari/webdriver.py
@@ -22,6 +22,7 @@
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
 
+from ..common.driver_finder import DriverFinder
 from .options import Options
 from .remote_connection import SafariRemoteConnection
 from .service import Service
@@ -57,20 +58,21 @@ def __init__(
             )
 
         self.service = service if service else Service()
-        self.options = options if options else Options()
-        self.keep_alive = keep_alive
+        options = options if options else Options()
+
+        self.service.path = DriverFinder.get_path(self.service, options)
 
         self._reuse_service = reuse_service and self.service.reuse_service
         if not self._reuse_service:
             self.service.start()
 
         executor = SafariRemoteConnection(
             remote_server_addr=self.service.service_url,
-            keep_alive=self.keep_alive,
-            ignore_proxy=self.options._ignore_local_proxy,
+            keep_alive=keep_alive,
+            ignore_proxy=options._ignore_local_proxy,
         )
 
-        super().__init__(command_executor=executor, options=self.options)
+        super().__init__(command_executor=executor, options=options)
 
         self._is_remote = False
 
diff --git a/py/test/selenium/webdriver/common/selenium_manager_tests.py b/py/test/selenium/webdriver/common/selenium_manager_tests.py
@@ -99,6 +99,6 @@ def test_driver_finder_error(mocker):
 
     service = Service()
     options = Options()
-    msg = r"Unable to locate or obtain chromedriver.*errors\/driver_location"
+    msg = r"Unable to locate or obtain driver for chrome.*errors\/driver_location"
     with pytest.raises(WebDriverException, match=msg):
         DriverFinder.get_path(service, options)
