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

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.3.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.3
+Version: 5.4.4
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,7 +211,7 @@ 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.

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

@@ -8,7 +8,7 @@ insightconnect_plugin_runtime/helper.py,sha256=m5PxN04-NPXM1X10S2wwjqmiLvnNntd6T
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 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
@@ -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.3.dist-info/METADATA,sha256=94_KsoeJDJFV8lf6hbjmkBDB3qVglee4dPJ33KmO6Vs,12573
-insightconnect_plugin_runtime-5.4.3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-insightconnect_plugin_runtime-5.4.3.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.4.3.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/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)