Add a "--xvfb" option to run tests using an Xvfb virtual display

Author: mdmintz

README.md

@@ -360,8 +360,9 @@ The code above will leave your browser window open in case there's a failure. (i
 --firefox-pref=SET  # (Set a Firefox preference:value set, comma-separated.)
 --extension-zip=ZIP  # (Load a Chrome Extension .zip|.crx, comma-separated.)
 --extension-dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
---headless  # (Run tests headlessly. Default mode on Linux OS.)
---headed  # (Run tests with a GUI on Linux OS.)
+--headless  # (Run tests in headless mode. The default arg on Linux OS.)
+--headed  # (Run tests in headed/GUI mode on Linux OS.)
+--xvfb  # (Run tests using the Xvfb virtual display server on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --interval=SECONDS  # (The autoplay interval for presentations & tour steps)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)

examples/raw_parameter_script.py

@@ -33,6 +33,7 @@
     sb.browser = "chrome"
     sb.headless = False
     sb.headed = False
+    sb.xvfb = False
     sb.start_page = None
     sb.locale_code = None
     sb.protocol = "http"

help_docs/customizing_test_runs.md

@@ -122,8 +122,9 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 --firefox-pref=SET  # (Set a Firefox preference:value set, comma-separated.)
 --extension-zip=ZIP  # (Load a Chrome Extension .zip|.crx, comma-separated.)
 --extension-dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
---headless  # (Run tests headlessly. Default mode on Linux OS.)
---headed  # (Run tests with a GUI on Linux OS.)
+--headless  # (Run tests in headless mode. The default arg on Linux OS.)
+--headed  # (Run tests in headed/GUI mode on Linux OS.)
+--xvfb  # (Run tests using the Xvfb virtual display server on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --interval=SECONDS  # (The autoplay interval for presentations & tour steps)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)

seleniumbase/core/browser_launcher.py

@@ -519,7 +519,7 @@ def _set_firefox_options(
     options.set_preference(
         "browser.download.manager.showAlertOnComplete", False
     )
-    if headless and "linux" not in PLATFORM:
+    if headless:
         options.add_argument("--headless")
     if locale_code:
         options.set_preference("intl.accept_languages", locale_code)

seleniumbase/fixtures/base_case.py

@@ -2458,7 +2458,7 @@ def get_new_driver(
         if switch_to:
             self.driver = new_driver
             self.browser = browser_name
-            if self.headless:
+            if self.headless or self.xvfb:
                 # Make sure the invisible browser window is big enough
                 width = settings.HEADLESS_START_WIDTH
                 height = settings.HEADLESS_START_HEIGHT
@@ -5258,7 +5258,7 @@ def begin_presentation(
         interval - The delay time between autoplaying slides. (in seconds)
                    If set to 0 (default), autoplay is disabled.
         """
-        if self.headless:
+        if self.headless or self.xvfb:
             return  # Presentations should not run in headless mode.
         if not name:
             name = "default"
@@ -5949,7 +5949,7 @@ def display_chart(self, chart_name=None, filename=None, interval=0):
         interval - The delay time for auto-advancing charts. (in seconds)
                    If set to 0 (default), auto-advancing is disabled.
         """
-        if self.headless:
+        if self.headless or self.xvfb:
             interval = 1  # Race through chart if running in headless mode
         if not chart_name:
             chart_name = "default"
@@ -6635,7 +6635,7 @@ def play_tour(self, name=None, interval=0):
         """
         from seleniumbase.core import tour_helper
 
-        if self.headless:
+        if self.headless or self.xvfb:
             return  # Tours should not run in headless mode.
 
         self.wait_for_ready_state_complete()
@@ -6852,7 +6852,7 @@ def get_jqc_button_input(self, message, buttons, options=None):
             for option in options:
                 if not type(option) is list and not type(option) is tuple:
                     raise Exception('"options" should be a list of tuples!')
-        if self.headless:
+        if self.headless or self.xvfb:
             return buttons[-1][0]
         jqc_helper.jquery_confirm_button_dialog(
             self.driver, message, buttons, options
@@ -6939,7 +6939,7 @@ def get_jqc_text_input(self, message, button=None, options=None):
             for option in options:
                 if not type(option) is list and not type(option) is tuple:
                     raise Exception('"options" should be a list of tuples!')
-        if self.headless:
+        if self.headless or self.xvfb:
             return ""
         jqc_helper.jquery_confirm_text_dialog(
             self.driver, message, button, options
@@ -7014,7 +7014,7 @@ def get_jqc_form_inputs(self, message, buttons, options=None):
             for option in options:
                 if not type(option) is list and not type(option) is tuple:
                     raise Exception('"options" should be a list of tuples!')
-        if self.headless:
+        if self.headless or self.xvfb:
             return ("", buttons[-1][0])
         jqc_helper.jquery_confirm_full_dialog(
             self.driver, message, buttons, options
@@ -8839,6 +8839,7 @@ def setUp(self, masterqa_mode=False):
             self.headless = sb_config.headless
             self.headless_active = False
             self.headed = sb_config.headed
+            self.xvfb = sb_config.xvfb
             self.locale_code = sb_config.locale_code
             self.interval = sb_config.interval
             self.start_page = sb_config.start_page
@@ -8956,7 +8957,7 @@ def setUp(self, masterqa_mode=False):
                 self.__skip_reason = None
                 self.testcase_manager.insert_testcase_data(data_payload)
                 self.case_start_time = int(time.time() * 1000)
-            if self.headless:
+            if self.headless or self.xvfb:
                 width = settings.HEADLESS_START_WIDTH
                 height = settings.HEADLESS_START_HEIGHT
                 try:
@@ -9907,7 +9908,7 @@ def tearDown(self):
                         self.__process_dashboard(has_exception)
                 # (Pytest) Finally close all open browser windows
                 self.__quit_all_drivers()
-            if self.headless:
+            if self.headless or self.xvfb:
                 if self.headless_active:
                     try:
                         self.display.stop()

seleniumbase/plugins/pytest_plugin.py

@@ -49,8 +49,9 @@ def pytest_addoption(parser):
     --firefox-pref=SET  (Set a Firefox preference:value set, comma-separated.)
     --extension-zip=ZIP  (Load a Chrome Extension .zip|.crx, comma-separated.)
     --extension-dir=DIR  (Load a Chrome Extension directory, comma-separated.)
-    --headless  (Run tests headlessly. Default mode on Linux OS.)
-    --headed  (Run tests with a GUI on Linux OS.)
+    --headless  (Run tests in headless mode. The default arg on Linux OS.)
+    --headed  (Run tests in headed/GUI mode on Linux OS.)
+    --xvfb  (Run tests using the Xvfb virtual display server on Linux OS.)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
     --interval=SECONDS  (The autoplay interval for presentations & tour steps)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
@@ -504,6 +505,17 @@ def pytest_addoption(parser):
                 (The default setting on Linux is headless.)
                 (The default setting on Mac or Windows is headed.)""",
     )
+    parser.addoption(
+        "--xvfb",
+        action="store_true",
+        dest="xvfb",
+        default=False,
+        help="""Using this makes tests run headlessly using Xvfb
+                instead of the browser's built-in headless mode.
+                When using "--xvfb", the "--headless" option
+                will no longer be enabled by default on Linux.
+                Default: False. (Linux-ONLY!)""",
+        )
     parser.addoption(
         "--locale_code",
         "--locale-code",
@@ -957,6 +969,7 @@ def pytest_configure(config):
     sb_config.device_metrics = config.getoption("device_metrics")
     sb_config.headless = config.getoption("headless")
     sb_config.headed = config.getoption("headed")
+    sb_config.xvfb = config.getoption("xvfb")
     sb_config.locale_code = config.getoption("locale_code")
     sb_config.interval = config.getoption("interval")
     sb_config.start_page = config.getoption("start_page")
@@ -1051,14 +1064,20 @@ def pytest_configure(config):
             if sb_config._html_report_name == "dashboard.html":
                 sb_config._dash_is_html_report = True
 
+    if sb_config.xvfb and "linux" not in sys.platform:
+        # The Xvfb virtual display server is for Linux OS Only!
+        sb_config.xvfb = False
     if (
         "linux" in sys.platform
         and not sb_config.headed
         and not sb_config.headless
+        and not sb_config.xvfb
     ):
         print(
-            "(Running with --headless on Linux. "
-            "Use --headed or --gui to override.)"
+            "(Linux uses --headless by default. "
+            "To override, use --headed / --gui. "
+            "For Xvfb mode instead, use --xvfb. "
+            "Or hide this info with --headless.)"
         )
         sb_config.headless = True
     if not sb_config.headless:
@@ -1212,7 +1231,11 @@ def pytest_runtest_teardown(item):
         except Exception:
             pass
         try:
-            if hasattr(self, "headless") and self.headless:
+            if hasattr(self, "xvfb") and self.xvfb:
+                if self.headless_active and "--pdb" not in sys.argv:
+                    if hasattr(self, "display") and self.display:
+                        self.display.stop()
+            elif hasattr(self, "headless") and self.headless:
                 if self.headless_active and "--pdb" not in sys.argv:
                     if hasattr(self, "display") and self.display:
                         self.display.stop()

seleniumbase/plugins/selenium_plugin.py

@@ -29,8 +29,9 @@ class SeleniumBrowser(Plugin):
     --firefox-pref=SET  (Set a Firefox preference:value set, comma-separated.)
     --extension-zip=ZIP  (Load a Chrome Extension .zip|.crx, comma-separated.)
     --extension-dir=DIR  (Load a Chrome Extension directory, comma-separated.)
-    --headless  (Run tests headlessly. Default mode on Linux OS.)
-    --headed  (Run tests with a GUI on Linux OS.)
+    --headless  (Run tests in headless mode. The default arg on Linux OS.)
+    --headed  (Run tests in headed/GUI mode on Linux OS.)
+    --xvfb  (Run tests using the Xvfb virtual display server on Linux OS.)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
     --interval=SECONDS  (The autoplay interval for presentations & tour steps)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
@@ -273,6 +274,17 @@ def options(self, parser, env):
                     (The default setting on Linux is headless.)
                     (The default setting on Mac or Windows is headed.)""",
         )
+        parser.add_option(
+            "--xvfb",
+            action="store_true",
+            dest="xvfb",
+            default=False,
+            help="""Using this makes tests run headlessly using Xvfb
+                    instead of the browser's built-in headless mode.
+                    When using "--xvfb", the "--headless" option
+                    will no longer be enabled by default on Linux.
+                    Default: False. (Linux-ONLY!)""",
+        )
         parser.add_option(
             "--locale_code",
             "--locale-code",
@@ -575,6 +587,7 @@ def beforeTest(self, test):
         test.test.cap_string = self.options.cap_string
         test.test.headless = self.options.headless
         test.test.headed = self.options.headed
+        test.test.xvfb = self.options.xvfb
         test.test.locale_code = self.options.locale_code
         test.test.interval = self.options.interval
         test.test.start_page = self.options.start_page
@@ -626,12 +639,20 @@ def beforeTest(self, test):
         if test.test.servername != "localhost":
             # Use Selenium Grid (Use --server="127.0.0.1" for localhost Grid)
             test.test.use_grid = True
-        if "linux" in sys.platform and (
-            not self.options.headed and not self.options.headless
+        if self.options.xvfb and "linux" not in sys.platform:
+            # The Xvfb virtual display server is for Linux OS Only!
+            self.options.xvfb = False
+        if (
+            "linux" in sys.platform
+            and not self.options.headed
+            and not self.options.headless
+            and not self.options.xvfb
         ):
             print(
-                "(Running with --headless on Linux. "
-                "Use --headed or --gui to override.)"
+                "(Linux uses --headless by default. "
+                "To override, use --headed / --gui. "
+                "For Xvfb mode instead, use --xvfb. "
+                "Or hide this info with --headless.)"
             )
             self.options.headless = True
             test.test.headless = True
@@ -669,7 +690,7 @@ def afterTest(self, test):
             pass
         except Exception:
             pass
-        if self.options.headless:
+        if self.options.headless or self.options.xvfb:
             if self.headless_active:
                 try:
                     self.display.stop()