CiscoSMA- Added timeout parameter

Packs/CiscoSMA/Integrations/CiscoSMA/CiscoSMA.py

@@ -32,9 +32,9 @@ class Client(BaseClient):
     """Client class to interact with Cisco SMA API."""
 
     def __init__(
-        self, server_url: str, username: str, password: str, verify: bool, proxy: bool
+        self, server_url: str, username: str, password: str, verify: bool, proxy: bool, timeout: None | int = 60
     ):
-        super().__init__(base_url=server_url, headers={}, verify=verify, proxy=proxy)
+        super().__init__(base_url=server_url, headers={}, verify=verify, proxy=proxy, timeout=timeout)
         self.username = username
         self.password = password
         self.handle_request_headers()
@@ -73,7 +73,7 @@ def retrieve_jwt_token(self) -> str:
             return dict_safe_get(response, ["data", "jwtToken"])
 
         except DemistoException as e:
-            if e.res.status_code == 401:
+            if hasattr(e.res, 'status_code') and e.res.status_code == 401:
                 raise Exception(
                     "Authorization Error: make sure username and password are set correctly."
                 )
@@ -1851,7 +1851,7 @@ def main() -> None:
     filter_value = params.get("filter_value")
     recipient_filter_operator = params.get("recipient_filter_operator")
     recipient_filter_value = params.get("recipient_filter_value")
-
+    timeout = arg_to_number(params.get("timeout")) if params.get("timeout") else None
     verify_certificate: bool = not params.get("insecure", False)
     proxy = params.get("proxy", False)
 
@@ -1880,6 +1880,7 @@ def main() -> None:
             password,
             verify_certificate,
             proxy,
+            timeout=timeout
         )
 
         if command == "test-module":

Packs/CiscoSMA/Integrations/CiscoSMA/CiscoSMA.yml

@@ -72,6 +72,11 @@ configuration:
   type: 0
   additionalinfo: Recipient filter value to fetch by message field.
   required: false
+- name: timeout
+  display: Timeout
+  type: 0
+  additionalinfo: Timeout for the integration HTTP requests in seconds.
+  required: false
 - name: proxy
   display: Use system proxy settings
   defaultvalue: 'false'

Packs/CiscoSMA/Integrations/CiscoSMA/CiscoSMA_test.py

@@ -522,6 +522,7 @@ def test_message_search_command(
     assert len(outputs) == expected_outputs_len
     assert outputs[0]["mid"] == expected_message_id
     assert outputs[1]["recipient"] == expected_recipients
+    assert mock_request.last_request.timeout == 60
 
 
 @pytest.mark.parametrize(
@@ -872,3 +873,66 @@ def test_format_timestamp(timestamp, output_format, expected_result):
     result = format_timestamp(timestamp, output_format)
 
     assert result == expected_result
+
+
+@pytest.mark.parametrize(
+    "response_file_name,command_arguments,expected_outputs_len,expected_message_id,expected_recipients,requested_params",
+    [
+        (
+            "message_search.json",
+            {
+                "start_date": "2 weeks",
+                "end_date": "1 day",
+                "page": "2",
+                "page_size": "4",
+                "recipient_filter_operator": "is",
+                "recipient_filter_value": "test@test.com",
+                "timeout": "90"
+            },
+            4,
+            [315],
+            ["test@test.com"],
+            "test%40test.com",
+        ),
+    ],
+)
+@patch("CiscoSMA.Client.handle_request_headers", mock_access_token)
+def test_test_message_search_command_with_timout(
+    response_file_name,
+    command_arguments,
+    expected_outputs_len,
+    expected_message_id,
+    expected_recipients,
+    requested_params,
+    requests_mock
+):
+    """
+    Scenario: Tracking message search.
+    Given:
+     - User has provided valid credentials.
+     - User may provided pagination args.
+     - User may Provided filtering arguments.
+    When:
+     - cisco-sma-message-search command called.
+    Then:
+     - Ensure outputs prefix is correct.
+     - Ensure number of items is correct.
+     - Ensure that the timeout argument was sent.
+     - Validate outputs' fields.
+    """
+    from CiscoSMA import message_search_command
+    from CiscoSMA import Client
+    mock_client = Client(BASE_URL, USERNAME, PASSWORD, verify=False, proxy=False, timeout=90)
+    mock_response = load_mock_response(response_file_name)
+    url = f"{BASE_URL}/message-tracking/messages"
+    mock_request = requests_mock.get(url=url, json=mock_response)
+
+    result = message_search_command(mock_client, command_arguments)
+    outputs = result.outputs
+
+    assert requested_params in mock_request.last_request.query
+    assert result.outputs_prefix == "CiscoSMA.Message"
+    assert len(outputs) == expected_outputs_len
+    assert outputs[0]["mid"] == expected_message_id
+    assert outputs[1]["recipient"] == expected_recipients
+    assert mock_request.last_request.timeout == 90

Packs/CiscoSMA/Integrations/CiscoSMA/README.md

@@ -19,6 +19,7 @@ This integration was integrated and tested with version 12.0 of Cisco Security M
     | Filter value | The value to search for. | False |
     | Recipient filter operator | Recipient operator filter. | False |
     | Recipient filter value | Recipient filter value to fetch by message field. | False |
+    | Timeout | Timeout for the integration HTTP requests in seconds. | False |
     | Use system proxy settings |  | False |
     | Trust any certificate (not secure) |  | False |
     | Incident type |  | False |

Packs/CiscoSMA/ReleaseNotes/1_1_19.md

@@ -0,0 +1,5 @@
+
+#### Integrations
+
+##### Cisco Security Management Appliance
+- Added support for the *timeout* integration parameter.

Packs/CiscoSMA/pack_metadata.json

@@ -2,7 +2,7 @@
     "name": "CiscoSMA",
     "description": "The Security Management Appliance (SMA) is used to centralize services from Email Security Appliances (ESAs) and Web Security Appliances (WSAs).",
     "support": "xsoar",
-    "currentVersion": "1.1.18",
+    "currentVersion": "1.1.19",
     "author": "Cortex XSOAR",
     "url": "https://www.paloaltonetworks.com/cortex",
     "email": "",