Update plugins

Author: mdmintz

seleniumbase/plugins/base_plugin.py

@@ -16,8 +16,7 @@
 
 
 class Base(Plugin):
-    """
-    This plugin adds the following command-line options to nosetests:
+    """This plugin adds the following command-line options to nosetests:
     --env=ENV  (Set the test env. Access with "self.env" in tests.)
     --account=STR  (Set account. Access with "self.account" in tests.)
     --data=STRING  (Extra test data. Access with "self.data" in tests.)
@@ -160,12 +159,9 @@ def options(self, parser, env):
             help="If true when using report, will display it after tests run.",
         )
         found_processes_arg = False
-        found_timeout_arg = False
         for arg in sys.argv:
-            if "--processes=" in arg:
+            if "--processes=" in arg or "--processes" in arg:
                 found_processes_arg = True
-            if "--timeout=" in arg:
-                found_timeout_arg = True
         if found_processes_arg:
             print("* WARNING: Don't use multi-threading with nosetests! *")
             parser.addoption(
@@ -174,16 +170,6 @@ def options(self, parser, env):
                 default=0,
                 help="WARNING: Don't use multi-threading with nosetests!",
             )
-        if found_timeout_arg:
-            print("\n  WARNING: Don't use --timeout=s from pytest-timeout!")
-            print("  It's not thread-safe for WebDriver processes!")
-            print("  Use --time-limit=s from SeleniumBase instead!\n")
-            parser.addoption(
-                "--timeout",
-                dest="timeout",
-                default=0,
-                help="Don't use --timeout=s! Use --time-limit=s instead!",
-            )
 
     def configure(self, options, conf):
         super().configure(options, conf)
@@ -262,24 +248,6 @@ def finalize(self, result):
                     self.show_report,
                 )
 
-    def __log_all_options_if_none_specified(self, test):
-        """
-        When testing_base is specified, but none of the log options to save are
-        specified (basic_test_info, screen_shots, page_source), then save them
-        all by default. Otherwise, save only selected ones from their plugins.
-        """
-        if (
-            (not self.options.enable_plugin_basic_test_info)
-            and (not self.options.enable_plugin_screen_shots)
-            and (not self.options.enable_plugin_page_source)
-        ):
-            test_logpath = self.options.log_path + "/" + test.id()
-            log_helper.log_screenshot(test_logpath, test.driver)
-            log_helper.log_test_failure_data(
-                test, test_logpath, test.driver, test.browser
-            )
-            log_helper.log_page_source(test_logpath, test.driver)
-
     def addSuccess(self, test, capt):
         if self.report_on:
             self.duration = str(
@@ -336,15 +304,12 @@ def add_fails_or_errors(self, test, err):
                 )
 
     def addFailure(self, test, err, capt=None, tbinfo=None):
-        # self.__log_all_options_if_none_specified(test)
         self.add_fails_or_errors(test, err)
 
     def addError(self, test, err, capt=None):
-        """
-        Since Skip, Blocked, and Deprecated are all technically errors, but not
-        error states, we want to make sure that they don't show up in
-        the nose output as errors.
-        """
+        """Since Skip, Blocked, and Deprecated are all technically errors,
+        but not error states, we want to make sure that they
+        don't show up in the nose output as errors."""
         from seleniumbase.fixtures import errors
 
         if (
@@ -363,27 +328,19 @@ def addError(self, test, err, capt=None):
                 )[0]
             )
         else:
-            # self.__log_all_options_if_none_specified(test)
             pass
         self.add_fails_or_errors(test, err)
 
     def handleError(self, test, err, capt=None):
-        """
-        If the database plugin is not present, we have to handle capturing
-        "errors" that shouldn't be reported as such in base.
-        """
+        """After each test error, record testcase run information.
+        "Error" also encompasses any states other than Pass or Fail."""
         from nose.exc import SkipTest
         from seleniumbase.fixtures import errors
 
         if not hasattr(test.test, "testcase_guid"):
             if err[0] == errors.BlockedTest:
                 raise SkipTest(err[1])
-                return True
-
             elif err[0] == errors.DeprecatedTest:
                 raise SkipTest(err[1])
-                return True
-
             elif err[0] == errors.SkipTest:
                 raise SkipTest(err[1])
-                return True

seleniumbase/plugins/db_reporting_plugin.py

@@ -1,15 +1,8 @@
 """The plugin for recording test results in the Testcase Database."""
-import getpass
 import time
 import uuid
 from nose.plugins import Plugin
-from nose.exc import SkipTest
-from seleniumbase.core.application_manager import ApplicationManager
-from seleniumbase.core.testcase_manager import ExecutionQueryPayload
-from seleniumbase.core.testcase_manager import TestcaseDataPayload
-from seleniumbase.core.testcase_manager import TestcaseManager
 from seleniumbase.fixtures import constants
-from seleniumbase.fixtures import errors
 
 
 class DBReporting(Plugin):
@@ -51,13 +44,18 @@ def options(self, parser, env):
         )
 
     def configure(self, options, conf):
+        from seleniumbase.core.testcase_manager import TestcaseManager
+
         super().configure(options, conf)
         self.options = options
         self.testcase_manager = TestcaseManager(self.options.database_env)
 
     def begin(self):
         """At the start of the run, we want to record the test
         execution information in the database."""
+        import getpass
+        from seleniumbase.core.testcase_manager import ExecutionQueryPayload
+
         exec_payload = ExecutionQueryPayload()
         exec_payload.execution_start_time = int(time.time() * 1000)
         self.execution_start_time = exec_payload.execution_start_time
@@ -67,6 +65,9 @@ def begin(self):
 
     def startTest(self, test):
         """At the start of the test, set the testcase details."""
+        from seleniumbase.core.application_manager import ApplicationManager
+        from seleniumbase.core.testcase_manager import TestcaseDataPayload
+
         data_payload = TestcaseDataPayload()
         self.testcase_guid = str(uuid.uuid4())
         data_payload.guid = self.testcase_guid
@@ -111,52 +112,43 @@ def afterTest(self, test):
             self.__insert_test_result(constants.State.SKIPPED, self._test, err)
 
     def addSuccess(self, test, capt):
-        """
-        After each test success, record testcase run information.
-        """
+        """After each test success, record testcase run information."""
         self.__insert_test_result(constants.State.PASSED, test)
         self._result_set = True
 
     def addFailure(self, test, err, capt=None, tbinfo=None):
-        """
-        After each test failure, record testcase run information.
-        """
+        """After each test failure, record testcase run information."""
         self.__insert_test_result(constants.State.FAILED, test, err)
         self._result_set = True
 
     def addError(self, test, err, capt=None):
-        """
-        After each test error, record testcase run information.
-        (Test errors should be treated the same as test failures.)
-        """
+        """After each test error, record testcase run information.
+        (Test errors should be treated the same as test failures.)"""
         self.__insert_test_result(constants.State.FAILED, test, err)
         self._result_set = True
 
     def handleError(self, test, err, capt=None):
-        """
-        After each test error, record testcase run information.
-        "Error" also encompasses any states other than Pass or Fail, so we
-        check for those first.
-        """
+        """After each test error, record testcase run information.
+        "Error" also encompasses any states other than Pass or Fail."""
+        from nose.exc import SkipTest
+        from seleniumbase.fixtures import errors
+
         if err[0] == errors.BlockedTest:
             self.__insert_test_result(constants.State.BLOCKED, test, err)
             self._result_set = True
             raise SkipTest(err[1])
-            return True
-
         elif err[0] == errors.DeprecatedTest:
             self.__insert_test_result(constants.State.DEPRECATED, test, err)
             self._result_set = True
             raise SkipTest(err[1])
-            return True
-
         elif err[0] == errors.SkipTest:
             self.__insert_test_result(constants.State.SKIPPED, test, err)
             self._result_set = True
             raise SkipTest(err[1])
-            return True
 
     def __insert_test_result(self, state, test, err=None):
+        from seleniumbase.core.testcase_manager import TestcaseDataPayload
+
         data_payload = TestcaseDataPayload()
         data_payload.runtime = int(time.time() * 1000) - self.case_start_time
         data_payload.guid = self.testcase_guid

seleniumbase/plugins/pytest_plugin.py

@@ -20,8 +20,7 @@
 
 
 def pytest_addoption(parser):
-    """
-    This plugin adds the following command-line options to pytest:
+    """This plugin adds the following command-line options to pytest:
     --browser=BROWSER  (The web browser to use. Default: "chrome".)
     --chrome  (Shortcut for "--browser=chrome". Default.)
     --edge  (Shortcut for "--browser=edge".)
@@ -1616,6 +1615,9 @@ def pytest_configure(config):
     else:
         pass  # Use the browser specified by "--browser=BROWSER"
 
+    if sb_config.browser == "safari" and sb_config.headless:
+        sb_config.headless = False  # Safari doesn't support headless mode
+
     if sb_config.dash_title:
         constants.Dashboard.TITLE = sb_config.dash_title.replace("_", " ")
 
@@ -1659,8 +1661,7 @@ def _get_test_ids_(the_item):
         test_id = "unidentified_TestCase"
     display_id = test_id
     r"""
-    # Due to changes in SeleniumBase 1.66.0, we're now using the
-    # item's original nodeid for both the test_id and display_id.
+    # Now using the nodeid for both the test_id and display_id.
     # (This only impacts tests using The Dashboard.)
     # If there are any issues, we'll revert back to the old code.
     test_id = the_item.nodeid.split("/")[-1].replace(" ", "_")
@@ -1739,8 +1740,7 @@ def pytest_deselected(items):
 
 def pytest_collection_finish(session):
     """This runs after item collection is finalized.
-    https://docs.pytest.org/en/stable/reference.html
-    """
+    https://docs.pytest.org/en/stable/reference.html """
     sb_config._context_of_runner = False  # Context Manager Compatibility
     if "--co" in sys_argv or "--collect-only" in sys_argv:
         return
@@ -2234,8 +2234,7 @@ def pytest_runtest_makereport(item, call):
                 if not test_id:
                     test_id = "unidentified_TestCase"
                 r"""
-                # Due to changes in SeleniumBase 1.66.0, we're now using the
-                # item's original nodeid for both the test_id and display_id.
+                # Now using the nodeid for both the test_id and display_id.
                 # (This only impacts tests using The Dashboard.)
                 # If there are any issues, we'll revert back to the old code.
                 test_id = test_id.split("/")[-1].replace(" ", "_")
@@ -2258,8 +2257,8 @@ def pytest_runtest_makereport(item, call):
             if len(extra_report) > 1 and extra_report[1]["content"]:
                 report.extra = extra + extra_report
             if sb_config._dash_is_html_report:
-                # (If the Dashboard URL is the same as the HTML Report URL:)
-                # Have the html report refresh back to a dashboard on update
+                # If the Dashboard URL is the same as the HTML Report URL,
+                # have the html report refresh back to a dashboard on update.
                 refresh_updates = (
                     '<script type="text/javascript" src="%s">'
                     "</script>" % constants.Dashboard.LIVE_JS

seleniumbase/plugins/sb_manager.py

@@ -495,6 +495,8 @@ def SB(
             no_screenshot = False
     if save_screenshot and no_screenshot:
         save_screenshot = False  # "no_screenshot" has priority
+    if browser == "safari" and headless:
+        headless = False  # Safari doesn't support headless mode
     if js_checking_on is None:
         if "--check-js" in sys_argv:
             js_checking_on = True

seleniumbase/plugins/selenium_plugin.py

@@ -12,8 +12,7 @@
 
 
 class SeleniumBrowser(Plugin):
-    """
-    This plugin adds the following command-line options to nosetests:
+    """This plugin adds the following command-line options to nosetests:
     --browser=BROWSER  (The web browser to use. Default: "chrome".)
     --chrome  (Shortcut for "--browser=chrome". Default.)
     --edge  (Shortcut for "--browser=edge".)
@@ -1025,6 +1024,8 @@ def beforeTest(self, test):
         test.test.cap_string = self.options.cap_string
         test.test.headless = self.options.headless
         test.test.headless2 = self.options.headless2
+        if test.test.headless and test.test.browser == "safari":
+            test.test.headless = False  # Safari doesn't use headless
         if test.test.headless2 and test.test.browser == "firefox":
             test.test.headless2 = False  # Only for Chromium browsers
             test.test.headless = True  # Firefox has regular headless
@@ -1174,23 +1175,18 @@ def beforeTest(self, test):
         sb_config._virtual_display = None
         sb_config.headless_active = False
         self.headless_active = False
-        if (
-            self.options.headless
-            or self.options.headless2
-            or self.options.xvfb
-        ):
+        if "linux" in sys.platform:
+            width = settings.HEADLESS_START_WIDTH
+            height = settings.HEADLESS_START_HEIGHT
             try:
-                # from pyvirtualdisplay import Display  # Skip for own lib
                 from sbvirtualdisplay import Display
 
-                self._xvfb_display = Display(visible=0, size=(1440, 1880))
+                self._xvfb_display = Display(visible=0, size=(width, height))
                 self._xvfb_display.start()
                 sb_config._virtual_display = self._xvfb_display
                 self.headless_active = True
                 sb_config.headless_active = True
             except Exception:
-                # pyvirtualdisplay might not be necessary anymore because
-                # Chrome and Firefox now have built-in headless displays
                 pass
         sb_config._is_timeout_changed = False
         sb_config._SMALL_TIMEOUT = settings.SMALL_TIMEOUT