fix: path issue for default alert icon (#1839)

**Issue number:**

### PR Type

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

## Summary

### Changes

Fix the path issue for `alerticon.png`. Earlier, UCC was not able to
correctly find path for alerticon.png. Updated the smoke test case
respectively.
### User experience

No build failure will occur if `iconFileName` is not provide in alerts.

## 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).

* [ ] Unit - tests have been added/modified to cover the changes
* [x] Smoke - tests have been added/modified to cover the changes
* [ ] UI - tests have been added/modified to cover the changes
* [ ] 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*

---------

Co-authored-by: soleksy-splunk <143183665+soleksy-splunk@users.noreply.github.com>

Author: hetangmodi-crest

splunk_add_on_ucc_framework/generators/file_generator.py

@@ -14,9 +14,8 @@
 # limitations under the License.
 #
 import logging
-import os
 from abc import ABC
-from os.path import realpath, sep
+from os.path import realpath, sep, dirname, abspath
 from typing import Any, Dict, List, Union, NoReturn, Optional
 
 from jinja2 import Environment, FileSystemLoader, select_autoescape
@@ -39,7 +38,7 @@
 class FileGenerator(ABC):
     __description__ = "DESCRIBE THE FILE THAT IS GENERATED"
 
-    _ucc_dir = ucc_framework_file
+    _ucc_dir = abspath(dirname(ucc_framework_file))
 
     def __init__(
         self,
@@ -57,7 +56,7 @@ def __init__(
         self._global_config = global_config
         self._input_dir = input_dir
         self._output_dir = output_dir
-        self._template_dir = [(sep.join([os.path.dirname(self._ucc_dir), "templates"]))]
+        self._template_dir = [(sep.join([self._ucc_dir, "templates"]))]
         self._template = Environment(
             loader=FileSystemLoader(self._template_dir),
             trim_blocks=True,

tests/smoke/test_ucc_build.py

@@ -146,6 +146,7 @@ def test_ucc_generate_with_everything(caplog):
         files_to_be_equal = [
             ("README.txt",),
             ("appserver", "static", "test icon.png"),
+            ("appserver", "static", "alerticon.png"),
             ("appserver", "static", "js", "build", "custom", "custom_tab.js"),
             ("default", "alert_actions.conf"),
             ("default", "eventtypes.conf"),
@@ -158,6 +159,7 @@ def test_ucc_generate_with_everything(caplog):
             ("default", "commands.conf"),
             ("default", "searchbnf.conf"),
             ("default", "data", "ui", "alerts", "test_alert.html"),
+            ("default", "data", "ui", "alerts", "test_alert_default.html"),
             ("default", "data", "ui", "nav", "default.xml"),
             ("default", "data", "ui", "views", "configuration.xml"),
             ("default", "data", "ui", "views", "inputs.xml"),
@@ -188,6 +190,8 @@ def test_ucc_generate_with_everything(caplog):
             ("bin", "splunk_ta_uccexample_validate_account_rh.py"),
             ("bin", "myAlertLogic.py"),
             ("bin", "test_alert.py"),
+            ("bin", "test_alert_default.py"),
+            ("bin", "splunk_ta_uccexample", "modalert_test_alert_default_helper.py"),
             ("README", "alert_actions.conf.spec"),
             ("README", "inputs.conf.spec"),
             ("README", "some_conf.conf.spec"),
@@ -213,7 +217,6 @@ def test_ucc_generate_with_everything(caplog):
 
         # when custom files are provided, default files shouldn't be shipped
         files_should_be_absent = [
-            ("appserver", "static", "alerticon.png"),
             ("bin", "splunk_ta_uccexample", "modalert_test_alert_helper.py"),
             ("appserver", "static", "js", "build", "entry_page.js.map"),
             ("lib", "__pycache__"),

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/README/alert_actions.conf.spec

@@ -5,4 +5,8 @@ param.description = <string> Description. It's a required parameter. It's defaul
 param.all_incidents = <bool> All Incidents.
 param.table_list = <list> Table List.  It's default value is problem.
 param.action = <list> Action:. It's a required parameter. It's default value is update.
-param.account = <list> Select Account. It's a required parameter.
+param.account = <list> Select Account. It's a required parameter.
+
+[test_alert_default]
+param._cam = <json> Adaptive Response parameters.
+param.name = <string> Name. It's a required parameter. It's default value is xyz.

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/appserver/static/alerticon.png

@@ -0,0 +1,40 @@
+# encoding = utf-8
+
+def process_event(helper, *args, **kwargs):
+    """
+    # IMPORTANT
+    # Do not remove the anchor macro:start and macro:end lines.
+    # These lines are used to generate sample code. If they are
+    # removed, the sample code will not be updated when configurations
+    # are updated.
+
+    [sample_code_macro:start]
+
+    # The following example gets the alert action parameters and prints them to the log
+    name = helper.get_param("name")
+    helper.log_info("name={}".format(name))
+
+
+    # The following example adds two sample events ("hello", "world")
+    # and writes them to Splunk
+    # NOTE: Call helper.writeevents() only once after all events
+    # have been added
+    helper.addevent("hello", sourcetype="test:incident")
+    helper.addevent("world", sourcetype="test:incident")
+    helper.writeevents(index="summary", host="localhost", source="localhost")
+
+    # The following example gets the events that trigger the alert
+    events = helper.get_events()
+    for event in events:
+        helper.log_info("event={}".format(event))
+
+    # helper.settings is a dict that includes environment configuration
+    # Example usage: helper.settings["server_uri"]
+    helper.log_info("server_uri={}".format(helper.settings["server_uri"]))
+    [sample_code_macro:end]
+    """
+
+    helper.log_info("Alert action test_alert_default started.")
+
+    # TODO: Implement your alert action logic here
+    return 0

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/bin/splunk_ta_uccexample/modalert_test_alert_default_helper.py

@@ -0,0 +1,45 @@
+# encoding = utf-8
+# Always put this line at the beginning of this file
+import import_declare_test
+
+import os
+import sys
+
+from splunktaucclib.alert_actions_base import ModularAlertBase
+from splunk_ta_uccexample import modalert_test_alert_default_helper
+
+class AlertActionWorkertest_alert_default(ModularAlertBase):
+
+    def __init__(self, ta_name, alert_name):
+        super(AlertActionWorkertest_alert_default, self).__init__(ta_name, alert_name)
+
+    def validate_params(self):
+
+
+        if not self.get_param("name"):
+            self.log_error('name is a mandatory parameter, but its value is None.')
+            return False
+        return True
+
+    def process_event(self, *args, **kwargs):
+        status = 0
+        try:
+            if not self.validate_params():
+                return 3
+            status = modalert_test_alert_default_helper.process_event(self, *args, **kwargs)
+        except (AttributeError, TypeError) as ae:
+            self.log_error("Error: {}. Please double check spelling and also verify that a compatible version of Splunk_SA_CIM is installed.".format(str(ae)))#ae.message replaced with str(ae)
+            return 4
+        except Exception as e:
+            msg = "Unexpected error: {}."
+            if str(e):
+                self.log_error(msg.format(str(e)))#e.message replaced with str(ae)
+            else:
+                import traceback
+                self.log_error(msg.format(traceback.format_exc()))
+            return 5
+        return status
+
+if __name__ == "__main__":
+    exitcode = AlertActionWorkertest_alert_default("Splunk_TA_UCCExample", "test_alert_default").run(sys.argv)
+    sys.exit(exitcode)

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/bin/test_alert_default.py

@@ -11,4 +11,14 @@ param.action = update
 param.account = 
 python.version = python3
 is_custom = 1
-payload_format = json
+payload_format = json
+
+[test_alert_default]
+icon_path = alerticon.png
+label = Test Alert Default
+description = Description for test Alert Action
+param._cam = {"task": ["Create"], "subject": ["endpoint"], "category": ["Information Portrayal"], "technology": [{"version": ["1.0.0"], "product": "Test Incident Update", "vendor": "Splunk"}], "drilldown_uri": "search?q=search%20index%3D\"_internal\"&earliest=0&latest="}
+param.name = xyz
+python.version = python3
+is_custom = 1
+payload_format = json

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/alert_actions.conf

@@ -0,0 +1,12 @@
+<form class="form-horizontal form-complex">
+<div class="control-group">
+    <label class="control-label" for="test_alert_default_name">Name <span class="required">*</span> </label>
+    <div class="controls">
+<input type="text" name="action.test_alert_default.param.name"
+        id="test_alert_default_name" />
+            <span class="help-block">
+        Please enter your name
+    </span>
+    </div>
+</div>
+</form>

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/data/ui/alerts/test_alert_default.html

@@ -1,2 +1,5 @@
 [test_alert_modaction_result]
-search = sourcetype="test:incident"
+search = sourcetype="test:incident"
+
+[test_alert_default_modaction_result]
+search = sourcetype="test:incident"

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/eventtypes.conf

@@ -1,2 +1,5 @@
 [eventtype=test_alert_modaction_result]
-modaction_result = enabled
+modaction_result = enabled
+
+[eventtype=test_alert_default_modaction_result]
+modaction_result = enabled