Add ErrorReasons to 'core-action-status-get' Command (#37483)

* add errorReasons

* add error_description to HR

* add outputs

* add RN

* add polling output

* change to No Tests

* change output path

* UT

* readme

* precommit

* doc review

Author: BEAdi

Packs/ApiModules/Scripts/CoreIRApiModule/CoreIRApiModule.py

@@ -1363,7 +1363,7 @@ def get_script_execution_result_files(self, action_id: str, endpoint_id: str) ->
             resp_type='response',
         )
 
-    def action_status_get(self, action_id) -> Dict[str, Any]:
+    def action_status_get(self, action_id) -> Dict[str, Dict[str, Any]]:
         request_data: Dict[str, Any] = {
             'group_action_id': action_id,
         }
@@ -1376,7 +1376,7 @@ def action_status_get(self, action_id) -> Dict[str, Any]:
         )
         demisto.debug(f"action_status_get = {reply}")
 
-        return reply.get('reply').get('data')
+        return reply.get('reply')
 
     @logger
     def get_file(self, file_link):
@@ -1757,6 +1757,7 @@ def run_polling_command(client: CoreClient,
         outputs_result_func[0].get(polling_field)
     cond = result not in polling_value if stop_polling else result in polling_value
     if values_raise_error and result in values_raise_error:
+        return_results(command_results)
         raise DemistoException(f"The command {cmd} failed. Received status {result}")
     if cond:
         # schedule next poll
@@ -1959,24 +1960,38 @@ def action_status_get_command(client: CoreClient, args) -> CommandResults:
     demisto.debug(f'action_status_get_command {action_id_list=}')
     result = []
     for action_id in action_id_list:
-        data = client.action_status_get(action_id)
+        reply = client.action_status_get(action_id)
+        data = reply.get('data') or {}
+        error_reasons = reply.get('errorReasons', {})
 
         for endpoint_id, status in data.items():
-            result.append({
+            action_result = {
                 'action_id': action_id,
                 'endpoint_id': endpoint_id,
                 'status': status,
-            })
+            }
+            if error_reason := error_reasons.get(endpoint_id):
+                action_result['ErrorReasons'] = error_reason
+                action_result['error_description'] = (error_reason.get('errorDescription')
+                                                      or get_missing_files_description(error_reason.get('missing_files'))
+                                                      or 'An error occurred while processing the request.')
+            result.append(action_result)
 
     return CommandResults(
-        readable_output=tableToMarkdown(name='Get Action Status', t=result, removeNull=True),
+        readable_output=tableToMarkdown(name='Get Action Status', t=result, removeNull=True,
+                                        headers=['action_id', 'endpoint_id', 'status', 'error_description']),
         outputs_prefix=f'{args.get("integration_context_brand", "CoreApiModule")}.'
                        f'GetActionStatus(val.action_id == obj.action_id)',
         outputs=result,
         raw_response=result
     )
 
 
+def get_missing_files_description(missing_files):
+    if isinstance(missing_files, list) and len(missing_files) > 0 and isinstance(missing_files[0], dict):
+        return missing_files[0].get('description')
+
+
 def isolate_endpoint_command(client: CoreClient, args) -> CommandResults:
     endpoint_id = args.get('endpoint_id')
     disconnected_should_return_error = not argToBoolean(args.get('suppress_disconnected_endpoint_error', False))

Packs/ApiModules/Scripts/CoreIRApiModule/CoreIRApiModule_test.py

@@ -1381,7 +1381,7 @@ def test_get_script_code_command(requests_mock):
     assert raw_response == get_script_code_command_reply.get("reply")
 
 
-def test_action_status_get_command(requests_mock):
+def test_action_status_get_command(mocker):
     """
         Given:
             - An action_id
@@ -1396,18 +1396,21 @@ def test_action_status_get_command(requests_mock):
     action_status_get_command_command_reply = load_test_data('./test_data/action_status_get.json')
 
     data = action_status_get_command_command_reply.get('reply').get('data')
+    error_reasons = action_status_get_command_command_reply.get('reply').get('errorReasons') or {}
     result = []
     for item in data:
         result.append({
             'action_id': 1810,
             'endpoint_id': item,
             'status': data.get(item)
         })
-    action_status_get_command_expected_result = result
+        if error_reason := error_reasons.get(item):
+            result[-1]['error_description'] = error_reason['errorDescription']
+            result[-1]['ErrorReasons'] = error_reason
 
-    requests_mock.post(f'{Core_URL}/public_api/v1/actions/get_action_status/',
-                       json=action_status_get_command_command_reply)
+    action_status_get_command_expected_result = result
 
+    mocker.patch.object(CoreClient, '_http_request', return_value=action_status_get_command_command_reply)
     client = CoreClient(
         base_url=f'{Core_URL}/public_api/v1', headers={}
     )
@@ -1416,7 +1419,8 @@ def test_action_status_get_command(requests_mock):
     }
 
     res = action_status_get_command(client, args)
-    assert res.readable_output == tableToMarkdown(name='Get Action Status', t=result, removeNull=True)
+    assert res.readable_output == tableToMarkdown(name='Get Action Status', t=result, removeNull=True,
+                                                  headers=['action_id', 'endpoint_id', 'status', 'error_description'])
     assert res.outputs == action_status_get_command_expected_result
     assert res.raw_response == result
 
@@ -4511,7 +4515,6 @@ def test_run_polling_command_values_raise_error(mocker):
     """
     Given -
         - run_polling_command arguments.
-        -
 
     When -
         - Running the run_polling_command
@@ -4532,6 +4535,7 @@ def test_run_polling_command_values_raise_error(mocker):
     mock_command_results.raw_response = {"status": "TIMEOUT"}
     mock_command_results.return_value = mock_command_results
     client.get_command_results.return_value = mock_command_results
+    mocker.patch('CoreIRApiModule.return_results')
 
     with pytest.raises(DemistoException) as e:
         run_polling_command(client=client,

Packs/ApiModules/Scripts/CoreIRApiModule/test_data/action_status_get.json

@@ -2,7 +2,21 @@
   "reply": {
     	"data": {
             "aeec6a2cc92e46fab3b6f621722e9916": "COMPLETED_SUCCESSFULLY",
-            "23a86310665d413a958926fce5b794b3": "FAILED"
+            "23a86310665d413a958926fce5b794b3": "FAILED",
+            "5a763600a3e44928a94ba84b6088380f": "FAILED"
+        },
+        "errorReasons": {
+            "5a763600a3e44928a94ba84b6088380f": {
+                "errorData": "{\"reportIds\":[\"0ca3c1ace7694fcd8b44b735e5ba6c04\"],\"errorText\":\"\"}",
+                "terminated_by": "instance_id",
+                "errorDescription": "Element not found.\r\n",
+                "terminate_result": [
+                    {
+                        "path": null,
+                        "status": 1
+                    }
+                ]
             }
-       }
+        }
+    }
 }