Add recursive whole-file __include__ tag
[apex-tripleo-heat-templates.git] / merge.py
1 import sys
2 import yaml
3 import argparse
4
5 parser = argparse.ArgumentParser()
6 parser.add_argument('templates', nargs='+')
7 parser.add_argument('--master-role', nargs='?',
8                     help='Translate slave_roles to this')
9 parser.add_argument('--slave-roles', nargs='*',
10                     help='Translate all of these to master_role')
11
12 args = parser.parse_args()
13
14 templates = args.templates
15
16 def _translate_role(role):
17     global args
18     if not args.master_role:
19         return role
20     if role == args.master_role:
21         return role
22     if role not in args.slave_roles:
23         return role
24     return args.master_role
25
26 def translate_role(role):
27     r = _translate_role(role)
28     if not isinstance(r, basestring):
29         raise Exception('%s -> %r' % (role, r))
30     return r
31
32 def resolve_params(item, param, value):
33     if item == {'Ref': param}:
34         return value
35     if isinstance(item, dict):
36         copy_item = dict(item)
37         for k, v in iter(copy_item.items()):
38             item[k] = resolve_params(v, param, value)
39     elif isinstance(item, list):
40         copy_item = list(item)
41         new_item = []
42         for v in copy_item:
43             new_item.append(resolve_params(v, param, value))
44         item = new_item
45     return item
46
47 MERGABLE_TYPES = {'OS::Nova::Server':
48                   {'image': 'image'},
49                   'AWS::EC2::Instance':
50                   {'image': 'ImageId'},
51                  }
52
53
54 def resolve_includes(template, params=None):
55     new_template = {}
56     if params is None:
57         params = {}
58     for key, value in iter(template.items()):
59         if key == '__include__':
60             new_params = dict(params) # do not propagate up the stack
61             if not isinstance(value, dict):
62                 raise ValueError('__include__ must be a mapping')
63             if 'path' not in value:
64                 raise ValueError('__include__ must have path')
65             if 'params' in value:
66                 if not isinstance(value['params'], dict):
67                     raise ValueError('__include__ params must be a mapping')
68                 new_params.update(value['params'])
69             with open(value['path']) as include_file:
70                 sub_template = yaml.safe_load(include_file.read())
71                 if 'subkey' in value:
72                     if ((not isinstance(value['subkey'], int)
73                          and not isinstance(sub_template, dict))):
74                         raise RuntimeError('subkey requires mapping root or'
75                                            ' integer for list root')
76                     sub_template = sub_template[value['subkey']]
77                 for k, v in iter(new_params.items()):
78                     sub_template = resolve_params(sub_template, k, v)
79                 new_template.update(resolve_includes(sub_template))
80         else:
81             if isinstance(value, dict):
82                 new_template[key] = resolve_includes(value)
83             else:
84                 new_template[key] = value
85     return new_template
86
87 errors = []
88 end_template={'HeatTemplateFormatVersion': '2012-12-12',
89               'Description': []}
90 resource_changes=[]
91 for template_path in templates:
92     template = yaml.safe_load(open(template_path))
93     # Resolve __include__ tags
94     template = resolve_includes(template)
95     end_template['Description'].append(template.get('Description',
96                                                     template_path))
97     new_parameters = template.get('Parameters', {})
98     for p, pbody in sorted(new_parameters.items()):
99         if p in end_template.get('Parameters', {}):
100             if pbody != end_template['Parameters'][p]:
101                 errors.append('Parameter %s from %s conflicts.' % (p,
102                                                                    template_path))
103             continue
104         if 'Parameters' not in end_template:
105             end_template['Parameters'] = {}
106         end_template['Parameters'][p] = pbody
107
108     new_outputs = template.get('Outputs', {})
109     for o, obody in sorted(new_outputs.items()):
110         if o in end_template.get('Outputs', {}):
111             if pbody != end_template['Outputs'][p]:
112                 errors.append('Output %s from %s conflicts.' % (o,
113                                                                    template_path))
114             continue
115         if 'Outputs' not in end_template:
116             end_template['Outputs'] = {}
117         end_template['Outputs'][o] = obody
118
119     new_resources = template.get('Resources', {})
120     for r, rbody in sorted(new_resources.items()):
121         if rbody['Type'] in MERGABLE_TYPES:
122             image_key = MERGABLE_TYPES[rbody['Type']]['image']
123             # XXX Assuming ImageId is always a Ref
124             ikey_val = end_template['Parameters'][rbody['Properties'][image_key]['Ref']]
125             del end_template['Parameters'][rbody['Properties'][image_key]['Ref']]
126             role = rbody.get('Metadata', {}).get('OpenStack::Role', r)
127             role = translate_role(role)
128             if role != r:
129                 resource_changes.append((r, role))
130             if role in end_template.get('Resources', {}):
131                 new_metadata = rbody.get('Metadata', {})
132                 for m, mbody in iter(new_metadata.items()):
133                     if m in end_template['Resources'][role].get('Metadata', {}):
134                         if m == 'OpenStack::ImageBuilder::Elements':
135                             end_template['Resources'][role]['Metadata'][m].extend(mbody)
136                             continue
137                         if mbody != end_template['Resources'][role]['Metadata'][m]:
138                             errors.append('Role %s metadata key %s conflicts.' %
139                                           (role, m))
140                         continue
141                     end_template['Resources'][role]['Metadata'][m] = mbody
142                 continue
143             if 'Resources' not in end_template:
144                 end_template['Resources'] = {}
145             end_template['Resources'][role] = rbody
146             ikey = '%sImage' % (role)
147             end_template['Resources'][role]['Properties'][image_key] = {'Ref': ikey}
148             end_template['Parameters'][ikey] = ikey_val
149         elif rbody['Type'] == 'FileInclude':
150             with open(rbody['Path']) as rfile:
151                 include_content = yaml.safe_load(rfile.read())
152                 subkeys = rbody.get('SubKey','').split('.')
153                 while len(subkeys) and subkeys[0]:
154                     include_content = include_content[subkeys.pop(0)]
155                 for replace_param, replace_value in iter(rbody.get('Parameters',
156                                                                    {}).items()):
157                     include_content = resolve_params(include_content,
158                                                      replace_param,
159                                                      replace_value)
160                 end_template['Resources'][r] = include_content
161         else:
162             if r in end_template.get('Resources', {}):
163                 if rbody != end_template['Resources'][r]:
164                     errors.append('Resource %s from %s conflicts' % (r,
165                                                                      template_path))
166                 continue
167             if 'Resources' not in end_template:
168                 end_template['Resources'] = {}
169             end_template['Resources'][r] = rbody
170
171 def fix_ref(item, old, new):
172     if isinstance(item, dict):
173         copy_item = dict(item)
174         for k, v in sorted(copy_item.items()):
175             if k == 'Ref' and v == old:
176                 item[k] = new
177                 continue
178             if k == 'DependsOn' and v == old:
179                 item[k] = new
180                 continue
181             if k == 'Fn::GetAtt' and isinstance(v, list) and v[0] == old:
182                 new_list = list(v)
183                 new_list[0] = new
184                 item[k] = new_list
185                 continue
186             if k == 'AllowedResources' and isinstance(v, list) and old in v:
187                 while old in v:
188                     pos = v.index(old)
189                     v[pos] = new
190                 continue
191             fix_ref(v, old, new)
192     elif isinstance(item, list):
193         copy_item = list(item)
194         for v in item:
195             fix_ref(v, old, new)
196
197 for change in resource_changes:
198     fix_ref(end_template, change[0], change[1])
199  
200 if errors:
201     for e in errors:
202         sys.stderr.write("ERROR: %s\n" % e)
203 end_template['Description'] = ','.join(end_template['Description'])
204 sys.stdout.write(yaml.safe_dump(end_template, default_flow_style=False))