insightconnect-plugin-runtime 6.3.0__py3-none-any.whl → 6.3.2__py3-none-any.whl

insightconnect_plugin_runtime/api/endpoints.py

@@ -24,9 +24,11 @@ from insightconnect_plugin_runtime.exceptions import (
     ServerException,
 )
 from insightconnect_plugin_runtime.util import OutputMasker
+from uuid import UUID
 
 logger = structlog.get_logger("plugin")
 ORG_ID = "X-IPIMS-ORGID"
+INT_ID = "X-INTEGRATION-ID"
 
 PLUGIN_SPEC_DOCKERFILE = "/python/src/plugin.spec.yaml"
 PLUGIN_SPEC_PACK = "/workspace/plugin.spec.yaml"
@@ -173,15 +175,20 @@ 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")
+
             # No validation on the plugin custom config to leave this as configurable as possible.
             # `add_plugin_custom_config` will pass any available values to the plugin for interpretation.
             input_message = self.add_plugin_custom_config(
-                input_message, request.headers.get(ORG_ID)
+                input_message,
+                request.headers.get(ORG_ID, ""),
+                request.headers.get(INT_ID, ""),
+                name,
             )
             output = self.run_action_trigger_task(input_message, mask_output=False)
             self.logger.info("Plugin task finished execution...")
@@ -787,7 +794,7 @@ class Endpoints:
         return version
 
     def add_plugin_custom_config(
-            self, input_data: Dict[str, Any], org_id: str
+        self, input_data: Dict[str, Any], org_id: str, int_id: str, task_name: str
     ) -> Dict[str, Any]:
         """
         Using the retrieved configs pulled from komand-props, pass the configuration that matches the requesting
@@ -800,22 +807,100 @@ class Endpoints:
         - org 1 when in lookback mode will pull back 108 hours (task triggered with no state).
         - all orgs for default runs will poll back 12 hours.
         - all orgs in lookback mode will be 100 hours (task triggered with no state).
+
+        When Int ID is specified or task name. Then it can be used across all orgs (global config) or specific Org ID.
+        There's a hierarchy between task related config and Int ID related, where Int ID will always
+        replace task related config due to its higher priority.
+
+        Config example:
+        {
+            "org_1": {
+                "task_name_1": {
+                    "default": 12,
+                    "lookback": "100"
+                },
+                "int_1": {
+                    "default": 6,
+                    "lookback": "50"
+                },
+                {
+                    "default": 24,
+                    "lookback": "108"
+                }
+            },
+            "*": {
+                "default": 24,
+                "lookback": 200
+                "task_name_2": {
+                    "default": 2,
+                    "lookback": "10"
+                }
+            }
+        }
+
+        In this config example the following we be applied:
+        - org 1 to has a custom default time of 24 hours for their timings.
+        - org 1 when in lookback mode will pull back 108 hours (task triggered with no state).
+        - org 1 all integrations that uses task with 'task_name_1' will pull back 100 hours
+        and have a custom default time of 12 hours for their timings.
+        - org 1 specific integration 'int_1' will pull back 50 hours and have a custom
+        default time of 6 hours for their timings.
+        - all orgs for default runs will poll back 24 hours.
+        - all orgs in lookback mode will be 200 hours (task triggered with no state).
+        - all orgs that uses task with 'task_name_2' will pull back 2 hours
+        - all orgs that uses task with 'task_name_2' in lookback mode will be 10 hours
         """
-        additional_config = self.config_options.get(org_id) or self.config_options.get(
-            "*"
-        )
+
+        # Parse configuration based on organization or global. Use its copies, not to modify original dict.
+        organization_config, global_config = self.config_options.get(org_id, {}).copy(), self.config_options.get("*", {}).copy()
+
+        # Definition of additional config and its type variables.
+        additional_config, config_type = {}, ""
+
+        # Check if we have a global config.
+        # Also, use "config_type" variable just for logging purposes to have an indicator from where the config was pulled.
+        if global_config:
+            # Setup global config as starting point.
+            additional_config, config_type = global_config, "GLOBAL"
+
+            # If task configuration was found under global config, update it with task config to replace necessary values.
+            if task_config := global_config.get(task_name):
+                additional_config.update(task_config)
+                config_type = "GLOBAL_TASK"
+
+        # If organization config is present, then replace its values with the ones coming from global config.
+        if organization_config:
+            # Update additional config with values coming from organization config.
+            additional_config.update(organization_config)
+            config_type = "ORG"
+
+            # If task configuration was found under organization, replace its values with organization config.
+            if task_config := organization_config.get(task_name):
+                additional_config.update(task_config)
+                config_type = "ORG_TASK"
+
+            # If integration config was found under organization replace its values with organization
+            # and task config (higher priority).
+            if integration_config := organization_config.get(int_id):
+                additional_config.update(integration_config)
+                config_type = "ORG_INT"
+
         if additional_config:
             self.logger.info(
-                "Found config options; adding this to the request parameters..."
+                f"Found config options ({config_type}); adding this to the request parameters..."
             )
-            additional_config = (
-                additional_config.copy()
-            )  # copy to preserve the referenced value in self.config_options
+
+            # Sopy to preserve the referenced value in self.config_options.
+            # Also, remove unnecessary fields from that config (int_ids, or task_names) that occurs
+            # when updated global dictionary above. This thing is that we use global config as base
+            # and then updating some fields depending on the configuration.
+            additional_config = self._remove_unnecessary_fields_from_custom_config(additional_config)
+
             # As a safeguard we only pass the lookback config params if the plugin has no state
             # This means we still need to manually delete the state for plugins on a per org basis.
             # This also means first time customers for their 'initial' lookup would get the lookback value passed in.
             if input_data.get("body", {}).get("state") and additional_config.get(
-                    "lookback"
+                "lookback"
             ):
                 self.logger.info(
                     "Found an existing plugin state, not passing lookback value..."
@@ -842,8 +927,8 @@ class Endpoints:
             if isinstance(wrapped_exception, ClientException):
                 status_code = 400
             elif (
-                    isinstance(wrapped_exception, PluginException)
-                    and wrapped_exception.preset is PluginException.Preset.BAD_REQUEST
+                isinstance(wrapped_exception, PluginException)
+                and wrapped_exception.preset is PluginException.Preset.BAD_REQUEST
             ):
                 status_code = 400
             elif isinstance(wrapped_exception, (ConnectionTestException, ClientException)):
@@ -868,8 +953,8 @@ class Endpoints:
         if isinstance(wrapped_exception, (ConnectionTestException, ClientException)):
             return 400
         elif (
-                isinstance(wrapped_exception, PluginException)
-                and wrapped_exception.preset is PluginException.Preset.BAD_REQUEST
+            isinstance(wrapped_exception, PluginException)
+            and wrapped_exception.preset is PluginException.Preset.BAD_REQUEST
         ):
             return 400
         elif isinstance(wrapped_exception, ServerException):
@@ -878,3 +963,46 @@ class Endpoints:
             return 501
         else:
             return 500
+
+    def _remove_unnecessary_fields_from_custom_config(self, additional_config: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Removes unnecessary fields from custom config such as other task names, and int_ids,
+        leaving only the fields that needs to be parsed.
+
+        :param additional_config: The custom config dictionary on which, unnecessary fields will be removed.
+        :type additional_config: Dict[str, Any]
+
+        :return: New custom config dictionary with unnecessary fields removed.
+        :rtype: Dict[str, Any]
+        """
+
+        # Copy 'additional_config' not to operate on it
+        config_copy = additional_config.copy()
+
+        # Remove other task names from config
+        for task_ in self.plugin.tasks.keys():
+            config_copy.pop(task_, None)
+
+        # Remove other int_ids from config
+        for key_ in additional_config.keys():
+            if self._check_if_uuid(key_):
+                config_copy.pop(key_, None)
+        return config_copy
+
+    @staticmethod
+    def _check_if_uuid(input_string: str) -> bool:
+        """
+        Validates whether the provided string matches UUID format specifications.
+
+        :param input_string: The string to validate against UUID format standards
+        :type input_string: str
+
+        :return: True if the string is a valid UUID, False otherwise
+        :rtype: bool
+        """
+
+        try:
+            UUID(input_string)
+            return True
+        except (TypeError, ValueError):
+            return False

insightconnect_plugin_runtime/helper.py

@@ -262,7 +262,10 @@ def response_handler(
 ) -> None:
     """
     Check response status codes and return a generic PluginException preset if a HTTPError is raised.
-    Excetion cause, assistance, and data can be overwritten by supplied parameters.
+    Exception cause, assistance, and data can be overwritten by supplied parameters.
+
+    When we receive a common status code that we typically handle in the plugin, we raise an APIException
+    so that the status_code attribute can be easily accessed and raised further up the chain.
 
     :param response: Response object whose status should be checked.
     :type Response:
@@ -304,7 +307,7 @@ def response_handler(
             if hasattr(exception, "data") and data is not None:
                 exception.data = data
         elif status_code_preset:
-            exception = PluginException(preset=status_code_preset)
+            exception = APIException(preset=status_code_preset, status_code=status_code)
             exception.data = data
 
         raise exception

{insightconnect_plugin_runtime-6.3.0.dist-info → insightconnect_plugin_runtime-6.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.3.0
+Version: 6.3.2
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -224,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.3.2 - Raise `APIException` from within the `response_handler` to easily access the status code within the plugin
+* 6.3.1 - Improved filtering for `custom_config` parameters for plugin tasks
 * 6.3.0 - Add Tracing Instrumentation
 * 6.2.6 - Remove setuptools after installation
 * 6.2.5 - Fixed bug related to failure to set default region to assume role method in `aws_client` for newer versions of boto3 | Updated alpine image packages on build

{insightconnect_plugin_runtime-6.3.0.dist-info → insightconnect_plugin_runtime-6.3.2.dist-info}/RECORD

@@ -4,7 +4,7 @@ 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=Pvcdkx81o6qC2qU661x-DzNjuIMP82x52nPMSEqEo4s,8491
-insightconnect_plugin_runtime/helper.py,sha256=B0XqAXmn8CT1KQ6i5IoWLQrQ_HVOvuKrIKFuj_npQ-g,33770
+insightconnect_plugin_runtime/helper.py,sha256=xGiskPd4vHr_k7BNEb3_7gPxm8sB85A7_5N31S-0RE4,33994
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 insightconnect_plugin_runtime/plugin.py,sha256=Yf4LNczykDVc31F9G8uuJ9gxEsgmxmAr0n4pcZzichM,26393
 insightconnect_plugin_runtime/schema.py,sha256=6MVw5hqGATU1VLgwfOWfPsP3hy1OnsugCTsgX8sknes,521
@@ -16,7 +16,7 @@ insightconnect_plugin_runtime/trigger.py,sha256=Zq3cy68N3QxAGbNZKCID6CZF05Zi7YD2
 insightconnect_plugin_runtime/util.py,sha256=8cle29INhnshEcL2LWpaC0ZGqevjq8pW8TE0MFEiYYw,8475
 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=Kn9VfnpvcVO9oY5W07laJkXFNp0PfZQrY2AecYFbvNw,33377
+insightconnect_plugin_runtime/api/endpoints.py,sha256=ddqqYM7s1huvXFD0nCjpV_J2XULDn8F5sRakdjq-AKU,38893
 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=ViJF3klbD1YM5GVxme3BFYfpuADUlVGP8sdbX2Z6_Cw,23061
@@ -67,7 +67,7 @@ tests/unit/test_action.py,sha256=0SVen1qNrFLKKAXMurN9T4NpItpftnSpDZ71AdrGZeo,168
 tests/unit/test_api.py,sha256=uZ1dWMmgQ-ZePYjmcZfjc-qOTJsjs20Wic0Uf4U12-8,4441
 tests/unit/test_aws_action.py,sha256=pBE23Qn4aXKJqPmwiHMcEU5zPdyvbKO-eK-6jUlrsQw,9640
 tests/unit/test_custom_encoder.py,sha256=KLYyVOTq9MEkZXyhVHqjm5LVSW6uJS4Davgghsw9DGk,2207
-tests/unit/test_endpoints.py,sha256=LuXOfLBu47rDjGa5YEsOwTZBEdvQdl_C6-r46oxWZA8,6401
+tests/unit/test_endpoints.py,sha256=Ef0f6EudnAA_o6jZJ7rvgwgQHHswPuBEiyyo1D7BWMc,11523
 tests/unit/test_exceptions.py,sha256=Y4F-ij8WkEJkUU3mPvxlEchqE9NCdxDvR8bJzPVVNao,5328
 tests/unit/test_helpers.py,sha256=ym1tFi1VSKmdPaHEAlMEl1S7Ibu9-LrqZ2oqJv7bfbE,18685
 tests/unit/test_metrics.py,sha256=PjjTrB9w7uQ2Q5UN-893-SsH3EGJuBseOMHSD1I004s,7979
@@ -79,7 +79,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=hcY0A2H_DMgCDXUTvDtCXMdMvRjLQgTaGcTpATb8YG0,2236
-insightconnect_plugin_runtime-6.3.0.dist-info/METADATA,sha256=GCmcMcuLriTNb5PMLZc83UqlpxByddurw6G-WAwui-4,16225
-insightconnect_plugin_runtime-6.3.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-insightconnect_plugin_runtime-6.3.0.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-6.3.0.dist-info/RECORD,,
+insightconnect_plugin_runtime-6.3.2.dist-info/METADATA,sha256=vgKGS09fSB4nQCCckH633xSzDf4UO6Waaae_XHnVivE,16419
+insightconnect_plugin_runtime-6.3.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+insightconnect_plugin_runtime-6.3.2.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.3.2.dist-info/RECORD,,

tests/unit/test_endpoints.py

@@ -1,11 +1,42 @@
-import unittest
 import json
+import unittest
+from typing import Any, Dict
 
-from insightconnect_plugin_runtime.api.endpoints import Endpoints
-from insightconnect_plugin_runtime.plugin import Plugin
-from insightconnect_plugin_runtime.action import Action
 from insightconnect_plugin_runtime import Input
+from insightconnect_plugin_runtime.action import Action
+from insightconnect_plugin_runtime.api.endpoints import Endpoints
 from insightconnect_plugin_runtime.connection import Connection
+from insightconnect_plugin_runtime.plugin import Plugin
+from insightconnect_plugin_runtime.task import Task
+from parameterized import parameterized
+
+MOCKED_CONFIG = {
+    "*": {
+        "first_property": "first_property_global",
+        "second_property": "second_property_global",
+        "task_name_1": {"second_property": "second_property_global_task_name_1"},
+    },
+    "org_1": {
+        "first_property": "first_property_org_1",
+        "11111111-1111-1111-1111-111111111111": {
+            "first_property": "first_property_org_1_11111111-1111-1111-1111-111111111111"
+        },
+        "task_name_2": {"second_property": "second_property_task_name_2"},
+        "task_name_3": {
+            "first_property": "first_property_task_name_3",
+            "second_property": "second_property_task_name_3",
+        },
+        "22222222-2222-2222-2222-222222222222": {
+            "first_property": "first_property_org_1_22222222-2222-2222-2222-222222222222",
+            "second_property": "second_property_org_1_22222222-2222-2222-2222-222222222222",
+        },
+    },
+    "org_2": {
+        "first_property": "first_property_org_2",
+        "second_property": "second_property_org_2",
+        "task_name_1": {"first_property": "first_property_org_1_task_name_1"},
+    },
+}
 
 
 class TestDefinitionsAllActions(unittest.TestCase):
@@ -18,6 +49,7 @@ class TestDefinitionsAllActions(unittest.TestCase):
             workers=None,
             threads=None,
             master_pid=None,
+            config_options=MOCKED_CONFIG,
         )
 
         plugin = Plugin(
@@ -28,6 +60,11 @@ class TestDefinitionsAllActions(unittest.TestCase):
             connection=Connection(input=None),
         )
 
+        # Add example tasks
+        for task in ("task_name_1", "task_name_2", "task_name_3"):
+            plugin.add_task(
+                Task(name=task, description="Test", input=None, output=None)
+            )
         self.endpoints.plugin = plugin
 
     def test_input_good(self):
@@ -213,3 +250,106 @@ class TestDefinitionsAllActions(unittest.TestCase):
         actual = self.endpoints._create_action_definitions_payload()
 
         self.assertNotEqual(expected, actual)
+
+    @parameterized.expand(
+        [
+            (
+                "",
+                "",
+                "no_task_in_properties",
+                {
+                    "first_property": "first_property_global",
+                    "second_property": "second_property_global",
+                },
+            ),
+            (
+                "",
+                "",
+                "task_name_1",
+                {
+                    "first_property": "first_property_global",
+                    "second_property": "second_property_global_task_name_1",
+                },
+            ),
+            (
+                "org_1",
+                "",
+                "no_task_in_properties",
+                {
+                    "first_property": "first_property_org_1",
+                    "second_property": "second_property_global",
+                },
+            ),
+            (
+                "org_1",
+                "11111111-1111-1111-1111-111111111111",
+                "no_task_in_properties",
+                {
+                    "first_property": "first_property_org_1_11111111-1111-1111-1111-111111111111",
+                    "second_property": "second_property_global",
+                },
+            ),
+            (
+                "org_1",
+                "11111111-1111-1111-1111-111111111111",
+                "task_name_2",
+                {
+                    "first_property": "first_property_org_1_11111111-1111-1111-1111-111111111111",
+                    "second_property": "second_property_task_name_2",
+                },
+            ),
+            (
+                "org_1",
+                "11111111-1111-1111-1111-111111111111",
+                "task_name_3",
+                {
+                    "first_property": "first_property_org_1_11111111-1111-1111-1111-111111111111",
+                    "second_property": "second_property_task_name_3",
+                },
+            ),
+            (
+                "org_1",
+                "22222222-2222-2222-2222-222222222222",
+                "no_task_in_properties",
+                {
+                    "first_property": "first_property_org_1_22222222-2222-2222-2222-222222222222",
+                    "second_property": "second_property_org_1_22222222-2222-2222-2222-222222222222",
+                },
+            ),
+            (
+                "org_1",
+                "22222222-2222-2222-2222-222222222222",
+                "task_name_2",
+                {
+                    "first_property": "first_property_org_1_22222222-2222-2222-2222-222222222222",
+                    "second_property": "second_property_org_1_22222222-2222-2222-2222-222222222222",
+                },
+            ),
+            (
+                "org_2",
+                "",
+                "",
+                {
+                    "first_property": "first_property_org_2",
+                    "second_property": "second_property_org_2",
+                },
+            ),
+            (
+                "org_2",
+                "",
+                "task_name_1",
+                {
+                    "first_property": "first_property_org_1_task_name_1",
+                    "second_property": "second_property_org_2",
+                },
+            ),
+        ]
+    )
+    def test_add_plugin_custom_config(
+        self, org_id: str, int_id: str, task_name: str, expected: Dict[str, Any]
+    ) -> None:
+        response = self.endpoints.add_plugin_custom_config(
+            {"body": {}}, org_id, int_id, task_name
+        )
+        custom_config = response.get("body", {}).get("custom_config", {})
+        self.assertEqual(custom_config, expected)