Merge pull request #403 from AutomationSolutionz/auth

Authentication System 2.0

Author: sazid

.gitignore

@@ -25,6 +25,8 @@ AutomationLog/
 iosSimulator/*
 node_state.json
 *.zvt
+Framework/session.bin
+session.bin
 
 # Nodejs gitignore
 # Logs

.vscode/launch.json

@@ -15,43 +15,38 @@
             "type": "python",
             "request": "launch",
             "program": "${file}",
-            "console": "internalConsole",
-            "internalConsoleOptions": "openOnSessionStart"
+            "console": "integratedTerminal",
         },
         {
             "name": "Python: node_cli",
             "type": "python",
             "request": "launch",
             "program": "${workspaceFolder}/node_cli.py",
-            "console": "internalConsole",
-            "internalConsoleOptions": "openOnSessionStart"
+            "console": "integratedTerminal",
         },
         {
             "name": "Python: node_cli custom log dir",
             "type": "python",
             "request": "launch",
             "program": "${workspaceFolder}/node_cli.py",
             "args": ["-d /home/szxo3/Desktop/test_node_dir"],
-            "console": "internalConsole",
-            "internalConsoleOptions": "openOnSessionStart"
+            "console": "integratedTerminal",
         },
         {
             "name": "Python: local_run",
             "type": "python",
             "request": "launch",
             "program": "${workspaceFolder}/node_cli.py",
             "args": ["--local_run"],
-            "console": "internalConsole",
-            "internalConsoleOptions": "openOnSessionStart"
+            "console": "integratedTerminal",
         },
         {
             "name": "Python: node_cli with GH_TOKEN",
             "type": "python",
             "request": "launch",
             "program": "${workspaceFolder}/node_cli.py",
             "args": ["--gh", "TOKEN_HERE"],
-            "console": "internalConsole",
-            "internalConsoleOptions": "openOnSessionStart"
+            "console": "integratedTerminal",
         },
     ]
 }

CHANGELOG.md

@@ -1,10 +1,13 @@
 # Changelog
 
 
-# Version 18
+# Version 19
 
 ### [Current changes]
--
+- **[Change]** Support for the new Authentication System 2.0 has been added.
+- **[Change]** Improved reconnect time of node by 10x-30x once it detects a live server.
+- **[Change]** Removed unnecessary codes + APIs.
+- **[Change]** Improved general login time because of the above change.
 
 ### [18.1.0][Jan 13, 2024]
 - **[Add]** AI Test recorder extension

Framework/Built_In_Automation/Sequential_Actions/common_functions.py

@@ -4593,7 +4593,7 @@ def upload_attachment_to_testcase(data_set):
             CommonUtil.ExecLog(sModuleInfo, "Please insert attachment path ", 3)
             return "zeuz_failed"
         headers = RequestFormatter.add_api_key_to_headers({})
-        res = requests.post(
+        res = RequestFormatter.request("post", 
             RequestFormatter.form_uri("test_case_file_upload/"),
             files={"file": open(var_path, 'rb')},
             data={"file_upload_tc": var_id},
@@ -4647,7 +4647,7 @@ def download_attachment_from_testcase(data_set):
         headers = RequestFormatter.add_api_key_to_headers({})
         url = RequestFormatter.form_uri(f"static/tc_folder/{var_id}/{var_name}")
         local_filename = url.split('/')[-1]
-        with requests.get(url, stream=True, verify=False,**headers) as r:
+        with RequestFormatter.request("get", url, stream=True, verify=False,**headers) as r:
             r.raise_for_status()
             with open(var_path+'/'+local_filename, 'wb') as f:
                 for chunk in r.iter_content(chunk_size=8192):
@@ -4690,7 +4690,7 @@ def upload_attachment_to_step(data_set):
             CommonUtil.ExecLog(sModuleInfo, "Please insert attachment path ", 3)
             return "zeuz_failed"
         headers = RequestFormatter.add_api_key_to_headers({})
-        res = requests.post(
+        res = RequestFormatter.request("post", 
             RequestFormatter.form_uri("step_file_upload/"),
             files={"file": open(var_path,'rb')},
             data={"file_upload_step": var_id, },
@@ -4744,7 +4744,7 @@ def download_attachment_from_step(data_set):
         headers = RequestFormatter.add_api_key_to_headers({})
         url = RequestFormatter.form_uri(f"static/step_folder/{var_id}/{var_name}")
         local_filename = url.split('/')[-1]
-        with requests.get(url, stream=True, verify=False,**headers) as r:
+        with RequestFormatter.request("get", url, stream=True, verify=False,**headers) as r:
             r.raise_for_status()
             with open(var_path+'/'+local_filename, 'wb') as f:
                 for chunk in r.iter_content(chunk_size=8192):
@@ -4784,7 +4784,7 @@ def upload_attachment_to_global(data_set):
             return "zeuz_failed"
 
         headers = RequestFormatter.add_api_key_to_headers({})
-        res = requests.post(
+        res = RequestFormatter.request("post", 
             RequestFormatter.form_uri("global_file_upload/"),
             files={"file": open(var_path,'rb')},
             verify=False,
@@ -4830,7 +4830,7 @@ def download_attachment_from_global(data_set):
         headers = RequestFormatter.add_api_key_to_headers({})
         url = RequestFormatter.form_uri(f"static/global_folder/{var_name}")
         local_filename = url.split('/')[-1]
-        with requests.get(url, stream=True, verify=False,**headers) as r:
+        with RequestFormatter.request("get", url, stream=True, verify=False,**headers) as r:
             r.raise_for_status()
             with open(var_path+'/'+local_filename, 'wb') as f:
                 for chunk in r.iter_content(chunk_size=8192):
@@ -5889,7 +5889,7 @@ def data_store_read(data_set):
         headers = RequestFormatter.add_api_key_to_headers({})
         headers['headers']['content-type'] = 'application/json'
         headers['headers']['X-API-KEY'] = ConfigModule.get_config_value("Authentication", "api-key")
-        res = requests.get(
+        res = RequestFormatter.request("get", 
             RequestFormatter.form_uri('data_store/data_store/custom_operation/'),
             params=json.dumps(params),
             verify=False,
@@ -6047,7 +6047,7 @@ def data_store_insert(data_set):
         headers['headers']['content-type'] = 'application/json'
         headers['headers']['X-API-KEY'] = ConfigModule.get_config_value("Authentication", "api-key")
 
-        res = requests.post(
+        res = RequestFormatter.request("post", 
             RequestFormatter.form_uri('data_store/data_store/data_store_list/'),
             data=json.dumps(data),
             verify=False,

Framework/MainDriverApi.py

@@ -1218,7 +1218,7 @@ def set_device_info_according_to_user_order(device_order, device_dict,  test_cas
         if "local" in device_order["mobile"]:
             pass
         elif "browser_stack" in device_order["mobile"]:
-            project = f"PROJECT: {user_info_object['project']} & TEAM: {user_info_object['team']}"
+            project = f"PROJECT:{user_info_object['project_id']} & TEAM:{user_info_object['team_id']}"
             # build = f"{test_case_no} : {test_case_name}"
             build = kwargs['run_id']
             # Todo: session_name will be the run_id of the test case. So, we can reference with our zeuz better
@@ -1251,8 +1251,8 @@ def set_device_info_according_to_user_order(device_order, device_dict,  test_cas
             }
     # Todo: remove this section. Changing this for new device_info.
     # elif "browser_stack" in device_order and device_order["browser_stack"]:
-    #     project = user_info_object["project"]
-    #     team = user_info_object["team"]
+    #     project ["project"]
+    #     team ["team"]
     #
     #     project = "PROJECT:'" + project + "'  TEAM:'" + team + "'"
     #     build = test_case_no + " :: " + test_case_name
@@ -1421,21 +1421,19 @@ def upload_reports_and_zips(Userid, temp_ini_file, run_id):
             for _ in range(5):
                 try:
                     if perf_report_html is None:
-                        res = requests.post(
+                        res = RequestFormatter.request("post", 
                             RequestFormatter.form_uri("create_report_log_api/"),
                             data={"execution_report": json.dumps(tc_report)},
-                            verify=False,
-                            **RequestFormatter.add_api_key_to_headers({}))
+                            verify=False)
                     else:
-                            res = requests.post(
+                            res = RequestFormatter.request("post", 
                             RequestFormatter.form_uri("create_report_log_api/"),
                             data={"execution_report": json.dumps(tc_report),
                                   "processed_tc_id":processed_tc_id
 
                                   },
                             files=[("file",perf_report_html)],
-                            verify=False,
-                            **RequestFormatter.add_api_key_to_headers({}))
+                            verify=False)
 
 
                     if res.status_code == 200:
@@ -1475,12 +1473,11 @@ def upload_reports_and_zips(Userid, temp_ini_file, run_id):
                     files_list = []
                     for zips in opened_zips:
                         files_list.append(("file",zips))
-                    res = requests.post(
+                    res = RequestFormatter.request("post", 
                         RequestFormatter.form_uri("save_log_and_attachment_api/"),
                         files=files_list,
                         data={"machine_name": Userid},
-                        verify=False,
-                        **RequestFormatter.add_api_key_to_headers({}))
+                        verify=False)
                     if res.status_code == 200:
                         try:
                             res_json = res.json()
@@ -1564,7 +1561,7 @@ def download_attachment(attachment_info: Dict[str, Any]):
     file_name = url[file_name_start_pos:]
     file_path = attachment_info["download_dir"] / file_name
 
-    r = requests.get(url, stream=True)
+    r = RequestFormatter.request("get", url, stream=True)
     if r.status_code == requests.codes.ok:
         with open(file_path, 'wb') as f:
             for data in r.iter_content(chunk_size=512*1024):
@@ -1659,7 +1656,7 @@ def download_or_copy(attachment):
 
 
 # main function
-def main(device_dict, user_info_object):
+def main(device_dict, all_run_id_info):
     try:
         # get module info
         sModuleInfo = inspect.currentframe().f_code.co_name + " : " + MODULE_NAME
@@ -1679,8 +1676,6 @@ def main(device_dict, user_info_object):
         # get local machine user id
         Userid = (CommonUtil.MachineInfo().getLocalUser()).lower()
 
-        save_path = Path(ConfigModule.get_config_value("sectionOne", "temp_run_file_path", temp_ini_file)) / "attachments"
-
         # FIXME: Need to decide what to do with the following code or how to
         # handle it differently in case there are residual folders from previous
         # test cases inside the attachments folder.
@@ -1699,9 +1694,12 @@ def main(device_dict, user_info_object):
         # TODO: Remove all_file_specific_steps at a later period. keeping this
         # only for custom driver purpose
 
-        json_path = save_path.glob("*.zeuz.json").__next__()
-        with open(json_path, "r", encoding="utf-8") as f:
-            all_run_id_info = json.loads(f.read())
+        # Ensure that the path exists
+        # save_path = Path(ConfigModule.get_config_value("sectionOne", "temp_run_file_path", temp_ini_file)) / "attachments"
+        # save_path.mkdir(exist_ok=True, parents=True)
+        # json_path = save_path.glob("*.zeuz.json").__next__()
+        # with open(json_path, "r", encoding="utf-8") as f:
+        #     all_run_id_info = json.loads(f.read())
 
         if len(all_run_id_info) == 0:
             CommonUtil.ExecLog("", "No Test Run Schedule found for the current user : %s" % Userid, 2)
@@ -1888,6 +1886,10 @@ def main(device_dict, user_info_object):
                         performance_test_case = True
                     test_case_no = testcase_info["testcase_no"]
                     test_case_name = testcase_info["title"]
+                    user_info_object = {
+                        "project_id": run_id_info["project_id"],
+                        "team_id": str(run_id_info["team_id"]),
+                    }
                     set_device_info_according_to_user_order(device_order, device_dict, test_case_no, test_case_name, user_info_object, Userid, run_id=run_id)
                     CommonUtil.disabled_step = []