[py] Add fixtures for clean objects

Author: AutomatedTester

py/conftest.py

@@ -50,12 +50,30 @@ def pytest_addoption(parser):
         metavar="DRIVER",
         help="driver to run tests against ({})".format(", ".join(drivers)),
     )
-    parser.addoption("--browser-binary", action="store", dest="binary", help="location of the browser binary")
     parser.addoption(
-        "--driver-binary", action="store", dest="executable", help="location of the service executable binary"
+        "--browser-binary",
+        action="store",
+        dest="binary",
+        help="location of the browser binary",
+    )
+    parser.addoption(
+        "--driver-binary",
+        action="store",
+        dest="executable",
+        help="location of the service executable binary",
+    )
+    parser.addoption(
+        "--browser-args",
+        action="store",
+        dest="args",
+        help="arguments to start the browser with",
+    )
+    parser.addoption(
+        "--headless",
+        action="store",
+        dest="headless",
+        help="Allow tests to run in headless",
     )
-    parser.addoption("--browser-args", action="store", dest="args", help="arguments to start the browser with")
-    parser.addoption("--headless", action="store", dest="headless", help="Allow tests to run in headless")
 
 
 def pytest_ignore_collect(path, config):
@@ -119,7 +137,9 @@ def fin():
         if driver_class == "Chrome":
             options = get_options(driver_class, request.config)
         if driver_class == "Remote":
-            options = get_options("Firefox", request.config) or webdriver.FirefoxOptions()
+            options = (
+                get_options("Firefox", request.config) or webdriver.FirefoxOptions()
+            )
             options.set_capability("moz:firefoxOptions", {})
             options.enable_downloads = True
         if driver_class == "WebKitGTK":
@@ -262,7 +282,9 @@ def wait_for_server(url, timeout):
             ]
         )
         print(f"Selenium server running as process: {process.pid}")
-        assert wait_for_server(url, 10), f"Timed out waiting for Selenium server at {url}"
+        assert wait_for_server(
+            url, 10
+        ), f"Timed out waiting for Selenium server at {url}"
         print("Selenium server is ready")
         yield process
         process.terminate()
@@ -283,3 +305,32 @@ def edge_service():
     from selenium.webdriver.edge.service import Service as EdgeService
 
     return EdgeService
+
+
+@pytest.fixture(scope="function")
+def driver_executable(request):
+    return request.config.option.executable
+
+
+@pytest.fixture(scope="function")
+def clean_service(request):
+    try:
+        driver_class = request.config.option.drivers[0].capitalize()
+    except AttributeError:
+        raise Exception("This test requires a --driver to be specified.")
+
+    yield get_service(driver_class, request.config.option.executable)
+
+
+@pytest.fixture(scope="function")
+def clean_driver(request):
+    try:
+        driver_class = request.config.option.drivers[0].capitalize()
+    except AttributeError:
+        raise Exception("This test requires a --driver to be specified.")
+
+    driver_reference = getattr(webdriver, driver_class)
+    yield driver_reference
+
+    if request.node.get_closest_marker("no_driver_after_test"):
+        driver_reference = None

py/test/selenium/webdriver/chrome/chrome_launcher_tests.py

@@ -15,27 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 
-from selenium.webdriver import Chrome
+import pytest
+
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 
 
-def test_launch_and_close_browser():
-    driver = Chrome()
+@pytest.mark.no_driver_after_test
+def test_launch_and_close_browser(clean_driver, clean_service):
+    driver = clean_driver(service=clean_service)
     driver.quit()
 
 
-def test_we_can_launch_multiple_chrome_instances():
-    driver1 = Chrome()
-    driver2 = Chrome()
-    driver3 = Chrome()
+@pytest.mark.no_driver_after_test
+def test_we_can_launch_multiple_chrome_instances(clean_driver, clean_service):
+    driver1 = clean_driver(service=clean_service)
+    driver2 = clean_driver(service=clean_service)
+    driver3 = clean_driver(service=clean_service)
     driver1.quit()
     driver2.quit()
     driver3.quit()
-
-
-def test_launch_chrome_do_not_affect_default_capabilities():
-    expected = DesiredCapabilities.CHROME.copy()
-    driver = Chrome()
-    actual = DesiredCapabilities.CHROME.copy()
-    driver.quit()
-    assert actual == expected

py/test/selenium/webdriver/chrome/chrome_service_tests.py

@@ -23,46 +23,54 @@
 from selenium.webdriver.chrome.service import Service
 from selenium.common.exceptions import WebDriverException
 
-# @pytest.mark.xfail_chrome(raises=WebDriverException)
-# def test_uses_chromedriver_logging() -> None:
-#     log_file = "chromedriver.log"
-#     service_args = ["--append-log"]
-#
-#     service = Service(log_output=log_file, service_args=service_args)
-#     driver2 = None
-#     try:
-#         driver1 = Chrome(service=service)
-#         with open(log_file) as fp:
-#             lines = len(fp.readlines())
-#         driver2 = Chrome(service=service)
-#         with open(log_file) as fp:
-#             assert len(fp.readlines()) >= 2 * lines
-#     finally:
-#         driver1.quit()
-#         if driver2:
-#             driver2.quit()
-#         os.remove(log_file)
+
+@pytest.mark.xfail_chrome(raises=WebDriverException)
+@pytest.mark.no_driver_after_test
+def test_uses_chromedriver_logging(clean_driver, driver_executable) -> None:
+    log_file = "chromedriver.log"
+    service_args = ["--append-log"]
+
+    service = Service(
+        log_output=log_file,
+        service_args=service_args,
+        executable_path=driver_executable,
+    )
+    driver2 = None
+    try:
+        driver1 = clean_driver(service=service)
+        with open(log_file) as fp:
+            lines = len(fp.readlines())
+        driver2 = clean_driver(service=service)
+        with open(log_file) as fp:
+            assert len(fp.readlines()) >= 2 * lines
+    finally:
+        driver1.quit()
+        if driver2:
+            driver2.quit()
+        os.remove(log_file)
 
 
-def test_log_output_as_filename() -> None:
+@pytest.mark.no_driver_after_test
+def test_log_output_as_filename(clean_driver, driver_executable) -> None:
     log_file = "chromedriver.log"
-    service = Service(log_output=log_file)
+    service = Service(log_output=log_file, executable_path=driver_executable)
     try:
         assert "--log-path=chromedriver.log" in service.service_args
-        driver = Chrome(service=service)
+        driver = clean_driver(service=service)
         with open(log_file) as fp:
             assert "Starting ChromeDriver" in fp.readline()
     finally:
         driver.quit()
         os.remove(log_file)
 
 
-def test_log_output_as_file() -> None:
+@pytest.mark.no_driver_after_test
+def test_log_output_as_file(clean_driver, driver_executable) -> None:
     log_name = "chromedriver.log"
     log_file = open(log_name, "w", encoding="utf-8")
-    service = Service(log_output=log_file)
+    service = Service(log_output=log_file, executable_path=driver_executable)
     try:
-        driver = Chrome(service=service)
+        driver = clean_driver(service=service)
         time.sleep(1)
         with open(log_name) as fp:
             assert "Starting ChromeDriver" in fp.readline()
@@ -72,18 +80,18 @@ def test_log_output_as_file() -> None:
         os.remove(log_name)
 
 
-def test_log_output_as_stdout(capfd) -> None:
-    service = Service(log_output=subprocess.STDOUT)
-    driver = Chrome(service=service)
+@pytest.mark.no_driver_after_test
+def test_log_output_as_stdout(clean_driver, capfd, driver_executable) -> None:
+    service = Service(log_output=subprocess.STDOUT, executable_path=driver_executable)
+    driver = clean_driver(service=service)
 
     out, err = capfd.readouterr()
     assert "Starting ChromeDriver" in out
     driver.quit()
 
 
-def test_log_output_null_default(capfd) -> None:
-    driver = Chrome()
-
+@pytest.mark.no_driver_after_test
+def test_log_output_null_default(driver, capfd) -> None:
     out, err = capfd.readouterr()
     assert "Starting ChromeDriver" not in out
     driver.quit()

py/test/selenium/webdriver/chrome/proxy_tests.py

@@ -15,27 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 
+import pytest
 import os
-
 import urllib3
 
-from selenium import webdriver
-
 
-def test_bad_proxy_doesnt_interfere():
+@pytest.mark.no_driver_after_test
+def test_bad_proxy_doesnt_interfere(clean_driver, clean_service):
     # these values should be ignored if ignore_local_proxy_environment_variables() is called.
     os.environ["https_proxy"] = "bad"
     os.environ["http_proxy"] = "bad"
     options = webdriver.ChromeOptions()
 
     options.ignore_local_proxy_environment_variables()
 
-    chrome_kwargs = {"options": options}
-    driver = webdriver.Chrome(**chrome_kwargs)
-
-    assert hasattr(driver, "command_executor")
-    assert hasattr(driver.command_executor, "_proxy_url")
-    assert isinstance(driver.command_executor._conn, urllib3.PoolManager)
-    os.environ.pop("https_proxy")
-    os.environ.pop("http_proxy")
-    driver.quit()
+    chrome_kwargs = {"options": options, "service": clean_service}
+    driver = clean_driver(**chrome_kwargs)
+
+    try:
+        assert hasattr(driver, "command_executor")
+        assert hasattr(driver.command_executor, "_proxy_url")
+        assert isinstance(driver.command_executor._conn, urllib3.PoolManager)
+    finally:
+        os.environ.pop("https_proxy")
+        os.environ.pop("http_proxy")
+        driver.quit()