insightconnect-plugin-runtime 5.6.0__tar.gz → 6.0.0__tar.gz

{insightconnect_plugin_runtime-5.6.0/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.6.0
+Version: 6.0.0
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -15,7 +15,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: requests==2.32.0
 Requires-Dist: python_jsonschema_objects==0.5.2
 Requires-Dist: jsonschema==4.21.1
-Requires-Dist: certifi==2024.2.2
+Requires-Dist: certifi==2024.07.04
 Requires-Dist: Flask==3.0.2
 Requires-Dist: gunicorn==22.0.0
 Requires-Dist: greenlet==3.0.3
@@ -211,6 +211,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.

{insightconnect_plugin_runtime-5.6.0 → insightconnect_plugin_runtime-6.0.0}/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
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.

{insightconnect_plugin_runtime-5.6.0 → insightconnect_plugin_runtime-6.0.0}/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.6.0 → insightconnect_plugin_runtime-6.0.0}/insightconnect_plugin_runtime/plugin.py

@@ -402,6 +402,9 @@ class Plugin(object):
         status_code = None
         error_object = None
 
+        # Properties specific to tasks tests
+        task_test_log = None
+
         try:
             # Attempt to grab message type first
             message_type = input_message.get("type")
@@ -444,7 +447,7 @@ class Plugin(object):
                 out_type = "task_event"
                 if is_test:
                     # state will not be returned by task's test method
-                    output = self.start_step(
+                    output, task_test_log = self.start_step(
                         input_message["body"],
                         "task",
                         struct_logger,
@@ -471,7 +474,7 @@ class Plugin(object):
                     )
             elif message_type == "connection_test":
                 out_type = "connection_test"
-                output = self.start_step(
+                output, task_test_log = self.start_step(
                     input_message["body"],
                     "connection_test",
                     struct_logger,
@@ -481,15 +484,28 @@ class Plugin(object):
                     is_connection_test=True,
                     connection_test_type=connection_test_type
                 )
-        except (ClientException, ServerException, PluginException, Exception) as e:
+        except (
+            ClientException,
+            ServerException,
+            PluginException,
+            ConnectionTestException,
+            Exception,
+        ) as error_message:
             success = False
-            caught_exception = e
-            struct_logger.exception(e)
+            caught_exception = error_message
+            struct_logger.exception(error_message)
+
+            # now returning the value of data instead of the log buffer for connection task tests - SOAR-16566
+            if isinstance(error_message, ConnectionTestException) and connection_test_type == "test_task":
+                task_test_log = f"{error_message.data}" if error_message.data else "Connection test failed"
         finally:
+            # if we are running a task connection test we want to return the pre-defined message
+            # rather than a stack trace of logs - SOAR-16566
+            log_message = task_test_log if task_test_log else log_stream.getvalue()
             output = self.envelope(
                 out_type,
                 input_message,
-                log_stream.getvalue(),
+                log_message,
                 success,
                 output,
                 str(caught_exception),
@@ -541,18 +557,25 @@ class Plugin(object):
                     plugin_version=connection.meta.version,
                 )
             )
+
+            # As the message type for both api/v1/connection/test and api/v1/connection/test_task calls are
+            # message_type == "connection_test", this means that both the task and normal connection test code
+            # hits this path and needs to have the same return structure, as a result we return None when
+            # connection.test is called, as there is no message returned along side it,
+            # and the code above then sees this and reads the "message" from the io buffer as normal
             if hasattr(connection, "test_task") and connection_test_type == "test_task":
                 func = connection.test_task
+                output, log = func()
+                return output, log
             elif hasattr(connection, "test"):
                 func = connection.test
+                output = func()
+                return output, None
             else:
                 raise NotImplementedError(
                     "The server successfully processed the request and is not "
                     "returning any content (no connection test function)"
                 )
-            output = func()
-
-            return output
 
         else:
             action_name = message_body[step_key]
@@ -626,8 +649,10 @@ class Plugin(object):
             if is_test:
                 # 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
+                    if hasattr(step.connection, "test_task") and connection_test_type == "test_task":
+                        func = step.connection.test_task
+                        output, log = func()
+                        return output, log
                     else:
                         func = step.connection.test
                 else:

{insightconnect_plugin_runtime-5.6.0 → insightconnect_plugin_runtime-6.0.0/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.6.0
+Version: 6.0.0
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -15,7 +15,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: requests==2.32.0
 Requires-Dist: python_jsonschema_objects==0.5.2
 Requires-Dist: jsonschema==4.21.1
-Requires-Dist: certifi==2024.2.2
+Requires-Dist: certifi==2024.07.04
 Requires-Dist: Flask==3.0.2
 Requires-Dist: gunicorn==22.0.0
 Requires-Dist: greenlet==3.0.3
@@ -211,6 +211,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 5.5.5 - Address bug with typing for type `Dict` in Python 3.8
 * 5.5.4 - Support pagination parameters within AWS client.

{insightconnect_plugin_runtime-5.6.0 → insightconnect_plugin_runtime-6.0.0}/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -1,7 +1,7 @@
 requests==2.32.0
 python_jsonschema_objects==0.5.2
 jsonschema==4.21.1
-certifi==2024.2.2
+certifi==2024.07.04
 Flask==3.0.2
 gunicorn==22.0.0
 greenlet==3.0.3

{insightconnect_plugin_runtime-5.6.0 → insightconnect_plugin_runtime-6.0.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="5.6.0",
+    version="6.0.0",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -17,7 +17,7 @@ setup(
         "requests==2.32.0",
         "python_jsonschema_objects==0.5.2",
         "jsonschema==4.21.1",
-        "certifi==2024.2.2",
+        "certifi==2024.07.04",
         "Flask==3.0.2",
         "gunicorn==22.0.0",
         "greenlet==3.0.3",