insightconnect-plugin-runtime 5.4.2__py3-none-any.whl → 5.4.4__py3-none-any.whl

insightconnect_plugin_runtime/plugin.py

@@ -18,7 +18,7 @@ from insightconnect_plugin_runtime.exceptions import (
     PluginException,
 )
 from insightconnect_plugin_runtime.metrics import MetricsBuilder
-from insightconnect_plugin_runtime.util import is_running_in_cloud
+from insightconnect_plugin_runtime.util import is_running_in_cloud, flush_logging_handlers
 
 message_output_type = {
     "action_start": "action_event",
@@ -374,8 +374,12 @@ class Plugin(object):
         log_stream = io.StringIO()
         stream_handler = logging.StreamHandler(log_stream)
         stream_handler.setLevel(logging.DEBUG if is_debug else logging.INFO)
-        logging.getLogger("plugin").addHandler(stream_handler)
-        logger = structlog.get_logger("plugin")
+
+        # Getting logger instances, struct_logger is formatted and mainly used in actions, triggers, and tasks
+        # while plugin_logger is the same instance that is used to add/remove and flush handlers during step execution
+        struct_logger = structlog.get_logger("plugin")
+        plugin_logger = logging.getLogger("plugin")
+        plugin_logger.addHandler(stream_handler)
 
         success = True
         caught_exception = None
@@ -409,7 +413,7 @@ class Plugin(object):
                 output = self.start_step(
                     input_message["body"],
                     "action",
-                    logger,
+                    struct_logger,
                     log_stream,
                     is_test,
                     is_debug,
@@ -419,7 +423,7 @@ class Plugin(object):
                 output = self.start_step(
                     input_message["body"],
                     "trigger",
-                    logger,
+                    struct_logger,
                     log_stream,
                     is_test,
                     is_debug,
@@ -431,7 +435,7 @@ class Plugin(object):
                     output = self.start_step(
                         input_message["body"],
                         "task",
-                        logger,
+                        struct_logger,
                         log_stream,
                         is_test,
                         is_debug,
@@ -440,7 +444,7 @@ class Plugin(object):
                     output, state, has_more_pages, status_code, error_object = self.start_step(
                         input_message["body"],
                         "task",
-                        logger,
+                        struct_logger,
                         log_stream,
                         is_test,
                         is_debug,
@@ -450,7 +454,7 @@ class Plugin(object):
                 output = self.start_step(
                     input_message["body"],
                     "connection_test",
-                    logger,
+                    struct_logger,
                     log_stream,
                     is_test,
                     is_debug,
@@ -459,7 +463,7 @@ class Plugin(object):
         except (ClientException, ServerException, PluginException, Exception) as e:
             success = False
             caught_exception = e
-            logger.exception(e)
+            struct_logger.exception(e)
         finally:
             output = self.envelope(
                 out_type,
@@ -475,6 +479,11 @@ class Plugin(object):
                 caught_exception,
                 is_test,
             )
+
+            # Flush all the handlers and remove the one that was previously created
+            flush_logging_handlers(plugin_logger)
+            plugin_logger.removeHandler(stream_handler)
+
             if not success:
                 raise LoggedException(caught_exception, output)
             return output
@@ -497,6 +506,7 @@ class Plugin(object):
         :param log_stream the raw stream for the log
         :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
         :return: An action_event message
         """
         connection = self.connection_cache.get(message_body["connection"], logger)

insightconnect_plugin_runtime/server.py

@@ -14,7 +14,7 @@ from gunicorn.arbiter import Arbiter
 import structlog
 from pythonjsonlogger.jsonlogger import JsonFormatter
 from requests import get as request_get
-from requests.exceptions import HTTPError, MissingSchema, Timeout, JSONDecodeError
+from requests.exceptions import HTTPError, MissingSchema, Timeout, JSONDecodeError, ConnectionError
 from time import sleep
 from werkzeug.utils import secure_filename
 
@@ -194,7 +194,7 @@ class PluginServer(gunicorn.app.base.BaseApplication):
 
                     self.config_options = plugin_config
                     self.logger.info("Plugin configuration successfully retrieved...")
-                    break
+                    return
                 except MissingSchema as missing_schema:
                     self.logger.error(f"Invalid URL being requested: {CPS_ENDPOINT}, error={missing_schema}")
                 except Timeout as timeout:
@@ -203,9 +203,14 @@ class PluginServer(gunicorn.app.base.BaseApplication):
                     self.logger.error(f"Connection error when trying to reach CPS. CPS={CPS_ENDPOINT}, error={http_error}")
                 except JSONDecodeError as bad_json:
                     self.logger.error(f"Got bad JSON back. Response content={request_response.content}, error={bad_json}")
+                except ConnectionError as http_connection_pool_error:
+                    self.logger.info(
+                        "Connection refused when trying to reach CPS, retrying as the connection is still establishing."
+                    )
                 except Exception as error:
                     self.logger.error(f"Hit an unexpected error when retrieving plugin custom configs, error={error}")
                 sleep(RETRY_SLEEP)
+            self.logger.error(f"Unable to reach CPS after {CPS_RETRY} attempts. CPS={CPS_ENDPOINT}")
 
     def register_api_spec(self):
         """Register all swagger schema definitions and path objects"""

insightconnect_plugin_runtime/util.py

@@ -139,6 +139,21 @@ class OutputMasker:
         return masked_response
 
 
+def flush_logging_handlers(logger: logging.Logger) -> None:
+    """
+    Flush all the logging handlers attached to the logger.
+
+    :param logger: The logger object to flush the handlers for.
+    :type: logging.Logger
+
+    :return: None
+    :rtype: None
+    """
+
+    for handler in logger.handlers:
+        handler.flush()
+
+
 def default_for_object(obj, defs):
     defaults = {}
 

{insightconnect_plugin_runtime-5.4.2.dist-info → insightconnect_plugin_runtime-5.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.4.2
+Version: 5.4.4
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -14,14 +14,14 @@ Classifier: Topic :: Software Development :: Build Tools
 Description-Content-Type: text/markdown
 Requires-Dist: requests ==2.31.0
 Requires-Dist: python-jsonschema-objects ==0.5.2
-Requires-Dist: jsonschema ==4.21.0
-Requires-Dist: certifi ==2023.11.17
-Requires-Dist: Flask ==3.0.0
+Requires-Dist: jsonschema ==4.21.1
+Requires-Dist: certifi ==2024.2.2
+Requires-Dist: Flask ==3.0.2
 Requires-Dist: gunicorn ==21.2.0
 Requires-Dist: greenlet ==3.0.3
-Requires-Dist: gevent ==23.9.1
-Requires-Dist: marshmallow ==3.20.2
-Requires-Dist: apispec ==6.4.0
+Requires-Dist: gevent ==24.2.1
+Requires-Dist: marshmallow ==3.21.0
+Requires-Dist: apispec ==6.5.0
 Requires-Dist: apispec-webframeworks ==1.0.0
 Requires-Dist: blinker ==1.7.0
 Requires-Dist: structlog ==24.1.0
@@ -211,7 +211,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
-
+* 5.4.4 - Handling the 'Connection Refused' to cps (during startup) as an info instead of error log as this is an expected error.
+* 5.4.3 - Updated dependencies to the latest versions | Fixed issue related to logger `StreamHandlers`
 * 5.4.2 - Remove background scheduler to simplify when the server gets custom_config values | Revert to use `bullseye` for slim image.
 * 5.4.1 - Retry logic added to get values from external API for custom_config values.
 * 5.4.0 - Implementation of custom_config parameter for plugin tasks | Alpine image updated OpenSSL and expat | Use `bookworm` for slim image.

{insightconnect_plugin_runtime-5.4.2.dist-info → insightconnect_plugin_runtime-5.4.4.dist-info}/RECORD

@@ -6,13 +6,13 @@ insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf
 insightconnect_plugin_runtime/exceptions.py,sha256=rC74M9aCSrY7J-nq9ttsccLkNbHR0gbZ2SRvXlCgLx0,6507
 insightconnect_plugin_runtime/helper.py,sha256=m5PxN04-NPXM1X10S2wwjqmiLvnNntd6TnwLoW4nnus,21108
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
-insightconnect_plugin_runtime/plugin.py,sha256=A6GMrYTNFpyCeEP00jRbp89Xu6KdQFq0HOVWV2AxA6Q,22969
+insightconnect_plugin_runtime/plugin.py,sha256=0IcyhAxklL8lMX7qRXBJ0V6rCt56b5VyrqBG3RAOatU,23573
 insightconnect_plugin_runtime/schema.py,sha256=jTNc6KAMqFpaDVWrAYhkVC6e8I63P3X7uVlJkAr1hiY,583
-insightconnect_plugin_runtime/server.py,sha256=vm0fJcnaI9Z3WYB37wUFkOjcym_kMlSm3lAyFP3ARiM,11771
+insightconnect_plugin_runtime/server.py,sha256=Qf2LF4_6VDRK55xzNXpd5znwe78gA26wOWbvlmvp4Ro,12141
 insightconnect_plugin_runtime/step.py,sha256=KdERg-789-s99IEKN61DR08naz-YPxyinPT0C_T81C4,855
 insightconnect_plugin_runtime/task.py,sha256=d-H1EAzVnmSdDEJtXyIK5JySprxpF9cetVoFGtWlHrg,123
 insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2sdy_qbedUY8,874
-insightconnect_plugin_runtime/util.py,sha256=lE6UVOYyzY9Ldyqpf91V24CvvdKjUu3WjGOSy957Sm0,8073
+insightconnect_plugin_runtime/util.py,sha256=msLDZrVDNaOY_lnkZghZk-GKsKpJHOpxz5iYIE8DnQ8,8398
 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=HjiGmYlg8T7_Q_2JHiywMWnE3_mrLfnmbLSj9zFwoSE,31445
@@ -23,7 +23,7 @@ insightconnect_plugin_runtime/clients/oauth.py,sha256=bWtAGRMwdK4dw9vMPcw9usklyI
 insightconnect_plugin_runtime/data/input_message_schema.json,sha256=7_BcHi6UOBiVWGrrJHHn5IoddteXjL7GOKETdO9T2DE,1770
 insightconnect_plugin_runtime/data/output_message_schema.json,sha256=Qya6U-NR5MfOlw4V98VpQzGBVq75eGMUQhI-j3yxOHI,1137
 tests/__init__.py,sha256=uKG3ssG-d51oNHQxKheE9Wzcusd7OW3ei6EYT3WxPnw,106
-tests/plugin/__init__.py,sha256=ZTPmMxZoDAHcbFqyIQVFkeifTfun5f5r_hffPP17Y2w,2713
+tests/plugin/__init__.py,sha256=Qw_OZORrBIvkyyV04gocNa5BUgVrvt8XmXM3_iIzyD0,2712
 tests/plugin/hello_world/__init__.py,sha256=fzr7Uek0yDCKBchW3fgtv1IAp8JIlW335GwENk4-wPk,42
 tests/plugin/hello_world/hello_world/__init__.py,sha256=lJWXmKWkacbMKKfq-vXx2iTlNfJtmq-jVhOlRfUWn2w,1110
 tests/plugin/hello_world/hello_world/setup.py,sha256=-NAHjSoYB-qU4fZrs_0nHzN7OxkSJ7OHUvQE8SXA6eg,467
@@ -73,12 +73,12 @@ tests/unit/test_metrics.py,sha256=PjjTrB9w7uQ2Q5UN-893-SsH3EGJuBseOMHSD1I004s,79
 tests/unit/test_oauth.py,sha256=nbFG0JH1x04ExXqSe-b5BGdt_hJs7DP17eUa6bQzcYI,2093
 tests/unit/test_plugin.py,sha256=ZTNAZWwZhDIAbxkVuWhnz9FzmojbijgMmsLWM2mXQI0,4160
 tests/unit/test_schema.py,sha256=swWZPRo_Q4M6VHte-srmxcV2wH-XS7pgmNRxpaL0Qrg,642
-tests/unit/test_server_cloud_plugins.py,sha256=GvJCOgpaxw3jOz_ABCkui_Ymai0kAZK1MqR0ldERnhw,4544
+tests/unit/test_server_cloud_plugins.py,sha256=PuMDHTz3af6lR9QK1BtPScr7_cRbWhetowADieVlXdo,5096
 tests/unit/test_server_spec.py,sha256=je97BaktgK0Fiz3AwFPkcmHzYtOJJNqJV_Fw5hrvqX4,644
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
-tests/unit/utils.py,sha256=-GB3nz4YJ2nMm0AR7Fm4lCNJMHCWOmLtNI1N4b9hRdo,470
-insightconnect_plugin_runtime-5.4.2.dist-info/METADATA,sha256=8h98fhwRRCE9c7y4U6-96Qw7ci0h89KqvnrS2r-XPg0,12472
-insightconnect_plugin_runtime-5.4.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-insightconnect_plugin_runtime-5.4.2.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.4.2.dist-info/RECORD,,
+tests/unit/utils.py,sha256=g_phxLH96rNwsdrry8Y7SjT9oZCps7ussI-ofc9K_xw,478
+insightconnect_plugin_runtime-5.4.4.dist-info/METADATA,sha256=BpiS7DqRutG4tJTDJcr7y9LvoxJl597-4yFswMpo2b4,12702
+insightconnect_plugin_runtime-5.4.4.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+insightconnect_plugin_runtime-5.4.4.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-5.4.4.dist-info/RECORD,,

tests/plugin/__init__.py

@@ -46,7 +46,6 @@ def run_action(input_file, output_file, handler, expect_fail=False):
 
 
 def run_trigger(input_file, output_file, plugin, expect_timeout=False):
-
     input_message = json.load(open(input_file))
     expected_output = json.load(open(output_file))
 

tests/unit/test_server_cloud_plugins.py

@@ -1,4 +1,4 @@
-from requests.exceptions import HTTPError, Timeout, TooManyRedirects
+from requests.exceptions import HTTPError, Timeout, TooManyRedirects, ConnectionError
 from parameterized import parameterized
 from unittest import TestCase, skip
 from unittest.mock import patch, MagicMock
@@ -46,11 +46,22 @@ class TestServerCloudPlugins(TestCase):
 
         self.plugin.tasks = None  # reset tasks value
 
-    @parameterized.expand([["error", HTTPError], ["error", Timeout], ["unexpected", TooManyRedirects]])
+    @parameterized.expand(
+        [
+            ["error", HTTPError],
+            ["error", Timeout],
+            ["unexpected", TooManyRedirects],
+            ["Connection refused", ConnectionError],
+        ]
+    )
     @patch("insightconnect_plugin_runtime.server.request_get")
     @patch("structlog.get_logger")
-    @patch("insightconnect_plugin_runtime.server.CPS_RETRY", new=2)  # reduce retries in unit tests
-    @patch("insightconnect_plugin_runtime.server.RETRY_SLEEP", new=1)  # reduce sleep in unit tests
+    @patch(
+        "insightconnect_plugin_runtime.server.CPS_RETRY", new=2
+    )  # reduce retries in unit tests
+    @patch(
+        "insightconnect_plugin_runtime.server.RETRY_SLEEP", new=1
+    )  # reduce sleep in unit tests
     def test_cps_raises_an_error(self, test_cond, exception, log, mocked_req, _mock_cloud, _run):
         log.return_value = Logger()
         # If we have successfully got config and scheduler options, and later this call fails we should keep values
@@ -63,11 +74,18 @@ class TestServerCloudPlugins(TestCase):
 
         self.assertDictEqual(plugin_server.config_options, PLUGIN_VALUE_2)
 
-        # First call has happened and now successful - force to hit specific handled and unexpected errors.
-        mocked_req.side_effect = exception("Warning HTTP error returned...")
-        plugin_server.get_plugin_properties_from_cps()
-        # we log error in all and `unexpected` in TooManyRedirects as there is no direct catch for this
-        self.assertIn(test_cond, plugin_server.logger.last_error)
+        if test_cond == "Connection refused":
+            mocked_req.side_effect = ConnectionError("Connection Refused")
+            plugin_server.get_plugin_properties_from_cps()
+            # we log error as info log, as this is likely to be hit when the pod is just starting up
+            self.assertIn(test_cond, plugin_server.logger.last_info[-1])
+
+        else:
+            # First call has happened and now successful - force to hit specific handled and unexpected errors.
+            mocked_req.side_effect = exception("Warning HTTP error returned...")
+            plugin_server.get_plugin_properties_from_cps()
+            # we log error in all and `unexpected` in TooManyRedirects as there is no direct catch for this
+            self.assertIn(test_cond, plugin_server.logger.last_error[-2])
 
         # Values should not have changed
         self.assertDictEqual(plugin_server.config_options, PLUGIN_VALUE_2)

tests/unit/utils.py

@@ -10,11 +10,11 @@ class MockResponse:
 class Logger:
     """Mocked logger to easily find last log triggered from SDK server."""
     def __init__(self):
-        self.last_error = None
-        self.last_info = None
+        self.last_error = []
+        self.last_info = []
 
     def info(self, log: str):
-        self.last_info = log
+        self.last_info.append(log)
 
     def error(self, log: str):
-        self.last_error = log
+        self.last_error.append(log)