Merge pull request #373 from splunk/dashboard_fix

fix dashboard file names

Author: patel-bhavin

contentctl/objects/constants.py

@@ -124,7 +124,6 @@
     "{app_label} - {detection_name} - Rule"
 )
 
-CONTENTCTL_DASHBOARD_LABEL_TEMPLATE = "{app_label} - {dashboard_name}"
 CONTENTCTL_BASELINE_STANZA_NAME_FORMAT_TEMPLATE = "{app_label} - {detection_name}"
 CONTENTCTL_RESPONSE_TASK_NAME_FORMAT_TEMPLATE = (
     "{app_label} - {detection_name} - Response Task"

contentctl/objects/dashboard.py

@@ -7,11 +7,10 @@
 from pydantic import Field, Json, model_validator
 
 from contentctl.objects.config import build
-from contentctl.objects.constants import CONTENTCTL_DASHBOARD_LABEL_TEMPLATE
 from contentctl.objects.security_content_object import SecurityContentObject
 
 DEFAULT_DASHBOARD_JINJA2_TEMPLATE = """<dashboard version="2" theme="{{ dashboard.theme }}">
-    <label>{{ dashboard.label(config) }}</label>
+    <label>{{ dashboard.name }}</label>
     <description></description>
     <definition><![CDATA[
 {{ dashboard.pretty_print_json_obj() }}
@@ -50,11 +49,6 @@ class Dashboard(SecurityContentObject):
         ..., description="Valid JSON object that describes the dashboard"
     )
 
-    def label(self, config: build) -> str:
-        return CONTENTCTL_DASHBOARD_LABEL_TEMPLATE.format(
-            app_label=config.app.label, dashboard_name=self.name
-        )
-
     @model_validator(mode="before")
     @classmethod
     def validate_fields_from_json(cls, data: Any) -> Any:
@@ -102,9 +96,16 @@ def pretty_print_json_obj(self):
         return json.dumps(self.json_obj, indent=4)
 
     def getOutputFilepathRelativeToAppRoot(self, config: build) -> pathlib.Path:
-        # for clarity, the name of the dashboard file will follow the same convention
-        # as we use for detections, prefixing it with app_name -
-        filename = f"{self.label(config)}.xml"
+        if self.file_path is None:
+            raise FileNotFoundError(
+                f"Dashboard {self.name} file_path was None. Dashboards must be backed by a file."
+            )
+        # Prefix with the appLabel__ in order to make a search for these easy with match="__"
+        # in the default.xml file
+        filename = f"{config.app.label}__{self.file_path.stem}.xml".lower().replace(
+            " ", "_"
+        )
+
         return pathlib.Path("default/data/ui/views") / filename
 
     def writeDashboardFile(self, j2_env: Environment, config: build):

contentctl/templates/app_template/default/data/ui/nav/default.xml

@@ -2,6 +2,6 @@
   <view name="escu_summary" default="true"/>
   <view name="search"/>
   <collection label="Dashboards">
-    <view source="unclassified" match=" - "/>
+    <view source="unclassified" match="__"/>
   </collection>
 </nav>