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         yaml.load(open(filename).read())
  28     except Exception:
  29         print(traceback.format_exc())
  30         return 1
  31     return 0
  32
  33 if len(sys.argv) < 2:
  34     exit_usage()
  35
  36 path_args = sys.argv[1:]
  37 exit_val = 0
  38 failed_files = []
  39
  40 for base_path in path_args:
  41     if os.path.isdir(base_path):
  42         for subdir, dirs, files in os.walk(base_path):
  43             for f in files:
  44                 if f.endswith('.yaml'):
  45                     file_path = os.path.join(subdir, f)
  46                     failed = validate(file_path)
  47                     if failed:
  48                         failed_files.append(file_path)
  49                     exit_val |= failed
  50     elif os.path.isfile(base_path) and base_path.endswith('.yaml'):
  51         failed = validate(base_path)
  52         if failed:
  53             failed_files.append(base_path)
  54         exit_val |= failed
  55     else:
  56         print('Unexpected argument %s' % base_path)
  57         exit_usage()
  58
  59 if failed_files:
  60     print('Validation failed on:')
  61     for f in failed_files:
  62         print(f)
  63 else:
  64     print('Validation successful!')
  65 sys.exit(exit_val)