insightconnect-plugin-runtime 5.5.1__py3-none-any.whl → 5.5.3__py3-none-any.whl

insightconnect_plugin_runtime/api/endpoints.py

@@ -634,14 +634,19 @@ class Endpoints:
             schema = conn.schema
             return jsonify(ConnectionDetailsSchema().dump(schema))
 
-        @v1.route("/connection/test", methods=["POST"])
-        def connection_test():
+        @v1.route("/connection/<string:connection_test_type>", methods=["POST"])
+        def connection_test(connection_test_type: str):
             """
             Run connection test endpoint
             ---
             post:
               summary: Run connection test
               description: Run InsightConnect plugin connection test
+              parameters:
+                - in: path
+                  name: connection_test_type
+                  description: Type of connection test to be run
+                  type: string
               responses:
                 200:
                   description: Connection test output to be returned
@@ -658,12 +663,26 @@ class Endpoints:
             status_code = 200
             output = None
 
+            supported_tests = ["test", "test_task"]
+            if connection_test_type not in supported_tests:
+                return make_response(
+                    jsonify(
+                        {
+                            "error": f"The requested endpoint is not available, only {supported_tests} are supported.",
+                            "code": 404,
+                            "method": "POST",
+                            "name": "Not Found"
+                        }
+                    ),
+                    404,
+                )
+
             input_message = request.get_json(force=True)
             Endpoints.validate_action_trigger_task_empty_input(input_message)
 
             try:
                 output = self.plugin.handle_step(
-                    input_message, is_debug=self.debug, is_test=True
+                    input_message, is_debug=self.debug, is_test=True, connection_test_type=connection_test_type
                 )
                 if output.get("body", {}).get("output") is None:
                     status_code = 204

insightconnect_plugin_runtime/helper.py

@@ -31,11 +31,11 @@ ENCODE_TYPE = "utf-8"
 DEFAULTS_HOURS_AGO = 24
 
 
-def hash_sha1(log: dict) -> str:
+def hash_sha1(log: Dict) -> str:
     """
     Iterate through a dictionary and hash each value.
     :param log: Dictionary to be hashed.
-    :type dict:
+    :type Dict:
     :return: Hex digest of hash.
     :rtype: str
     """
@@ -80,8 +80,8 @@ def make_request(
     allow_redirects: bool = True,
     exception_custom_configs: Dict[int, Exception]={},
     exception_data_location: str = None,
-    allowed_status_codes: list[str] = [],
-) -> Tuple[requests.Response, dict]:
+    allowed_status_codes: List[str] = [],
+) -> Tuple[requests.Response, Dict]:
     """
     Makes a HTTP request while checking for RequestErrors and JSONDecodeErrors
     Returns the request response and the response JSON if required.
@@ -92,7 +92,7 @@ def make_request(
     :param verify: Whether to verify the server's TLS certificate
     :type bool:
     :param cert: Certificate to include with request, str location or key/value pair
-    :type Union[str, dict]:
+    :type Union[str, Dict]:
     :param stream: Whether to immediately download the response content
     :type bool:
     :param allow_redirects: Set to true by default
@@ -102,10 +102,10 @@ def make_request(
     :param exception_data_location: Where the returned data should be retrieved. Can provide ResponseExceptionData values.
     :type str:
     :param allowed_status_codes: Status codes that will not raise an exception.
-    :type list[str]:
+    :type List[str]:
 
     :return: The request response and the response JSON.
-    :rtype: Tuple[Response, dict]
+    :rtype: Tuple[Response, Dict]
     """
     try:
         with requests.Session() as session:
@@ -139,7 +139,7 @@ def make_request(
     return response
 
 
-def extract_json(response: requests.Response) -> dict:
+def extract_json(response: requests.Response) -> Dict:
     """Extract JSON from a request object while error handling a JSONDecodeError.
     :param response: Response object ot utilize in extract
     :type Response:
@@ -197,7 +197,7 @@ def response_handler(
     response: requests.Response,
     custom_configs: Dict[int, Exception]={},
     data_location: str = None,
-    allowed_status_codes: list[str] = [],
+    allowed_status_codes: List[str] = [],
 ) -> None:
     """
     Check response status codes and return a generic PluginException preset if a HTTPError is raised.
@@ -210,7 +210,7 @@ def response_handler(
     :param data_location: Where the returned data should be retrieved. Can provide ResponseExceptionData values.
     :type str:
     :param allowed_status_codes: Status codes that will not raise an exception.
-    :type list[str]:
+    :type List[str]:
 
     :return: None.
     :rtype: None

insightconnect_plugin_runtime/plugin.py

@@ -362,7 +362,7 @@ class Plugin(object):
         if "input" not in body:
             body["input"] = {}
 
-    def handle_step(self, input_message, is_test=False, is_debug=False):
+    def handle_step(self, input_message, is_test=False, is_debug=False, connection_test_type="test"):
         """
         Executes a single step, given the input message dictionary.
 
@@ -427,6 +427,7 @@ class Plugin(object):
                     log_stream,
                     is_test,
                     is_debug,
+                    connection_test_type=connection_test_type
                 )
             elif message_type == "trigger_start":
                 out_type = "trigger_event"
@@ -437,6 +438,7 @@ class Plugin(object):
                     log_stream,
                     is_test,
                     is_debug,
+                    connection_test_type=connection_test_type
                 )
             elif message_type == "task_start":
                 out_type = "task_event"
@@ -449,6 +451,7 @@ class Plugin(object):
                         log_stream,
                         is_test,
                         is_debug,
+                        connection_test_type=connection_test_type
                     )
                 else:
                     (
@@ -464,6 +467,7 @@ class Plugin(object):
                         log_stream,
                         is_test,
                         is_debug,
+                        connection_test_type=connection_test_type
                     )
             elif message_type == "connection_test":
                 out_type = "connection_test"
@@ -475,6 +479,7 @@ class Plugin(object):
                     is_test,
                     is_debug,
                     is_connection_test=True,
+                    connection_test_type=connection_test_type
                 )
         except (ClientException, ServerException, PluginException, Exception) as e:
             success = False
@@ -513,6 +518,7 @@ class Plugin(object):
         is_test=False,
         is_debug=False,
         is_connection_test=False,
+        connection_test_type="test"
     ):
         """
         Starts an action.
@@ -523,6 +529,7 @@ class Plugin(object):
         :param is_test: True if the action's test method should execute
         :param is_debug: True if debug is enabled
         :param is_connection_test: True if connection test is running
+        :param connection_test_type: The type of connection test to be run
         :return: An action_event message
         """
         connection = self.connection_cache.get(message_body["connection"], logger)
@@ -534,7 +541,9 @@ class Plugin(object):
                     plugin_version=connection.meta.version,
                 )
             )
-            if hasattr(connection, "test"):
+            if hasattr(connection, "test_task") and connection_test_type == "test_task":
+                func = connection.test_task
+            elif hasattr(connection, "test"):
                 func = connection.test
             else:
                 raise NotImplementedError(
@@ -617,7 +626,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"):
-                    func = step.connection.test
+                    if hasattr(step.connection, "test") and connection_test_type == "test_task":
+                        func = step.connection.task_test
+                    else:
+                        func = step.connection.test
                 else:
                     func = step.test
             else:

{insightconnect_plugin_runtime-5.5.1.dist-info → insightconnect_plugin_runtime-5.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.5.1
+Version: 5.5.3
 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.5.3 - Adding in a new endpoint that can be called to run a task connection test
+* 5.5.2 - Address bug with typing for type `List` in Python 3.8
 * 5.5.1 - Address bug with typing for type `Tuple` in Python 3.8
 * 5.5.0 - Updated helper class to add `make_request`, `response_handler`, `extract_json`, and `request_error_handling` for HTTP requests, and `hash_sha1` and `compare_and_dedupe_hashes` to provide support for hash comparisons | Add `METHOD_NOT_ALLOWED`, `CONFLICT`, `REDIRECT_ERROR`, and `CONNECTION_ERROR` to PluginException presets
 * 5.4.9 - Updated aws_client to clean assume role json object to remove any none or empty string values.

{insightconnect_plugin_runtime-5.5.1.dist-info → insightconnect_plugin_runtime-5.5.3.dist-info}/RECORD

@@ -4,9 +4,9 @@ insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C
 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=EXPqe-2tG7Er_vOwEzQCPmGpBgauNbUIU0G_R-tWKgk,31155
+insightconnect_plugin_runtime/helper.py,sha256=XlMGpW2LQYo5KjhJeJtaYRCEDDWjrA9ZW1jP9FDpKpE,31155
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
-insightconnect_plugin_runtime/plugin.py,sha256=9k01QqEh78OTs0pMRfnwZcRr-vFe7iyAtLz_QBa23e4,24127
+insightconnect_plugin_runtime/plugin.py,sha256=s2YVyygPcNeXeDi3X_JmaCiLHXZWIqz4mlLJy6p7-UA,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=57pSoVSyZU6ERPZ6joMUf6eTDXVRCROLJkmtw4DJhUg,31720
+insightconnect_plugin_runtime/api/endpoints.py,sha256=rqieWL71Eu0jIKrspizof4xSyp672xCQxbrQUYdpbbA,32560
 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=p_s7YLYOeSrBnJl-1gStuNwse6nw4_sl7kz6AKThboY,20465
@@ -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.1.dist-info/METADATA,sha256=-BI5OWO_Kg7Im2iXx12G2otyOjy_Noob-MUAF4ZGjLg,13572
-insightconnect_plugin_runtime-5.5.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-insightconnect_plugin_runtime-5.5.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.5.1.dist-info/RECORD,,
+insightconnect_plugin_runtime-5.5.3.dist-info/METADATA,sha256=md4T9Yk6AkiGS9oQfd-kSxfL7QIoSqZedyp9abVmWL8,13720
+insightconnect_plugin_runtime-5.5.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+insightconnect_plugin_runtime-5.5.3.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-5.5.3.dist-info/RECORD,,