insightconnect-plugin-runtime 6.4.0__py3-none-any.whl → 6.4.2__py3-none-any.whl

insightconnect_plugin_runtime/clients/aws_client.py

@@ -19,6 +19,7 @@ from insightconnect_plugin_runtime.exceptions import (
     ConnectionTestException,
 )
 from insightconnect_plugin_runtime.helper import clean
+from insightconnect_plugin_runtime.util import is_running_in_cloud
 
 REGION = "region"
 EXTERNAL_ID = "external_id"
@@ -371,6 +372,7 @@ class AWSAction(Action):
         aws_service: str,
         aws_command: str,
         pagination_helper: PaginationHelper = None,
+        close_client: bool = None,
     ):
         """
 
@@ -382,6 +384,8 @@ class AWSAction(Action):
         :param output: The output schema object
         :param aws_service: The AWS service. Should be snake case.
         :param aws_command: The type of request to invoke. Should be snake case.
+        :param pagination_helper: Paginating helper indicate attrs like max_pages and token location.
+        :param close_client: Determine if the created client should be closed at the end of the action.
         """
 
         super().__init__(
@@ -391,6 +395,11 @@ class AWSAction(Action):
         self.aws_command = aws_command
         self.pagination_helper = pagination_helper
 
+        # when running in cloud mode we won't hold this connection, so each call to action.run() will spawn a new
+        # client, in this case we should close the client unless otherwise specified. A use case to not close
+        # is on a task plugin that re-uses the client for list_objects_v2 and get_bucket_content.
+        self.close_client = is_running_in_cloud() if close_client is None else close_client
+
     def _handle_botocore_function(
         self, client_function: Callable, params: Dict
     ) -> Dict:
@@ -441,6 +450,9 @@ class AWSAction(Action):
             raise PluginException(
                 cause="Error occurred when invoking the aws-cli.", data=error
             )
+        finally:
+            if self.close_client:
+                self.connection.client.close()
         return response
 
     def _handle_format_output(self, response: Dict, helper: ActionHelper) -> Dict:
@@ -542,6 +554,9 @@ class AWSAction(Action):
             if not self.pagination_helper.max_pages:
                 self.pagination_helper.remove_keys(response)
 
+        if self.close_client:
+            self.connection.client.close()
+
         return response
 
     def test(self, params={}):
@@ -610,14 +625,14 @@ class AWSAction(Action):
                     }
                 )
             )
+            sts_client.close()
         except ClientError as error:
             raise PluginException(
                 cause=f"Boto3 raised following error during assume role: {error.response['Error']['Code']}",
                 assistance="Please verify your role ARN and external ID are correct",
             )
         credentials = assumed_role_object["Credentials"]
-        session = botocore.session.Session()
-        boto_session = session.create_client(
+        boto_client = boto3.client(
             service_name,
             aws_access_key_id=credentials["AccessKeyId"],
             aws_secret_access_key=credentials["SecretAccessKey"],
@@ -625,4 +640,4 @@ class AWSAction(Action):
             region_name=assume_role_params[REGION],
         )
 
-        return boto_session
+        return boto_client

insightconnect_plugin_runtime/helper.py

@@ -71,7 +71,7 @@ def hash_sha1(log: Dict[str, Any], keys: Optional[List[str]] = None) -> str:
 
     # Iterate through items to hash and hash
     for key, value in items_to_hash:
-        hash_.update(f"{key}{value}".encode(ENCODE_TYPE))
+        hash_.update(f"{key}{value}".encode(ENCODE_TYPE, errors="ignore"))
 
     return hash_.hexdigest()
 

insightconnect_plugin_runtime/server.py

@@ -11,7 +11,7 @@ from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec_webframeworks.flask import FlaskPlugin
 from flask import Flask, request_started, request
 from gunicorn.arbiter import Arbiter
-from pythonjsonlogger.jsonlogger import JsonFormatter
+from pythonjsonlogger.jsonlogger import JsonFormatter, RESERVED_ATTRS
 from requests import get as request_get
 from requests.exceptions import (
     HTTPError,
@@ -146,7 +146,8 @@ class PluginServer(gunicorn.app.base.BaseApplication):
         console_handler = logging.StreamHandler()
         if is_running_in_cloud():
             console_handler.setFormatter(
-                JsonFormatter()
+                # since python bump to 3.13 the logging lib now includes a bunch of extra keywords we want to discard
+                JsonFormatter(reserved_attrs=RESERVED_ATTRS + ("taskName",))
             )  # Only log in JSON if running in cloud
 
         logger.addHandler(console_handler)

{insightconnect_plugin_runtime-6.4.0.dist-info → insightconnect_plugin_runtime-6.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.4.0
+Version: 6.4.2
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -12,27 +12,27 @@ 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.4
+Requires-Dist: requests==2.32.5
 Requires-Dist: python_jsonschema_objects==0.5.2
 Requires-Dist: jsonschema==4.22.0
-Requires-Dist: certifi==2025.8.3
-Requires-Dist: Flask==3.1.1
+Requires-Dist: certifi==2026.1.4
+Requires-Dist: Flask==3.1.2
 Requires-Dist: gunicorn==23.0.0
-Requires-Dist: greenlet==3.2.3
+Requires-Dist: greenlet==3.3.0
 Requires-Dist: gevent==25.5.1
-Requires-Dist: marshmallow==3.21.0
+Requires-Dist: marshmallow==3.26.2
 Requires-Dist: apispec==6.5.0
 Requires-Dist: apispec-webframeworks==1.0.0
 Requires-Dist: blinker==1.9.0
-Requires-Dist: structlog==25.4.0
+Requires-Dist: structlog==25.5.0
 Requires-Dist: python-json-logger==2.0.7
 Requires-Dist: Jinja2==3.1.6
 Requires-Dist: python-dateutil==2.9.0.post0
-Requires-Dist: opentelemetry-sdk==1.36.0
-Requires-Dist: opentelemetry-instrumentation-flask==0.57b0
-Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.36.0
-Requires-Dist: opentelemetry-instrumentation-requests==0.57b0
-Requires-Dist: urllib3==2.5.0
+Requires-Dist: opentelemetry-sdk==1.39.1
+Requires-Dist: opentelemetry-instrumentation-flask==0.60b1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.39.1
+Requires-Dist: opentelemetry-instrumentation-requests==0.60b1
+Requires-Dist: urllib3==2.6.3
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -63,10 +63,10 @@ to get started.
 
 ## Development of the InsightConnect Plugin Runtime
 
-The Python Runtime codebase is built to support Python 3.11.13 as of version 6.2.3. The following dependencies will need 
+The Python Runtime codebase is built to support Python 3.13 as of version 6.4.0. The following dependencies will need 
 to be installed when developing or testing the Plugin Runtime:
 
-- Python 3.11.13
+- Python 3.13.11
 - Docker
 - make
 - tox
@@ -226,6 +226,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.4.2 - Added error handling for `hash_sha1` in helpers | Updated base images to Python 3.13.11 | Updated dependencies
+* 6.4.1 - Fix logging on cloud mode to remove `taskName` | Close boto client after assuming role
 * 6.4.0 - When running in cloud mode, always create a new connection object | Bump Python version to 3.13.9 | Docker build tidyup to reduce image size
 * 6.3.10 - Fixed tracing name to better allign otel standards
 * 6.3.9 - Fixed `monitor_task_delay` decorator handling of millisecond epoch timestamps | Allow `test_task` connection method to accept task name parameter | Updated base images to Python 3.11.13

{insightconnect_plugin_runtime-6.4.0.dist-info → insightconnect_plugin_runtime-6.4.2.dist-info}/RECORD

@@ -4,11 +4,11 @@ insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C
 insightconnect_plugin_runtime/connection.py,sha256=4uWclDTFSKZXbvzrq2VGwIM0_o54XaqHeGje3IMFCSA,2672
 insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf69rM7Iezs4rbnw,1774
 insightconnect_plugin_runtime/exceptions.py,sha256=LeZR2H_seHIUALLwnKyH5W7PX3VNa-lOTxJ0vZJra8I,8068
-insightconnect_plugin_runtime/helper.py,sha256=xGiskPd4vHr_k7BNEb3_7gPxm8sB85A7_5N31S-0RE4,33994
+insightconnect_plugin_runtime/helper.py,sha256=saD2Vl_9Pt86pmrQOc5FvjjJAcHl5wgmKkcbyS8c4gE,34011
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 insightconnect_plugin_runtime/plugin.py,sha256=5CNxVAmiAwdEXviBU-_oA3_Ud03PYO_fs-ph9x_2yO0,27286
 insightconnect_plugin_runtime/schema.py,sha256=6MVw5hqGATU1VLgwfOWfPsP3hy1OnsugCTsgX8sknes,521
-insightconnect_plugin_runtime/server.py,sha256=DHooHBQa1M2z7aETTWK6u9B2jChi8vONzqK4n_c94f4,13138
+insightconnect_plugin_runtime/server.py,sha256=OCJ_cr3y744RaDhuwoOclzdVSQzbn42Me7s2hh7HUJc,13317
 insightconnect_plugin_runtime/step.py,sha256=KdERg-789-s99IEKN61DR08naz-YPxyinPT0C_T81C4,855
 insightconnect_plugin_runtime/task.py,sha256=d-H1EAzVnmSdDEJtXyIK5JySprxpF9cetVoFGtWlHrg,123
 insightconnect_plugin_runtime/telemetry.py,sha256=ZOG4Gv9o4JgO46RbqIsSkWSMuQnbfTnmgc5WURe5FTs,8026
@@ -19,7 +19,7 @@ insightconnect_plugin_runtime/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 insightconnect_plugin_runtime/api/endpoints.py,sha256=ddqqYM7s1huvXFD0nCjpV_J2XULDn8F5sRakdjq-AKU,38893
 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=ViJF3klbD1YM5GVxme3BFYfpuADUlVGP8sdbX2Z6_Cw,23061
+insightconnect_plugin_runtime/clients/aws_client.py,sha256=BTQ-NTIRr08K-AezA62ADSXxv06SwghF4NFyPN3K9-A,23931
 insightconnect_plugin_runtime/clients/oauth.py,sha256=bWtAGRMwdK4dw9vMPcw9usklyIHBDtZh55kMZ7sWROc,2453
 insightconnect_plugin_runtime/data/input_message_schema.json,sha256=7_BcHi6UOBiVWGrrJHHn5IoddteXjL7GOKETdO9T2DE,1770
 insightconnect_plugin_runtime/data/output_message_schema.json,sha256=Qya6U-NR5MfOlw4V98VpQzGBVq75eGMUQhI-j3yxOHI,1137
@@ -65,8 +65,8 @@ tests/plugin/hello_world/tests/test_server.py,sha256=7QfMNVsNcRoX5aAL0xM9tXS-ciy
 tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit/test_action.py,sha256=0SVen1qNrFLKKAXMurN9T4NpItpftnSpDZ71AdrGZeo,1683
 tests/unit/test_api.py,sha256=uZ1dWMmgQ-ZePYjmcZfjc-qOTJsjs20Wic0Uf4U12-8,4441
-tests/unit/test_aws_action.py,sha256=pBE23Qn4aXKJqPmwiHMcEU5zPdyvbKO-eK-6jUlrsQw,9640
-tests/unit/test_connection.py,sha256=rU0k9kWsGzaHdXmXmNaJWJnbXCTwvNXPD03Y6IeSbb4,5838
+tests/unit/test_aws_action.py,sha256=qsDP56m5mWNYTyck4I3udgj__ZbJqByHeDCbM5_F98U,13379
+tests/unit/test_connection.py,sha256=AOQm1PYkaqXK22evyjKV4_ZsdgUeIbXQ0pt6vmzphK4,5832
 tests/unit/test_custom_encoder.py,sha256=KLYyVOTq9MEkZXyhVHqjm5LVSW6uJS4Davgghsw9DGk,2207
 tests/unit/test_endpoints.py,sha256=Ef0f6EudnAA_o6jZJ7rvgwgQHHswPuBEiyyo1D7BWMc,11523
 tests/unit/test_exceptions.py,sha256=Y4F-ij8WkEJkUU3mPvxlEchqE9NCdxDvR8bJzPVVNao,5328
@@ -80,7 +80,7 @@ tests/unit/test_server_spec.py,sha256=je97BaktgK0Fiz3AwFPkcmHzYtOJJNqJV_Fw5hrvqX
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
 tests/unit/utils.py,sha256=hcY0A2H_DMgCDXUTvDtCXMdMvRjLQgTaGcTpATb8YG0,2236
-insightconnect_plugin_runtime-6.4.0.dist-info/METADATA,sha256=M_TyHBaLttm8RXGSY6zbVdm3lsxRdS_jpgVniO0a5BI,17413
-insightconnect_plugin_runtime-6.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-insightconnect_plugin_runtime-6.4.0.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-6.4.0.dist-info/RECORD,,
+insightconnect_plugin_runtime-6.4.2.dist-info/METADATA,sha256=ZIS-QYMiVGgGODEBRwOXRq_2dk5dx2rQ9frEWS0NX5I,17628
+insightconnect_plugin_runtime-6.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+insightconnect_plugin_runtime-6.4.2.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.4.2.dist-info/RECORD,,

tests/unit/test_aws_action.py

@@ -3,6 +3,7 @@ import io
 import json
 import unittest
 import unittest.mock
+from os import environ
 from pathlib import Path
 
 import botocore.exceptions as be
@@ -28,6 +29,10 @@ class Boto3Stub:
             }
         }
 
+    def close(self):
+        # stub for closing the sts client after assuming the role
+        pass
+
 
 class TestAwsAction(unittest.TestCase):
     def setUp(self) -> None:
@@ -37,6 +42,12 @@ class TestAwsAction(unittest.TestCase):
         }
         self.region = "us-east"
 
+        self.assume_role_params = {
+            "role_arn": "test_role",
+            "external_id": "test_id",
+            "region": "test-region",
+        }
+
         self.aws_action = AWSAction(
             "NewAction", "Description", None, None, "ec2", "service"
         )
@@ -45,19 +56,11 @@ class TestAwsAction(unittest.TestCase):
         self.aws_action.input = Input({})
         self.aws_action.output = Output({})
 
-    @unittest.mock.patch("botocore.session.Session", return_value=unittest.mock.Mock())
     @unittest.mock.patch("boto3.client", return_value=Boto3Stub())
-    def test_assume_role(self, mock_session, mock_sts_client):
-        assume_role_params = {
-            "role_arn": "test_role",
-            "external_id": "test_id",
-            "region": "test-region",
-        }
-        aws_session = unittest.mock.Mock()
-
-        AWSAction.try_to_assume_role("ec2", assume_role_params, self.auth_params)
+    def test_assume_role(self, mock_sts_client):
+        AWSAction.try_to_assume_role("ec2", self.assume_role_params, self.auth_params)
 
-        mock_sts_client.assert_called_once()
+        self.assertEqual(mock_sts_client.call_count, 2)  # twice for assume role and create client afterwards
 
     @unittest.mock.patch("botocore.session.Session", return_value=unittest.mock.Mock())
     @unittest.mock.patch("boto3.client", return_value=Boto3Stub())
@@ -135,6 +138,58 @@ class TestAwsAction(unittest.TestCase):
         with self.assertRaises(PluginException):
             self.aws_action.handle_rest_call(mock_call, {})
 
+    @unittest.mock.patch.dict(environ, {"PLUGIN_RUNTIME_ENVIRONMENT": "orchestrator"})
+    @unittest.mock.patch.object(AWSAction, "handle_rest_call", return_value={"mock_key": "mock_value"})
+    def test_run_client_non_cloud_mode_in_action_default_behaviour(self, _mock_handle_rest_call):
+        # Test AWSAction called for customers running on an orchestrator that their client can remain open
+        aws_action = AWSAction("NewAction", "Description", None, None, "s3", "service")
+        aws_action.connection = unittest.mock.create_autospec(Connection)
+        aws_action.connection.assume_role_params = self.assume_role_params
+        aws_action.connection.auth_params = self.auth_params
+        aws_action.connection.client = unittest.mock.create_autospec(Boto3Stub)
+        aws_action.connection.client.service = unittest.mock.MagicMock()
+        aws_action.run()
+        aws_action.connection.client.close.assert_not_called()
+
+    @unittest.mock.patch.dict(environ, {"PLUGIN_RUNTIME_ENVIRONMENT": "cloud"})
+    @unittest.mock.patch.object(AWSAction, "handle_rest_call", return_value={"mock_key": "mock_value"})
+    def test_run_client_cloud_mode_in_normal_action(self, _mock_handle_rest_call):
+        # Test the same AWSAction as above but now running in cloud - we should close this client
+        aws_action = AWSAction("NewAction", "Description", None, None, "s3", "service")
+        aws_action.connection = unittest.mock.create_autospec(Connection)
+        aws_action.connection.assume_role_params = self.assume_role_params
+        aws_action.connection.auth_params = self.auth_params
+        aws_action.connection.client = unittest.mock.create_autospec(Boto3Stub)
+        aws_action.connection.client.service = unittest.mock.MagicMock()
+        aws_action.run()
+        aws_action.connection.client.close.assert_called_once()
+
+    @unittest.mock.patch.dict(environ, {"PLUGIN_RUNTIME_ENVIRONMENT": "orchestrator"})
+    @unittest.mock.patch.object(AWSAction, "handle_rest_call", return_value={"mock_key": "mock_value"})
+    def test_run_client_non_cloud_mode_in_action_default_override(self, _mock_handle_rest_call):
+        # Test AWSAction when we have specified to close the client
+        aws_action = AWSAction("NewAction", "Description", None, None, "s3", "service", close_client=True)
+        aws_action.connection = unittest.mock.create_autospec(Connection)
+        aws_action.connection.assume_role_params = self.assume_role_params
+        aws_action.connection.auth_params = self.auth_params
+        aws_action.connection.client = unittest.mock.create_autospec(Boto3Stub)
+        aws_action.connection.client.service = unittest.mock.MagicMock()
+        aws_action.run()
+        aws_action.connection.client.close.assert_called_once()
+
+    @unittest.mock.patch.dict(environ, {"PLUGIN_RUNTIME_ENVIRONMENT": "cloud"})
+    @unittest.mock.patch.object(AWSAction, "handle_rest_call", return_value={"mock_key": "mock_value"})
+    def test_run_client_cloud_mode_in_typical_c2c_task(self, _mock_handle_rest_call):
+        # Test AWSAction used within a C2C task, we want to keep the client for subsequent calls
+        aws_action = AWSAction("NewAction", "Description", None, None, "s3", "service", close_client=False)
+        aws_action.connection = unittest.mock.create_autospec(Connection)
+        aws_action.connection.assume_role_params = self.assume_role_params
+        aws_action.connection.auth_params = self.auth_params
+        aws_action.connection.client = unittest.mock.create_autospec(Boto3Stub)
+        aws_action.connection.client.service = unittest.mock.MagicMock()
+        aws_action.run()
+        aws_action.connection.client.close.assert_not_called()
+
     def mocked_requests_get(*args, **kwargs):
         class MockResponse:
             def __init__(self, json_data, status_code):

tests/unit/test_connection.py

@@ -64,7 +64,7 @@ class TestCloudConnections(TestCase):
     def test_running_onprem_has_cached_connection(self):
         conn = self.connection_cache.get(self.connection, self.logger)
         self.assertEqual(conn.parameters, self.connection)
-        self.assertNotEquals(self.connection_cache.connections, {})
+        self.assertNotEqual(self.connection_cache.connections, {})
 
         # the connection cache key should exist
         hashed_key = key(conn.parameters)
@@ -81,13 +81,13 @@ class TestCloudConnections(TestCase):
             # first call the connection cache for the first time adding a new entry
             conn = self.connection_cache.get(self.connection, self.logger)
             self.assertEqual(len(self.connection_cache.connections), 1)
-            self.assertEquals(list(self.connection_cache.connections.values())[0], pretend_obj)
-            self.assertEquals(conn, pretend_obj)
+            self.assertEqual(list(self.connection_cache.connections.values())[0], pretend_obj)
+            self.assertEqual(conn, pretend_obj)
             self.assertEqual(stub_key.call_count, 1)
 
             # on a second call we get the same value but the create_and_validate shouldn't be called again
             conn2 = self.connection_cache.get(self.connection, self.logger)
-            self.assertEquals(conn, conn2)
+            self.assertEqual(conn, conn2)
             stub_create.assert_called_once_with(self.connection, self.logger)
 
             # on a third call we add a new entry to the cached connections
@@ -103,11 +103,11 @@ class TestCloudConnections(TestCase):
             _conn = self.connection_cache.get(self.connection, self.logger)
 
         # this means the connection object is not saved in cache
-        self.assertEquals(self.connection_cache.connections, {})
+        self.assertEqual(self.connection_cache.connections, {})
 
     def test_connection_validation_raised(self):
         with self.assertRaises(Exception):  # not the expected input to match the connection schema
             _conn = self.connection_cache.get({"not_expected_key": "value"}, self.logger)
 
         # this means the connection object is not saved in cache
-        self.assertEquals(self.connection_cache.connections, {})
+        self.assertEqual(self.connection_cache.connections, {})