summaryrefslogtreecommitdiff
path: root/distbuild/artifact_reference.py
blob: 633ed749bc7b7aebb112921e8fdcd98ceffe1c89 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# distbuild/artifact_reference.py -- Decode/encode ArtifactReference objects
#
# Copyright (C) 2012, 2014-2015  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, see <http://www.gnu.org/licenses/>.


import json
import logging
import yaml

import morphlib


class ArtifactReference(object): # pragma: no cover

    '''Container for some basic information about an artifact.'''

    def __init__(self, basename, encoded):
        self._basename = basename
        self._dict = encoded

    def __str__(self):
        return self._basename

    def __repr__(self):
        return '<ArtifactReference: %s>' % self._basename

    def __getattr__(self, name):
        if not name.startswith('_'):
            return self._dict[name]
        else:
            super(ArtifactReference, self).__getattr__(name)

    def __setattr__(self, name, val):
        if not name.startswith('_'):
            self._dict[name] = val
        else:
            super(ArtifactReference, self).__setattr__(name, val)

    def basename(self):
        return self._basename

    def walk(self):
        done = set()

        def depth_first(a):
            if a not in done:
                done.add(a)
                for dep in a.dependencies:
                    for ret in depth_first(dep):
                        yield ret
                yield a

        return list(depth_first(self))


def encode_artifact(artifact, repo, ref):
    '''Encode part of an Artifact object and dependencies into string form.'''

    def get_source_dict(source):
        source_dict = {
            'filename': source.filename,
            'kind': source.morphology['kind'],
            'source_name': source.name,
            'source_repo': source.repo_name,
            'source_ref': source.original_ref,
            'source_sha1': source.sha1,
            'source_artifact_names': [],
            'dependencies': []
        }
        for dependency in source.dependencies:
            source_dict['dependencies'].append(dependency.basename())
        for source_artifact_name in source.artifacts:
            source_dict['source_artifact_names'].append(source_artifact_name)
        return source_dict

    def get_artifact_dict(a):
        if artifact.source.morphology['kind'] == 'system': # pragma: no cover
            arch = artifact.source.morphology['arch']
        else:
            arch = artifact.arch

        a_dict = {
            'arch': arch,
            'cache_key': a.source.cache_key,
            'name': a.name,
            'repo': repo,
            'ref': ref,
        }
        return a_dict

    encoded_artifacts = {}
    encoded_sources = {}

    root_filename = artifact.source.filename
    for a in artifact.walk():
        if a.basename() not in encoded_artifacts: # pragma: no cover
            encoded_artifacts[a.basename()] = get_artifact_dict(a)
            encoded_sources[a.source.cache_key] = get_source_dict(a.source)

    content = {
        'root-artifact': artifact.basename(),
        'root-filename': root_filename,
        'artifacts': encoded_artifacts,
        'sources': encoded_sources
    }

    return json.dumps(yaml.dump(content))


def encode_artifact_reference(artifact): # pragma: no cover
    '''Encode an ArtifactReference object into string form.

    The ArtifactReference object is encoded such that it can be recreated by
    ``decode_artifact_reference``.

    '''
    artifact_dict = {
        'arch': artifact.arch,
        'cache_key': artifact.cache_key,
        'name': artifact.name,
        'repo': artifact.repo,
        'ref': artifact.ref
    }
    source_dict = {
        'filename': artifact.filename,
        'kind': artifact.kind,
        'source_name': artifact.source_name,
        'source_repo': artifact.source_repo,
        'source_ref': artifact.source_ref,
        'source_sha1': artifact.source_sha1,
        'source_artifact_names': [],
        'dependencies': []
    }

    for dependency in artifact.dependencies:
        source_dict['dependencies'].append(dependency.basename())

    for source_artifact_name in artifact.source_artifact_names:
        source_dict['source_artifact_names'].append(source_artifact_name)

    content = {
        'root-artifact': artifact.basename(),
        'root-filename': artifact.root_filename,
        'artifacts': {artifact.basename(): artifact_dict},
        'sources': {artifact.cache_key: source_dict}
    }

    return json.dumps(yaml.dump(content))


def decode_artifact_reference(encoded):
    '''Decode an ArtifactReference object from `encoded`.

    The argument should be a string returned by ``encode_artifact``
    or ``encode_artifact_reference``. The decoded ArtifactReference
    object will be sufficient to represent a build graph and contain
    enough information to allow `morph worker-build` to calculate a
    build graph and find the original Artifact object it needs to
    build.

    '''
    content = yaml.load(json.loads(encoded))
    root = content['root-artifact']
    encoded_artifacts = content['artifacts']
    encoded_sources = content['sources']

    artifacts = {}

    # decode artifacts
    for basename, artifact_dict in encoded_artifacts.iteritems():
        artifact_dict.update(encoded_sources[artifact_dict['cache_key']])
        artifact = ArtifactReference(basename, artifact_dict)
        artifact.root_filename = content['root-filename']
        artifacts[basename] = artifact

    # add dependencies
    for basename, a_dict in encoded_artifacts.iteritems():
        artifact = artifacts[basename]
        artifact.dependencies = [artifacts.get(dep)
                                 for dep in artifact.dependencies]

    return artifacts[root]