insightconnect-plugin-runtime 6.2.1__py3-none-any.whl → 6.2.4__py3-none-any.whl

insightconnect_plugin_runtime/api/endpoints.py

@@ -1,27 +1,27 @@
+import importlib.metadata as importlib_metadata
 import json
-import subprocess
-import yaml
 import os
-import pkg_resources
 import signal
-from flask import jsonify, request, abort, make_response, Blueprint
-from werkzeug.exceptions import InternalServerError, HTTPException
+import subprocess
 from typing import Any, Dict
 
 import structlog
+import yaml
+from flask import Blueprint, abort, jsonify, make_response, request
+from werkzeug.exceptions import HTTPException, InternalServerError
 
+from insightconnect_plugin_runtime.api.schemas import (
+    ActionTriggerDetailsSchema,
+    ConnectionDetailsSchema,
+    PluginInfoSchema,
+    TaskDetailsSchema,
+)
 from insightconnect_plugin_runtime.exceptions import (
     ClientException,
-    ServerException,
-    LoggedException,
     ConnectionTestException,
+    LoggedException,
     PluginException,
-)
-from insightconnect_plugin_runtime.api.schemas import (
-    PluginInfoSchema,
-    ActionTriggerDetailsSchema,
-    TaskDetailsSchema,
-    ConnectionDetailsSchema,
+    ServerException,
 )
 from insightconnect_plugin_runtime.util import OutputMasker
 
@@ -780,11 +780,10 @@ class Endpoints:
 
     def get_plugin_sdk_version(self):
         try:
-            version = pkg_resources.require("insightconnect-plugin-runtime")[0].version
+            version = importlib_metadata.version("insightconnect-plugin-runtime")
         except Exception:
             self.logger.warn("Unable to get SDK version")
             version = "0.0.0"
-
         return version
 
     def add_plugin_custom_config(

insightconnect_plugin_runtime/helper.py

@@ -10,7 +10,7 @@ import subprocess
 import time
 from datetime import datetime, timedelta
 from io import IOBase
-from typing import Any, Callable, Dict, List, Union, Tuple
+from typing import Any, Callable, Dict, List, Union, Tuple, Optional
 from urllib import request
 from hashlib import sha1
 from json import JSONDecodeError
@@ -21,6 +21,7 @@ from insightconnect_plugin_runtime.exceptions import (
     PluginException,
     HTTPStatusCodes,
     ResponseExceptionData,
+    APIException
 )
 
 CAMEL_CASE_REGEX = r"\b[a-z0-9]+([A-Z][a-z]+[0-9]*)*\b"
@@ -33,17 +34,45 @@ DEFAULTS_HOURS_AGO = 24
 logger = logging.getLogger()
 
 
-def hash_sha1(log: Dict) -> str:
+def hash_sha1(log: Dict[str, Any], keys: Optional[List[str]] = None) -> str:
     """
     Iterate through a dictionary and hash each value.
+    Optionally only hash certain keys in the dictionary.
+
     :param log: Dictionary to be hashed.
-    :type Dict:
+    :param keys: Optional list of keys to hash on if provided
+
     :return: Hex digest of hash.
-    :rtype: str
     """
+
     hash_ = sha1()  # nosec B303
-    for key, value in log.items():
+
+    # Leaving no room for developer error and ensuring they know exactly where it went wrong
+    # if they provide a key not in list format
+    if keys is not None and not isinstance(keys, list):
+        raise TypeError(
+            f"The 'keys' parameter must be a list or None in the 'hash_sha1' function, not {type(keys).__name__}"
+        )
+
+    # Hash all key-value pairs if no keys provided
+    if keys is None:
+        items_to_hash = log.items()
+
+    # Otherwise, only include specified keys
+    else:
+        items_to_hash = []
+        for key in keys:
+            if key in log:
+                items_to_hash.append((key, log[key]))
+
+            # Alert if the key is not found in the log
+            else:
+                raise KeyError(f"Key '{key}' not found in the provided log.")
+
+    # Iterate through items to hash and hash
+    for key, value in items_to_hash:
         hash_.update(f"{key}{value}".encode(ENCODE_TYPE))
+
     return hash_.hexdigest()
 
 
@@ -83,6 +112,7 @@ def make_request(
     exception_custom_configs: Dict[int, Exception] = {},
     exception_data_location: str = None,
     allowed_status_codes: List[str] = [],
+    max_response_size: int = None,
 ) -> Tuple[requests.Response, Dict]:
     """
     Makes a HTTP request while checking for RequestErrors and JSONDecodeErrors
@@ -105,6 +135,8 @@ def make_request(
     :type str:
     :param allowed_status_codes: Status codes that will not raise an exception.
     :type List[str]:
+    :param max_response_size: Raise an error if the stream content is bigger than this specified size
+    :type int:
 
     :return: The request response and the response JSON.
     :rtype: Tuple[Response, Dict]
@@ -120,6 +152,19 @@ def make_request(
                 cert=cert,
                 stream=stream,
             )
+
+            # Before we close this session check and download all content, check if the returned content is too large.
+            # This may not be supported on all APIs as they need to support streaming and return the content-length
+            # header but adding this extra check will be beneficial for memory usage to those that do support it.
+            if stream and max_response_size:
+                resp_size = response.headers.get("content-length", "0")
+                if int(resp_size) > max_response_size:
+                    raise APIException(
+                        status_code=400,
+                        cause=f"API response is exceeding allowed limit of {max_response_size} bytes.",
+                        assistance="Please update the parameters to reduce the size of the data being returned.",
+                        data=f"Content length returned was {resp_size} and max allowed is {max_response_size}",
+                    )
     except requests.exceptions.Timeout as exception:
         raise PluginException(
             preset=PluginException.Preset.TIMEOUT, data=str(exception)
@@ -137,7 +182,12 @@ def make_request(
             raise PluginException(
                 preset=PluginException.Preset.UNKNOWN, data=str(exception)
             )
-    response_handler(response, exception_custom_configs, exception_data_location, allowed_status_codes)
+    response_handler(
+        response,
+        exception_custom_configs,
+        exception_data_location,
+        allowed_status_codes,
+    )
     return response
 
 
@@ -192,7 +242,7 @@ def request_error_handling(
                         exception.response,
                         data_location=exception_data_location,
                         custom_configs=custom_configs,
-                        allowed_status_codes=allowed_status_codes
+                        allowed_status_codes=allowed_status_codes,
                     )
                 else:
                     raise PluginException(
@@ -443,15 +493,19 @@ def convert_dict_to_snake_case(
 
     if isinstance(input_dict, list):
         return [
-            convert_dict_to_snake_case(element)
-            if isinstance(element, (dict, list))
-            else element
+            (
+                convert_dict_to_snake_case(element)
+                if isinstance(element, (dict, list))
+                else element
+            )
             for element in input_dict
         ]
     return {
-        convert_to_snake_case(key): convert_dict_to_snake_case(value)
-        if isinstance(value, (dict, list))
-        else value
+        convert_to_snake_case(key): (
+            convert_dict_to_snake_case(value)
+            if isinstance(value, (dict, list))
+            else value
+        )
         for key, value in input_dict.items()
     }
 
@@ -665,7 +719,7 @@ def open_cachefile(cache_file, append=False):
             logger.info("OpenCacheFile: %s created", cache_file)
             f = open(cache_file, "a+" if append else "r+")
         return f
-    logging.error("OpenCacheFile: %s directory or does not exist", cache_dir)
+    logger.error("OpenCacheFile: %s directory or does not exist", cache_dir)
 
 
 def remove_cachefile(cache_file):
@@ -748,11 +802,11 @@ def open_url(url, timeout=None, verify=True, **kwargs):
             urlobj = request.urlopen(req, timeout=timeout, context=ctx)
         return urlobj
     except request.HTTPError as e:
-        logging.error("HTTPError: %s for %s", str(e.code), url)
+        logger.error("HTTPError: %s for %s", str(e.code), url)
         if e.code == 304:
             return None
     except request.URLError as e:
-        logging.error("URLError: %s for %s", str(e.reason), url)
+        logger.error("URLError: %s for %s", str(e.reason), url)
     raise Exception("GetURL Failed")
 
 
@@ -780,17 +834,17 @@ def check_url(url):
             return True
 
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)
     return False
 
 
@@ -810,7 +864,7 @@ def exec_command(command):
         rcode = p.poll()
         return {"stdout": stdout, "stderr": stderr, "rcode": rcode}
     except OSError as e:
-        logging.error(
+        logger.error(
             "SubprocessError: %s %s: %s", str(e.filename), str(e.strerror), str(e.errno)
         )
     raise Exception("ExecCommand")
@@ -836,7 +890,7 @@ def encode_file(file_path):
             return efile
         return None
     except (IOError, OSError) as e:
-        logging.error("EncodeFile: Failed to open file: %s", e.strerror)
+        logger.error("EncodeFile: Failed to open file: %s", e.strerror)
         raise Exception("EncodeFile")
     finally:
         if isinstance(f, IOBase):
@@ -859,17 +913,17 @@ def check_url_modified(url):
         if resp.status_code == 200:
             return True
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)
     return False
 
 
@@ -895,7 +949,7 @@ def get_url_path_filename(url):
             if name[n].endswith("."):
                 return name
     except IndexError:
-        logging.error("Range: IndexError: URL basename is short: %s of %s", name, url)
+        logger.error("Range: IndexError: URL basename is short: %s of %s", name, url)
         return None
     return None
 
@@ -915,16 +969,16 @@ def get_url_filename(url):
             return name
         return None
     except requests.exceptions.MissingSchema:
-        logging.error("Requests: MissingSchema: Requires ftp|http(s):// for %s", url)
+        logger.error("Requests: MissingSchema: Requires ftp|http(s):// for %s", url)
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)

insightconnect_plugin_runtime/schema.py

@@ -1,21 +1,18 @@
 import json
+from pathlib import Path
 
-import pkg_resources
 
-
-def load_schema(file_name):
+def load_schema(file_name: str) -> dict:
     """
     Loads a json schema from the packages data folder.
     :param file_name: name of the file
     :return: JSON object as a dictionary
     """
 
-    schema = pkg_resources.resource_stream(__name__, "/".join(("data", file_name)))
-    schema = schema.read()
-    if isinstance(schema, bytes):
-        schema = schema.decode("utf-8")
-    schema = json.loads(schema)
-    return schema
+    with open(
+        Path(__file__).parent / "data" / file_name, "r", encoding="utf-8"
+    ) as schema_file:
+        return json.loads(schema_file.read())
 
 
 input_message_schema = load_schema("input_message_schema.json")

{insightconnect_plugin_runtime-6.2.1.dist-info → insightconnect_plugin_runtime-6.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: insightconnect-plugin-runtime
-Version: 6.2.1
+Version: 6.2.4
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -12,20 +12,28 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Topic :: Software Development :: Build Tools
 Description-Content-Type: text/markdown
-Requires-Dist: requests==2.32.2
+Requires-Dist: requests==2.32.3
 Requires-Dist: python_jsonschema_objects==0.5.2
-Requires-Dist: jsonschema==4.21.1
-Requires-Dist: certifi==2024.07.04
-Requires-Dist: Flask==3.0.2
-Requires-Dist: gunicorn==22.0.0
+Requires-Dist: jsonschema==4.22.0
+Requires-Dist: certifi==2024.12.14
+Requires-Dist: Flask==3.1.0
+Requires-Dist: gunicorn==23.0.0
 Requires-Dist: greenlet==3.1.1
-Requires-Dist: gevent==24.10.1
+Requires-Dist: gevent==24.11.1
 Requires-Dist: marshmallow==3.21.0
 Requires-Dist: apispec==6.5.0
 Requires-Dist: apispec-webframeworks==1.0.0
-Requires-Dist: blinker==1.7.0
-Requires-Dist: structlog==24.1.0
+Requires-Dist: blinker==1.9.0
+Requires-Dist: structlog==24.4.0
 Requires-Dist: python-json-logger==2.0.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
 
 
 # InsightConnect Python Plugin Runtime ![Build Status](https://github.com/rapid7/komand-plugin-sdk-python/workflows/Continuous%20Integration/badge.svg)
@@ -48,10 +56,10 @@ to get started.
 
 ## Development of the InsightConnect Plugin Runtime
 
-The Python Runtime codebase is built to support Python 3.11.10 as of version 6.2.0. The following dependencies will need 
+The Python Runtime codebase is built to support Python 3.11.11 as of version 6.2.3. The following dependencies will need 
 to be installed when developing or testing the Plugin Runtime:
 
-- Python 3.11.10
+- Python 3.11.11
 - Docker
 - make
 - tox
@@ -67,7 +75,7 @@ version and activate it. Then build, install, and confirm the package has been i
 > source venv/bin/activate
 > pip install -e ./
 > pip list | grep insightconnect-plugin-runtime
-insightconnect-plugin-runtime 5.2.2
+insightconnect-plugin-runtime 6.2.3
 ```
 
 #### Building the InsightConnect Plugin Runtime Docker Images
@@ -123,7 +131,7 @@ name as a parameter:
 
 The plugin will be started in `http` mode and listening at `http:0.0.0.0:10001`:
 ```
-[2020-02-13 23:21:13 -0500] [56567] [INFO] Starting gunicorn 19.7.1
+[2020-02-13 23:21:13 -0500] [56567] [INFO] Starting gunicorn 23.0.0
 [2020-02-13 23:21:13 -0500] [56567] [INFO] Listening at: http://0.0.0.0:10001 (56567)
 [2020-02-13 23:21:13 -0500] [56567] [INFO] Using worker: threads
 [2020-02-13 23:21:13 -0500] [56571] [INFO] Booting worker with pid: 56571
@@ -184,7 +192,7 @@ Running a specific test file:
 
 |                   | Plugin  | Slim Plugin |
 |:------------------|:-------:|:-----------:|
-| Python Version    | 3.11.10 |   3.11.10   |
+| Python Version    | 3.11.11 |   3.11.11   |
 | OS                | Alpine  |  Bullseye   |
 | Package installer |   apk   |     apt     |
 | Shell             | /bin/sh |  /bin/bash  |
@@ -211,6 +219,9 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response
+* 6.2.3 - Updated dockerfiles for both `slim` and `full` SDK types to use Python 3.11.11 | Updated dependencies | Removed `pkg_resources` usage due to deprecation
+* 6.2.2 - Fix instances where logging errors would lead to duplicate entries being output | Add option to hash only on provided keys for `hash_sha1` function
 * 6.2.1 - Fix instances where logging would lead to duplicate entries being output
 * 6.2.0 - Update base images to pull Python 3.11.10 | changed the pep-8 check in tox to `pycodestyle`
 * 6.1.4 - Address vulnerabilities within local development requirements.txt and vulnerabilities in slim image.

{insightconnect_plugin_runtime-6.2.1.dist-info → insightconnect_plugin_runtime-6.2.4.dist-info}/RECORD

@@ -4,10 +4,10 @@ insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C
 insightconnect_plugin_runtime/connection.py,sha256=4bHHV2B0UFGsAtvLu1fiYQRwx7fissUakHPUyjLQO0E,2340
 insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf69rM7Iezs4rbnw,1774
 insightconnect_plugin_runtime/exceptions.py,sha256=Pvcdkx81o6qC2qU661x-DzNjuIMP82x52nPMSEqEo4s,8491
-insightconnect_plugin_runtime/helper.py,sha256=IY4-ntZbiXWFx7jAQ_n1vBjQBd_tt4Zr4INtXzQmiGg,31564
+insightconnect_plugin_runtime/helper.py,sha256=B0XqAXmn8CT1KQ6i5IoWLQrQ_HVOvuKrIKFuj_npQ-g,33770
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 insightconnect_plugin_runtime/plugin.py,sha256=Yf4LNczykDVc31F9G8uuJ9gxEsgmxmAr0n4pcZzichM,26393
-insightconnect_plugin_runtime/schema.py,sha256=jTNc6KAMqFpaDVWrAYhkVC6e8I63P3X7uVlJkAr1hiY,583
+insightconnect_plugin_runtime/schema.py,sha256=6MVw5hqGATU1VLgwfOWfPsP3hy1OnsugCTsgX8sknes,521
 insightconnect_plugin_runtime/server.py,sha256=09fxsbKf2ZZvSqRP2Bv9e9-fspDyEFR8_YgIFeMnXqQ,12578
 insightconnect_plugin_runtime/step.py,sha256=KdERg-789-s99IEKN61DR08naz-YPxyinPT0C_T81C4,855
 insightconnect_plugin_runtime/task.py,sha256=d-H1EAzVnmSdDEJtXyIK5JySprxpF9cetVoFGtWlHrg,123
@@ -15,7 +15,7 @@ insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2
 insightconnect_plugin_runtime/util.py,sha256=qPkZ3LA55nYuNYdansEbnCnBccQkpzIpp9NA1B64Kvw,8444
 insightconnect_plugin_runtime/variables.py,sha256=7FjJGnU7KUR7m9o-_tRq7Q3KiaB1Pp0Apj1NGgOwrJk,3056
 insightconnect_plugin_runtime/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-insightconnect_plugin_runtime/api/endpoints.py,sha256=gIxuxO7AFqmic0k9b_2gWjjJ8ICtWDa88X4Tl4fEgik,33333
+insightconnect_plugin_runtime/api/endpoints.py,sha256=8QQrxzW8jmQIkalud8fqYwB05uUw8sTiDNgO5ZekOCA,33353
 insightconnect_plugin_runtime/api/schemas.py,sha256=jRmDrwLJTBl-iQOnyZkSwyJlCWg4eNjAnKfD9Eko4z0,2754
 insightconnect_plugin_runtime/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 insightconnect_plugin_runtime/clients/aws_client.py,sha256=bgSK3Txr1YonDiUN5JFEZ5cAyCXFM14JjfMus6lRV8o,23017
@@ -68,7 +68,7 @@ tests/unit/test_aws_action.py,sha256=pBE23Qn4aXKJqPmwiHMcEU5zPdyvbKO-eK-6jUlrsQw
 tests/unit/test_custom_encoder.py,sha256=KLYyVOTq9MEkZXyhVHqjm5LVSW6uJS4Davgghsw9DGk,2207
 tests/unit/test_endpoints.py,sha256=LuXOfLBu47rDjGa5YEsOwTZBEdvQdl_C6-r46oxWZA8,6401
 tests/unit/test_exceptions.py,sha256=Y4F-ij8WkEJkUU3mPvxlEchqE9NCdxDvR8bJzPVVNao,5328
-tests/unit/test_helpers.py,sha256=_1jlU-h-GNY9MLQ8nV_or4zkTI911AmHKtvFyamKjfU,16297
+tests/unit/test_helpers.py,sha256=ym1tFi1VSKmdPaHEAlMEl1S7Ibu9-LrqZ2oqJv7bfbE,18685
 tests/unit/test_metrics.py,sha256=PjjTrB9w7uQ2Q5UN-893-SsH3EGJuBseOMHSD1I004s,7979
 tests/unit/test_oauth.py,sha256=nbFG0JH1x04ExXqSe-b5BGdt_hJs7DP17eUa6bQzcYI,2093
 tests/unit/test_plugin.py,sha256=ZTNAZWwZhDIAbxkVuWhnz9FzmojbijgMmsLWM2mXQI0,4160
@@ -77,8 +77,8 @@ tests/unit/test_server_cloud_plugins.py,sha256=PuMDHTz3af6lR9QK1BtPScr7_cRbWheto
 tests/unit/test_server_spec.py,sha256=je97BaktgK0Fiz3AwFPkcmHzYtOJJNqJV_Fw5hrvqX4,644
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
-tests/unit/utils.py,sha256=VooVmfpIgxmglNdtmT32AkEDFxHxyRHLK8RsCWjjYRY,2153
-insightconnect_plugin_runtime-6.2.1.dist-info/METADATA,sha256=7VvNCT7PV0qyLXPRcZcp6tUulmRLyEHix_Qf53iwn3M,15117
-insightconnect_plugin_runtime-6.2.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-insightconnect_plugin_runtime-6.2.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-6.2.1.dist-info/RECORD,,
+tests/unit/utils.py,sha256=hcY0A2H_DMgCDXUTvDtCXMdMvRjLQgTaGcTpATb8YG0,2236
+insightconnect_plugin_runtime-6.2.4.dist-info/METADATA,sha256=zprsS3dKV5_7yPthb5aUPyXTAItb-fJt-8NQn9M98bA,15719
+insightconnect_plugin_runtime-6.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+insightconnect_plugin_runtime-6.2.4.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.2.4.dist-info/RECORD,,

{insightconnect_plugin_runtime-6.2.1.dist-info → insightconnect_plugin_runtime-6.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tests/unit/test_helpers.py

@@ -4,6 +4,7 @@ from insightconnect_plugin_runtime.exceptions import (
     HTTPStatusCodes,
     ResponseExceptionData,
     PluginException,
+    APIException
 )
 import requests
 import os
@@ -378,16 +379,39 @@ class TestRequestsHelpers(TestCase):
             json={"sample": "value"},
             headers={"Content-Type": "application/json"},
         )
-        response = helper.make_request(_request=request)
+        response = helper.make_request(_request=request, stream=True, max_response_size=100)
         expected = {
             "json": {"example": "sample"},
             "status_code": 200,
             "content": b"example",
             "url": "https://example.com/success",
+            "content-length": "1",
         }
         self.assertEqual(response.content, expected.get("content"))
         self.assertEqual(response.status_code, expected.get("status_code"))
         self.assertEqual(response.url, expected.get("url"))
+        self.assertEqual(response.headers.get("content-length"), expected.get("content-length"))
+
+    @patch("requests.Session.send")
+    def test_make_request_enforces_max_response_size(self, mocked_request):
+        returned_max_size, test_max_size = "5000", 1527
+
+        response = requests.Response()
+        response.headers = {"content-length": returned_max_size, "content-type": "application/json"}
+        mocked_request.return_value = response
+
+        test_request = requests.Request(method="GET", url="https://event_source.com/api/v1/logs")
+
+        with self.assertRaises(APIException) as api_err:
+            helper.make_request(_request=test_request, stream=True, max_response_size=test_max_size)
+
+        self.assertEqual(400, api_err.exception.status_code)
+        exp_err_cause = f"API response is exceeding allowed limit of {test_max_size} bytes."
+        exp_err_data = f"Content length returned was {returned_max_size} and max allowed is {test_max_size}"
+        self.assertEqual(400, api_err.exception.status_code)
+        self.assertEqual(exp_err_cause, api_err.exception.cause)
+        self.assertEqual(exp_err_data, api_err.exception.data)
+
 
     @parameterized.expand(
         [
@@ -510,20 +534,46 @@ class TestRequestsHelpers(TestCase):
         )
 
 
-def test_hash_sha1():
-    log = {"example": "value", "sample": "value"}
-    assert "2e1ccc1a95e9b2044f13546c25fe380bbd039293" == helper.hash_sha1(log)
+class TestHashing(TestCase):
+    def setUp(self) -> None:
+        self.log = {"example": "value", "sample": "value"}
 
+    def test_hash_sha1_no_keys(self):
+        # Test hash with no keys provided
+        expected_hash = "2e1ccc1a95e9b2044f13546c25fe380bbd039293"
+        self.assertEqual(helper.hash_sha1(self.log), expected_hash)
 
-def test_compare_and_dedupe_hashes():
-    hashes = ["2e1ccc1a95e9b2044f13546c25fe380bbd039293"]
-    logs = [
-        {
-            "example": "value",
-            "sample": "value",
-        },
-        {"specimen": "new_value"},
-    ]
-    assert [{"specimen": "new_value"}], [
-        "ad6ae80c0356e02b1561cb58408ee678eb1070bb"
-    ] == helper.compare_and_dedupe_hashes(hashes, logs)
+    def test_hash_sha1_keys(self):
+        # Test hash with valid key provided
+        expected_hash = "61c908e52d66a763ceed0798b8e5f4b7f0328a21"
+        self.assertEqual(helper.hash_sha1(self.log, keys=["example"]), expected_hash)
+
+    def test_hash_sha1_keys_wrong_type(self):
+        # Test hash with wrong type for keys
+        with self.assertRaises(TypeError) as context:
+            helper.hash_sha1(self.log, keys="test")
+
+        self.assertEqual(
+            str(context.exception),
+            "The 'keys' parameter must be a list or None in the 'hash_sha1' function, not str"
+        )
+
+    def test_hash_sha1_keys_not_found(self):
+        # Test hash with key not found
+        with self.assertRaises(KeyError) as context:
+            helper.hash_sha1(self.log, keys=["example", "test"])
+
+        self.assertEqual(str(context.exception), "\"Key 'test' not found in the provided log.\"")
+
+    def test_compare_and_dedupe_hashes(self):
+        hashes = ["2e1ccc1a95e9b2044f13546c25fe380bbd039293"]
+        logs = [
+            {
+                "example": "value",
+                "sample": "value",
+            },
+            {"specimen": "new_value"},
+        ]
+        assert [{"specimen": "new_value"}], [
+            "ad6ae80c0356e02b1561cb58408ee678eb1070bb"
+        ] == helper.compare_and_dedupe_hashes(hashes, logs)

tests/unit/utils.py

@@ -34,6 +34,7 @@ def get_mock_response(
     response._content = bytes_string
     response.url = url
     response.reason = reason
+    response.headers = {"content-length": "1", "content-type": "application/json"}
 
     def return_json():
         return data