[py] Simplify print pdf tests

This introduces a new headless target and simplifies the tests into only
one test file.

Author: AutomatedTester

py/BUILD.bazel

@@ -215,7 +215,9 @@ py_test_suite(
         "test/selenium/webdriver/chrome/**/*.py",
         "test/selenium/webdriver/common/**/*.py",
         "test/selenium/webdriver/support/**/*.py",
-    ]),
+        ],
+        exclude=["test/selenium/webdriver/common/print_pdf_tests.py"]
+    ),
     args = [
         "--instafail",
         "--driver=Chrome",
@@ -246,6 +248,46 @@ py_test_suite(
     ],
 )
 
+py_test_suite(
+    name="test-chrome-headless",
+    size="large",
+    srcs=glob([
+        "test/selenium/webdriver/chrome/**/*.py",
+        "test/selenium/webdriver/common/**/*.py",
+        "test/selenium/webdriver/support/**/*.py",
+        ],
+    ),
+    args=[
+        "--instafail",
+        "--driver=Chrome",
+        "--headless=true"
+    ],
+    tags=[
+        "no-sandbox",
+    ],
+    deps=[
+        ":init-tree",
+        ":selenium",
+        ":webserver",
+        requirement("attrs"),
+        requirement("idna"),
+        requirement("iniconfig"),
+        requirement("importlib_metadata"),
+        requirement("h11"),
+        requirement("more_itertools"),
+        requirement("multidict"),
+        requirement("outcome"),
+        requirement("pluggy"),
+        requirement("py"),
+        requirement("pytest"),
+        requirement("pytest-instafail"),
+        requirement("pytest-trio"),
+        requirement("sortedcontainers"),
+        requirement("sniffio"),
+        requirement("zipp"),
+    ],
+)
+
 py_test_suite(
     name = "test-edge",
     size = "large",

py/conftest.py

@@ -53,6 +53,8 @@ def pytest_addoption(parser):
                      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")
 
 
 def pytest_ignore_collect(path, config):
@@ -112,6 +114,8 @@ def fin():
     if driver_instance is None:
         if driver_class == 'Firefox':
             options = get_options(driver_class, request.config)
+        if driver_class == 'Chrome':
+            options = get_options(driver_class, request.config)
         if driver_class == 'Remote':
             capabilities = DesiredCapabilities.FIREFOX.copy()
             kwargs.update({'desired_capabilities': capabilities})
@@ -136,6 +140,7 @@ def fin():
 def get_options(driver_class, config):
     browser_path = config.option.binary
     browser_args = config.option.args
+    headless = bool(config.option.headless)
     options = None
 
     if driver_class == 'ChromiumEdge':
@@ -152,6 +157,12 @@ def get_options(driver_class, config):
         if browser_args is not None:
             for arg in browser_args.split():
                 options.add_argument(arg)
+
+    if headless:
+        if not options:
+            options = getattr(webdriver, f"{driver_class}Options")()
+
+        options.headless = headless
     return options
 
 

py/test/selenium/webdriver/chrome/print_pdf_tests.py

@@ -21,32 +21,33 @@
 END_INDEX = 5
 PDF_MAGIC_NUMBER = 'JVBER'
 
-@pytest.mark.xfail_chrome(reason='chrome needs a headless driver instance.', run=False)
+
 def test_pdf_with_2_pages(driver, pages):
-    firefox_print_options = PrintOptions()
-    firefox_print_options.page_ranges = ['1-2']
+    print_options = PrintOptions()
+    print_options.page_ranges = ['1-2']
+
+    pages.load("printPage.html")
+
+    base64code = driver.print_page(print_options)
 
-    driver.get(pages.url("printPage.html"))
-    firefox_base64code = driver.print_page(firefox_print_options)
+    assert base64code[START_INDEX: END_INDEX] == PDF_MAGIC_NUMBER
 
-    assert firefox_base64code[START_INDEX : END_INDEX] == PDF_MAGIC_NUMBER
 
-@pytest.mark.xfail_chrome(reason='chrome needs a headless driver instance.', run=False)
 def test_pdf_with_all_pages(driver, pages):
-    driver.get(pages.url("printPage.html"))
-    firefox_base64code = driver.print_page()
+    pages.load("printPage.html")
+    base64code = driver.print_page()
+
+    assert base64code[START_INDEX: END_INDEX] == PDF_MAGIC_NUMBER
 
-    assert firefox_base64code[START_INDEX : END_INDEX] == PDF_MAGIC_NUMBER
 
-@pytest.mark.xfail_chrome(reason='chrome needs a headless driver instance.', run=False)
 def test_valid_params(driver, pages):
-    firefox_print_options = PrintOptions()
+    print_options = PrintOptions()
+
+    print_options.page_ranges = ['1-2']
+    print_options.orientation = 'landscape'
+    print_options.width = 30
 
-    firefox_print_options.page_ranges = ['1-2']
-    firefox_print_options.orientation = 'landscape'
-    firefox_print_options.width = 30
-    
-    driver.get(pages.url("printPage.html"))
-    firefox_base64code = driver.print_page(firefox_print_options)
+    pages.load("printPage.html")
+    base64code = driver.print_page(print_options)
 
-    assert firefox_base64code[START_INDEX : END_INDEX] == PDF_MAGIC_NUMBER
+    assert base64code[START_INDEX: END_INDEX] == PDF_MAGIC_NUMBER