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 required_params = ['EndpointMap', 'ServiceNetMap', 'DefaultPasswords']
  21
  22 envs_containing_endpoint_map = ['tls-endpoints-public-dns.yaml',
  23                                 'tls-endpoints-public-ip.yaml',
  24                                 'tls-everywhere-endpoints-dns.yaml']
  25 ENDPOINT_MAP_FILE = 'endpoint_map.yaml'
  26
  27 def exit_usage():
  28     print('Usage %s <yaml file or directory>' % sys.argv[0])
  29     sys.exit(1)
  30
  31
  32 def get_base_endpoint_map(filename):
  33     try:
  34         tpl = yaml.load(open(filename).read())
  35         return tpl['parameters']['EndpointMap']['default']
  36     except Exception:
  37         print(traceback.format_exc())
  38     return None
  39
  40
  41 def get_endpoint_map_from_env(filename):
  42     try:
  43         tpl = yaml.load(open(filename).read())
  44         return {
  45             'file': filename,
  46             'map': tpl['parameter_defaults']['EndpointMap']
  47         }
  48     except Exception:
  49         print(traceback.format_exc())
  50     return None
  51
  52
  53 def validate_endpoint_map(base_map, env_map):
  54     return sorted(base_map.keys()) == sorted(env_map.keys())
  55
  56
  57 def validate_mysql_connection(settings):
  58     no_op = lambda *args: False
  59     error_status = [0]
  60
  61     def mysql_protocol(items):
  62         return items == ['EndpointMap', 'MysqlInternal', 'protocol']
  63
  64     def client_bind_address(item):
  65         return 'read_default_file' in item and \
  66                'read_default_group' in item
  67
  68     def validate_mysql_uri(key, items):
  69         # Only consider a connection if it targets mysql
  70         if key.endswith('connection') and \
  71            search(items, mysql_protocol, no_op):
  72             # Assume the "bind_address" option is one of
  73             # the token that made up the uri
  74             if not search(items, client_bind_address, no_op):
  75                 error_status[0] = 1
  76         return False
  77
  78     def search(item, check_item, check_key):
  79         if check_item(item):
  80             return True
  81         elif isinstance(item, list):
  82             for i in item:
  83                 if search(i, check_item, check_key):
  84                     return True
  85         elif isinstance(item, dict):
  86             for k in item.keys():
  87                 if check_key(k, item[k]):
  88                     return True
  89                 elif search(item[k], check_item, check_key):
  90                     return True
  91         return False
  92
  93     search(settings, no_op, validate_mysql_uri)
  94     return error_status[0]
  95
  96
  97 def validate_service(filename, tpl):
  98     if 'outputs' in tpl and 'role_data' in tpl['outputs']:
  99         if 'value' not in tpl['outputs']['role_data']:
 100             print('ERROR: invalid role_data for filename: %s'
 101                   % filename)
 102             return 1
 103         role_data = tpl['outputs']['role_data']['value']
 104         if 'service_name' not in role_data:
 105             print('ERROR: service_name is required in role_data for %s.'
 106                   % filename)
 107             return 1
 108         # service_name must match the filename, but with an underscore
 109         if (role_data['service_name'] !=
 110                 os.path.basename(filename).split('.')[0].replace("-", "_")):
 111             print('ERROR: service_name should match file name for service: %s.'
 112                   % filename)
 113             return 1
 114         # if service connects to mysql, the uri should use option
 115         # bind_address to avoid issues with VIP failover
 116         if 'config_settings' in role_data and \
 117            validate_mysql_connection(role_data['config_settings']):
 118             print('ERROR: mysql connection uri should use option bind_address')
 119             return 1
 120     if 'parameters' in tpl:
 121         for param in required_params:
 122             if param not in tpl['parameters']:
 123                 print('ERROR: parameter %s is required for %s.'
 124                       % (param, filename))
 125                 return 1
 126     return 0
 127
 128
 129 def validate(filename):
 130     print('Validating %s' % filename)
 131     retval = 0
 132     try:
 133         tpl = yaml.load(open(filename).read())
 134
 135         # The template alias version should be used instead a date, this validation
 136         # will be applied to all templates not just for those in the services folder.
 137         if 'heat_template_version' in tpl and not str(tpl['heat_template_version']).isalpha():
 138             print('ERROR: heat_template_version needs to be the release alias not a date: %s'
 139                   % filename)
 140             return 1
 141
 142         if (filename.startswith('./puppet/services/') and
 143                 filename != './puppet/services/services.yaml'):
 144             retval = validate_service(filename, tpl)
 145
 146     except Exception:
 147         print(traceback.format_exc())
 148         return 1
 149     # yaml is OK, now walk the parameters and output a warning for unused ones
 150     if 'heat_template_version' in tpl:
 151         for p in tpl.get('parameters', {}):
 152             if p in required_params:
 153                 continue
 154             str_p = '\'%s\'' % p
 155             in_resources = str_p in str(tpl.get('resources', {}))
 156             in_outputs = str_p in str(tpl.get('outputs', {}))
 157             if not in_resources and not in_outputs:
 158                 print('Warning: parameter %s in template %s '
 159                       'appears to be unused' % (p, filename))
 160
 161     return retval
 162
 163 if len(sys.argv) < 2:
 164     exit_usage()
 165
 166 path_args = sys.argv[1:]
 167 exit_val = 0
 168 failed_files = []
 169 base_endpoint_map = None
 170 env_endpoint_maps = list()
 171
 172 for base_path in path_args:
 173     if os.path.isdir(base_path):
 174         for subdir, dirs, files in os.walk(base_path):
 175             for f in files:
 176                 if f.endswith('.yaml') and not f.endswith('.j2.yaml'):
 177                     file_path = os.path.join(subdir, f)
 178                     failed = validate(file_path)
 179                     if failed:
 180                         failed_files.append(file_path)
 181                     exit_val |= failed
 182                     if f == ENDPOINT_MAP_FILE:
 183                         base_endpoint_map = get_base_endpoint_map(file_path)
 184                     if f in envs_containing_endpoint_map:
 185                         env_endpoint_map = get_endpoint_map_from_env(file_path)
 186                         if env_endpoint_map:
 187                             env_endpoint_maps.append(env_endpoint_map)
 188     elif os.path.isfile(base_path) and base_path.endswith('.yaml'):
 189         failed = validate(base_path)
 190         if failed:
 191             failed_files.append(base_path)
 192         exit_val |= failed
 193     else:
 194         print('Unexpected argument %s' % base_path)
 195         exit_usage()
 196
 197 if base_endpoint_map and \
 198         len(env_endpoint_maps) == len(envs_containing_endpoint_map):
 199     for env_endpoint_map in env_endpoint_maps:
 200         matches = validate_endpoint_map(base_endpoint_map,
 201                                         env_endpoint_map['map'])
 202         if not matches:
 203             print("ERROR: %s needs to be updated to match changes in base "
 204                   "endpoint map" % env_endpoint_map['file'])
 205             failed_files.append(env_endpoint_map['file'])
 206             exit_val |= 1
 207         else:
 208             print("%s matches base endpoint map" % env_endpoint_map['file'])
 209 else:
 210     print("ERROR: Can't validate endpoint maps since a file is missing. "
 211           "If you meant to delete one of these files you should update this "
 212           "tool as well.")
 213     if not base_endpoint_map:
 214         failed_files.append(ENDPOINT_MAP_FILE)
 215     if len(env_endpoint_maps) != len(envs_containing_endpoint_map):
 216         matched_files = set(os.path.basename(matched_env_file['file'])
 217                             for matched_env_file in env_endpoint_maps)
 218         failed_files.extend(set(envs_containing_endpoint_map) - matched_files)
 219     exit_val |= 1
 220
 221 if failed_files:
 222     print('Validation failed on:')
 223     for f in failed_files:
 224         print(f)
 225 else:
 226     print('Validation successful!')
 227 sys.exit(exit_val)