Headless Selenium with pytest when using --headless

Author: mdmintz

conftest.py

@@ -34,6 +34,11 @@ def pytest_addoption(parser):
     parser.addoption('--log_path', dest='log_path',
                      default='logs/',
                      help='Where the log files are saved.')
+    parser.addoption('--headless', action="store_true",
+                     dest='headless',
+                     default=False,
+                     help="""Using this makes Webdriver run headlessly,
+                          which is useful inside a Linux Docker.""")
     parser.addoption('--demo_mode', action="store_true",
                      dest='demo_mode',
                      default=False,
@@ -50,6 +55,7 @@ def pytest_configure(config):
     with_testing_base = config.getoption('with_testing_base')
     browser = config.getoption('browser')
     log_path = config.getoption('log_path')
+    headless = config.getoption('headless')
     demo_mode = config.getoption('demo_mode')
     demo_sleep = ''
     data = ''
@@ -65,6 +71,7 @@ def pytest_configure(config):
     config_file.write("data:::%s\n" % data)
     config_file.write("with_testing_base:::%s\n" % with_testing_base)
     config_file.write("log_path:::%s\n" % log_path)
+    config_file.write("headless:::%s\n" % headless)
     config_file.write("demo_mode:::%s\n" % demo_mode)
     config_file.write("demo_sleep:::%s\n" % demo_sleep)
     config_file.close()

seleniumbase/fixtures/base_case.py

@@ -11,6 +11,7 @@
 import sys
 import time
 import unittest
+from pyvirtualdisplay import Display
 from seleniumbase.config import settings
 from seleniumbase.core import browser_launcher
 from seleniumbase.core import log_helper
@@ -303,12 +304,18 @@ def setUp(self):
             self.is_pytest = False
         if self.is_pytest:
             self.with_selenium = pytest.config.option.with_selenium
+            self.headless = pytest.config.option.headless
+            self.headless_active = False
             self.with_testing_base = pytest.config.option.with_testing_base
             self.log_path = pytest.config.option.log_path
             self.browser = pytest.config.option.browser
             self.data = pytest.config.option.data
             self.demo_mode = pytest.config.option.demo_mode
             self.demo_sleep = pytest.config.option.demo_sleep
+            if self.headless:
+                self.display = Display(visible=0, size=(1200, 800))
+                self.display.start()
+                self.headless_active = True
             if self.with_selenium:
                 self.driver = browser_launcher.get_driver(self.browser)
 
@@ -336,6 +343,8 @@ def tearDown(self):
                         test_logpath, self.driver, self.browser)
                     # Handle page source logging
                     log_helper.log_page_source(test_logpath, self.driver)
-
                 # Finally close the browser
                 self.driver.quit()
+            if self.headless:
+                if self.headless_active:
+                    self.display.stop()