summaryrefslogtreecommitdiff
path: root/morphlib/morph2.py
blob: 6e24765ed7afaa46fe45b18fdb511fcaf775546f (plain)
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
# 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', ''),
            ('configure-commands', None),
            ('build-commands', None),
            ('test-commands', None),
            ('install-commands', 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):
        # Load as JSON first, then try YAML, so morphologies
        # that read as JSON are dumped as JSON, likewise with YAML.
        try:
            self._dict = self._load_json(text)
            self._dumper = self._dump_json
        except Exception, e: # pragma: no cover
            self._dict = morphlib.yamlparse.load(text)
            self._dumper = morphlib.yamlparse.dump
        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 _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 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 _set_defaults(self):
        if 'max-jobs' in self:
            self._dict['max-jobs'] = int(self['max-jobs'])

        if 'disk-size' in self:
            size = self['disk-size']
            self._dict['_disk-size'] = size
            self._dict['disk-size'] = self._parse_size(size)

        for name, value in self.static_defaults[self['kind']]:
            if name not in self._dict:
                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:
                source['repo'] = source['name']
            if 'morph' not in source:
                source['morph'] = source['name']
            if 'build-depends' not in source:
                source['build-depends'] = None

    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 write_to_file(self, f): # pragma: no cover
        # Recreate dict without the empty default values, with a few kind
        # specific hacks to try and edit standard morphologies as
        # non-destructively as possible
        as_dict = OrderedDict()
        for key in self.keys():
            if self['kind'] == 'stratum' and key == 'chunks':
                value = copy.copy(self[key])
                for chunk in value:
                    if chunk["morph"] == chunk["name"]:
                        del chunk["morph"]
            if self['kind'] == 'system' and key == 'disk-size':
                # Use human-readable value (assumes we never programmatically
                # change this value within morph)
                value = self['_disk-size']
            else:
                value = self[key]
            if value and key[0] != '_':
                as_dict[key] = value
        self._dumper(as_dict, f)