Merge "Synchronize NetworkDeployment inputs for generic roles"

[apex-tripleo-heat-templates.git] / tools / yaml-validate.py

diff --git a/tools/yaml-validate.py b/tools/yaml-validate.py
index fe690d8..95c7d02 100755 (executable)
--- a/tools/yaml-validate.py
+++ b/tools/yaml-validate.py
@@ -17,18 +17,65 @@ import traceback
 import yaml
 
 
+required_params = ['EndpointMap', 'ServiceNetMap', 'DefaultPasswords']
+
 def exit_usage():
     print('Usage %s <yaml file or directory>' % sys.argv[0])
     sys.exit(1)
 
+
+def validate_service(filename, tpl):
+    if 'outputs' in tpl and 'role_data' in tpl['outputs']:
+        if 'value' not in tpl['outputs']['role_data']:
+            print('ERROR: invalid role_data for filename: %s'
+                  % filename)
+            return 1
+        role_data = tpl['outputs']['role_data']['value']
+        if 'service_name' not in role_data:
+            print('ERROR: service_name is required in role_data for %s.'
+                  % filename)
+            return 1
+        # service_name must match the filename, but with an underscore
+        if (role_data['service_name'] !=
+                os.path.basename(filename).split('.')[0].replace("-", "_")):
+            print('ERROR: service_name should match file name for service: %s.'
+                  % filename)
+            return 1
+    if 'parameters' in tpl:
+        for param in required_params:
+            if param not in tpl['parameters']:
+                print('ERROR: parameter %s is required for %s.'
+                      % (param, filename))
+                return 1
+    return 0
+
+
 def validate(filename):
     print('Validating %s' % filename)
+    retval = 0
     try:
-        yaml.load(open(filename).read())
+        tpl = yaml.load(open(filename).read())
+
+        if (filename.startswith('./puppet/services/') and
+                filename != './puppet/services/services.yaml'):
+            retval = validate_service(filename, tpl)
+
     except Exception:
         print(traceback.format_exc())
         return 1
-    return 0
+    # yaml is OK, now walk the parameters and output a warning for unused ones
+    if 'heat_template_version' in tpl:
+        for p in tpl.get('parameters', {}):
+            if p in required_params:
+                continue
+            str_p = '\'%s\'' % p
+            in_resources = str_p in str(tpl.get('resources', {}))
+            in_outputs = str_p in str(tpl.get('outputs', {}))
+            if not in_resources and not in_outputs:
+                print('Warning: parameter %s in template %s '
+                      'appears to be unused' % (p, filename))
+
+    return retval
 
 if len(sys.argv) < 2:
     exit_usage()
@@ -41,7 +88,7 @@ for base_path in path_args:
     if os.path.isdir(base_path):
         for subdir, dirs, files in os.walk(base_path):
             for f in files:
-                if f.endswith('.yaml'):
+                if f.endswith('.yaml') and not f.endswith('.j2.yaml'):
                     file_path = os.path.join(subdir, f)
                     failed = validate(file_path)
                     if failed: