feat(generate): restructure file generation of conf and spec files

docs/generated_files.md

@@ -0,0 +1,19 @@
+---
+title: UCC framework generated files
+---
+
+Below table describes the files generated by UCC framework
+
+## File Description
+
+| File Name  | File Location | File Description |
+| ------------ | ------------ | ----------------- |
+| app.conf | output/<YOUR_ADDON_NAME>/default | Generates `app.conf` with the details mentioned in globalConfig[meta] |
+| inputs.conf | output/<YOUR_ADDON_NAME>/default | Generates `inputs.conf` and `inputs.conf.spec` file for the services mentioned in globalConfig |
+| server.conf | output/<YOUR_ADDON_NAME>/default | Generates `server.conf` for the custom conf files created as per configurations in globalConfig |
+| restmap.conf | output/<YOUR_ADDON_NAME>/default | Generates `restmap.conf` for the custom REST handlers that are generated based on configs from globalConfig |
+| web.conf | output/<YOUR_ADDON_NAME>/default | Generates `web.conf` to expose the endpoints generated in `restmap.conf` which is generated based on configurations from globalConfig. |
+| alert_actions.conf | output/<YOUR_ADDON_NAME>/default | Generates `alert_actions.conf` and `alert_actions.conf.spec` file for the custom alert actions defined in globalConfig |
+| eventtypes.conf | output/<YOUR_ADDON_NAME>/default | Generates `eventtypes.conf` file if the sourcetype is mentioned in Adaptive Response of custom alert action in globalConfig |
+| tags.conf | output/<YOUR_ADDON_NAME>/default | Generates `tags.conf` file based on the `eventtypes.conf` created for custom alert actions. |
+

mkdocs.yml

@@ -43,6 +43,7 @@ nav:
   - Home: "index.md"
   - Quickstart: "quickstart.md"
   - ".conf files": "dot_conf_files.md"
+  - Generated Files: "generated_files.md"
   - Inputs:
       - "inputs/index.md"
       - Introduction: "inputs/index.md"
@@ -91,9 +92,9 @@ nav:
       - Custom Warning: "advanced/custom_warning.md"
   - Troubleshooting: "troubleshooting.md"
   - Contributing: "contributing.md"
-  - Changelog: "CHANGELOG.md"
   - Metadata: "metadata.md"
   - Storybook: "storybook/index.html"
+  - Changelog: "CHANGELOG.md"
   - UI Tests:
       - Configuration Page:
           - General: "ui_tests_config_page_general.md"
@@ -102,4 +103,4 @@ nav:
           - Logging: "ui_tests_config_page_logging.md"
           - Proxy: "ui_tests_config_page_proxy.md"
       - Alert Action Page: "ui_tests_alert_actions_page.md"
-      - Input Page: "ui_tests_inputs_page.md"
+      - Input Page: "ui_tests_inputs_page.md"

splunk_add_on_ucc_framework/commands/build.py

@@ -34,9 +34,7 @@
     utils,
 )
 from splunk_add_on_ucc_framework import dashboard
-from splunk_add_on_ucc_framework import app_conf as app_conf_lib
 from splunk_add_on_ucc_framework import meta_conf as meta_conf_lib
-from splunk_add_on_ucc_framework import server_conf as server_conf_lib
 from splunk_add_on_ucc_framework import app_manifest as app_manifest_lib
 from splunk_add_on_ucc_framework import global_config as global_config_lib
 from splunk_add_on_ucc_framework import data_ui_generator
@@ -54,7 +52,8 @@
 from splunk_add_on_ucc_framework.commands.openapi_generator import (
     ucc_to_oas,
 )
-
+from splunk_add_on_ucc_framework.generators.file_generator import begin
+from splunk_add_on_ucc_framework.generators.conf_files.create_app_conf import AppConf
 
 logger = logging.getLogger("ucc_gen")
 
@@ -522,9 +521,12 @@ def generate(
     logger.info(f"Cleaned out directory {output_directory}")
     app_manifest = _get_app_manifest(source)
     ta_name = app_manifest.get_addon_name()
+    generated_files = []
+    ui_available = False
 
     gc_path = _get_and_check_global_config_path(source, config_path)
     if gc_path:
+        ui_available = True
         logger.info(f"Using globalConfig file located @ {gc_path}")
         global_config = global_config_lib.GlobalConfig(gc_path)
         # handle the update of globalConfig before validating
@@ -590,6 +592,20 @@ def generate(
         logger.info(
             f"Installed add-on requirements into {ucc_lib_target} from {source}"
         )
+        generated_files.extend(
+            begin(
+                global_config=global_config,
+                input_dir=source,
+                output_dir=output_directory,
+                ucc_dir=internal_root_dir,
+                addon_name=ta_name,
+                app_manifest=app_manifest,
+                addon_version=addon_version,
+                has_ui=ui_available,
+            )
+        )
+        # TODO: all FILES GENERATED object: generated_files, use it for comparison
+
         builder_obj = RestBuilder(scheme, os.path.join(output_directory, ta_name))
         builder_obj.build()
         _modify_and_replace_token_for_oauth_templates(
@@ -611,22 +627,6 @@ def generate(
         conf_file_names.extend(list(scheme.configs_conf_file_names))
         conf_file_names.extend(list(scheme.oauth_conf_file_names))
 
-        source_server_conf_path = os.path.join(source, "default", "server.conf")
-        # For now, only create server.conf only if no server.conf is present in
-        # the source package.
-        if not os.path.isfile(source_server_conf_path):
-            server_conf = server_conf_lib.ServerConf()
-            server_conf.create_default(conf_file_names)
-            output_server_conf_path = os.path.join(
-                output_directory,
-                ta_name,
-                "default",
-                server_conf_lib.SERVER_CONF_FILE_NAME,
-            )
-            server_conf.write(output_server_conf_path)
-            logger.info(
-                f"Created default {server_conf_lib.SERVER_CONF_FILE_NAME} file in the output folder"
-            )
         if global_config.has_dashboard():
             logger.info("Including dashboard")
             dashboard_definition_json_path = os.path.join(
@@ -698,32 +698,17 @@ def generate(
         logger.info(
             f"Updated {app_manifest_lib.APP_MANIFEST_FILE_NAME} file in the output folder"
         )
-
-    app_conf = app_conf_lib.AppConf()
-    output_app_conf_path = os.path.join(
-        output_directory, ta_name, "default", app_conf_lib.APP_CONF_FILE_NAME
-    )
-    app_conf.read(output_app_conf_path)
-    should_be_visible = False
-    check_for_updates = "true"
-    supported_themes = ""
-    if global_config:
-        should_be_visible = True
-        if global_config.meta.get("checkForUpdates") is False:
-            check_for_updates = "false"
-        if global_config.meta.get("supportedThemes") is not None:
-            supported_themes = ", ".join(global_config.meta["supportedThemes"])
-    app_conf.update(
-        addon_version,
-        app_manifest,
-        conf_file_names,
-        should_be_visible,
-        check_for_updates=check_for_updates,
-        supported_themes=supported_themes,
-    )
-    app_conf.write(output_app_conf_path)
-    logger.info(f"Updated {app_conf_lib.APP_CONF_FILE_NAME} file in the output folder")
-
+    # NOTE: merging source and generated 'app.conf' as per previous design
+    AppConf(
+        global_config=global_config,
+        input_dir=source,
+        output_dir=output_directory,
+        ucc_dir=internal_root_dir,
+        addon_name=ta_name,
+        app_manifest=app_manifest,
+        addon_version=addon_version,
+        has_ui=ui_available,
+    ).generate()
     license_dir = os.path.abspath(os.path.join(source, os.pardir, "LICENSES"))
     if os.path.exists(license_dir):
         logger.info("Copy LICENSES directory")