insightconnect-plugin-runtime 5.5.5__tar.gz → 5.6.1__tar.gz

{insightconnect_plugin_runtime-5.5.5/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-5.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.5.5
+Version: 5.6.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,6 +211,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.
 * 5.5.3 - Adding in a new endpoint that can be called to run a task connection test

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/README.md

@@ -182,6 +182,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.
 * 5.5.3 - Adding in a new endpoint that can be called to run a task connection test

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/insightconnect_plugin_runtime/api/endpoints.py

@@ -283,7 +283,7 @@ class Endpoints:
             self.logger.debug("Request input: %s", input_message)
             Endpoints.validate_action_trigger_task_empty_input(input_message)
             Endpoints.validate_action_trigger_task_name(input_message, name, "task")
-            output = self.run_action_trigger_task(input_message, True)
+            output = self.run_action_trigger_task(input_message, True, connection_test_type="test_task")
             return output
 
         @v1.route("/api")
@@ -821,13 +821,13 @@ class Endpoints:
 
         return input_data
 
-    def run_action_trigger_task(self, input_message, test=False):
+    def run_action_trigger_task(self, input_message, test=False, connection_test_type="test"):
         connection = input_message.get("body", {}).get("connection", {})
         status_code = 200
         output = None
         try:
             output = self.plugin.handle_step(
-                input_message, is_debug=self.debug, is_test=test
+                input_message, is_debug=self.debug, is_test=test, connection_test_type=connection_test_type
             )
         except LoggedException as error:
             wrapped_exception = error.ex
@@ -841,6 +841,8 @@ class Endpoints:
                 and wrapped_exception.preset is PluginException.Preset.BAD_REQUEST
             ):
                 status_code = 400
+            elif isinstance(wrapped_exception, (ConnectionTestException, ClientException)):
+                status_code = 400
             elif isinstance(wrapped_exception, ServerException):
                 # I'm unsure about this
                 status_code = 500

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/insightconnect_plugin_runtime/exceptions.py

@@ -207,3 +207,9 @@ class PluginException(ConnectionTestException):
             return "An error occurred during plugin execution!\n\n{cause} {assistance}".format(
                 cause=self.cause, assistance=self.assistance
             )
+
+
+class APIException(PluginException):
+    def __init__(self, cause=None, assistance=None, data=None, preset=None, status_code=None):
+        super().__init__(cause, assistance, data, preset)
+        self.status_code = status_code

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/insightconnect_plugin_runtime/helper.py

@@ -243,7 +243,8 @@ def response_handler(
             if hasattr(exception, "data") and data is not None:
                 exception.data = data
         elif status_code_preset:
-            exception = PluginException(preset=status_code_preset, data=data)
+            exception = PluginException(preset=status_code_preset)
+            exception.data = data
 
         raise exception
 

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/insightconnect_plugin_runtime/plugin.py

@@ -627,7 +627,7 @@ class Plugin(object):
                 # Check if connection test func available. If so - use it (preferred). Else fallback to action/trigger test
                 if hasattr(step.connection, "test"):
                     if hasattr(step.connection, "test") and connection_test_type == "test_task":
-                        func = step.connection.task_test
+                        func = step.connection.test_task
                     else:
                         func = step.connection.test
                 else:

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.5.5
+Version: 5.6.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,6 +211,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.
 * 5.5.3 - Adding in a new endpoint that can be called to run a task connection test

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/setup.py

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

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/tests/unit/test_exceptions.py

@@ -1,4 +1,4 @@
-from insightconnect_plugin_runtime.exceptions import PluginException
+from insightconnect_plugin_runtime.exceptions import PluginException, APIException
 from unittest import TestCase
 
 
@@ -85,3 +85,20 @@ class TestExceptions(TestCase):
                 raise (PluginException(preset=test_data.get("preset")))
             assert context.exception.cause == test_data.get("expected_cause")
             assert context.exception.assistance == test_data.get("expected_assistance")
+
+    def test_api_exception(self):
+        with self.assertRaises(APIException) as context:
+            raise (
+                APIException(
+                    preset=PluginException.Preset.NOT_FOUND,
+                    status_code=404,
+                    data="example",
+                )
+            )
+        assert context.exception.cause == "Invalid or unreachable endpoint provided."
+        assert (
+            context.exception.assistance
+            == "Verify the URLs or endpoints in your configuration are correct."
+        )
+        assert context.exception.data == "example"
+        assert context.exception.status_code == 404

{insightconnect_plugin_runtime-5.5.5 → insightconnect_plugin_runtime-5.6.1}/tests/unit/test_helpers.py

@@ -439,7 +439,11 @@ class TestRequestsHelpers(TestCase):
     ):
         request = requests.Request(method=method, url=url, json=None)
         with self.assertRaises(PluginException) as error:
-            helper.make_request(_request=request, exception_custom_configs=exp_config)
+            helper.make_request(
+                _request=request,
+                exception_custom_configs=exp_config,
+                exception_data_location=ResponseExceptionData.RESPONSE,
+            )
         assert (isinstance(error, exception_type), True)
         if test_name == "custom404":
             self.assertEqual(
@@ -450,6 +454,8 @@ class TestRequestsHelpers(TestCase):
                 error.exception.assistance,
                 "CustomAssistance",
             )
+            self.assertEqual(error.exception.data.text, "example")
+            self.assertEqual(error.exception.data.status_code, 404)
 
     @parameterized.expand(
         [