insightconnect-plugin-runtime 6.0.1__tar.gz → 6.1.1__tar.gz

{insightconnect_plugin_runtime-6.0.1/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 6.0.1
+Version: 6.1.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,7 +211,9 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
-* 6.0.1 -  Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
+* 6.1.1 - Addressed vulnerabilities within the slim and non-slim Python images (bumping packages).
+* 6.1.0 - Update AWSAction tests to utilise AWS Client Error names for connection test | Update `request_error_handling` to include input for custom configuration
+* 6.0.1 - Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
 * 6.0.0 - Address vulnerabilities within `certifi` python package | Bump the version of OpenSSL used | If running a task connection test, return a custom message from the task test and not the full log.
 * 5.6.1 - Making sure all paths that can call the task connection test endpoints return a 400 error if the test fails
 * 5.6.0 - Add APIException class for error handling | Fix error in response_handler where data of type Response was not correctly being returned

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/README.md

@@ -182,7 +182,9 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
-* 6.0.1 -  Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
+* 6.1.1 - Addressed vulnerabilities within the slim and non-slim Python images (bumping packages).
+* 6.1.0 - Update AWSAction tests to utilise AWS Client Error names for connection test | Update `request_error_handling` to include input for custom configuration
+* 6.0.1 - Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
 * 6.0.0 - Address vulnerabilities within `certifi` python package | Bump the version of OpenSSL used | If running a task connection test, return a custom message from the task test and not the full log.
 * 5.6.1 - Making sure all paths that can call the task connection test endpoints return a 400 error if the test fails
 * 5.6.0 - Add APIException class for error handling | Fix error in response_handler where data of type Response was not correctly being returned

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/insightconnect_plugin_runtime/api/endpoints.py

@@ -28,6 +28,9 @@ from insightconnect_plugin_runtime.util import OutputMasker
 logger = structlog.get_logger("plugin")
 ORG_ID = "X-IPIMS-ORGID"
 
+PLUGIN_SPEC_DOCKERFILE = "/python/src/plugin.spec.yaml"
+PLUGIN_SPEC_PACK = "/workspace/plugin.spec.yaml"
+
 
 # Must be defined at application level in order to capture all 404's with blueprints,
 # see https://flask.palletsprojects.com/en/2.3.x/errorhandling/#blueprint-error-handlers
@@ -329,9 +332,7 @@ class Endpoints:
                   description: InsightConnect Plugin Information to be returned
                   schema: PluginInfoSchema
             """
-            plugin_spec_json = Endpoints.load_file_json_format(
-                "/python/src/plugin.spec.yaml"
-            )
+            plugin_spec_json = Endpoints.load_plugin_spec_file()
             plugin_info_fields = [
                 "name",
                 "description",
@@ -430,9 +431,7 @@ class Endpoints:
                 400:
                   description: Bad request
             """
-            plugin_spec_json = Endpoints.load_file_json_format(
-                "/python/src/plugin.spec.yaml"
-            )
+            plugin_spec_json = Endpoints.load_plugin_spec_file()
             Endpoints.action_trigger_task_exists(plugin_spec_json, "actions", name)
             return jsonify(
                 ActionTriggerDetailsSchema().dump(
@@ -459,9 +458,7 @@ class Endpoints:
                 400:
                   description: Bad request
             """
-            plugin_spec_json = Endpoints.load_file_json_format(
-                "/python/src/plugin.spec.yaml"
-            )
+            plugin_spec_json = Endpoints.load_plugin_spec_file()
             Endpoints.action_trigger_task_exists(plugin_spec_json, "tasks", name)
             return jsonify(
                 TaskDetailsSchema().dump(plugin_spec_json.get("tasks").get(name))
@@ -486,9 +483,7 @@ class Endpoints:
                 400:
                   description: Bad request
             """
-            plugin_spec_json = Endpoints.load_file_json_format(
-                "/python/src/plugin.spec.yaml"
-            )
+            plugin_spec_json = Endpoints.load_plugin_spec_file()
             Endpoints.action_trigger_task_exists(plugin_spec_json, "triggers", name)
             return jsonify(
                 ActionTriggerDetailsSchema().dump(
@@ -559,8 +554,12 @@ class Endpoints:
                     jsonify({"error": "The specified format is not supported"}), 422
                 )
 
-            with open("/python/src/plugin.spec.yaml", "r") as p_spec:
-                plugin_spec = p_spec.read()
+            try:
+                with open(PLUGIN_SPEC_DOCKERFILE, "r") as p_spec:
+                    plugin_spec = p_spec.read()
+            except FileNotFoundError:
+                with open(PLUGIN_SPEC_PACK, "r") as p_spec:
+                    plugin_spec = p_spec.read()
 
             if format_ == "yaml":
                 return plugin_spec
@@ -744,7 +743,14 @@ class Endpoints:
         return actions_triggers_tasks.get(p_name)
 
     @staticmethod
-    def load_file_json_format(filename):
+    def load_plugin_spec_file() -> Dict[str, Any]:
+        try:
+            return Endpoints.load_file_json_format(PLUGIN_SPEC_DOCKERFILE)
+        except FileNotFoundError:
+            return Endpoints.load_file_json_format(PLUGIN_SPEC_PACK)
+
+    @staticmethod
+    def load_file_json_format(filename: str) -> Dict[str, Any]:
         with open(filename, "r") as plugin_spec:
             return yaml.safe_load(plugin_spec.read())
 

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/insightconnect_plugin_runtime/clients/aws_client.py

@@ -14,13 +14,26 @@ from botocore.exceptions import ClientError
 
 import insightconnect_plugin_runtime
 from insightconnect_plugin_runtime.action import Action
-from insightconnect_plugin_runtime.exceptions import PluginException
+from insightconnect_plugin_runtime.exceptions import (
+    PluginException,
+    ConnectionTestException,
+)
 from insightconnect_plugin_runtime.helper import clean
 
 REGION = "region"
 EXTERNAL_ID = "external_id"
 ROLE_ARN = "role_arn"
 ASSUME_ROLE_PARAMETERS = "assume_role_params"
+AWS_CLIENT_ERRORS = [
+    "AccessDeniedException",
+    "InternalServerException",
+    "ResourceNotFoundException",
+    "InternalFailure",
+    "InvalidClientTokenId",
+    "NotAuthorized",
+    "ServiceUnavailable",
+    "OptInRequired",
+]
 
 
 class PaginationHelper:
@@ -36,7 +49,7 @@ class PaginationHelper:
         limit_key: str = None,
         more_results: str = None,
         non_aggregate_keys: List[str] = None,
-        max_pages : int = None,  # if we want to limit how many pages of data we pull from AWS
+        max_pages: int = None,  # if we want to limit how many pages of data we pull from AWS
     ):
         self.input_token = input_token
         self.output_token = output_token
@@ -512,7 +525,9 @@ class AWSAction(Action):
         if self.pagination_helper:
             while self.pagination_helper.check_pagination(params, response):
                 if self.pagination_helper.check_total_results(params, response):
-                    self.logger.info("Reached max amount of pages per execution breaking...")
+                    self.logger.info(
+                        "Reached max amount of pages per execution breaking..."
+                    )
                     break
 
                 self.logger.info("Response was paginated. Performing another call.")
@@ -547,7 +562,28 @@ class AWSAction(Action):
         endpoint = client._endpoint.host  # pylint:disable=protected-access
         response = requests.get(endpoint)
 
-        assert response.ok  # noqa: B101
+        response_text = response.text
+        status_code = response.status_code
+
+        # AWS client errors are not always mapped predictably, and some service endpoints will return an unexpected
+        # result
+        if not (200 <= status_code <= 299):
+            if (
+                status_code in [401, 403, 404, 500, 503]
+                and "UnknownOperationException" not in response_text
+            ):
+                raise ConnectionTestException(
+                    cause=f"Error code {status_code} returned from AWS service",
+                    assistance="Please check the response for more information",
+                    data=response_text,
+                )
+            for error in AWS_CLIENT_ERRORS:
+                if error in response_text:
+                    raise ConnectionTestException(
+                        cause=f"Error code {status_code} returned from AWS service with {error} exception",
+                        assistance="Please check the response for more information",
+                        data=response_text,
+                    )
 
         if "properties" in self.output.schema:
             response = helper.format_output(self.output.schema, {})

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/insightconnect_plugin_runtime/helper.py

@@ -155,7 +155,11 @@ def extract_json(response: requests.Response) -> Dict:
         )
 
 
-def request_error_handling() -> Union[Any, None]:
+def request_error_handling(
+    custom_configs: Dict[int, Exception]={},
+    exception_data_location: str = None,
+    allowed_status_codes: List[str] = [],
+) -> Union[Any, None]:
     """request_error_handling. This decorator allows a method that makes a request to complete with error handling.
     A plugin exception will be raised whenever an error is caught. Response.raise_for_status() must be called in the
     wrapped method to handle HTTPErrors.
@@ -182,7 +186,12 @@ def request_error_handling() -> Union[Any, None]:
                 )
             except requests.exceptions.RequestException as exception:
                 if isinstance(exception, requests.exceptions.HTTPError):
-                    response_handler(exception.response)
+                    response_handler(
+                        exception.response,
+                        data_location=exception_data_location,
+                        custom_configs=custom_configs,
+                        allowed_status_codes=allowed_status_codes
+                    )
                 else:
                     raise PluginException(
                         preset=PluginException.Preset.UNKNOWN, data=str(exception)

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 6.0.1
+Version: 6.1.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,7 +211,9 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
-* 6.0.1 -  Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
+* 6.1.1 - Addressed vulnerabilities within the slim and non-slim Python images (bumping packages).
+* 6.1.0 - Update AWSAction tests to utilise AWS Client Error names for connection test | Update `request_error_handling` to include input for custom configuration
+* 6.0.1 - Address vulnerabilities within the following python packages: `Jinja2`, `requests`, `urllib3`, `zipp` and `setuptools`. 
 * 6.0.0 - Address vulnerabilities within `certifi` python package | Bump the version of OpenSSL used | If running a task connection test, return a custom message from the task test and not the full log.
 * 5.6.1 - Making sure all paths that can call the task connection test endpoints return a 400 error if the test fails
 * 5.6.0 - Add APIException class for error handling | Fix error in response_handler where data of type Response was not correctly being returned

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="6.0.1",
+    version="6.1.1",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",

{insightconnect_plugin_runtime-6.0.1 → insightconnect_plugin_runtime-6.1.1}/tests/unit/test_aws_action.py

@@ -141,6 +141,7 @@ class TestAwsAction(unittest.TestCase):
                 self.json_data = json_data
                 self.status_code = status_code
                 self.ok = True
+                self.text = str(json_data)
 
         return MockResponse(None, 200)