1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
# Copyright (C) 2012-2013 Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import copy
import re
import morphlib
from morphlib.util import OrderedDict, json
class Morphology(object):
'''An in-memory representation of a morphology.
This is a parsed version of the morphology, with rules for default
values applied. No other processing.
'''
static_defaults = {
'chunk': [
('description', ''),
('pre-configure-commands', None),
('configure-commands', None),
('post-configure-commands', None),
('pre-build-commands', None),
('build-commands', None),
('post-build-commands', None),
('pre-test-commands', None),
('test-commands', None),
('post-test-commands', None),
('pre-install-commands', None),
('install-commands', None),
('post-install-commands', None),
('devices', None),
('chunks', []),
('max-jobs', None),
('build-system', 'manual')
],
'stratum': [
('chunks', []),
('description', ''),
('build-depends', None),
],
'system': [
('strata', []),
('description', ''),
('arch', None),
('system-kind', None),
('configuration-extensions', []),
]
}
@staticmethod
def _load_json(text):
return json.loads(text, object_pairs_hook=OrderedDict)
@staticmethod
def _dump_json(obj, f):
text = json.dumps(obj, indent=4)
text = re.sub(" \n", "\n", text)
f.write(text)
f.write('\n')
def __init__(self, text):
self._dict, self._dumper = self._load_morphology_dict(text)
self._set_defaults()
self._validate_children()
def __getitem__(self, key):
return self._dict[key]
def __contains__(self, key):
return key in self._dict
def keys(self):
return self._dict.keys()
def _load_morphology_dict(self, text):
'''Load morphology, identifying whether it is JSON or YAML'''
try:
data = self._load_json(text)
dumper = self._dump_json
except ValueError as e: # pragma: no cover
data = morphlib.yamlparse.load(text)
dumper = morphlib.yamlparse.dump
if data is None:
raise morphlib.YAMLError("Morphology is empty")
if type(data) not in [dict, OrderedDict]:
raise morphlib.YAMLError("Morphology did not parse as a dict")
return data, dumper
def _validate_children(self):
if self['kind'] == 'system':
names = set()
for info in self['strata']:
name = info.get('alias', info['morph'])
if name in names:
raise ValueError('Duplicate stratum "%s"' % name)
names.add(name)
elif self['kind'] == 'stratum':
names = set()
for info in self['chunks']:
name = info.get('alias', info['name'])
if name in names:
raise ValueError('Duplicate chunk "%s"' % name)
names.add(name)
def _set_default_value(self, target_dict, key, value):
'''Change a value in the in-memory representation of the morphology
Record the default value separately, so that when writing out the
morphology we can determine whether the change from the on-disk value
was done at load time, or later on (we want to only write back out
the later, deliberate changes).
'''
target_dict[key] = value
target_dict['_orig_' + key] = value
def _set_defaults(self):
if 'max-jobs' in self:
self._set_default_value(self._dict, 'max-jobs',
int(self['max-jobs']))
if 'disk-size' in self:
self._set_default_value(self._dict, 'disk-size',
self._parse_size(self['disk-size']))
for name, value in self.static_defaults[self['kind']]:
if name not in self._dict:
self._set_default_value(self._dict, name, value)
if self['kind'] == 'stratum':
self._set_stratum_defaults()
def _set_stratum_defaults(self):
for source in self['chunks']:
if 'repo' not in source:
self._set_default_value(source, 'repo', source['name'])
if 'morph' not in source:
self._set_default_value(source, 'morph', source['name'])
if 'build-depends' not in source:
self._set_default_value(source, 'build-depends', None)
if 'build-mode' not in source:
self._set_default_value(source, 'build-mode', 'staging')
if 'prefix' not in source:
self._set_default_value(source, 'prefix', '/usr')
def _parse_size(self, size):
if isinstance(size, basestring):
size = size.lower()
if size.endswith('g'):
return int(size[:-1]) * 1024 ** 3
elif size.endswith('m'): # pragma: no cover
return int(size[:-1]) * 1024 ** 2
elif size.endswith('k'): # pragma: no cover
return int(size[:-1]) * 1024
return int(size) # pragma: no cover
def lookup_child_by_name(self, name):
'''Find child reference by its name.
This lookup honors aliases.
'''
if self['kind'] == 'system':
for info in self['strata']:
source_name = info.get('alias', info['morph'])
if source_name == name:
return info
elif self['kind'] == 'stratum':
for info in self['chunks']:
source_name = info.get('alias', info['morph'])
if source_name == name:
return info
raise KeyError('"%s" not found' % name)
def _apply_changes(self, live_dict, original_dict):
'''Returns a new dict updated with changes from the in-memory object
This allows us to write out a morphology including only the changes
that were done after the morphology was loaded -- not the changes done
to set default values during construction.
'''
output_dict = OrderedDict()
for key in live_dict.keys():
if key.startswith('_orig_'):
continue
value = self._apply_changes_for_key(key, live_dict, original_dict)
if value is not None:
output_dict[key] = value
return output_dict
def _apply_changes_for_key(self, key, live_dict, original_dict):
'''Return value to write out for one key, recursing if necessary'''
live_value = live_dict.get(key, None)
orig_value = original_dict.get(key, None)
if type(live_value) in [dict, OrderedDict] and orig_value is not None:
# Recursively apply changes for dict
result = self._apply_changes(live_value, orig_value)
elif type(live_value) is list and orig_value is not None:
# Recursively apply changes for list (existing, then new items).
result = []
for i in range(0, min(len(orig_value), len(live_value))):
if type(live_value[i]) in [dict, OrderedDict]:
item = self._apply_changes(live_value[i], orig_value[i])
else:
item = live_value[i]
result.append(item)
for i in range(len(orig_value), len(live_value)):
if type(live_value[i]) in [dict, OrderedDict]:
item = self._apply_changes(live_value[i], {})
else:
item = live_value[i]
result.append(item)
else:
# Simple values. Use original value unless it has been changed from
# the default in memmory.
if live_dict[key] == live_dict.get('_orig_' + key, None):
if key in original_dict:
result = original_dict[key]
else:
result = None
else:
result = live_dict[key]
return result
def update_text(self, text, output_fd, convert_to=None):
'''Write out in-memory changes to loaded morphology text
Similar in function to update_file().
'''
original_dict, dumper = self._load_morphology_dict(text)
if convert_to == 'json': # pragma: no cover
dumper = self._dump_json
elif convert_to == 'yaml': # pragma: no cover
dumper = morphlib.yamlparse.dump
output_dict = self._apply_changes(self._dict, original_dict)
dumper(output_dict, output_fd)
def update_file(self, filename, output_fd=None, **kws): # pragma: no cover
'''Write out in-memory changes to on-disk morphology file
This function reads the original morphology text from 'filename', so
that it can avoid writing out properties that are set in memory
to their default value but weren't specified by the user at all.
'''
with open(filename, 'r') as f:
text = f.read()
with output_fd or morphlib.savefile.SaveFile(filename, 'w') as f:
self.update_text(text, f, **kws)
|