chore: merge develop into main (#1843)

Author: hetangmodi-crest

.github/workflows/ta-tests.yml

@@ -150,4 +150,14 @@ jobs:
       - name: Run ucc-gen build in Target Add-on
         working-directory: TA
         run: |
-          poetry run ucc-gen build
+          poetry run ucc-gen build > build_output.log 2>&1
+          if tail -n 1 build_output.log | grep -q "^INFO: File creation summary: created: "; then
+            echo "✓ Build completed successfully with expected output"
+            cat build_output.log
+          else
+            echo "✗ Build did not complete with expected output"
+            echo "Last line of output should start with 'INFO: File creation summary: created: '"
+            echo "Full output:"
+            cat build_output.log
+            exit 1
+          fi

splunk_add_on_ucc_framework/generators/conf_files/create_account_conf.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Tuple, List, Dict
+from typing import Tuple, List, Dict, Optional
 
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
 
@@ -36,24 +36,25 @@ def _set_attributes(self) -> None:
                 if account["name"] == "oauth":
                     continue
                 content = self._gc_schema._get_oauth_enitities(account["entity"])
-                fields, special_fields = self._gc_schema._parse_fields(content)
+                fields, _ = self._gc_schema._parse_fields(content)
                 self.account_fields.append(
                     ("<name>", [f"{f._name} = " for f in fields])
                 )
 
-    def generate(self) -> Dict[str, str]:
+    def generate(self) -> Optional[List[Dict[str, str]]]:
         if not self.account_fields:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["README", self.conf_spec_file])
         self.set_template_and_render(
             template_file_path=["README"], file_name="account_conf_spec.template"
         )
 
         rendered_content = self._template.render(account_stanzas=self.account_fields)
-        self.writer(
-            file_name=self.conf_spec_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_spec_file: file_path}
+        return [
+            {
+                "file_name": self.conf_spec_file,
+                "file_path": file_path,
+                "content": rendered_content,
+            }
+        ]

splunk_add_on_ucc_framework/generators/conf_files/create_alert_actions_conf.py

@@ -16,7 +16,7 @@
 import json
 import shutil
 from os import path
-from typing import Any, Dict
+from typing import Any, Dict, List, Optional
 
 from splunk_add_on_ucc_framework.commands.modular_alert_builder import normalize
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
@@ -127,41 +127,43 @@ def _set_attributes(self) -> None:
                     value = f"{str(k).strip()} = {str(v).strip()}"
                     self.alerts[alert_name].append(value)
 
-    def generate(self) -> Dict[str, str]:
-        conf_files: Dict[str, str] = {}
-        conf_files.update(self.generate_conf())
-        conf_files.update(self.generate_conf_spec())
-        return conf_files
+    def generate(self) -> Optional[List[Dict[str, str]]]:
+        conf_files: List[Dict[str, str]] = []
+        conf = self.generate_conf()
+        conf_spec = self.generate_conf_spec()
+        if conf is not None:
+            conf_files.append(conf)
+        if conf_spec is not None:
+            conf_files.append(conf_spec)
+        return None if conf_files == [] else conf_files
 
-    def generate_conf(self) -> Dict[str, str]:
+    def generate_conf(self) -> Optional[Dict[str, str]]:
         if not self.alerts:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
             template_file_path=["conf_files"], file_name="alert_actions_conf.template"
         )
         rendered_content = self._template.render(alerts=self.alerts)
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_file: file_path}
+        return {
+            "file_name": self.conf_file,
+            "file_path": file_path,
+            "content": rendered_content,
+        }
 
-    def generate_conf_spec(self) -> Dict[str, str]:
+    def generate_conf_spec(self) -> Optional[Dict[str, str]]:
         if not self.alerts_spec:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["README", self.conf_spec_file])
         self.set_template_and_render(
             template_file_path=["README"],
             file_name="alert_actions_conf_spec.template",
         )
         rendered_content = self._template.render(alerts=self.alerts_spec)
-        self.writer(
-            file_name=self.conf_spec_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_spec_file: file_path}
+        return {
+            "file_name": self.conf_spec_file,
+            "file_path": file_path,
+            "content": rendered_content,
+        }

splunk_add_on_ucc_framework/generators/conf_files/create_app_conf.py

@@ -14,9 +14,10 @@
 # limitations under the License.
 #
 from time import time
-from typing import Dict
-from splunk_add_on_ucc_framework.global_config import GlobalConfig
+from typing import Dict, List
+
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
+from splunk_add_on_ucc_framework.global_config import GlobalConfig
 from splunk_add_on_ucc_framework.utils import get_app_manifest
 
 
@@ -57,7 +58,7 @@ def _set_attributes(self) -> None:
         ).lower()
         self.build = str(int(time()))
 
-    def generate(self) -> Dict[str, str]:
+    def generate(self) -> List[Dict[str, str]]:
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
             template_file_path=["conf_files"], file_name="app_conf.template"
@@ -75,10 +76,11 @@ def generate(self) -> Dict[str, str]:
             label=self.title,
             is_visible=self.is_visible,
         )
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-            merge_mode="item_overwrite",
-        )
-        return {self.conf_file: file_path}
+        return [
+            {
+                "file_name": self.conf_file,
+                "file_path": file_path,
+                "content": rendered_content,
+                "merge_mode": "item_overwrite",
+            }
+        ]

splunk_add_on_ucc_framework/generators/conf_files/create_commands_conf.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Dict
+from typing import Dict, List, Optional
 
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
 
@@ -30,9 +30,9 @@ def _set_attributes(self) -> None:
             for command in self._global_config.custom_search_commands:
                 self.command_names.append(command["commandName"])
 
-    def generate(self) -> Dict[str, str]:
+    def generate(self) -> Optional[List[Dict[str, str]]]:
         if not self._global_config.has_custom_search_commands():
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
@@ -41,9 +41,10 @@ def generate(self) -> Dict[str, str]:
         rendered_content = self._template.render(
             command_names=self.command_names,
         )
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_file: file_path}
+        return [
+            {
+                "file_name": self.conf_file,
+                "file_path": file_path,
+                "content": rendered_content,
+            }
+        ]

splunk_add_on_ucc_framework/generators/conf_files/create_eventtypes_conf.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from splunk_add_on_ucc_framework.commands.modular_alert_builder import normalize
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
@@ -35,18 +35,19 @@ def _set_attributes(self) -> None:
         schema_content = envs["schema.content"]
         self.alert_settings = schema_content["modular_alerts"]
 
-    def generate(self) -> Dict[str, str]:
+    def generate(self) -> Optional[List[Dict[str, str]]]:
         if not self.alert_settings:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
             template_file_path=["conf_files"], file_name="eventtypes_conf.template"
         )
         rendered_content = self._template.render(mod_alerts=self.alert_settings)
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_file: file_path}
+        return [
+            {
+                "file_name": self.conf_file,
+                "file_path": file_path,
+                "content": rendered_content,
+            }
+        ]

splunk_add_on_ucc_framework/generators/conf_files/create_inputs_conf.py

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 from collections import defaultdict
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 from splunk_add_on_ucc_framework.generators.file_generator import FileGenerator
 
@@ -99,15 +99,19 @@ def _set_attributes(self) -> None:
                 prop = f"{field_name} = {field_value}".rstrip()
                 spec_properties.append(prop)
 
-    def generate(self) -> Dict[str, str]:
-        conf_files: Dict[str, str] = {}
-        conf_files.update(self.generate_conf())
-        conf_files.update(self.generate_conf_spec())
-        return conf_files
-
-    def generate_conf(self) -> Dict[str, str]:
+    def generate(self) -> Optional[List[Dict[str, str]]]:
+        conf_files: List[Dict[str, str]] = []
+        conf = self.generate_conf()
+        conf_spec = self.generate_conf_spec()
+        if conf is not None:
+            conf_files.append(conf)
+        if conf_spec is not None:
+            conf_files.extend(conf_spec)
+        return None if conf_files == [] else conf_files
+
+    def generate_conf(self) -> Optional[Dict[str, str]]:
         if not self.inputs_conf_names:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
@@ -118,16 +122,15 @@ def generate_conf(self) -> Dict[str, str]:
             input_names=self.inputs_conf_names,
             default_values=self.inputs_conf_params,
         )
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_file: file_path}
+        return {
+            "file_name": self.conf_file,
+            "file_path": file_path,
+            "content": rendered_content,
+        }
 
-    def _generate_spec_inputs(self) -> Dict[str, str]:
+    def _generate_spec_inputs(self) -> Optional[Dict[str, str]]:
         if not self.inputs_conf_spec:
-            return {}
+            return None
 
         spec_file = self._spec_file_name("inputs")
         file_path = self.get_file_output_path(["README", spec_file])
@@ -140,12 +143,11 @@ def _generate_spec_inputs(self) -> Dict[str, str]:
             input_names=self.inputs_conf_names,
             input_stanzas=self.inputs_conf_spec,
         )
-        self.writer(
-            file_name=spec_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {spec_file: file_path}
+        return {
+            "file_name": spec_file,
+            "file_path": file_path,
+            "content": rendered_content,
+        }
 
     def _generate_spec_other(self, name: str, parameters: List[str]) -> Dict[str, str]:
         spec_file = self._spec_file_name(name)
@@ -154,20 +156,21 @@ def _generate_spec_other(self, name: str, parameters: List[str]) -> Dict[str, st
         content = ["[<name>]"]
         content.extend(parameters)
 
-        self.writer(
-            file_name=spec_file,
-            file_path=file_path,
-            content="\n".join(content),
-        )
-        return {spec_file: file_path}
+        return {
+            "file_name": spec_file,
+            "file_path": file_path,
+            "content": "\n".join(content),
+        }
 
-    def generate_conf_spec(self) -> Dict[str, str]:
-        files = self._generate_spec_inputs()
+    def generate_conf_spec(self) -> Optional[List[Dict[str, str]]]:
+        files: List[Dict[str, str]] = []
+        spec_input = self._generate_spec_inputs()
+        if spec_input is not None:
+            files.append(spec_input)
 
         for name, params in self.other_spec_files.items():
-            files.update(self._generate_spec_other(name, params))
+            files.append(self._generate_spec_other(name, params))
 
         if not files:
-            return {}
-
+            return None
         return files

splunk_add_on_ucc_framework/generators/conf_files/create_restmap_conf.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Dict, Union, List
+from typing import Dict, Union, List, Optional
 
 from splunk_add_on_ucc_framework.commands.rest_builder.endpoint.base import (
     RestEndpointBuilder,
@@ -43,9 +43,9 @@ def _set_attributes(self) -> None:
 
         self.endpoint_names = ", ".join(sorted([ep.name for ep in self.endpoints]))
 
-    def generate(self) -> Dict[str, str]:
+    def generate(self) -> Optional[List[Dict[str, str]]]:
         if not self.endpoints:
-            return {}
+            return None
 
         file_path = self.get_file_output_path(["default", self.conf_file])
         self.set_template_and_render(
@@ -56,9 +56,10 @@ def generate(self) -> Dict[str, str]:
             endpoint_names=self.endpoint_names,
             namespace=self.namespace,
         )
-        self.writer(
-            file_name=self.conf_file,
-            file_path=file_path,
-            content=rendered_content,
-        )
-        return {self.conf_file: file_path}
+        return [
+            {
+                "file_name": self.conf_file,
+                "file_path": file_path,
+                "content": rendered_content,
+            }
+        ]