[py] User Server class in conftest

Author: cgoldberg

py/conftest.py

@@ -17,14 +17,11 @@
 
 import os
 import platform
-import socket
-import subprocess
-import time
-from urllib.request import urlopen
 
 import pytest
 
 from selenium import webdriver
+from selenium.webdriver.remote.server import Server
 from test.selenium.webdriver.common.network import get_lan_ip
 from test.selenium.webdriver.common.webserver import SimpleWebServer
 
@@ -125,7 +122,7 @@ def driver(request):
 
     # skip tests in the 'remote' directory if run with a local driver
     if request.node.path.parts[-2] == "remote" and driver_class != "Remote":
-        pytest.skip(f"Remote tests can't be run with driver '{driver_option}'")
+        pytest.skip(f"Remote tests can't be run with driver '{driver_option.lower()}'")
 
     # skip tests that can't run on certain platforms
     _platform = platform.system()
@@ -295,60 +292,21 @@ def server(request):
         yield None
         return
 
-    _host = "localhost"
-    _port = 4444
-    _path = os.path.join(
+    path = os.path.join(
         os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
         "java/src/org/openqa/selenium/grid/selenium_server_deploy.jar",
     )
 
-    def wait_for_server(url, timeout):
-        start = time.time()
-        while time.time() - start < timeout:
-            try:
-                urlopen(url)
-                return 1
-            except OSError:
-                time.sleep(0.2)
-        return 0
-
-    _socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-    url = f"http://{_host}:{_port}/status"
-    try:
-        _socket.connect((_host, _port))
-        print(
-            "The remote driver server is already running or something else"
-            "is using port {}, continuing...".format(_port)
-        )
-    except Exception:
-        remote_env = os.environ.copy()
-        if platform.system() == "Linux":
-            # There are issues with window size/position when running Firefox
-            # under Wayland, so we use XWayland instead.
-            remote_env["MOZ_ENABLE_WAYLAND"] = "0"
-        print("Starting the Selenium server")
-        process = subprocess.Popen(
-            [
-                "java",
-                "-jar",
-                _path,
-                "standalone",
-                "--port",
-                "4444",
-                "--selenium-manager",
-                "true",
-                "--enable-managed-downloads",
-                "true",
-            ],
-            env=remote_env,
-        )
-        print(f"Selenium server running as process: {process.pid}")
-        assert wait_for_server(url, 10), f"Timed out waiting for Selenium server at {url}"
-        print("Selenium server is ready")
-        yield process
-        process.terminate()
-        process.wait()
-        print("Selenium server has been terminated")
+    remote_env = os.environ.copy()
+    if platform.system() == "Linux":
+        # There are issues with window size/position when running Firefox
+        # under Wayland, so we use XWayland instead.
+        remote_env["MOZ_ENABLE_WAYLAND"] = "0"
+
+    server = Server(path=path, env=remote_env)
+    server.start()
+    yield server
+    server.stop()
 
 
 @pytest.fixture(autouse=True, scope="session")

py/selenium/webdriver/remote/server.py

@@ -29,21 +29,23 @@
 class Server:
     """Manage the Selenium Remote (Grid) Server.
 
+    Selenium Manager will detect the server location and download it if necessary, unless an existing server path is specified.
+
     Parameters:
     -----------
     host : str
-        Hostname or IP address to bind to.
+        Hostname or IP address to bind to (determined automatically if not specified)
     port : str
-        Port to listen on.
+        Port to listen on ('4444' if not specified)
     path : str
-        Path/filename of existing server .jar file (if not specified, server will be downloaded).
+        Path/filename of existing server .jar file (Selenium Manager is used if not specified)
     version : str
-        Version of server to download (if not specified, latest will be downloaded).
+        Version of server to download (latest version if not specified)
     env: dict
-        Environment variables passed to server environment.
+        Environment variables passed to server environment
     """
 
-    def __init__(self, host="localhost", port="4444", path=None, version=None, env=None):
+    def __init__(self, host=None, port="4444", path=None, version=None, env=None):
         if path and version:
             raise TypeError("Not allowed to specify a version when using an existing server path")
 
@@ -79,38 +81,41 @@ def _wait_for_server(self, timeout=10):
 
     def start(self):
         """Start the server."""
-        if not self.path:
+
+        if self.path is None:
             selenium_manager = SeleniumManager()
             args = ["--grid"]
             if self.version:
                 args.append(self.version)
             self.path = selenium_manager.binary_paths(args)["driver_path"]
-        java = shutil.which("java")
-        if java is None:
+
+        java_path = shutil.which("java")
+        if java_path is None:
             raise OSError("Can't find java on system PATH. JRE is required to run the Selenium server")
+
+        command = [
+            java_path,
+            "-jar",
+            self.path,
+            "standalone",
+            "--port",
+            self.port,
+            "--selenium-manager",
+            "true",
+            "--enable-managed-downloads",
+            "true",
+        ]
+        if self.host is not None:
+            command.extend(["--host", self.host])
+
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        host = self.host if self.host is not None else "localhost"
         try:
-            sock.connect((self.host, int(self.port)))
-            raise ConnectionError(
-                f"The remote driver server is already running or something else is using port {self.port}"
-            )
+            sock.connect((host, int(self.port)))
+            raise ConnectionError(f"Selenium server is already running, or something else is using port {self.port}")
         except ConnectionRefusedError:
-            print("Starting Selenium server")
-            self.process = subprocess.Popen(
-                [
-                    "java",
-                    "-jar",
-                    self.path,
-                    "standalone",
-                    "--port",
-                    self.port,
-                    "--selenium-manager",
-                    "true",
-                    "--enable-managed-downloads",
-                    "true",
-                ],
-                env=self.env,
-            )
+            print(f"Starting Selenium server at: {self.path}")
+            self.process = subprocess.Popen(command, env=self.env)
             print(f"Selenium server running as process: {self.process.pid}")
             if not self._wait_for_server():
                 f"Timed out waiting for Selenium server at {self.status_url}"