Merge pull request #3991 from splunk/update-template-script

Author: ljstella

.github/workflows/response_templates/template_script.py

@@ -19,19 +19,22 @@
 import argparse
 import collections
 import json
+import urllib.parse
 from pathlib import Path
 
-def generate_manifest(directory, prefix, output_dir):
+def _get_out_template_name(template_name):
+    return f"{urllib.parse.quote(template_name)}.json"
+
+def generate_manifest(template_mapping, prefix, output_dir):
     # Code to generate the manifest file
-    
+
     response_templates = []
     res = {
         "response_templates": response_templates
     }
     try:
-        template_mapping = _get_template_mapping(directory)
         for template_name, template_list in sorted(template_mapping.items(), key=lambda x: x[0]):
-            out_template_name = f"{template_name}.json"
+            out_template_name = _get_out_template_name(template_name)
             curr_template_name = template_name
 
             templates_version= []
@@ -54,7 +57,7 @@ def generate_manifest(directory, prefix, output_dir):
                 "versions": templates_version,
                 "link": f"{prefix}{out_template_name}"
             })
-        
+
         with open(Path(output_dir) / "manifest.json", 'w') as out_file:
             out_file.write(json.dumps(res, indent=2))
 
@@ -67,54 +70,67 @@ def _get_template_mapping(directory):
     path = Path(directory)
     if not path.exists() or not path.is_dir():
         raise ValueError(f"The directory {directory} does not exist or is not a directory.")
-    
+
     # Check for non-JSON files
     non_json_files = [f.name for f in path.iterdir() if f.is_file() and f.suffix != '.json']
     if non_json_files:
         raise ValueError(f"Non-JSON files found in directory {directory}: {', '.join(non_json_files)}")
-    
+
     files = [f for f in path.glob("*.json") if f.is_file()]
     if not files:
         raise ValueError(f"No files found in the directory {directory} to merge.")
-    
+
     template_to_file_mapping = collections.defaultdict(list)
 
     for file in files:
-        name_split = file.stem.rsplit("_v", 1)
-        if len(name_split) != 2:
-            raise ValueError(f"File {file.name} does not match expected pattern '<template_name>_v<version>'")
-        template_name = name_split[0]
-        version = name_split[1]
-
-        template_to_file_mapping[template_name].append((version, file))
-    
+        with open(file, 'r') as in_file:
+            try:
+                content = in_file.read()
+                template_json = json.loads(content)
+                template_name = template_json.get("name")
+                version = template_json.get("version")
+                if not template_name or not version:
+                    raise ValueError(f"File {file.name} is missing required 'name' or 'version' fields in JSON content.")
+                template_to_file_mapping[template_name].append((version, file))
+            except json.JSONDecodeError as e:
+                raise ValueError(f"File {file.name} contains invalid JSON: {e}")
+
+    # Validate that (template_name, version) pairs are unique
+    for template_name, template_list in template_to_file_mapping.items():
+        seen_versions = {}
+        for version, file in template_list:
+            if version in seen_versions:
+                raise ValueError(
+                    f"Duplicate version '{version}' for template '{template_name}': "
+                    f"found in both '{seen_versions[version].name}' and '{file.name}'"
+                )
+            seen_versions[version] = file
+
     # Sort each template's version list by version number (ascending order)
     for template_name in template_to_file_mapping:
         try:
             template_to_file_mapping[template_name].sort(key=lambda x: int(x[0]))
         except ValueError:
             raise ValueError(f"Template '{template_name}' has invalid version(s) that cannot be converted to integer")
-    
+
     return template_to_file_mapping
 
-def merge_files(directory, output_dir):
+def merge_files(template_mapping, output_dir):
     try:
-        template_mapping = _get_template_mapping(directory)
-
         for template_name, template_list in sorted(template_mapping.items(), key=lambda x: x[0]):
-            out_template_name = f"{template_name}.json"
+            out_template_name = _get_out_template_name(template_name)
 
             templates = []
             for _, file in template_list:
                 with open(file, 'r') as in_file:
                     content = in_file.read()
                     templates.append(json.loads(content))
-            
+
             with open(Path(output_dir) / out_template_name, 'w') as out_file:
                 out_file.write(json.dumps(templates, indent=2))
     except Exception as e:
         print(f"Error during merging files: {e}")
-        raise    
+        raise
 
 def main():
     parser = argparse.ArgumentParser(description="Response template file merger and manifest generator")
@@ -128,11 +144,13 @@ def main():
 
     output_path = Path(args.output)
     output_path.mkdir(parents=True, exist_ok=True)
-    
-    merge_files(args.directory, args.output)
+
+    template_mapping = _get_template_mapping(args.directory)
+
+    merge_files(template_mapping, args.output)
 
     if args.manifest:
-        generate_manifest(args.directory, args.prefix, args.output)
+        generate_manifest(template_mapping, args.prefix, args.output)
 
 if __name__ == "__main__":
     main()