tools/yaml-validate.py

   1 #!/usr/bin/env python
   2 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   3 #    not use this file except in compliance with the License. You may obtain
   4 #    a copy of the License at
   5 #
   6 #         http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 #    Unless required by applicable law or agreed to in writing, software
   9 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  10 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  11 #    License for the specific language governing permissions and limitations
  12 #    under the License.
  13
  14 import os
  15 import sys
  16 import traceback
  17 import yaml
  18
  19
  20 def exit_usage():
  21     print('Usage %s <yaml file or directory>' % sys.argv[0])
  22     sys.exit(1)
  23
  24 def validate(filename):
  25     print('Validating %s' % filename)
  26     try:
  27         tpl = yaml.load(open(filename).read())
  28     except Exception:
  29         print(traceback.format_exc())
  30         return 1
  31     # yaml is OK, now walk the parameters and output a warning for unused ones
  32     for p in tpl.get('parameters', {}):
  33         str_p = '\'%s\'' % p
  34         in_resources =  str_p in str(tpl.get('resources', {}))
  35         in_outputs =  str_p in str(tpl.get('outputs', {}))
  36         if not in_resources and not in_outputs:
  37             print('Warning: parameter %s in template %s appears to be unused'
  38                   % (p, filename))
  39
  40     return 0
  41
  42 if len(sys.argv) < 2:
  43     exit_usage()
  44
  45 path_args = sys.argv[1:]
  46 exit_val = 0
  47 failed_files = []
  48
  49 for base_path in path_args:
  50     if os.path.isdir(base_path):
  51         for subdir, dirs, files in os.walk(base_path):
  52             for f in files:
  53                 if f.endswith('.yaml'):
  54                     file_path = os.path.join(subdir, f)
  55                     failed = validate(file_path)
  56                     if failed:
  57                         failed_files.append(file_path)
  58                     exit_val |= failed
  59     elif os.path.isfile(base_path) and base_path.endswith('.yaml'):
  60         failed = validate(base_path)
  61         if failed:
  62             failed_files.append(base_path)
  63         exit_val |= failed
  64     else:
  65         print('Unexpected argument %s' % base_path)
  66         exit_usage()
  67
  68 if failed_files:
  69     print('Validation failed on:')
  70     for f in failed_files:
  71         print(f)
  72 else:
  73     print('Validation successful!')
  74 sys.exit(exit_val)