insightconnect-plugin-runtime 5.4.2__tar.gz → 5.4.4__tar.gz

{insightconnect-plugin-runtime-5.4.2/insightconnect_plugin_runtime.egg-info → insightconnect-plugin-runtime-5.4.4}/PKG-INFO

@@ -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 → insightconnect-plugin-runtime-5.4.4}/README.md

@@ -182,7 +182,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 → insightconnect-plugin-runtime-5.4.4}/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-5.4.2 → insightconnect-plugin-runtime-5.4.4}/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-5.4.2 → insightconnect-plugin-runtime-5.4.4}/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 → insightconnect-plugin-runtime-5.4.4/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -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 → insightconnect-plugin-runtime-5.4.4}/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -1,13 +1,13 @@
 requests==2.31.0
 python_jsonschema_objects==0.5.2
-jsonschema==4.21.0
-certifi==2023.11.17
-Flask==3.0.0
+jsonschema==4.21.1
+certifi==2024.2.2
+Flask==3.0.2
 gunicorn==21.2.0
 greenlet==3.0.3
-gevent==23.9.1
-marshmallow==3.20.2
-apispec==6.4.0
+gevent==24.2.1
+marshmallow==3.21.0
+apispec==6.5.0
 apispec-webframeworks==1.0.0
 blinker==1.7.0
 structlog==24.1.0

{insightconnect-plugin-runtime-5.4.2 → insightconnect-plugin-runtime-5.4.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="5.4.2",
+    version="5.4.4",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -16,14 +16,14 @@ setup(
     install_requires=[
         "requests==2.31.0",
         "python_jsonschema_objects==0.5.2",
-        "jsonschema==4.21.0",
-        "certifi==2023.11.17",
-        "Flask==3.0.0",
+        "jsonschema==4.21.1",
+        "certifi==2024.2.2",
+        "Flask==3.0.2",
         "gunicorn==21.2.0",
         "greenlet==3.0.3",
-        "gevent==23.9.1",
-        "marshmallow==3.20.2",
-        "apispec==6.4.0",
+        "gevent==24.2.1",
+        "marshmallow==3.21.0",
+        "apispec==6.5.0",
         "apispec-webframeworks==1.0.0",
         "blinker==1.7.0",
         "structlog==24.1.0",

{insightconnect-plugin-runtime-5.4.2 → insightconnect-plugin-runtime-5.4.4}/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))
 

{insightconnect-plugin-runtime-5.4.2 → insightconnect-plugin-runtime-5.4.4}/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)

{insightconnect-plugin-runtime-5.4.2 → insightconnect-plugin-runtime-5.4.4}/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)