insightconnect-plugin-runtime 6.2.6__tar.gz → 6.3.1__tar.gz

{insightconnect_plugin_runtime-6.2.6/insightconnect_plugin_runtime.egg-info → insightconnect_plugin_runtime-6.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.2.6
+Version: 6.3.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -26,6 +26,11 @@ Requires-Dist: apispec-webframeworks==1.0.0
 Requires-Dist: blinker==1.9.0
 Requires-Dist: structlog==24.4.0
 Requires-Dist: python-json-logger==2.0.7
+Requires-Dist: Jinja2==3.1.6
+Requires-Dist: opentelemetry-sdk==1.31.1
+Requires-Dist: opentelemetry-instrumentation-flask==0.52b1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.31.1
+Requires-Dist: opentelemetry-instrumentation-requests==0.52b1
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -219,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/README.md

@@ -182,6 +182,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/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,17 +807,95 @@ 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.
@@ -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-6.2.6 → insightconnect_plugin_runtime-6.3.1}/insightconnect_plugin_runtime/server.py

@@ -1,17 +1,16 @@
-import os
-import sys
 import json
 import logging
+import os
+import sys
+from time import sleep
 
+import gunicorn.app.base
+import structlog
 from apispec import APISpec
 from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec_webframeworks.flask import FlaskPlugin
-
 from flask import Flask, request_started, request
-import gunicorn.app.base
 from gunicorn.arbiter import Arbiter
-
-import structlog
 from pythonjsonlogger.jsonlogger import JsonFormatter
 from requests import get as request_get
 from requests.exceptions import (
@@ -21,9 +20,9 @@ from requests.exceptions import (
     JSONDecodeError,
     ConnectionError,
 )
-from time import sleep
 from werkzeug.utils import secure_filename
 
+from insightconnect_plugin_runtime.api.endpoints import Endpoints, handle_errors
 from insightconnect_plugin_runtime.api.schemas import (
     PluginInfoSchema,
     ActionTriggerOutputBodySchema,
@@ -39,9 +38,9 @@ from insightconnect_plugin_runtime.api.schemas import (
     ConnectionDetailsSchema,
     ConnectionTestSchema,
 )
-from insightconnect_plugin_runtime.api.endpoints import Endpoints, handle_errors
-from insightconnect_plugin_runtime.util import is_running_in_cloud
 from insightconnect_plugin_runtime.helper import clean_dict
+from insightconnect_plugin_runtime.telemetry import create_post_fork
+from insightconnect_plugin_runtime.util import is_running_in_cloud, OTEL_ENDPOINT
 
 API_TITLE = "InsightConnect Plugin Runtime API"
 API_VERSION = "1.0"
@@ -72,14 +71,14 @@ class PluginServer(gunicorn.app.base.BaseApplication):
     """
 
     def __init__(
-        self,
-        plugin,
-        port=10001,
-        workers=1,
-        threads=4,
-        debug=False,
-        worker_class="sync",
-        worker_connections=200,
+            self,
+            plugin,
+            port=10001,
+            workers=1,
+            threads=4,
+            debug=False,
+            worker_class="sync",
+            worker_connections=200,
     ):
 
         gunicorn_file = os.environ.get("GUNICORN_CONFIG_FILE")
@@ -120,6 +119,9 @@ class PluginServer(gunicorn.app.base.BaseApplication):
         self.get_plugin_properties_from_cps()
         self.app, self.blueprints = self.create_flask_app()
 
+        if os.environ.get(OTEL_ENDPOINT):
+            self.config_options[OTEL_ENDPOINT] = os.environ[OTEL_ENDPOINT]
+
     @staticmethod
     def configure_structlog_instance(is_debug: bool) -> None:
         structlog.configure(
@@ -166,6 +168,9 @@ class PluginServer(gunicorn.app.base.BaseApplication):
         for key, value in config.items():
             self.cfg.set(key.lower(), value)
 
+        post_fork = create_post_fork(lambda: self.app, lambda: self.plugin, lambda: self.config_options)
+        self.cfg.set("post_fork", post_fork)
+
     def create_flask_app(self):
         app = Flask(__name__)
 
@@ -193,7 +198,7 @@ class PluginServer(gunicorn.app.base.BaseApplication):
 
     def get_plugin_properties_from_cps(self):
         # Call out to komand-props to get configurations related to only the plugin pod running.
-        if is_running_in_cloud() and self.plugin.tasks:
+        if is_running_in_cloud():
             for attempt in range(1, CPS_RETRY + 1):
                 self.logger.info(
                     f"Getting plugin configuration information... (attempt {attempt}/{CPS_RETRY})"
@@ -206,7 +211,12 @@ class PluginServer(gunicorn.app.base.BaseApplication):
                     )  # match how we name our images
                     plugin_config = resp_json.get("plugins", {}).get(plugin, {})
 
-                    self.config_options = plugin_config
+                    if self.plugin.tasks:
+                        self.config_options = plugin_config
+
+                    if resp_json.get(OTEL_ENDPOINT, {}):
+                        self.config_options[OTEL_ENDPOINT] = resp_json.get(OTEL_ENDPOINT, {})
+
                     self.logger.info("Plugin configuration successfully retrieved...")
                     return
                 except MissingSchema as missing_schema:

insightconnect_plugin_runtime-6.3.1/insightconnect_plugin_runtime/telemetry.py

@@ -0,0 +1,73 @@
+import functools
+from typing import Any, Callable
+from flask.app import Flask
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.trace import Status, StatusCode
+
+from insightconnect_plugin_runtime.plugin import Plugin
+from insightconnect_plugin_runtime.util import is_running_in_cloud, OTEL_ENDPOINT
+
+
+def init_tracing(app: Flask, plugin: Plugin, endpoint: str) -> None:
+    """
+    Initialize OpenTelemetry Tracing
+
+    The function sets up the tracer provider, span processor and exporter with auto-instrumentation
+
+    :param app: The Flask Application
+    :param plugin: The plugin to derive the service name from
+    :param endpoint: The Otel Endpoint to emit traces to
+    """
+
+    if not is_running_in_cloud():
+        return
+
+    resource = Resource(attributes={"service.name": f'{plugin.name.lower().replace(" ", "_")}-{plugin.version}'})
+
+    trace_provider = TracerProvider(resource=resource)
+    exporter = OTLPSpanExporter(endpoint=endpoint)
+    trace_provider.add_span_processor(BatchSpanProcessor(exporter))
+    trace.set_tracer_provider(trace_provider)
+
+    FlaskInstrumentor().instrument_app(app)
+
+    def requests_callback(span: trace.Span, _: Any, response: Any) -> None:
+        if hasattr(response, "status_code"):
+            span.set_status(Status(StatusCode.OK if response.status_code < 400 else StatusCode.ERROR))
+
+    RequestsInstrumentor().instrument(trace_provider=trace_provider, response_hook=requests_callback)
+
+
+def auto_instrument(func: Callable) -> Callable:
+    """
+    Decorator that auto-instruments a function with a trace
+
+    :param func: function to instrument
+    :return:
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        tracer = trace.get_tracer(__name__)
+        with tracer.start_as_current_span(func.__name__):
+            return func(*args, **kwargs)
+
+    return wrapper
+
+
+def create_post_fork(app_getter: Callable, plugin_getter: Callable, config_getter: Callable) -> Callable:
+    def post_fork(server, worker):
+        app = app_getter()
+        plugin = plugin_getter()
+        endpoint = config_getter().get(OTEL_ENDPOINT, None)
+        if endpoint:
+            init_tracing(app, plugin, endpoint)
+
+    return post_fork

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/insightconnect_plugin_runtime/util.py

@@ -10,6 +10,7 @@ import python_jsonschema_objects as pjs
 KEYS_TO_CHECK_SECRETS = ("secretKey", "password", "key", "token")
 DEFAULT_REPLACE_THRESHOLD = 0.8
 DEFAULT_NUMBER_OF_ITERATIONS = 50
+OTEL_ENDPOINT = "otel_tracing"
 
 
 class OutputMasker:

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1/insightconnect_plugin_runtime.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: insightconnect-plugin-runtime
-Version: 6.2.6
+Version: 6.3.1
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -26,6 +26,11 @@ Requires-Dist: apispec-webframeworks==1.0.0
 Requires-Dist: blinker==1.9.0
 Requires-Dist: structlog==24.4.0
 Requires-Dist: python-json-logger==2.0.7
+Requires-Dist: Jinja2==3.1.6
+Requires-Dist: opentelemetry-sdk==1.31.1
+Requires-Dist: opentelemetry-instrumentation-flask==0.52b1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.31.1
+Requires-Dist: opentelemetry-instrumentation-requests==0.52b1
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -219,6 +224,8 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 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
 * 6.2.4 - Update `make_request` helper to support extra parameter of `max_response_size` to cap the response

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/insightconnect_plugin_runtime.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ insightconnect_plugin_runtime/schema.py
 insightconnect_plugin_runtime/server.py
 insightconnect_plugin_runtime/step.py
 insightconnect_plugin_runtime/task.py
+insightconnect_plugin_runtime/telemetry.py
 insightconnect_plugin_runtime/trigger.py
 insightconnect_plugin_runtime/util.py
 insightconnect_plugin_runtime/variables.py

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/insightconnect_plugin_runtime.egg-info/requires.txt

@@ -12,3 +12,8 @@ apispec-webframeworks==1.0.0
 blinker==1.9.0
 structlog==24.4.0
 python-json-logger==2.0.7
+Jinja2==3.1.6
+opentelemetry-sdk==1.31.1
+opentelemetry-instrumentation-flask==0.52b1
+opentelemetry-exporter-otlp-proto-http==1.31.1
+opentelemetry-instrumentation-requests==0.52b1

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="insightconnect-plugin-runtime",
-    version="6.2.6",
+    version="6.3.1",
     description="InsightConnect Plugin Runtime",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -28,6 +28,11 @@ setup(
         "blinker==1.9.0",
         "structlog==24.4.0",
         "python-json-logger==2.0.7",
+        "Jinja2==3.1.6",
+        "opentelemetry-sdk==1.31.1",
+        "opentelemetry-instrumentation-flask==0.52b1",
+        "opentelemetry-exporter-otlp-proto-http==1.31.1",
+        "opentelemetry-instrumentation-requests==0.52b1",
     ],
     tests_require=[
         "pytest",

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/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)

{insightconnect_plugin_runtime-6.2.6 → insightconnect_plugin_runtime-6.3.1}/tests/unit/test_server_cloud_plugins.py

@@ -4,6 +4,7 @@ from unittest import TestCase, skip
 from unittest.mock import patch, MagicMock
 
 from insightconnect_plugin_runtime.server import PluginServer
+from insightconnect_plugin_runtime.util import OTEL_ENDPOINT
 from tests.plugin.hello_world import KomandHelloWorld
 from .utils import MockResponse, Logger
 
@@ -20,15 +21,19 @@ class TestServerCloudPlugins(TestCase):
     @parameterized.expand([["Set cloud to false", False], ["Set cloud to true", True]])
     @patch("insightconnect_plugin_runtime.server.request_get")
     def test_cloud_plugin_no_tasks_ignore_cps(self, _test_name, cloud, mocked_req, mock_cloud, _run):
+        fake_endpoint = "http://fake.endpoint.com"
+        mocked_req.return_value = MockResponse({OTEL_ENDPOINT: fake_endpoint}) if cloud else MockResponse({})
         mock_cloud.return_value = cloud  # Mock plugin running in cloud vs not
         self.plugin.tasks = None  # ensure still no tasks as other tests edit this and could fail before reverting
-        plugin_server = PluginServer(self.plugin)  # this plugin has no tasks by default
 
+        plugin_server = PluginServer(self.plugin)  # this plugin has no tasks by default
         plugin_server.start()
-        self.assertEqual(plugin_server.config_options, {})
 
-        # Plugin server never calls out to CPS as either we are not running in cloud mode or have no tasks.
-        self.assertFalse(mocked_req.called)
+        self.assertEqual(plugin_server.config_options, {OTEL_ENDPOINT: fake_endpoint} if cloud else {})
+
+        # Plugin server calls out to CPS when cloud to get tracing endpoint
+        self.assertEqual(mocked_req.called, cloud)
+
 
     @patch("insightconnect_plugin_runtime.server.request_get")
     def test_cloud_plugin_calls_cps(self, mocked_req, _mock_cloud, _run):