test: 100% unit test coverage for generators (#1861)

**Issue number:** ADDON-79015

### PR Type

**What kind of change does this PR introduce?**
* [ ] Feature
* [ ] Bug Fix
* [x] Refactoring (no functional or API changes)
* [ ] Documentation Update
* [ ] Maintenance (dependency updates, CI, etc.)

## Summary

### Changes

Added unit test cases for the generator's module to achieve `100% test
coverage`.

### User experience

No change in user experience.

## Checklist

If an item doesn't apply to your changes, leave it unchecked.

### Review

* [x] self-review - I have performed a self-review of this change
according to the [development
guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines)
* [ ] Changes are documented. The documentation is understandable,
examples work [(more
info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines)
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)
* [ ] meeting - I have scheduled a meeting or recorded a demo to explain
these changes (if there is a video, put a link below and in the ticket)

### Tests

See [the testing
doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test).

* [x] Unit - tests have been added/modified to cover the changes
* [ ] Smoke - tests have been added/modified to cover the changes
* [ ] UI - tests have been added/modified to cover the changes
* [x] coverage - I have checked the code coverage of my changes [(see
more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage)

**Demo/meeting:**

*Reviewers are encouraged to request meetings or demos if any part of
the change is unclear*

Author: hetangmodi-crest

splunk_add_on_ucc_framework/generators/conf_files/create_alert_actions_conf.py

@@ -35,8 +35,6 @@ def __init__(
         super().__init__(global_config, input_dir, output_dir)
         self.conf_file = "alert_actions.conf"
         self.conf_spec_file = f"{self.conf_file}.spec"
-        if global_config is None:
-            return
 
         envs = normalize.normalize(
             global_config.alerts,

splunk_add_on_ucc_framework/generators/python_files/create_custom_command_python.py

@@ -72,7 +72,7 @@ def argument_generator(
                     if args
                     else f", validate=validators.{validate_type}()"
                 )
-            elif validate_type:
+            else:
                 validate_str = f", validate=validators.{validate_type}()"
 
         if arg["default"] is None:

tests/unit/generators/conf_files/test_create_alert_actions_conf.py

@@ -4,6 +4,17 @@
 from textwrap import dedent
 
 
+@patch.object(shutil, "copy")
+def test_custom_icon_file_name(
+    mock_copy, global_config_for_alerts, input_dir, output_dir
+):
+    alert_action_conf = AlertActionsConf(
+        global_config_for_alerts, input_dir, output_dir
+    )
+
+    assert "icon_path = dev_icon.png" in alert_action_conf.alerts["test_alert_default"]
+
+
 def test_init_global_config_with_empty_alerts(
     global_config_only_configuration,
     input_dir,
@@ -55,7 +66,7 @@ def test_generate_conf(mock_copy, global_config_for_alerts, input_dir, output_di
                 "is_custom = 1",
                 "payload_format = json",
                 "[test_alert_default]",
-                "icon_path = alerticon.png",
+                "icon_path = dev_icon.png",
                 "label = Test Alert Default",
                 "description = Description for test Alert Action",
                 (

tests/unit/generators/conf_files/test_create_inputs_conf.py

@@ -1,31 +1,12 @@
 import json
 from pathlib import Path
 from textwrap import dedent
-from unittest.mock import MagicMock
 
 from splunk_add_on_ucc_framework.generators.conf_files import InputsConf
 from splunk_add_on_ucc_framework.global_config import GlobalConfig
 from tests.unit.helpers import get_testdata_file_path
 
 
-def test_init_no_inputs_in_global_config(
-    global_config_only_configuration,
-    input_dir,
-    output_dir,
-):
-    """Test when _global_config is provided but has no inputs."""
-    inputs_conf = InputsConf(
-        global_config_only_configuration,
-        input_dir,
-        output_dir,
-    )
-    inputs_conf._global_config = MagicMock()
-    inputs_conf._global_config.inputs = []
-
-    assert not inputs_conf.generate_conf()
-    assert not inputs_conf.generate_conf_spec()
-
-
 def test_generate_conf(
     global_config_all_json,
     input_dir,
@@ -227,6 +208,7 @@ def test_inputs_conf_content_input_with_conf(input_dir, output_dir, ta_name, tmp
                     "type": "text",
                     "label": "Required field",
                     "field": "required_field",
+                    "defaultValue": "test_field",
                     "required": True,
                 },
                 {
@@ -266,7 +248,7 @@ def test_inputs_conf_content_input_with_conf(input_dir, output_dir, ta_name, tmp
     assert specs[0]["content"] == "\n".join(
         [
             "[<name>]",
-            "required_field =",
+            "required_field = (Default: test_field)",
             "optional_field =",
             "field_desc = Some description",
         ]

tests/unit/generators/conf_files/test_create_settings_conf.py

@@ -38,6 +38,11 @@ def test_init_no_settings_key(global_config_for_alerts, input_dir, output_dir):
     assert settings_conf.default_content == ""
 
 
+def test_init_tab_without_entity(global_config_only_custom_tab, input_dir, output_dir):
+    settings_conf = SettingsConf(global_config_only_custom_tab, input_dir, output_dir)
+    assert settings_conf.default_content == "[custom_tab]\n\n"
+
+
 def test_generate_conf(global_config_all_json, input_dir, output_dir):
     ta_name = global_config_all_json.product
     exp_fname = f"{global_config_all_json.namespace.lower()}_settings.conf"

tests/unit/generators/python_files/test_create_custom_command_python.py

@@ -24,6 +24,10 @@ def custom_search_commands():
                     "required": True,
                     "validate": {"type": "Integer", "minimum": 5, "maximum": 10},
                 },
+                {
+                    "name": "max_word",
+                    "validate": {"type": "Integer", "maximum": 100},
+                },
                 {
                     "name": "age",
                     "validate": {"type": "Integer", "minimum": 18},
@@ -72,6 +76,7 @@ def test_init(
             "list_arg": [
                 "count = Option(name='count', require=True, "
                 "validate=validators.Integer(minimum=5, maximum=10))",
+                "max_word = Option(name='max_word', require=False, validate=validators.Integer(maximum=100))",
                 "age = Option(name='age', require=False, validate=validators.Integer(minimum=18))",
                 "text = Option(name='text', require=True, default='test_text')",
                 "contains = Option(name='contains', require=False)",

tests/unit/generators/test_file_generator.py

@@ -105,6 +105,38 @@ def test_set_template_and_render_invalid_file_name(
         file_gen.set_template_and_render(["dir1"], "test.invalid")
 
 
+@patch(
+    "splunk_add_on_ucc_framework.generators.conf_files.create_app_conf.get_app_manifest"
+)
+def test_begin_no_inputs(
+    dummy_app_manifest, global_config_only_configuration, input_dir, output_dir
+):
+    dummy_app_manifest.return_value = dummy_app_manifest
+    result = begin(global_config_only_configuration, input_dir, output_dir)
+    ta_name = global_config_only_configuration.product
+    assert result == [
+        {"app.conf": f"{output_dir}/{ta_name}/default/app.conf"},
+        {"server.conf": f"{output_dir}/{ta_name}/default/server.conf"},
+        {"restmap.conf": f"{output_dir}/{ta_name}/default/restmap.conf"},
+        {"web.conf": f"{output_dir}/{ta_name}/default/web.conf"},
+        {
+            "splunk_ta_uccexample_account.conf.spec": f"{output_dir}/{ta_name}/"
+            "README/splunk_ta_uccexample_account.conf.spec"
+        },
+        {
+            "splunk_ta_uccexample_settings.conf": f"{output_dir}/{ta_name}/default/splunk_ta_uccexample_settings.conf"
+        },
+        {
+            "splunk_ta_uccexample_settings.conf.spec": f"{output_dir}/{ta_name}/"
+            "README/splunk_ta_uccexample_settings.conf.spec"
+        },
+        {
+            "configuration.xml": f"{output_dir}/{ta_name}/default/data/ui/views/configuration.xml"
+        },
+        {"default.xml": f"{output_dir}/{ta_name}/default/data/ui/nav/default.xml"},
+    ]
+
+
 @patch(
     "splunk_add_on_ucc_framework.generators.conf_files.create_app_conf.get_app_manifest"
 )

tests/unit/generators/xml_files/test_create_default_xml.py

@@ -1,6 +1,7 @@
 import pytest
 from splunk_add_on_ucc_framework.generators.xml_files import DefaultXml
 from tests.unit.helpers import compare_xml_content
+from unittest.mock import patch
 
 
 @pytest.fixture
@@ -18,6 +19,22 @@ def default_xml_object(global_config_all_json, input_dir, output_dir):
     return default_xml
 
 
+@patch("os.path.exists", return_value=True)
+def test_default_xml_already_exsits(
+    mock_copy, global_config_all_json, input_dir, output_dir, caplog
+):
+    expected_msg = (
+        "Skipping generating data/ui/nav/default.xml because file already exists."
+    )
+    default_xml = DefaultXml(
+        global_config_all_json,
+        input_dir,
+        output_dir,
+    )
+    assert expected_msg in caplog.text
+    assert not hasattr(default_xml, "default_xml_content")
+
+
 def test_init_with_error(
     global_config_all_json,
     input_dir,
@@ -33,22 +50,78 @@ def test_init_with_error(
         )
 
 
-def test_generate_nav_default_xml(default_xml_object):
+@pytest.mark.parametrize(
+    (
+        "has_input",
+        "has_dashboard",
+        "has_configuration",
+        "default_view",
+        "expected_result",
+    ),
+    [
+        (
+            False,
+            False,
+            True,
+            None,
+            """<?xml version="1.0" ?>
+                <nav>
+                    <view default="true" name="configuration"/>
+                    <view name="search"/>
+                </nav>
+            """,
+        ),
+        (
+            True,
+            False,
+            False,
+            None,
+            """<?xml version="1.0" ?>
+                <nav>
+                    <view default="true" name="inputs"/>
+                    <view name="search"/>
+                </nav>
+            """,
+        ),
+        (
+            False,
+            True,
+            False,
+            None,
+            """<?xml version="1.0" ?>
+                <nav>
+                    <view default="true" name="dashboard"/>
+                    <view name="search"/>
+                </nav>
+            """,
+        ),
+        (
+            False,
+            False,
+            False,
+            None,
+            """<?xml version="1.0" ?>
+                <nav>
+                    <view default="true" name="search"/>
+                </nav>
+            """,
+        ),
+    ],
+)
+def test_generate_nav_default_view_is_none(
+    has_input,
+    has_dashboard,
+    has_configuration,
+    default_view,
+    expected_result,
+    default_xml_object,
+):
     result = default_xml_object.generate_nav_default_xml(
-        include_inputs=True,
-        include_dashboard=True,
-        include_configuration=True,
-        default_view="configuration",
+        include_inputs=has_input,
+        include_dashboard=has_dashboard,
+        include_configuration=has_configuration,
+        default_view=default_view,
     )
-
-    expected_result = """<?xml version="1.0" ?>
-    <nav>
-        <view name="inputs"/>
-        <view default="true" name="configuration"/>
-        <view name="dashboard"/>
-        <view name="search"/>
-    </nav>
-    """
     diff = compare_xml_content(result, expected_result)
     assert diff == ""
 
@@ -90,26 +163,6 @@ def test_generate_nav_default_xml_with_default_inputs_page(default_xml_object):
     assert diff == ""
 
 
-def test_generate_nav_default_xml_with_default_dashboard_page(default_xml_object):
-    result = default_xml_object.generate_nav_default_xml(
-        include_inputs=True,
-        include_dashboard=True,
-        include_configuration=True,
-        default_view="dashboard",
-    )
-
-    expected_result = """<?xml version="1.0" ?>
-    <nav>
-        <view name="inputs"/>
-        <view name="configuration"/>
-        <view default="true" name="dashboard"/>
-        <view name="search"/>
-    </nav>
-    """
-    diff = compare_xml_content(result, expected_result)
-    assert diff == ""
-
-
 def test_generate_nav_default_xml_with_search_view_default(default_xml_object):
     result = default_xml_object.generate_nav_default_xml(
         include_inputs=False,
@@ -158,7 +211,7 @@ def test_generate_nav_default_xml_with_no_configuration(default_xml_object):
                     <view name="dashboard"/>
                     <view name="search"/>
                 </nav>
-                """,
+            """,
         ),
         (
             "inputs",
@@ -169,7 +222,7 @@ def test_generate_nav_default_xml_with_no_configuration(default_xml_object):
                     <view name="dashboard"/>
                     <view name="search"/>
                 </nav>
-                """,
+            """,
         ),
         (
             "dashboard",
@@ -180,7 +233,7 @@ def test_generate_nav_default_xml_with_no_configuration(default_xml_object):
                     <view default="true" name="dashboard"/>
                     <view name="search"/>
                 </nav>
-                """,
+            """,
         ),
         (
             "search",
@@ -191,7 +244,7 @@ def test_generate_nav_default_xml_with_no_configuration(default_xml_object):
                     <view name="dashboard"/>
                     <view default="true" name="search"/>
                 </nav>
-                """,
+            """,
         ),
     ],
 )
@@ -255,3 +308,15 @@ def test_generate_xml(
         output[0]["file_path"]
         == f"{output_dir}/{ta_name}/default/data/ui/nav/{exp_fname}"
     )
+
+
+def test_generate_xml_without_pages(
+    global_config_for_conf_only_TA, input_dir, output_dir
+):
+    default_xml = DefaultXml(
+        global_config_for_conf_only_TA,
+        input_dir,
+        output_dir,
+    )
+    output = default_xml.generate()
+    assert output is None

tests/unit/testdata/valid_config_all_alerts.json

@@ -121,6 +121,7 @@
         {
             "name": "test_alert_default",
             "label": "Test Alert Default",
+            "iconFileName": "dev_icon.png",
             "description": "Description for test Alert Action",
             "adaptiveResponse": {
                 "task": [