Merge pull request #418 from seleniumbase/add-html-inspector

Add the inspect_html() method

Author: mdmintz

.travis.yml

@@ -35,6 +35,7 @@ script:
   - "nosetests examples/boilerplates/boilerplate_test.py --browser=chrome --headless"
   - "pytest examples/my_first_test.py --browser=firefox -s --headless --with-db_reporting"
   - "pytest examples/my_first_test.py --browser=chrome -s --headless --with-db_reporting --demo_mode --demo_sleep=0.2"
+  - "pytest examples/test_inspect_html.py --browser=chrome -s --headless --with-db_reporting"
   - "pytest examples/tour_examples/google_tour.py -s --headless --with-db_reporting"
   - "sudo mysql --password=test -e 'select test_address,browser,state,start_time,runtime from test_db.test_run_data'"
 #after_script:

azure-pipelines.yml

@@ -54,6 +54,9 @@ jobs:
   - script: 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
+    displayName: 'Run pytest test_inspect_html.py --browser=chrome --headless'
+
   - script: pytest examples/my_first_test.py --browser=firefox --headless -v -s --junit-xml=junit/test-results.xml
     displayName: 'Run pytest my_first_test.py --browser=firefox --headless'
 

examples/test_inspect_html.py

@@ -0,0 +1,13 @@
+"""
+Uses the SeleniumBase implementation of HTML-Inspector to inspect the HTML.
+See https://github.com/philipwalton/html-inspector for more details.
+"""
+
+from seleniumbase import BaseCase
+
+
+class MyTestClass(BaseCase):
+
+    def test_html_inspector(self):
+        self.open("https://xkcd.com/1144/")
+        self.inspect_html()

help_docs/method_summary.md

@@ -243,6 +243,8 @@ self.assert_title(title)
 
 self.assert_no_js_errors()
 
+self.inspect_html()
+
 self.get_google_auth_password(totp_key=None)
 
 self.convert_xpath_to_css(xpath)

requirements.txt

@@ -19,7 +19,7 @@ pytest-forked>=1.1.3
 pytest-html==1.22.0
 pytest-metadata>=1.8.0
 pytest-ordering>=0.6
-pytest-rerunfailures>=7.0
+pytest-rerunfailures>=8.0
 pytest-timeout>=1.3.3
 pytest-xdist>=1.30.0
 parameterized>=0.7.0
@@ -28,7 +28,7 @@ atomicwrites>=1.3.0
 portalocker>=1.5.2
 cryptography>=2.8
 asn1crypto>=1.2.0
-pyopenssl>=19.0.0
+pyopenssl>=19.1.0
 colorama>=0.4.1
 pymysql>=0.9.3
 pyotp>=2.3.0

seleniumbase/fixtures/base_case.py

@@ -2022,6 +2022,49 @@ def assert_no_js_errors(self):
             messenger_post = ("ASSERT NO JS ERRORS")
             self.__highlight_with_assert_success(messenger_post, "html")
 
+    def __activate_html_inspector(self):
+        js_utils.activate_html_inspector(self.driver)
+
+    def inspect_html(self):
+        """ Inspects the Page HTML with HTML-Inspector.
+            (https://github.com/philipwalton/html-inspector)
+            (https://cdnjs.com/libraries/html-inspector)
+            Prints the results and also returns them. """
+        self.__activate_html_inspector()
+        script = ("""HTMLInspector.inspect();""")
+        self.execute_script(script)
+        time.sleep(0.1)
+        browser_logs = []
+        try:
+            browser_logs = self.driver.get_log('browser')
+        except (ValueError, WebDriverException):
+            # If unable to get browser logs, skip the assert and return.
+            return("(Unable to Inspect HTML! -> Only works on Chrome!)")
+        messenger_library = "//cdnjs.cloudflare.com/ajax/libs/messenger"
+        url = self.get_current_url()
+        header = '\n* HTML Inspection Results: %s' % url
+        results = [header]
+        row_count = 0
+        for entry in browser_logs:
+            message = entry['message']
+            if "0:6053 " in message:
+                message = message.split("0:6053")[1]
+            message = message.replace("\\u003C", "<")
+            if message.startswith(' "') and message.count('"') == 2:
+                message = message.split('"')[1]
+            message = "X - " + message
+            if messenger_library not in message:
+                if message not in results:
+                    results.append(message)
+                    row_count += 1
+        if row_count > 0:
+            results.append('* (See the Console output for details!)')
+        else:
+            results.append('* (No issues detected!)')
+        results = '\n'.join(results)
+        print(results)
+        return(results)
+
     def get_google_auth_password(self, totp_key=None):
         """ Returns a time-based one-time password based on the
             Google Authenticator password algorithm. Works with Authy.

seleniumbase/fixtures/constants.py

@@ -66,6 +66,12 @@ class Backbone:
               "backbone.js/%s/backbone-min.js" % VER)
 
 
+class HtmlInspector:
+    VER = "0.8.2"
+    MIN_JS = ("//cdnjs.cloudflare.com/ajax/libs/"
+              "html-inspector/%s/html-inspector.min.js" % VER)
+
+
 class BootstrapTour:
     VER = "0.11.0"
     MIN_CSS = ("//cdnjs.cloudflare.com/ajax/libs/"

seleniumbase/fixtures/js_utils.py

@@ -75,6 +75,14 @@ def wait_for_angularjs(driver, timeout=settings.LARGE_TIMEOUT, **kwargs):
         time.sleep(0.05)
 
 
+def is_html_inspector_activated(driver):
+    try:
+        driver.execute_script("HTMLInspector")  # Fails if not defined
+        return True
+    except Exception:
+        return False
+
+
 def is_jquery_activated(driver):
     try:
         driver.execute_script("jQuery('html')")  # Fails if jq is not defined
@@ -386,6 +394,28 @@ def activate_jquery_confirm(driver):
             time.sleep(0.1)
 
 
+def activate_html_inspector(driver):
+    jquery_js = constants.JQuery.MIN_JS
+    html_inspector_js = constants.HtmlInspector.MIN_JS
+
+    if is_html_inspector_activated(driver):
+        return
+    if not is_jquery_activated(driver):
+        add_js_link(driver, jquery_js)
+        wait_for_jquery_active(driver, timeout=0.6)
+    add_js_link(driver, html_inspector_js)
+
+    for x in range(7):
+        # HTML-Inspector needs a small amount of time to load & activate.
+        try:
+            driver.execute_script("HTMLInspector")
+            wait_for_ready_state_complete(driver)
+            wait_for_angularjs(driver)
+            return
+        except Exception:
+            time.sleep(0.1)
+
+
 def activate_messenger(driver):
     jquery_js = constants.JQuery.MIN_JS
     messenger_css = constants.Messenger.MIN_CSS

seleniumbase/resources/html_inspector/html-inspector.min.js

@@ -45,7 +45,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.32.24',
+    version='1.33.0',
     description='Fast, Easy, and Reliable Browser Automation & Testing.',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -102,7 +102,7 @@
         'pytest-html==1.22.0',  # Keep at 1.22.0 unless tested on Windows
         'pytest-metadata>=1.8.0',
         'pytest-ordering>=0.6',
-        'pytest-rerunfailures>=7.0',
+        'pytest-rerunfailures>=8.0',
         'pytest-timeout>=1.3.3',
         'pytest-xdist>=1.30.0',
         'parameterized>=0.7.0',
@@ -111,7 +111,7 @@
         'portalocker>=1.5.2',
         'cryptography>=2.8',
         'asn1crypto>=1.2.0',
-        'pyopenssl>=19.0.0',
+        'pyopenssl>=19.1.0',
         'colorama>=0.4.1',
         'pymysql>=0.9.3',
         'pyotp>=2.3.0',