insightconnect-plugin-runtime 5.5.5__py3-none-any.whl → 5.6.1__py3-none-any.whl

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/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/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/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.dist-info → insightconnect_plugin_runtime-5.6.1.dist-info}/METADATA

@@ -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.dist-info → insightconnect_plugin_runtime-5.6.1.dist-info}/RECORD

@@ -3,10 +3,10 @@ insightconnect_plugin_runtime/action.py,sha256=8gsOONf7mzY83O3DNjCBIafk7C7acnf7m
 insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C3clJqh4,8939
 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=7aYNoGgmV6SugHAQqeQYm1zo2LZm0vgXEGqHmYD7NCo,8260
-insightconnect_plugin_runtime/helper.py,sha256=XlMGpW2LQYo5KjhJeJtaYRCEDDWjrA9ZW1jP9FDpKpE,31155
+insightconnect_plugin_runtime/exceptions.py,sha256=Pvcdkx81o6qC2qU661x-DzNjuIMP82x52nPMSEqEo4s,8491
+insightconnect_plugin_runtime/helper.py,sha256=kXUt_yq6-9_wMdCIkS1fC3dddE8uwH9tcRITXvrJHIM,31178
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
-insightconnect_plugin_runtime/plugin.py,sha256=s2YVyygPcNeXeDi3X_JmaCiLHXZWIqz4mlLJy6p7-UA,24904
+insightconnect_plugin_runtime/plugin.py,sha256=l09-NxNPIfjSyklO4Jnbwf5yHQdobkcs29sjFV6N2ZE,24904
 insightconnect_plugin_runtime/schema.py,sha256=jTNc6KAMqFpaDVWrAYhkVC6e8I63P3X7uVlJkAr1hiY,583
 insightconnect_plugin_runtime/server.py,sha256=09fxsbKf2ZZvSqRP2Bv9e9-fspDyEFR8_YgIFeMnXqQ,12578
 insightconnect_plugin_runtime/step.py,sha256=KdERg-789-s99IEKN61DR08naz-YPxyinPT0C_T81C4,855
@@ -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=rqieWL71Eu0jIKrspizof4xSyp672xCQxbrQUYdpbbA,32560
+insightconnect_plugin_runtime/api/endpoints.py,sha256=xprYehTnO6TSpWcNXZ5iYOAgYk5-5UnxtgM9BDIYuRw,32792
 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=qKldWkyETmVhfoXbMZY58FFaDas6B5Uqc0D1LJROf6M,21658
@@ -67,8 +67,8 @@ tests/unit/test_api.py,sha256=uZ1dWMmgQ-ZePYjmcZfjc-qOTJsjs20Wic0Uf4U12-8,4441
 tests/unit/test_aws_action.py,sha256=eei4uPDx1Y8WcYgAWhiyqBYv5OOHGiZrCvajXC7RHdM,9597
 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=t8c67n3ZQPpyzzYPN6TZHpNeE8uKlOSfHJPk71QONuU,4668
-tests/unit/test_helpers.py,sha256=NaZBnVVsQuRb_0uxPjCyptEd5408Ok_AIPjhetGLPjk,16043
+tests/unit/test_exceptions.py,sha256=Y4F-ij8WkEJkUU3mPvxlEchqE9NCdxDvR8bJzPVVNao,5328
+tests/unit/test_helpers.py,sha256=_1jlU-h-GNY9MLQ8nV_or4zkTI911AmHKtvFyamKjfU,16297
 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
@@ -78,7 +78,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=VooVmfpIgxmglNdtmT32AkEDFxHxyRHLK8RsCWjjYRY,2153
-insightconnect_plugin_runtime-5.5.5.dist-info/METADATA,sha256=r5fE44VH3fBDRvvbWrg4XzwK5fA4zz8zCwRLI2DVWU4,13843
-insightconnect_plugin_runtime-5.5.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-insightconnect_plugin_runtime-5.5.5.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.5.5.dist-info/RECORD,,
+insightconnect_plugin_runtime-5.6.1.dist-info/METADATA,sha256=Ytd-U6ssnfYqZdQ-KKlMfTjDi6fPOFsPGGHcULACkLg,14106
+insightconnect_plugin_runtime-5.6.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+insightconnect_plugin_runtime-5.6.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-5.6.1.dist-info/RECORD,,

{insightconnect_plugin_runtime-5.5.5.dist-info → insightconnect_plugin_runtime-5.6.1.dist-info}/WHEEL

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

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

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(
         [