[py] Add headless fixture

Author: cgoldberg

py/conftest.py

@@ -28,6 +28,7 @@
 from test.selenium.webdriver.common.network import get_lan_ip
 from test.selenium.webdriver.common.webserver import SimpleWebServer
 
+
 drivers = (
     "chrome",
     "edge",
@@ -96,6 +97,11 @@ def pytest_ignore_collect(path, config):
     return len([d for d in _drivers if d.lower() in parts]) > 0
 
 
+def pytest_generate_tests(metafunc):
+    if "driver" in metafunc.fixturenames and metafunc.config.option.drivers:
+        metafunc.parametrize("driver", metafunc.config.option.drivers, indirect=True)
+
+
 def get_driver_class(driver_option):
     """Generate the driver class name from the lowercase driver option."""
     if driver_option == "webkitgtk":
@@ -391,6 +397,6 @@ def clean_driver(request):
         driver_reference = None
 
 
-def pytest_generate_tests(metafunc):
-    if "driver" in metafunc.fixturenames and metafunc.config.option.drivers:
-        metafunc.parametrize("driver", metafunc.config.option.drivers, indirect=True)
+@pytest.fixture
+def headless(request):
+    return request.config.option.headless

py/test/selenium/webdriver/firefox/firefox_sizing_tests.py

@@ -30,33 +30,26 @@ def is_running_wayland():
 
 
 @pytest.mark.skipif(not is_running_wayland(), reason="This test only runs on Linux under Wayland")
-def test_firefox_opens_large_when_running_xwayland(request):  # noqa: F821
-    options = Options()
-    if request.config.getoption("--headless"):
-        options.add_argument("-headless")
+def test_firefox_opens_large_when_running_xwayland(headless):
     # setting environment variable `MOZ_ENABLE_WAYLAND=0` forces Firefox
     # to run under XWayland on Wayland based systems
     with patch.dict("os.environ", {"MOZ_ENABLE_WAYLAND": "0"}):
-        try:
-            driver = webdriver.Firefox(options=options)
+        options = Options()
+        if headless:
+            options.add_argument("-headless")
+        with webdriver.Firefox(options=options) as driver:
             size = driver.get_window_size()
             assert size["height"] > 500
             assert size["width"] > 500
-        finally:
-            driver.quit()
 
 
 @pytest.mark.skipif(not is_running_wayland(), reason="This test only runs on Linux under Wayland")
 @pytest.mark.xfail(reason="https://bugzilla.mozilla.org/show_bug.cgi?id=1959040")
-# Firefox opens in a small window when running on Linux/Wayland
-def test_firefox_opens_large_when_running_wayland(request):  # noqa: F821
+def test_firefox_opens_large_when_running_wayland(headless):
     options = Options()
-    if request.config.getoption("--headless"):
+    if headless:
         options.add_argument("-headless")
-    try:
-        driver = webdriver.Firefox(options=options)
+    with webdriver.Firefox(options=options) as driver:
         size = driver.get_window_size()
         assert size["height"] > 500
         assert size["width"] > 500
-    finally:
-        driver.quit()

py/test/selenium/webdriver/remote/remote_custom_locator_tests.py

@@ -28,15 +28,15 @@ def convert(self, by, value):
         return super().convert(by, value)
 
 
-@pytest.mark.xfail
+@pytest.mark.skip(reason="Needs to be updated")
 def test_find_element_with_custom_locator(driver):
     driver.get("data:text/html,<div custom-attr='example'>Test</div>")
     element = driver.find_element("custom", "example")
     assert element is not None
     assert element.text == "Test"
 
 
-@pytest.mark.xfail
+@pytest.mark.skip(reason="Needs to be updated")
 def test_find_elements_with_custom_locator(driver):
     driver.get("data:text/html,<div custom-attr='example'>Test1</div><div custom-attr='example'>Test2</div>")
     elements = driver.find_elements("custom", "example")

py/test/selenium/webdriver/remote/remote_downloads_tests.py

@@ -18,7 +18,6 @@
 import os
 import tempfile
 
-
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support.wait import WebDriverWait
 

py/test/selenium/webdriver/remote/remote_firefox_profile_tests.py

@@ -20,11 +20,12 @@
 from selenium.webdriver.firefox.options import Options
 
 
-def test_profile_is_used():
+def test_profile_is_used(headless):
     ff_profile = FirefoxProfile()
     ff_profile.set_preference("browser.startup.page", "1")
     options = Options()
     options.profile = ff_profile
-    options.add_argument("-headless")
+    if headless:
+        options.add_argument("-headless")
     with webdriver.Remote(options=options) as driver:
         assert "browser/content/blanktab.html" in driver.current_url