Use jquery-confirm by default for MasterQA page checks

Author: mdmintz

seleniumbase/masterqa/master_qa.py

@@ -7,6 +7,7 @@
 from seleniumbase import BaseCase
 from seleniumbase.core.style_sheet import style
 from seleniumbase.config import settings
+from seleniumbase.fixtures import js_utils
 
 LATEST_REPORT_DIR = settings.LATEST_REPORT_DIR
 ARCHIVE_DIR = settings.REPORT_ARCHIVE_DIR
@@ -57,54 +58,135 @@ def clear_out_old_logs(self, archive_past_runs=True, get_log_folder=False):
             for f in filelist:
                 os.remove("%s/%s" % (file_path, f))
 
+    def jq_confirm_dialog(self, question):
+        count = self.manual_check_count + 1
+        question = js_utils.escape_quotes_if_needed(question)
+        jqcd = ("""jconfirm({
+                    boxWidth: '30%%',
+                    useBootstrap: false,
+                    containerFluid: false,
+                    theme: 'light',
+                    animation: 'scale',
+                    draggable: true,
+                    dragWindowGap: 0,
+                    container: 'body',
+                    title: 'Manual Check #%s:',
+                    content: '<h3><b>%s</b></h3>',
+                    buttons: {
+                        fail_button: {
+                            btnClass: 'btn-red',
+                            text: 'NO / FAIL',
+                            action: function(){
+                                $jqc_status = "Failure!"
+                            }
+                        },
+                        pass_button: {
+                            btnClass: 'btn-green',
+                            text: 'YES / PASS',
+                            action: function(){
+                                $jqc_status = "Success!"
+                            }
+                        }
+                    }
+                });""" % (count, question))
+        self.execute_script(jqcd)
+
     def manual_page_check(self, *args):
         if not args:
-            instructions = DEFAULT_VALIDATION_MESSAGE
+            instructions = DEFAULT_VALIDATION_MESSAGE  # self.verify()
         else:
             instructions = str(args[0])
+            if len(args) > 1:
+                pass
 
-        # Give the human enough time to see the page first
-        wait_time_before_verify = WAIT_TIME_BEFORE_VERIFY
-        if self.verify_delay:
-            wait_time_before_verify = float(self.verify_delay)
-        time.sleep(wait_time_before_verify)
-        question = "Approve?"
+        question = "Approve?"  # self.verify("")
         if instructions and "?" not in instructions:
-            question = instructions + " Approve?"
+            question = instructions + " <> Approve?"
         elif instructions and "?" in instructions:
             question = instructions
 
-        if self.browser == 'ie':
-            text = self.execute_script(
-                '''if(confirm("%s")){return "Success!"}
-                else{return "Failure!"}''' % question)
-        elif self.browser == 'chrome':
-            self.execute_script('''if(confirm("%s"))
-                {window.master_qa_result="Success!"}
-                else{window.master_qa_result="Failure!"}''' % question)
-            time.sleep(0.05)
-            self.wait_for_special_alert_absent()
-            text = self.execute_script('''return window.master_qa_result''')
+        use_jqc = False
+        if js_utils.is_jquery_confirm_activated(self.driver):
+            use_jqc = True
         else:
+            if self.browser == "firefox":
+                js_utils.activate_jquery(self.driver)
+            js_utils.activate_jquery_confirm(self.driver)
+            get_jqc = None
+            try:
+                get_jqc = self.execute_script("return jconfirm")
+                get_jqc = get_jqc["instances"]
+                use_jqc = True
+            except Exception:
+                use_jqc = False
+
+        if use_jqc:
+            wait_time_before_verify = WAIT_TIME_BEFORE_VERIFY
+            if self.verify_delay:
+                wait_time_before_verify = float(self.verify_delay)
+            # Allow a moment to see the full page before the dialog box pops up
+            time.sleep(wait_time_before_verify)
+
+            # Use the jquery_confirm library for manual page checks
+            self.jq_confirm_dialog(question)
+            time.sleep(0.02)
+            waiting_for_response = True
+            while waiting_for_response:
+                time.sleep(0.05)
+                jqc_open = self.execute_script(
+                    "return jconfirm.instances.length")
+                if str(jqc_open) == "0":
+                    break
+            time.sleep(0.1)
+            status = None
             try:
-                self.execute_script(
-                    '''if(confirm("%s")){window.master_qa_result="Success!"}
+                status = self.execute_script("return $jqc_status")
+            except Exception:
+                status = "Failure!"
+                pre_status = self.execute_script(
+                    "return jconfirm.lastClicked.hasClass('btn-green')")
+                if pre_status:
+                    status = "Success!"
+        else:
+            # Fallback to plain js confirm dialogs if can't load jquery_confirm
+            if self.browser == 'ie':
+                text = self.execute_script(
+                    '''if(confirm("%s")){return "Success!"}
+                    else{return "Failure!"}''' % question)
+            elif self.browser == 'chrome':
+                self.execute_script('''if(confirm("%s"))
+                    {window.master_qa_result="Success!"}
                     else{window.master_qa_result="Failure!"}''' % question)
-            except WebDriverException:
-                # Fix for https://github.com/mozilla/geckodriver/issues/431
-                pass
-            time.sleep(0.05)
-            self.wait_for_special_alert_absent()
-            text = self.execute_script('''return window.master_qa_result''')
+                time.sleep(0.05)
+                self.wait_for_special_alert_absent()
+                text = self.execute_script('return window.master_qa_result')
+            else:
+                try:
+                    self.execute_script(
+                        '''if(confirm("%s"))
+                        {window.master_qa_result="Success!"}
+                        else{window.master_qa_result="Failure!"}''' % question)
+                except WebDriverException:
+                    # Fix for https://github.com/mozilla/geckodriver/issues/431
+                    pass
+                time.sleep(0.05)
+                self.wait_for_special_alert_absent()
+                text = self.execute_script('return window.master_qa_result')
+            status = text
+
         self.manual_check_count += 1
-        if "Success!" in text:
+        try:
+            current_url = self.driver.current_url
+        except Exception:
+            current_url = self.execute_script("return document.URL")
+        if "Success!" in str(status):
             self.manual_check_successes += 1
             self.page_results_list.append(
                 '"%s","%s","%s","%s","%s","%s","%s","%s"' % (
                     self.manual_check_count,
                     "Success",
                     "-",
-                    self.driver.current_url,
+                    current_url,
                     self.browser,
                     self.get_timestamp()[:-3],
                     instructions,
@@ -118,7 +200,7 @@ def manual_page_check(self, *args):
                     self.manual_check_count,
                     "FAILED!",
                     bad_page_name,
-                    self.driver.current_url,
+                    current_url,
                     self.browser,
                     self.get_timestamp()[:-3],
                     instructions,
@@ -200,15 +282,18 @@ def process_manual_check_results(self, auto_close_results_page=False):
         if self.manual_check_successes == self.manual_check_count:
             pass
         else:
-            print("WARNING!!! There were page issues detected!")
+            print("WARNING: There were page issues detected!")
             perfection = False
 
         if self.incomplete_runs > 0:
-            print("WARNING!!! Not all tests finished running!")
+            print("WARNING: Not all tests finished running!")
             perfection = False
 
         if perfection:
-            print("SUCCESS!!! Everything checks out OKAY!")
+            if self.manual_check_count > 0:
+                print("SUCCESS: Everything checks out OKAY!")
+            else:
+                print("WARNING: No manual checks were performed!")
         else:
             pass
         self.add_bad_page_log_file()  # Includes successful results
@@ -303,13 +388,23 @@ def process_manual_check_results(self, auto_close_results_page=False):
 class MasterQA(__MasterQATestCase__):
 
     def setUp(self):
+        self.check_count = 0
         self.auto_close_results_page = False
         super(__MasterQATestCase__, self).setUp()
         self.manual_check_setup()
+        if self.headless:
+            self.auto_close_results_page = True
         if START_IN_FULL_SCREEN_MODE:
             self.maximize_window()
 
     def verify(self, *args):
+        warn_msg = "\nWARNING: MasterQA skips manual checks in headless mode!"
+        self.check_count += 1
+        if self.headless:
+            if self.check_count == 1:
+                print(warn_msg)
+            return
+        # This is where the magic happens
         self.manual_page_check(*args)
 
     def auto_close_results(self):
@@ -320,6 +415,8 @@ def auto_close_results(self):
         self.auto_close_results_page = True
 
     def tearDown(self):
+        if self.headless and self.check_count > 0:
+            print("WARNING: %s manual checks were skipped!" % self.check_count)
         if sys.exc_info()[1]:
             self.add_failure(sys.exc_info()[1])
         self.process_manual_check_results(self.auto_close_results_page)