insightconnect-plugin-runtime 6.2.2__tar.gz → 6.2.4__tar.gz

{insightconnect_plugin_runtime-6.2.2/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: insightconnect-plugin-runtime
-Version: 6.2.2
+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,8 @@ 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`

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/README.md

@@ -19,10 +19,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
@@ -38,7 +38,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
@@ -94,7 +94,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
@@ -155,7 +155,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  |
@@ -182,6 +182,8 @@ 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`

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/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-6.2.2 → insightconnect_plugin_runtime-6.2.4}/insightconnect_plugin_runtime/helper.py

@@ -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"
@@ -111,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
@@ -133,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]
@@ -148,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)

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/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.2 → insightconnect_plugin_runtime-6.2.4/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: insightconnect-plugin-runtime
-Version: 6.2.2
+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,8 @@ 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`

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -1,14 +1,14 @@
-requests==2.32.2
+requests==2.32.3
 python_jsonschema_objects==0.5.2
-jsonschema==4.21.1
-certifi==2024.07.04
-Flask==3.0.2
-gunicorn==22.0.0
+jsonschema==4.22.0
+certifi==2024.12.14
+Flask==3.1.0
+gunicorn==23.0.0
 greenlet==3.1.1
-gevent==24.10.1
+gevent==24.11.1
 marshmallow==3.21.0
 apispec==6.5.0
 apispec-webframeworks==1.0.0
-blinker==1.7.0
-structlog==24.1.0
+blinker==1.9.0
+structlog==24.4.0
 python-json-logger==2.0.7

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="6.2.2",
+    version="6.2.4",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -14,19 +14,19 @@ setup(
     url="https://github.com/rapid7/komand-plugin-sdk-python",
     packages=find_packages(),
     install_requires=[
-        "requests==2.32.2",
+        "requests==2.32.3",
         "python_jsonschema_objects==0.5.2",
-        "jsonschema==4.21.1",
-        "certifi==2024.07.04",
-        "Flask==3.0.2",
-        "gunicorn==22.0.0",
+        "jsonschema==4.22.0",
+        "certifi==2024.12.14",
+        "Flask==3.1.0",
+        "gunicorn==23.0.0",
         "greenlet==3.1.1",
-        "gevent==24.10.1",
+        "gevent==24.11.1",
         "marshmallow==3.21.0",
         "apispec==6.5.0",
         "apispec-webframeworks==1.0.0",
-        "blinker==1.7.0",
-        "structlog==24.1.0",
+        "blinker==1.9.0",
+        "structlog==24.4.0",
         "python-json-logger==2.0.7"
     ],
     tests_require=[

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/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(
         [

{insightconnect_plugin_runtime-6.2.2 → insightconnect_plugin_runtime-6.2.4}/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