browser profile addition for Chrome, Edge and Firefox

Author: Tareq

Framework/Built_In_Automation/Sequential_Actions/action_declarations/info.py

@@ -85,6 +85,7 @@
     "graphql",
     "shared capability",
     "chrome option", "chrome options", "chrome experimental option", "chrome experimental options",
+    "profile option", "profile options",
     "pre sleep", "post sleep", "pre post sleep", "post pre sleep"
 )
 patterns = [

Framework/Built_In_Automation/Web/Selenium/BuiltInFunctions.py

@@ -478,9 +478,23 @@ def set_extension_variables():
                 file.write(text.replace("__ZeuZ__SibLing_maPP_true", "__ZeuZ__SibLing_maPP", 1))
 
 
+def browser_process_status(browser:str):
+    list_process_command = ['tasklist']
+    seacrh_command = ['findstr', f'{browser}.exe']
+
+    list_process = subprocess.Popen(list_process_command, stdout=subprocess.PIPE)
+    search_process = subprocess.Popen(seacrh_command, stdin=list_process.stdout, stdout=subprocess.PIPE, text=True)
+
+    output,_ = search_process.communicate()
+
+    if output:
+        return True
+    else:
+        return False
+
 initial_download_folder = None
 @logger
-def Open_Browser(dependency, window_size_X=None, window_size_Y=None, capability=None, browser_options=None):
+def Open_Browser(dependency, window_size_X=None, window_size_Y=None, capability=None, browser_options=None, profile_options=None):
     """ Launch browser and create instance """
 
     global selenium_driver
@@ -540,6 +554,52 @@ def Open_Browser(dependency, window_size_X=None, window_size_Y=None, capability=
         CommonUtil.teardown = True
         browser = browser.lower().strip()
         selenium_version = selenium.__version__
+
+        kill_process = False
+
+        browser_map = {
+            "microsoft edge chromium": 'msedge',
+            "chrome": "chrome",
+            "fireFox": "firefox",
+            "firefox": "firefox",
+            "chromeHeadless": "chrome",
+            "firefoxHeadless": "firefox",
+            "edgeChromiumHeadless": "msedge",
+        }
+
+        if profile_options:
+            if browser in browser_map.keys():
+                browser_short_form = browser_map[browser] 
+                process_status = browser_process_status(browser_short_form)
+                for options in profile_options:
+                    if options[0] == "autokillforprofile" and options[1] == "True":
+                        kill_process = True
+
+                if process_status == True and kill_process == False:
+                    err_msg = f'''
+                    Please close all the {browser} browser instance.
+                    Or, use the following optional parameter to do it automatically:
+                    ( auto kill for profile | browser option | True )
+                    '''
+                    CommonUtil.ExecLog(
+                        sModuleInfo, err_msg, 3
+                    )
+                    raise Exception
+                elif process_status == True and kill_process == True:
+                    task_kill_command = ['taskkill', '/IM', f'{browser_short_form}.exe', '/F']
+                    task_kill_process = subprocess.Popen(task_kill_command, stdout=subprocess.PIPE, text=True)
+                    kill_output,err = task_kill_process.communicate()
+                    kill_output_status = kill_output.split()[0]
+                    if kill_output_status == "SUCCESS:":
+                        CommonUtil.ExecLog(
+                            sModuleInfo, f"Successfully terminated all the {browser_short_form}.exe processes", 1
+                        )
+            else:
+                CommonUtil.ExecLog(
+                        sModuleInfo, f"ZeuZ does not support browser profile for {browser} browser", 3
+                    )
+                raise Exception
+                
         if browser in ("ios",):
             # Finds the appium binary and starts the server.
             appium_port = start_appium_server()
@@ -614,6 +674,12 @@ def Open_Browser(dependency, window_size_X=None, window_size_Y=None, capability=
                         else:
                             options.add_experimental_option(list(right.items())[0][0], list(right.items())[0][1])
 
+            if profile_options:
+                for left, right in profile_options:
+                    if left in ("addargument", "addarguments"):
+                        options.add_argument(right.strip())
+                        print(left, right)
+
             if browser == "android":
                 mobile_emulation = {"deviceName": "Pixel 2 XL"}
                 options.add_experimental_option("mobileEmulation", mobile_emulation)
@@ -692,6 +758,12 @@ def chromeheadless():
             from selenium.webdriver.firefox.options import Options
             options = Options()
 
+            if profile_options:
+                for left, right in profile_options:
+                    if left in ("addargument", "addarguments"):
+                        options.add_argument(right.strip())
+                        print(left, right)
+
             if remote_browser_version:
                 options.set_capability("browserVersion",remote_browser_version)
 
@@ -796,6 +868,12 @@ def firefoxheadless():
 
             options.use_chromium = True
 
+            if profile_options:
+                for left, right in profile_options:
+                    if left in ("addargument", "addarguments"):
+                        options.add_argument(right.strip())
+                        print(left, right)
+
             if "headless" in browser:
                 def edgeheadless():
                     options.headless = True
@@ -1121,6 +1199,7 @@ def Go_To_Link(step_data, page_title=False):
 
     # options for add_argument or add_extension etc
     browser_options = []
+    profile_options = []
 
     # Open browser and create driver if user has not already done so
     global dependency
@@ -1161,6 +1240,8 @@ def Go_To_Link(step_data, page_title=False):
                 browser_options.append([left, right.strip()])
             elif mid.strip().lower() in ("chrome experimental option", "chrome experimental options") and dependency["Browser"].lower() == "chrome":
                 browser_options.append(["addexperimentaloption", {left.strip():CommonUtil.parse_value_into_object(right.strip())}])
+            elif mid.strip().lower() in ("profile option", "profile options"):
+                profile_options.append([left, right.strip()])
 
         if browser_options:
             CommonUtil.ExecLog(sModuleInfo, f"Got these browser_options\n{browser_options}", 1)
@@ -1189,13 +1270,13 @@ def Go_To_Link(step_data, page_title=False):
                 Tear_Down_Selenium()    # If dependency is changed then teardown and relaunch selenium driver
             CommonUtil.ExecLog(sModuleInfo, "Browser not previously opened, doing so now", 1)
             if window_size_X == "None" and window_size_Y == "None":
-                result = Open_Browser(dependency, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             elif window_size_X == "None":
-                result = Open_Browser(dependency, window_size_Y, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_Y, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             elif window_size_Y == "None":
-                result = Open_Browser(dependency, window_size_X, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_X, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             else:
-                result = Open_Browser(dependency, window_size_X, window_size_Y, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_X, window_size_Y, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
 
             if result == "zeuz_failed":
                 return "zeuz_failed"
@@ -1232,13 +1313,13 @@ def Go_To_Link(step_data, page_title=False):
             else:
                 return CommonUtil.Exception_Handler(sys.exc_info())
             if window_size_X == "None" and window_size_Y == "None":
-                result = Open_Browser(dependency, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             elif window_size_X == "None":
-                result = Open_Browser(dependency, window_size_Y, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_Y, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             elif window_size_Y == "None":
-                result = Open_Browser(dependency, window_size_X, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_X, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
             else:
-                result = Open_Browser(dependency, window_size_X, window_size_Y, capability=capabilities, browser_options=browser_options)
+                result = Open_Browser(dependency, window_size_X, window_size_Y, capability=capabilities, browser_options=browser_options, profile_options=profile_options)
         else:
             result = "zeuz_failed"