insightconnect-plugin-runtime 5.2.4__py3-none-any.whl → 5.3.1__py3-none-any.whl

insightconnect_plugin_runtime/api/endpoints.py

@@ -157,11 +157,13 @@ class Endpoints:
                 500:
                   description: Unexpected error
             """
+            self.logger.info("Plugin task beginning execution...")
             input_message = request.get_json(force=True)
             self.logger.debug("Request input: %s", input_message)
             Endpoints.validate_action_trigger_task_empty_input(input_message)
             Endpoints.validate_action_trigger_task_name(input_message, name, "task")
             output = self.run_action_trigger_task(input_message)
+            self.logger.info("Plugin task finished execution...")
             return output
 
         @legacy.route("/triggers/<string:name>/test", methods=["POST"])

insightconnect_plugin_runtime/exceptions.py

@@ -1,4 +1,8 @@
 # -*- coding: utf-8 -*-
+import structlog
+logger = structlog.get_logger("plugin")
+
+
 class ClientException(Exception):
     """
     An exception which marks an error made by the plugin invoker.
@@ -120,6 +124,12 @@ class ConnectionTestException(Exception):
 
         self.data = str(data) if data else ""
 
+        # Safeguard to ensure the exception is logged across all plugins even if the plugin
+        # itself does not call `self.logger.error(<error info>)`
+        params = ["cause", "assistance", "data", "preset"]
+        info_log = ", ".join([f"{atr}='{getattr(self, atr)}'" for atr in params if getattr(self, atr)])
+        logger.error(f"Plugin exception instantiated. {info_log}")
+
     def __str__(self):
         if self.data:
             return "Connection test failed!\n\n{cause} {assistance} Response was: {data}".format(

{insightconnect_plugin_runtime-5.2.4.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 5.2.4
+Version: 5.3.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -15,11 +15,11 @@ Description-Content-Type: text/markdown
 Requires-Dist: requests ==2.31.0
 Requires-Dist: python-jsonschema-objects ==0.3.12
 Requires-Dist: jsonschema ==3.2.0
-Requires-Dist: certifi ==2022.12.7
+Requires-Dist: certifi ==2023.7.22
 Requires-Dist: Flask ==2.3.2
 Requires-Dist: gunicorn ==20.0.4
-Requires-Dist: greenlet <=1.1.2,>=0.4.17
-Requires-Dist: gevent ==20.9.0
+Requires-Dist: greenlet ==3.0.1
+Requires-Dist: gevent ==23.9.1
 Requires-Dist: marshmallow ==3.4.0
 Requires-Dist: apispec ==3.2.0
 Requires-Dist: apispec-webframeworks ==0.5.2
@@ -48,10 +48,10 @@ to get started.
 
 ## Development of the InsightConnect Plugin Runtime
 
-The Python Runtime codebase is built to support Python 3.8+ as of version 4.0.0. The following dependencies will need 
+The Python Runtime codebase is built to support Python 3.9.18 as of version 5.3.0. The following dependencies will need 
 to be installed when developing or testing the Plugin Runtime:
 
-- Python 3.8
+- Python 3.9.18
 - Docker
 - make
 - tox
@@ -67,19 +67,51 @@ version and activate it. Then build, install, and confirm the package has been i
 > source venv/bin/activate
 > pip install -e ./
 > pip list | grep insightconnect-plugin-runtime
-insightconnect-plugin-runtime 4.0.0
+insightconnect-plugin-runtime 5.2.2
 ```
 
 #### Building the InsightConnect Plugin Runtime Docker Images
 
-Currently the `3-38` dockerfile is used by default when building the docker image. If you want to specify another 
-dockerfile for testing purposes, such as `3-38-slim`, you can pass it as an argument.
+Currently the `python-3` dockerfile is used by default when building the docker image. If you want to specify another
+dockerfile for testing purposes, such as `python-3-slim`, you can pass it as an argument.
 
 ```
-make build-image DOCKERFILE=3-38-slim
+make build-image DOCKERFILE=python-3-slim
 ```
 
-This will overwrite the default `3-38`, provided that it exists in the `dockerfiles` directory.
+This will overwrite the default `python-3`, provided that it exists in the `dockerfiles` directory.
+
+#### Building/troubleshooting local images (Mac M1)
+
+Our images are built with OS/ARCH:linux/amd64 due to our ci.yml file specifying linux. Historically this has
+not caused any issues but with an M1 Mac, docker will now use arm64. This is because docker builds the image to match the
+distribution of the OS running the command. To ensure that building locally and on GH produces an image of the same 
+architecture the `--platform` specifier is passed in the dockerfile.
+
+If you build a plugin locally we can see further issues that:
+- the local image does match the current OS distro so docker continues to look remotely..
+- docker can not find this (newly created) image remotely on docker registry (dev images should not be pushed to registry)
+
+To overcome this we need to specify `platform=linux/amd64` in the plugin docker file. E.g. if building plugins/html then
+this file should be updated `plugins/html/Dockerfile`.
+*Note*: building this arch on mac M1 will cause the build to be slower.
+
+
+Example error of local image not matching OS distro without passing the `--platform` flag:
+```
+ => ERROR [internal] load metadata for docker.io/rapid7/insightconnect-python-3-slim-plugin:latest                          1.4s
+------
+ > [internal] load metadata for docker.io/rapid7/insightconnect-python-3-slim-plugin:latest:
+------
+Dockerfile:1
+--------------------
+   1 | >>> FROM rapid7/insightconnect-python-3-slim-plugin
+   2 |     LABEL organization=rapid7
+   3 |     LABEL sdk=python
+--------------------
+ERROR: failed to solve: rapid7/insightconnect-python-3-slim-plugin: pull access denied, repository does not exist or may require authorization: server message: insufficient_scope: authorization failed
+make: *** [image] Error 1
+```
 
 ### Testing Sample Plugin
 The easiest way to test changes to the runtime is by running it locally against one of the [sample plugins](./samples) 
@@ -145,9 +177,21 @@ Running all tests:
 
 Running a specific test file:
 ```
-> tox -e py38 -- tests/plugin/hello_world/tests/test_cli.py
+> tox -e py39 -- tests/plugin/hello_world/tests/test_cli.py
 ```
 
+## Plugin vs Slim Plugin Comparison
+
+|                   | Plugin  | Slim Plugin |
+|:------------------|:-------:|:-----------:|
+| Python Version    | 3.9.18  |   3.9.18    |
+| OS                | Alpine  |  Bullseye   |
+| Package installer |   apk   |     apt     |
+| Shell             | /bin/sh |  /bin/bash  |
+| Image Size        | ~350MB  |   ~180MB    |
+
+Note that for the plugin image, we run `apk update` and `apk add ..` which leads to a longer build time.
+
 ## Release
 
 To release a new version of the InsightConnect Python Plugin Runtime, the below steps must be followed:
@@ -168,6 +212,8 @@ after cloning this repository.
 
 ## Changelog
 
+* 5.3.1 - New logging added to the beginning and end of a task | New logging when an exception is instantiated.
+* 5.3.0 - Update base images to pull Python 3.9.18 | python packages bump | rename image to drop python minor version.
 * 5.2.4 - Extended logging with OrgID and IntID
 * 5.2.3 - Extended logging in AWSClient
 * 5.2.2 - Fix longstanding bug where some error responses from a plugin could be in HTML format instead of JSON 

{insightconnect_plugin_runtime-5.2.4.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ insightconnect_plugin_runtime/action.py,sha256=8gsOONf7mzY83O3DNjCBIafk7C7acnf7m
 insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C3clJqh4,8939
 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=YEbm63_s6J6978Elsfz2mavoSaxdtPVkHPC6WYNDTBI,6060
+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=YEwxPHyIYsQcGAZYQZqh60POQOzbrtsZAcA5TcBmy8g,22708
@@ -15,7 +15,7 @@ insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2
 insightconnect_plugin_runtime/util.py,sha256=lE6UVOYyzY9Ldyqpf91V24CvvdKjUu3WjGOSy957Sm0,8073
 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=BjLr9YNM9J5cHXWfpD49JvBSB93jr-EChXxmXHhFVig,28966
+insightconnect_plugin_runtime/api/endpoints.py,sha256=jjKTFArNIOJkZw-L0QU_1yzRcKC6xyAC8ge86M6fQjQ,29099
 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=3Ytx-uchkl7dTcwYKZPKvCJaWralEqZUZeireOCWlPo,20290
@@ -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=oZCsCJtYxak9TF8ATlV2ee5JklIJr87WITkvC69GTqM,2430
+tests/plugin/__init__.py,sha256=ZTPmMxZoDAHcbFqyIQVFkeifTfun5f5r_hffPP17Y2w,2713
 tests/plugin/hello_world/__init__.py,sha256=fzr7Uek0yDCKBchW3fgtv1IAp8JIlW335GwENk4-wPk,42
 tests/plugin/hello_world/hello_world/__init__.py,sha256=rJm2tr4rZ2uR9AfjMyoQRntFM0JOf2SpHCfO7uWho2g,1018
 tests/plugin/hello_world/hello_world/setup.py,sha256=-NAHjSoYB-qU4fZrs_0nHzN7OxkSJ7OHUvQE8SXA6eg,467
@@ -44,13 +44,13 @@ tests/plugin/hello_world/hello_world/komand_hello_world/connection/schema.py,sha
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/__init__.py,sha256=6gwJkxwZLglGm_nIhMo96z5uM2ENAIHYxpJneuEDRrU,221
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/hello_trigger/__init__.py,sha256=b8c55qKjWULUk5uhTvzSs246lm8VQxw0h4nvTyYqWuA,74
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/hello_trigger/schema.py,sha256=NGOXa58BprKTZjyF4BNGPPnRnGnAqwVnZYNiIWElDZg,944
-tests/plugin/hello_world/hello_world/komand_hello_world/triggers/hello_trigger/trigger.py,sha256=P4f95CO_45zn2Bx5AuhPu_xca1Az9w-3x6FHO9gXe74,793
+tests/plugin/hello_world/hello_world/komand_hello_world/triggers/hello_trigger/trigger.py,sha256=PYPY8aW1h6mvQf61sE3ngopXm5SCOeRyhSm7-I1-Hr0,1148
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/return_bad_json_trigger/__init__.py,sha256=PxfCcfOn24CwtojXbyI8qYTGhfv49kZMR5P30UdJhdg,82
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/return_bad_json_trigger/schema.py,sha256=7M5gAmMzj_DWSZ982yu-J8yL6mjlCPld1nmNkx30_UE,960
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/return_bad_json_trigger/trigger.py,sha256=1amZOxQiWaSdUwGjN-siTVSZw71ouUX4Xlp73Gh17yc,717
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/throw_exception_trigger/__init__.py,sha256=gwdLBOIougxWEhHEQkOueHlWv0Ocq0EjzlfqwcfLucA,83
 tests/plugin/hello_world/hello_world/komand_hello_world/triggers/throw_exception_trigger/schema.py,sha256=Y1FozH6fhm8apf_5yncc3mDT51Xqw_c-JzgB_x1sssU,962
-tests/plugin/hello_world/hello_world/komand_hello_world/triggers/throw_exception_trigger/trigger.py,sha256=BRBm3h6L2WGObYqb9W7P16DTrgFvPHl067w19OsXRwU,680
+tests/plugin/hello_world/hello_world/komand_hello_world/triggers/throw_exception_trigger/trigger.py,sha256=pydbyz09YdLzq_NrdvNW11Fhr53INn1NWa4TZ7L9DUw,696
 tests/plugin/hello_world/hello_world/komand_hello_world/util/__init__.py,sha256=RAUlyeHr0LBBRVgwatrSBl7iAaUmrw8Z6BAZlCby_vY,40
 tests/plugin/hello_world/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/plugin/hello_world/tests/conftest.py,sha256=fM3XJmVDHMeYZA__yjXVocgx7kwgr5FRwcWsY1XsV70,1046
@@ -71,7 +71,7 @@ tests/unit/test_schema.py,sha256=swWZPRo_Q4M6VHte-srmxcV2wH-XS7pgmNRxpaL0Qrg,642
 tests/unit/test_server_spec.py,sha256=7hmXdsY36nP0ENhijrolBInAMJwht2-Z-D6yhcg_zZI,578
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
-insightconnect_plugin_runtime-5.2.4.dist-info/METADATA,sha256=DDsZqrWzHfulFn90APOnV1Ng09hsyjGKkk1Uo-ceqZE,9579
-insightconnect_plugin_runtime-5.2.4.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-insightconnect_plugin_runtime-5.2.4.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-5.2.4.dist-info/RECORD,,
+insightconnect_plugin_runtime-5.3.1.dist-info/METADATA,sha256=nNNrHZvzCIPzoz3isVDx8T05UKQckWjbQOzz6Wp03mY,12026
+insightconnect_plugin_runtime-5.3.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+insightconnect_plugin_runtime-5.3.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-5.3.1.dist-info/RECORD,,

{insightconnect_plugin_runtime-5.2.4.dist-info → insightconnect_plugin_runtime-5.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tests/plugin/__init__.py

@@ -55,10 +55,16 @@ def run_trigger(input_file, output_file, plugin, expect_timeout=False):
     plugin.triggers[trigger_name].dispatcher = capture
 
     executor = thread.ThreadPoolExecutor()
-    executor.submit(plugin.handle_step, input_message)
-    future = executor.submit(capture.wait_for_caught_message)
-    out = futures.wait([future], timeout=10)
-    done = out.done
+
+    if expect_timeout:
+        future = executor.submit(plugin.handle_step, input_message)
+        future_ans = future.exception()
+        done = future_ans.output
+    else:
+        executor.submit(plugin.handle_step, input_message)
+        future = executor.submit(capture.wait_for_caught_message)
+        out = futures.wait([future], timeout=10)
+        done = out.done
 
     # Non-graceful shutdown
     executor._threads.clear()
@@ -69,7 +75,8 @@ def run_trigger(input_file, output_file, plugin, expect_timeout=False):
             return
         raise Exception("Timeout")
 
-    output = capture.caught_message
+    # output = capture.caught_message
+    output = done if expect_timeout else capture.caught_message
 
     if "body" in output and "log" in output["body"]:
         output["body"]["log"] = ""
@@ -79,7 +86,7 @@ def run_trigger(input_file, output_file, plugin, expect_timeout=False):
 
     if output != expected_output:
         raise Exception(
-            "Actual output differs from expected output.{} != {}".format(
-                output, expected_output
-            )
+            f"Actual output differs from expected output/ \n"
+            f"Actual output: {output} \n"
+            f"Expected output: {expected_output}"
         )

tests/plugin/hello_world/hello_world/komand_hello_world/triggers/hello_trigger/trigger.py

@@ -18,8 +18,14 @@ class HelloTrigger(insightconnect_plugin_runtime.Trigger):
         """Run the trigger"""
         while True:
             self.logger.info("I am the log")
-            self.send({"message": self.connection.greeting.format(params["name"])})
+            resp = {"message": self.connection.greeting.format(params["name"])}
+            self.send(resp)
             time.sleep(10)
+            # because this is a test we need to return otherwise the thread runs indefinitely to match how
+            # triggers run in production. Check using params 'test' so that if we build image of this plugin and
+            # test we will enter the loop as usual.
+            if params["test"]:
+                return resp
 
     def test(self):
         self.logger.info("This is a test")

tests/plugin/hello_world/hello_world/komand_hello_world/triggers/throw_exception_trigger/trigger.py

@@ -15,7 +15,7 @@ class ThrowExceptionTrigger(insightconnect_plugin_runtime.Trigger):
         )
 
     def run(self, params={}):
-        raise Exception("because I can")
+        raise Exception("Forced exception test")
 
     def test(self, params={}):
-        raise Exception("because I can")
+        raise Exception("Forced exception test")