Merge pull request #235 from AutomationSolutionz/selenium_deprecation_fix

Selenium deprecation fix

Author: Muntasib-creator

Framework/Built_In_Automation/Sequential_Actions/common_functions.py

@@ -790,7 +790,9 @@ def save_into_variable(data_set):
 
         try:
             if extra_operation:
-                if "length" in extra_operation:
+                if "path" in extra_operation or "directory" in extra_operation:
+                    variable_value = CommonUtil.path_parser(variable_value)
+                elif "length" in extra_operation:
                     variable_value = len(variable_value)
                 elif "no duplicate" in extra_operation:
                     variable_value = list(set(variable_value))

Framework/Built_In_Automation/Sequential_Actions/sequential_actions.py

@@ -587,7 +587,7 @@ def for_loop_action(step_data, data_set_no):
                         iterable = CommonUtil.ZeuZ_map_code_decoder(iterable)   # Decode if this is a ZeuZ_map_code
                     else:
                         iterable = CommonUtil.parse_value_into_object(left)
-                    CommonUtil.ExecLog(sModuleInfo, "Looping through a %s: %s" % (type(iterable).__name__, str(iterable)), 1)
+                        CommonUtil.ExecLog(sModuleInfo, "Looping through a %s: %s" % (type(iterable).__name__, str(iterable)), 1)
             elif row[0].strip().lower().startswith("exit loop"):
                 if not row[2].lower().startswith("if"):
                     CommonUtil.ExecLog(
@@ -2135,6 +2135,7 @@ def Action_Handler(_data_set, action_row, _bypass_bug=True):
             return "zeuz_failed" 
 
     module, function, original_module, screenshot = common.get_module_and_function(action_name, action_subfield)  # New, get the module to execute
+    CommonUtil.prettify_limit = sr.Get_Shared_Variables("zeuz_prettify_limit")
 
     if module in failed_tag_list or module == "" or function == "":  # New, make sure we have a function
         CommonUtil.ExecLog(sModuleInfo, "You probably didn't add the module as part of the action. Eg: appium action", 3)
@@ -2157,11 +2158,16 @@ def Action_Handler(_data_set, action_row, _bypass_bug=True):
     data_set = []
     for row in _data_set:
         new_row = list(row)
-        if row[1].strip().lower() in ("optional parameter", "optional option") and row[0].strip().lower() in ("screen capture", "screenshot", "ss"):
-            screenshot = row[2].strip().lower()
-            if screenshot in ("false", "no", "none", "disable"):
-                screenshot = "none"
-            continue
+        if row[1].strip().lower() in ("optional parameter", "optional option"):
+            if row[0].strip().lower() in ("screen capture", "screenshot", "ss"):
+                screenshot = row[2].strip().lower()
+                if screenshot in ("false", "no", "none", "disable"):
+                    screenshot = "none"
+                continue
+            if row[0].replace(" ", "").lower() in ("prettifylimit"):
+                CommonUtil.prettify_limit = CommonUtil.parse_value_into_object(row[2].split(" ")[-1])
+                continue
+
         if "optional" in row[1]:
             new_row[1] = new_row[1].replace("optional", "").strip()
         if "bypass" in row[1]:

Framework/Built_In_Automation/Shared_Resources/LocateElement.py

@@ -219,6 +219,7 @@ def Get_Element(step_data_set, driver, query_debug=False, return_all_elements=Fa
                     pass
             if save_parameter != "":  # save element to a variable
                 sr.Set_Shared_Variables(save_parameter, result)
+            sr.Set_Shared_Variables("zeuz_element", result)
             return result  # Return on pass
         elif result == "zeuz_failed":
             try:

Framework/Built_In_Automation/Web/Selenium/BuiltInFunctions.py

@@ -82,6 +82,31 @@
 selenium_details = {}
 default_x, default_y = 1920, 1080
 
+# JavaScript for collecting First Contentful Paint value.
+JS_FCP = '''
+return performance.getEntriesByName("first-contentful-paint")[0].startTime
+'''
+
+# JavaScript for collecting Largest Contentful Paint value.
+JS_LCP = '''
+var args = arguments;
+const po = new PerformanceObserver(list => {
+    const entries = list.getEntries();
+    const entry = entries[entries.length - 1];
+    // Process entry as the latest LCP candidate
+    // LCP is accurate when the renderTime is available.
+    // Try to avoid this being false by adding Timing-Allow-Origin headers!
+    const accurateLCP = entry.renderTime ? true : false;
+    // Use startTime as the LCP timestamp. It will be renderTime if available, or loadTime otherwise.
+    const largestPaintTime = entry.startTime;
+    // Send the LCP information for processing.
+
+    console.log("[ZeuZ Node] Largest Contentful Paint: ", largestPaintTime);
+    args[0](largestPaintTime);
+});
+po.observe({ type: 'largest-contentful-paint', buffered: true });
+'''
+
 # if Shared_Resources.Test_Shared_Variables('selenium_driver'): # Check if driver is already set in shared variables
 #    selenium_driver = Shared_Resources.Get_Shared_Variables('selenium_driver') # Retreive appium driver
 
@@ -387,6 +412,7 @@ def get_performance_metrics(dataset):
         metrics = selenium_details[driver_id]["driver"].execute_cdp_cmd('Performance.getMetrics', {})
         perf_json_data = {data["name"]: data["value"] for data in metrics["metrics"]}
         Shared_Resources.Set_Shared_Variables(var_name,perf_json_data)
+        CommonUtil.browser_perf[current_driver_id].append(perf_json_data)
         return "passed"
     except:
         return CommonUtil.Exception_Handler(sys.exc_info())
@@ -975,15 +1001,28 @@ def Go_To_Link(step_data, page_title=False):
     except Exception:
         ErrorMessage = "failed to open your link: %s" % (web_link)
         return CommonUtil.Exception_Handler(sys.exc_info(), None, ErrorMessage)
+
+    # Collect custom performance metrics
     try:
         if current_driver_id not in CommonUtil.browser_perf:
             metrics = selenium_driver.execute_cdp_cmd('Performance.getMetrics', {})
             metrics_dict = {data["name"]: data["value"] for data in metrics["metrics"]}
+
+            # FCP - First Contentful Paint
             try:
-                metrics_dict["first-contentful-paint"] = selenium_driver.execute_script('return performance.getEntriesByName("first-contentful-paint")[0].startTime')
+                metrics_dict["first-contentful-paint"] = selenium_driver.execute_script(JS_FCP)
             except:
                 metrics_dict["first-contentful-paint"] = 0
+
+            # LCP - Largest Contenful Paint
+            try:
+                metrics_dict["largest-contentful-paint"] = selenium_driver.execute_async_script(JS_LCP)
+            except:
+                metrics_dict["largest-contentful-paint"] = 0
+
             CommonUtil.browser_perf[current_driver_id] = [metrics_dict]
+
+            # CommonUtil.prettify(key="metrics", val=metrics_dict)
         return "passed"
     except:
         return CommonUtil.Exception_Handler(sys.exc_info())
@@ -1167,7 +1206,7 @@ def Enter_Text_In_Text_Box(step_data):
             selenium_driver.execute_script("arguments[0].click();", Element)
         else:
             try:
-                handle_clickability_and_click(step_data, Element)
+                Element = handle_clickability_and_click(step_data, Element)
             except:
                 CommonUtil.ExecLog(sModuleInfo, "Entering text without clicking the element", 2)
             if clear:
@@ -1358,28 +1397,38 @@ def execute_javascript(data_set):
 
 def handle_clickability_and_click(dataset, Element:selenium.webdriver.remote.webelement.WebElement):
     sModuleInfo = inspect.currentframe().f_code.co_name + " : " + MODULE_NAME
-    wait_clickable = 0
-    for left, mid, right in dataset:
-        if mid.strip().lower() == "option":
-            left = left.strip().lower()
-            if "wait" in left and "clickable" in left:
-                wait_clickable = int(right.strip())
-    if not wait_clickable:
-        Element.click()     # no need of try except here. we need to return the exact exception upto this point
-    else:
-        log_flag = True
-        start = time.time()
-        while True:
-            try:
-                Element.click()
-                break
-            except ElementClickInterceptedException:
-                if log_flag:
-                    CommonUtil.ExecLog(sModuleInfo, "The Element is overlapped. Waiting %s seconds max for the element to become clickable" % wait_clickable, 2)
-                    log_flag = False
-                if time.time() > start + wait_clickable:
-                    raise Exception     # not ElementClickInterceptedException. we dont want js to perform click
-
+    wait_clickable = Shared_Resources.Get_Shared_Variables("element_wait")
+    # for left, mid, right in dataset:
+    #     if mid.strip().lower() == "option":
+    #         left = left.strip().lower()
+    #         if "wait" in left and "clickable" in left:
+    #             wait_clickable = int(right.strip())
+    # if not wait_clickable:
+    #     Element.click()     # no need of try except here. we need to return the exact exception upto this point
+    # else:
+    log_flag = True
+    log_flag2 = True
+    start = time.perf_counter()
+    stale_i = 0
+    while True:
+        try:
+            Element.click()
+            CommonUtil.ExecLog(sModuleInfo, "Element has become clickable after %s seconds" % round(time.perf_counter() - start, 2), 2)
+            return Element
+        except ElementClickInterceptedException:
+            if log_flag:
+                CommonUtil.ExecLog(sModuleInfo, "Click is Intercepted. Waiting %s seconds max for the element to become clickable" % wait_clickable, 2)
+                log_flag = False
+        except StaleElementReferenceException:
+            if log_flag2:
+                CommonUtil.ExecLog(sModuleInfo, "Element is stale. Waiting %s seconds max for the element to become clickable" % wait_clickable, 2)
+                log_flag2 = False
+            Element = LocateElement.Get_Element(dataset, selenium_driver)  # Element may need to be relocated in stale
+            if stale_i == 0:
+                stale_i += 1
+                continue
+        if time.perf_counter() > start + wait_clickable:
+            raise Exception     # not StaleElementReferenceException. we don't want js to perform click
 
 # Method to click on element; step data passed on by the user
 @logger

Framework/MainDriverApi.py

@@ -867,6 +867,10 @@ def run_test_case(
         TestCaseName = testcase_info["title"]
         shared.Set_Shared_Variables("zeuz_current_tc", testcase_info, print_variable=False, pretty=False)
         shared.Set_Shared_Variables("zeuz_auto_teardown", "on")
+        if not CommonUtil.debug_status or not shared.Test_Shared_Variables("zeuz_prettify_limit"):
+            shared.Set_Shared_Variables("zeuz_prettify_limit", None)
+            CommonUtil.prettify_limit = None
+
         # shared.Set_Shared_Variables("zeuz_automation_log", Path(temp_ini_file).parent.__str__())
         shared.Set_Shared_Variables("zeuz_attachments_dir", (Path(temp_ini_file).parent/"attachments").__str__())
         if not shared.Test_Shared_Variables("element_wait"):

Framework/Utilities/CommonUtil.py

@@ -106,6 +106,7 @@
 previous_log_line = None
 teardown = True
 print_execlog = True
+prettify_limit = None
 
 step_module_name = None
 
@@ -216,17 +217,22 @@ def prettify(key, val):
     """Tries to pretty print the given value."""
     color = Fore.MAGENTA
     try:
-        if type(val) == str:
-            val = parse_value_into_object(val)
-        print(color + "%s = " % (key), end="")
-        print_json(data=val)
-        expression = "%s = %s" % (key, json.dumps(val, indent=2, sort_keys=True))
+        if prettify_limit is None:
+            if type(val) == str:
+                val = parse_value_into_object(val)
+            print(color + "%s = " % (key), end="")
+            print_json(data=val)
+        else:
+            print(color + "%s = " % (key), end="")
+            print(json.dumps(val,indent=2)[:prettify_limit])
+
+        expression = "%s = %s" % (key, json.dumps(val, indent=2, sort_keys=True)[:prettify_limit])
         if debug_status and key not in dont_prettify_on_server:
             live_log_service.log("VARIABLE", 4, expression.replace("\n", "<br>").replace(" ", "&nbsp;"))
             # 4 means console log which is Magenta color in server console
     except:
         # expression = "%s" % (key, val)
-        print(color + str(val))
+        print(color + str(val)[:prettify_limit])
         if debug_status and key not in dont_prettify_on_server:
             live_log_service.log("VARIABLE", 4, str(val).replace("\n", "<br>").replace(" ", "&nbsp;"))