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

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":
+                    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.1.dist-info → insightconnect_plugin_runtime-6.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.6.1
+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,7 @@ 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

{insightconnect_plugin_runtime-5.6.1.dist-info → insightconnect_plugin_runtime-6.0.0.dist-info}/RECORD

@@ -6,7 +6,7 @@ insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf
 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=l09-NxNPIfjSyklO4Jnbwf5yHQdobkcs29sjFV6N2ZE,24904
+insightconnect_plugin_runtime/plugin.py,sha256=Yf4LNczykDVc31F9G8uuJ9gxEsgmxmAr0n4pcZzichM,26393
 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
@@ -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.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-6.0.0.dist-info/METADATA,sha256=3J-ljqWInkzVD1XZ_ZO0ru_LnsqPMSmodrLr3FVg4_8,14311
+insightconnect_plugin_runtime-6.0.0.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+insightconnect_plugin_runtime-6.0.0.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.0.0.dist-info/RECORD,,

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

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