Merge pull request #455 from seleniumbase/optimize-virtual-display-logging-and-teardown

Optimize virtual display logging and update boilerplate

Author: mdmintz

README.md

@@ -26,7 +26,7 @@ pytest my_first_test.py --demo
 
 ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Get Started:
 
-You'll need **[Python](https://www.python.org/downloads/)** on your System PATH. [<img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?logo=python&logoColor=lightblue" alt="Python versions" alt="Python versions" />](https://www.python.org/downloads/)
+You'll need **[Python](https://www.python.org/downloads/)** on your System PATH. [<img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?logo=python&logoColor=gold" alt="Python versions" alt="Python versions" />](https://www.python.org/downloads/)
 
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Install/upgrade ``pip``:
 ```bash

azure-pipelines.yml

@@ -30,10 +30,10 @@ jobs:
   - script: python -m pip install --upgrade pip && pip --version
     displayName: 'Install/upgrade pip'
 
-  - script: pip install seleniumbase
+  - script: python -m pip install seleniumbase
     displayName: 'Verify install from PyPI'
 
-  - script: pip install -r requirements.txt --upgrade
+  - script: python -m pip install -r requirements.txt --upgrade
     displayName: 'Install dependencies'
 
   - script: python setup.py install
@@ -53,13 +53,13 @@ jobs:
       pytest nothing.py
     displayName: 'Make sure pytest is working'
 
-  - script: pytest examples/boilerplates/boilerplate_test.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
+  - script: python -m pytest examples/boilerplates/boilerplate_test.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
     displayName: 'Run pytest boilerplate_test.py --browser=chrome --headless'
 
-  - script: pytest examples/my_first_test.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
+  - script: python -m pytest examples/my_first_test.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
     displayName: 'Run pytest my_first_test.py --browser=chrome --headless'
 
-  - script: pytest examples/test_inspect_html.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
+  - script: python -m pytest examples/test_inspect_html.py --browser=chrome --headless -v -s --junit-xml=junit/test-results.xml
     displayName: 'Run pytest test_inspect_html.py --browser=chrome --headless'
 
   - task: PublishTestResults@2

examples/boilerplates/base_test_case.py

@@ -12,10 +12,11 @@ class BaseTestCase(BaseCase):
 
     def setUp(self):
         super(BaseTestCase, self).setUp()
-        # Add custom setUp code for your tests AFTER the super().setUp()
+        # <<< Add custom setUp code for tests AFTER the super().setUp() >>>
 
     def tearDown(self):
-        # Add custom tearDown code for your tests BEFORE the super().tearDown()
+        self.save_teardown_screenshot()
+        # <<< Add custom tearDown code BEFORE the super().tearDown() >>>
         super(BaseTestCase, self).tearDown()
 
     def login(self):

seleniumbase/console_scripts/sb_mkdir.py

@@ -152,10 +152,11 @@ def main():
         data.append("")
         data.append("    def setUp(self):")
         data.append("        super(BaseTestCase, self).setUp()")
-        data.append("        # Add custom setUp code AFTER the super() line")
+        data.append("        # << Add custom code AFTER the super() line >>")
         data.append("")
         data.append("    def tearDown(self):")
-        data.append("        # Add custom code BEFORE the super() line")
+        data.append("        self.save_teardown_screenshot()")
+        data.append("        # << Add custom code BEFORE the super() line >>")
         data.append("        super(BaseTestCase, self).tearDown()")
         data.append("")
         data.append("    def login(self):")

seleniumbase/fixtures/base_case.py

@@ -39,6 +39,7 @@ def test_anything(self):
 from selenium.common import exceptions as selenium_exceptions
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.keys import Keys
+from selenium.webdriver.remote.remote_connection import LOGGER
 from selenium.webdriver.support.ui import Select
 from seleniumbase import config as sb_config
 from seleniumbase.common import decorators
@@ -58,6 +59,7 @@ def test_anything(self):
 logging.getLogger("requests").setLevel(logging.ERROR)
 logging.getLogger("urllib3").setLevel(logging.ERROR)
 urllib3.disable_warnings()
+LOGGER.setLevel(logging.WARNING)
 ENI_Exception = selenium_exceptions.ElementNotInteractableException
 
 
@@ -76,6 +78,7 @@ def __init__(self, *args, **kwargs):
         self.__last_page_load_url = "data:,"
         self.__last_page_screenshot = None
         self.__last_page_screenshot_png = None
+        self.__added_pytest_html_extra = None
         self.__delayed_assert_count = 0
         self.__delayed_assert_failures = []
         self.__device_width = None
@@ -4108,9 +4111,7 @@ def setUp(self, masterqa_mode=False):
             self.is_pytest = False
         if self.is_pytest:
             # pytest-specific code
-            test_id = "%s.%s.%s" % (self.__class__.__module__,
-                                    self.__class__.__name__,
-                                    self._testMethodName)
+            test_id = self.__get_test_id()
             self.browser = sb_config.browser
             self.data = sb_config.data
             self.slow_mode = sb_config.slow_mode
@@ -4216,10 +4217,10 @@ def setUp(self, masterqa_mode=False):
 
         # Verify that SeleniumBase is installed successfully
         if not hasattr(self, "browser"):
-            raise Exception("""SeleniumBase plugins did not load! """
-                            """Please reinstall using:\n"""
-                            """ >>> "pip install -r requirements.txt" <<<\n"""
-                            """ >>> "python setup.py install" <<< """)
+            raise Exception("""SeleniumBase plugins DID NOT load!\n\n"""
+                            """*** Please REINSTALL SeleniumBase using: >\n"""
+                            """    >>> "pip install -r requirements.txt"\n"""
+                            """    >>> "python setup.py install" """)
         if self.settings_file:
             settings_parser.set_settings(self.settings_file)
         # Mobile Emulator device metrics: CSS Width, CSS Height, & Pixel-Ratio
@@ -4346,27 +4347,29 @@ def __insert_test_result(self, state, err):
         self.testcase_manager.update_testcase_data(data_payload)
 
     def __add_pytest_html_extra(self):
-        try:
-            if self.with_selenium:
-                if not self.__last_page_screenshot:
-                    self.__set_last_page_screenshot()
-                if self.report_on:
-                    extra_url = {}
-                    extra_url['name'] = 'URL'
-                    extra_url['format'] = 'url'
-                    extra_url['content'] = self.get_current_url()
-                    extra_url['mime_type'] = None
-                    extra_url['extension'] = None
-                    extra_image = {}
-                    extra_image['name'] = 'Screenshot'
-                    extra_image['format'] = 'image'
-                    extra_image['content'] = self.__last_page_screenshot
-                    extra_image['mime_type'] = 'image/png'
-                    extra_image['extension'] = 'png'
-                    self._html_report_extra.append(extra_url)
-                    self._html_report_extra.append(extra_image)
-        except Exception:
-            pass
+        if not self.__added_pytest_html_extra:
+            try:
+                if self.with_selenium:
+                    if not self.__last_page_screenshot:
+                        self.__set_last_page_screenshot()
+                    if self.report_on:
+                        extra_url = {}
+                        extra_url['name'] = 'URL'
+                        extra_url['format'] = 'url'
+                        extra_url['content'] = self.get_current_url()
+                        extra_url['mime_type'] = None
+                        extra_url['extension'] = None
+                        extra_image = {}
+                        extra_image['name'] = 'Screenshot'
+                        extra_image['format'] = 'image'
+                        extra_image['content'] = self.__last_page_screenshot
+                        extra_image['mime_type'] = 'image/png'
+                        extra_image['extension'] = 'png'
+                        self.__added_pytest_html_extra = True
+                        self._html_report_extra.append(extra_url)
+                        self._html_report_extra.append(extra_image)
+            except Exception:
+                pass
 
     def __quit_all_drivers(self):
         if self._reuse_session and sb_config.shared_driver:
@@ -4392,19 +4395,55 @@ def __quit_all_drivers(self):
         self._default_driver = None
         self._drivers_list = []
 
+    def __has_exception(self):
+        has_exception = False
+        if sys.version_info[0] >= 3 and hasattr(self, '_outcome'):
+            if hasattr(self._outcome, 'errors') and self._outcome.errors:
+                has_exception = True
+        else:
+            has_exception = sys.exc_info()[1] is not None
+        return has_exception
+
+    def __get_test_id(self):
+        test_id = "%s.%s.%s" % (self.__class__.__module__,
+                                self.__class__.__name__,
+                                self._testMethodName)
+        return test_id
+
+    def __create_log_path_as_needed(self, test_logpath):
+        if not os.path.exists(test_logpath):
+            try:
+                os.makedirs(test_logpath)
+            except Exception:
+                pass  # Only reachable during multi-threaded runs
+
+    def save_teardown_screenshot(self):
+        """ (Should ONLY be used at the start of custom tearDown() methods.)
+            This method takes a screenshot of the current web page for a
+            failing test (or when running your tests with --save-screenshot).
+            That way your tearDown() method can navigate away from the last
+            page where the test failed, and still get the correct screenshot
+            before performing tearDown() steps on other pages. If this method
+            is not included in your custom tearDown() method, a screenshot
+            will still be taken after the last step of your tearDown(), where
+            you should be calling "super(SubClassOfBaseCase, self).tearDown()"
+        """
+        test_id = self.__get_test_id()
+        test_logpath = self.log_path + "/" + test_id
+        self.__create_log_path_as_needed(test_logpath)
+        if self.__has_exception() or self.save_screenshot_after_test:
+            self.__set_last_page_screenshot()
+            if self.is_pytest:
+                self.__add_pytest_html_extra()
+
     def tearDown(self):
         """
         Be careful if a subclass of BaseCase overrides setUp()
         You'll need to add the following line to the subclass's tearDown():
         super(SubClassOfBaseCase, self).tearDown()
         """
         self.__slow_mode_pause_if_active()
-        has_exception = False
-        if sys.version_info[0] >= 3 and hasattr(self, '_outcome'):
-            if hasattr(self._outcome, 'errors') and self._outcome.errors:
-                has_exception = True
-        else:
-            has_exception = sys.exc_info()[1] is not None
+        has_exception = self.__has_exception()
         if self.__delayed_assert_failures:
             print(
                 "\nWhen using self.delayed_assert_*() methods in your tests, "
@@ -4414,18 +4453,9 @@ def tearDown(self):
                 self.process_delayed_asserts()
             else:
                 self.process_delayed_asserts(print_only=True)
-        self.is_pytest = None
-        try:
-            # This raises an exception if the test is not coming from pytest
-            self.is_pytest = sb_config.is_pytest
-        except Exception:
-            # Not using pytest (probably nosetests)
-            self.is_pytest = False
         if self.is_pytest:
             # pytest-specific code
-            test_id = "%s.%s.%s" % (self.__class__.__module__,
-                                    self.__class__.__name__,
-                                    self._testMethodName)
+            test_id = self.__get_test_id()
             try:
                 with_selenium = self.with_selenium
             except Exception:
@@ -4460,11 +4490,7 @@ def tearDown(self):
                 if self.with_testing_base and not has_exception and (
                         self.save_screenshot_after_test):
                     test_logpath = self.log_path + "/" + test_id
-                    if not os.path.exists(test_logpath):
-                        try:
-                            os.makedirs(test_logpath)
-                        except Exception:
-                            pass  # Only reachable during multi-threaded runs
+                    self.__create_log_path_as_needed(test_logpath)
                     if not self.__last_page_screenshot_png:
                         self.__set_last_page_screenshot()
                     log_helper.log_screenshot(
@@ -4474,11 +4500,7 @@ def tearDown(self):
                     self.__add_pytest_html_extra()
                 if self.with_testing_base and has_exception:
                     test_logpath = self.log_path + "/" + test_id
-                    if not os.path.exists(test_logpath):
-                        try:
-                            os.makedirs(test_logpath)
-                        except Exception:
-                            pass  # Only reachable during multi-threaded runs
+                    self.__create_log_path_as_needed(test_logpath)
                     if ((not self.with_screen_shots) and (
                             not self.with_basic_test_info) and (
                             not self.with_page_source)):
@@ -4553,15 +4575,9 @@ def tearDown(self):
         else:
             # (Nosetests)
             if has_exception:
-                test_id = "%s.%s.%s" % (self.__class__.__module__,
-                                        self.__class__.__name__,
-                                        self._testMethodName)
+                test_id = self.__get_test_id()
                 test_logpath = self.log_path + "/" + test_id
-                if not os.path.exists(test_logpath):
-                    try:
-                        os.makedirs(test_logpath)
-                    except Exception:
-                        pass  # Only reachable during multi-threaded runs
+                self.__create_log_path_as_needed(test_logpath)
                 log_helper.log_test_failure_data(
                     self, test_logpath, self.driver, self.browser)
                 if len(self._drivers_list) > 0:
@@ -4573,15 +4589,9 @@ def tearDown(self):
                         self.__last_page_screenshot_png)
                     log_helper.log_page_source(test_logpath, self.driver)
             elif self.save_screenshot_after_test:
-                test_id = "%s.%s.%s" % (self.__class__.__module__,
-                                        self.__class__.__name__,
-                                        self._testMethodName)
+                test_id = self.__get_test_id()
                 test_logpath = self.log_path + "/" + test_id
-                if not os.path.exists(test_logpath):
-                    try:
-                        os.makedirs(test_logpath)
-                    except Exception:
-                        pass  # Only reachable during multi-threaded runs
+                self.__create_log_path_as_needed(test_logpath)
                 if not self.__last_page_screenshot_png:
                     self.__set_last_page_screenshot()
                 log_helper.log_screenshot(

seleniumbase/virtual_display/abstractdisplay.py

@@ -7,10 +7,6 @@
 from seleniumbase.virtual_display import xauth
 
 mutex = Lock()
-RANDOMIZE_DISPLAY_NR = False
-if RANDOMIZE_DISPLAY_NR:
-    import random
-    random.seed()
 MIN_DISPLAY_NR = 1000
 USED_DISPLAY_NR_LIST = []
 
@@ -59,8 +55,6 @@ def search_for_display(self):
             display = max(MIN_DISPLAY_NR, max(ls) + 3)
         else:
             display = MIN_DISPLAY_NR
-        if RANDOMIZE_DISPLAY_NR:
-            display += random.randint(0, 100)
         return display
 
     def redirect_display(self, on):

seleniumbase/virtual_display/easyprocess.py

@@ -13,6 +13,7 @@
 import time
 
 log = logging.getLogger(__name__)
+log.setLevel(logging.ERROR)
 SECTION_LINK = 'link'
 POLL_TIME = 0.1
 USE_POLL = 0

seleniumbase/virtual_display/xauth.py

@@ -1,7 +1,7 @@
 '''Utility functions for xauth.'''
 import os
 import hashlib
-from seleniumbase.virtual_display import easyprocess
+from seleniumbase.virtual_display.easyprocess import EasyProcess
 
 
 class NotFoundError(Exception):
@@ -14,8 +14,11 @@ def is_installed():
     Return whether or not xauth is installed.
     '''
     try:
-        easyprocess.EasyProcess(['xauth', '-h']).check_installed()
-    except easyprocess.EasyProcessCheckInstalledError:
+        p = EasyProcess(['xauth', '-V'])
+        p.enable_stdout_log = False
+        p.enable_stderr_log = False
+        p.call()
+    except Exception:
         return False
     else:
         return True
@@ -33,4 +36,4 @@ def call(*args):
     '''
     Call xauth with the given args.
     '''
-    easyprocess.EasyProcess(['xauth'] + list(args)).call()
+    EasyProcess(['xauth'] + list(args)).call()

seleniumbase/virtual_display/xephyr.py

@@ -1,9 +1,7 @@
 from seleniumbase.virtual_display.easyprocess import EasyProcess
 from seleniumbase.virtual_display.abstractdisplay import AbstractDisplay
 
-PACKAGE = 'xephyr'
 PROGRAM = 'Xephyr'
-URL = None
 
 
 class XephyrDisplay(AbstractDisplay):
@@ -26,8 +24,10 @@ def __init__(self, size=(1024, 768), color_depth=24, bgcolor='black'):
 
     @classmethod
     def check_installed(cls):
-        EasyProcess([PROGRAM, '-help'], url=URL,
-                    ubuntu_package=PACKAGE).check_installed()
+        p = EasyProcess([PROGRAM, '-help'])
+        p.enable_stdout_log = False
+        p.enable_stderr_log = False
+        p.call()
 
     @property
     def _cmd(self):