feat: add support for custom REST handlers without UI in web.conf and restmap.conf

splunk_add_on_ucc_framework/commands/rest_builder/user_defined_rest_handlers.py

@@ -64,6 +64,23 @@ def _eai_response_schema(schema: Any) -> oas.MediaTypeObject:
     )
 
 
+@dataclass
+class EndpointRegistrationEntry:
+    """
+    Represents an entry in the endpoint registration file.
+    """
+
+    name: str
+    rh_name: str
+    actions_list: List[str]
+
+    def actions(self) -> List[str]:
+        """
+        Method for consistency with RestEndpointBuilder.
+        """
+        return self.actions_list
+
+
 @dataclass
 class RestHandlerConfig:
     """
@@ -155,7 +172,7 @@ def _oas_object_eai_create_or_edit(
         if action not in self.supported_actions:
             return None
 
-        request_parameters = deepcopy(self.request_parameters[action])
+        request_parameters = deepcopy(self.request_parameters.get(action, {}))
 
         if action == "create":
             request_parameters["name"] = {
@@ -270,6 +287,27 @@ def oas_paths(self) -> Dict[str, oas.PathItemObject]:
         else:
             raise ValueError(f"Unsupported handler type: {self.handlerType}")
 
+    @property
+    def endpoint_registration_entry(self) -> Optional[EndpointRegistrationEntry]:
+        if not self.registerHandler:
+            return None
+
+        if not self.registerHandler.get("actions") or not self.registerHandler.get(
+            "file"
+        ):
+            return None
+
+        file: str = self.registerHandler["file"]
+
+        if file.endswith(".py"):
+            file = file[:-3]
+
+        return EndpointRegistrationEntry(
+            name=self.endpoint,
+            rh_name=file,
+            actions_list=self.registerHandler["actions"],
+        )
+
 
 class UserDefinedRestHandlers:
     """
@@ -294,10 +332,16 @@ def add_definition(
             definition = RestHandlerConfig(**definition)
 
         if definition.name in self._names:
-            raise ValueError(f"Duplicate REST handler name: {definition.name}")
+            raise ValueError(
+                f"REST handler defined in Global Config contains duplicated name: {definition.name}. "
+                "Please change it to a unique name."
+            )
 
         if definition.endpoint in self._endpoints:
-            raise ValueError(f"Duplicate REST handler endpoint: {definition.endpoint}")
+            raise ValueError(
+                f"REST handler defined in Global Config contains duplicated endpoint: {definition.endpoint} "
+                f"(name={definition.name}). Please change it to a unique endpoint."
+            )
 
         self._names.add(definition.name)
         self._endpoints.add(definition.endpoint)
@@ -312,3 +356,17 @@ def oas_paths(self) -> Dict[str, oas.PathItemObject]:
             paths.update(definition.oas_paths)
 
         return paths
+
+    @property
+    def endpoint_registration_entries(self) -> List[EndpointRegistrationEntry]:
+        entries = []
+
+        for definition in self._definitions:
+            entry = definition.endpoint_registration_entry
+
+            if entry is None:
+                continue
+
+            entries.append(entry)
+
+        return entries

splunk_add_on_ucc_framework/generators/conf_files/create_restmap_conf.py

@@ -13,8 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Any, Dict, Union
+from typing import Any, Dict, Union, List
 
+from splunk_add_on_ucc_framework.commands.rest_builder.endpoint.base import (
+    RestEndpointBuilder,
+)
+from splunk_add_on_ucc_framework.commands.rest_builder.user_defined_rest_handlers import (
+    EndpointRegistrationEntry,
+)
 from splunk_add_on_ucc_framework.generators.conf_files import ConfGenerator
 
 
@@ -26,10 +32,16 @@ class RestMapConf(ConfGenerator):
 
     def _set_attributes(self, **kwargs: Any) -> None:
         self.conf_file = "restmap.conf"
+        self.endpoints: List[Union[RestEndpointBuilder, EndpointRegistrationEntry]] = []
+
         if self._global_config and self._global_config.has_pages() and self._gc_schema:
-            self.endpoints = self._gc_schema.endpoints
-            self.endpoint_names = ", ".join(sorted([ep.name for ep in self.endpoints]))
+            self.endpoints.extend(self._gc_schema.endpoints)
             self.namespace = self._gc_schema.namespace
+            self.endpoints.extend(
+                self._global_config.user_defined_handlers.endpoint_registration_entries
+            )
+
+        self.endpoint_names = ", ".join(sorted([ep.name for ep in self.endpoints]))
 
     def generate_conf(self) -> Union[Dict[str, str], None]:
         if not (

splunk_add_on_ucc_framework/generators/conf_files/create_web_conf.py

@@ -13,8 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Any, Dict, Union
+from typing import Any, Dict, Union, List
 
+from splunk_add_on_ucc_framework.commands.rest_builder.endpoint.base import (
+    RestEndpointBuilder,
+)
+from splunk_add_on_ucc_framework.commands.rest_builder.user_defined_rest_handlers import (
+    EndpointRegistrationEntry,
+)
 from splunk_add_on_ucc_framework.generators.conf_files import ConfGenerator
 
 
@@ -26,8 +32,13 @@ class WebConf(ConfGenerator):
 
     def _set_attributes(self, **kwargs: Any) -> None:
         self.conf_file = "web.conf"
+        self.endpoints: List[Union[RestEndpointBuilder, EndpointRegistrationEntry]] = []
+
         if self._global_config and self._global_config.has_pages() and self._gc_schema:
-            self.endpoints = self._gc_schema.endpoints
+            self.endpoints.extend(self._gc_schema.endpoints)
+            self.endpoints.extend(
+                self._global_config.user_defined_handlers.endpoint_registration_entries
+            )
 
     def generate_conf(self) -> Union[Dict[str, str], None]:
         if not (

splunk_add_on_ucc_framework/schema/schema.json

@@ -2618,15 +2618,18 @@
           "properties": {
             "file": {
               "type": "string",
-              "description": "The file where the custom rest handler is located."
+              "description": "The file where the custom rest handler is located.",
+                "pattern": "^[a-zA-Z0-9_]+\\.py$"
             },
             "actions": {
               "type": "array",
               "description": "The actions that the custom rest handler supports.",
               "items": {
                 "type": "string",
                 "description": "The action that the custom rest handler supports.",
-                "enum": ["list", "edit", "create", "remove"]
+                "enum": ["list", "edit", "create", "remove"],
+                "minItems": 1,
+                "uniqueItems": true
               }
             }
           },

tests/testdata/expected_addons/expected_output_global_config_configuration/Splunk_TA_UCCExample/default/restmap.conf

@@ -1,6 +1,6 @@
 [admin:splunk_ta_uccexample]
 match = /
-members = splunk_ta_uccexample_account, splunk_ta_uccexample_oauth, splunk_ta_uccexample_settings
+members = Splunk_TA_Example_full, splunk_ta_uccexample_account, splunk_ta_uccexample_oauth, splunk_ta_uccexample_settings
 
 [admin_external:splunk_ta_uccexample_account]
 handlertype = python
@@ -21,4 +21,11 @@ handlertype = python
 python.version = python3
 handlerfile = splunk_ta_uccexample_rh_settings.py
 handleractions = edit, list
+handlerpersistentmode = true
+
+[admin_external:Splunk_TA_Example_full]
+handlertype = python
+python.version = python3
+handlerfile = someFile.py
+handleractions = create, edit, list
 handlerpersistentmode = true

tests/testdata/expected_addons/expected_output_global_config_configuration/Splunk_TA_UCCExample/default/web.conf

@@ -20,4 +20,12 @@ methods = POST, GET
 
 [expose:splunk_ta_uccexample_settings_specified]
 pattern = splunk_ta_uccexample_settings/*
+methods = POST, GET, DELETE
+
+[expose:Splunk_TA_Example_full]
+pattern = Splunk_TA_Example_full
+methods = POST, GET
+
+[expose:Splunk_TA_Example_full_specified]
+pattern = Splunk_TA_Example_full/*
 methods = POST, GET, DELETE

tests/testdata/test_addons/package_global_config_configuration/globalConfig.json

@@ -393,6 +393,14 @@
                 "name": "rest_handler_full",
                 "endpoint": "Splunk_TA_Example_full",
                 "handlerType": "EAI",
+                "registerHandler": {
+                    "file": "someFile.py",
+                    "actions": [
+                        "create",
+                        "edit",
+                        "list"
+                    ]
+                },
                 "requestParameters": {
                     "create": {
                         "param1_req": {

tests/unit/generators/conf_files/test_create_restmap_conf.py

@@ -1,10 +1,21 @@
+import os.path
+from textwrap import dedent
+
 from pytest import fixture
 from unittest.mock import patch, MagicMock
+
+from splunk_add_on_ucc_framework import __file__ as ucc_framework_file
+from splunk_add_on_ucc_framework.commands.rest_builder.user_defined_rest_handlers import (
+    RestHandlerConfig,
+)
 from splunk_add_on_ucc_framework.generators.conf_files import RestMapConf
 from splunk_add_on_ucc_framework.global_config import GlobalConfig
 from tests.unit.helpers import get_testdata_file_path
 
 
+UCC_DIR = os.path.dirname(ucc_framework_file)
+
+
 @fixture
 def global_config():
     return GlobalConfig(get_testdata_file_path("valid_config.json"))
@@ -106,3 +117,121 @@ def test_set_attributes(global_config, input_dir, output_dir, ucc_dir, ta_name):
     assert hasattr(restmap_conf, "endpoints")
     assert hasattr(restmap_conf, "endpoint_names")
     assert hasattr(restmap_conf, "namespace")
+
+
+def test_restmap_endpoints(global_config, input_dir, output_dir, ta_name):
+    expected_top = (
+        "[admin:splunk_ta_uccexample]\n"
+        "match = /\n"
+        "members = splunk_ta_uccexample_account, splunk_ta_uccexample_example_input_one, "
+        "splunk_ta_uccexample_example_input_two, splunk_ta_uccexample_oauth, splunk_ta_uccexample_settings\n\n"
+    )
+
+    expected_content = dedent(
+        """
+        [admin_external:splunk_ta_uccexample_account]
+        handlertype = python
+        python.version = python3
+        handlerfile = splunk_ta_uccexample_rh_account.py
+        handleractions = edit, list, remove, create
+        handlerpersistentmode = true
+
+        [admin_external:splunk_ta_uccexample_oauth]
+        handlertype = python
+        python.version = python3
+        handlerfile = splunk_ta_uccexample_rh_oauth.py
+        handleractions = edit
+        handlerpersistentmode = true
+
+        [admin_external:splunk_ta_uccexample_settings]
+        handlertype = python
+        python.version = python3
+        handlerfile = splunk_ta_uccexample_rh_settings.py
+        handleractions = edit, list
+        handlerpersistentmode = true
+
+        [admin_external:splunk_ta_uccexample_example_input_one]
+        handlertype = python
+        python.version = python3
+        handlerfile = splunk_ta_uccexample_rh_example_input_one.py
+        handleractions = edit, list, remove, create
+        handlerpersistentmode = true
+
+        [admin_external:splunk_ta_uccexample_example_input_two]
+        handlertype = python
+        python.version = python3
+        handlerfile = splunk_ta_uccexample_rh_example_input_two.py
+        handleractions = edit, list, remove, create
+        handlerpersistentmode = true
+        """
+    ).lstrip()
+    restmap_conf = RestMapConf(
+        global_config, input_dir, output_dir, addon_name=ta_name, ucc_dir=UCC_DIR
+    )
+    file_paths = restmap_conf.generate_conf()
+
+    assert file_paths is not None
+    assert file_paths.keys() == {"restmap.conf"}
+
+    with open(file_paths["restmap.conf"]) as fp:
+        content = fp.read()
+
+    assert content == (expected_top + expected_content)
+
+    global_config.user_defined_handlers.add_definitions(
+        [
+            RestHandlerConfig(
+                name="name1",
+                endpoint="endpoint1",
+                handlerType="EAI",
+                registerHandler={"file": "file1", "actions": ["list"]},
+            ),
+            RestHandlerConfig(
+                name="name2",
+                endpoint="endpoint2",
+                handlerType="EAI",
+                registerHandler={
+                    "file": "file2",
+                    "actions": ["list", "create", "delete", "edit"],
+                },
+            ),
+            RestHandlerConfig(
+                name="name3",
+                endpoint="endpoint3",
+                handlerType="EAI",
+            ),
+        ]
+    )
+
+    restmap_conf = RestMapConf(
+        global_config, input_dir, output_dir, addon_name=ta_name, ucc_dir=UCC_DIR
+    )
+    file_paths = restmap_conf.generate_conf()
+
+    assert file_paths is not None
+    assert file_paths.keys() == {"restmap.conf"}
+
+    with open(file_paths["restmap.conf"]) as fp:
+        content = fp.read()
+
+    expected_top = expected_top.replace("members =", "members = endpoint1, endpoint2,")
+
+    expected_content += dedent(
+        """
+        [admin_external:endpoint1]
+        handlertype = python
+        python.version = python3
+        handlerfile = file1.py
+        handleractions = list
+        handlerpersistentmode = true
+
+        [admin_external:endpoint2]
+        handlertype = python
+        python.version = python3
+        handlerfile = file2.py
+        handleractions = list, create, delete, edit
+        handlerpersistentmode = true
+        """
+    )
+
+    assert content == expected_top + expected_content