Add the inspect_html() method

Author: mdmintz

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/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