summaryrefslogtreecommitdiff
path: root/morphlib/plugins/artifact_inspection_plugin.py
blob: 0ff04bef7020dd509f3f4bc914f1b2fa912c437b (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
# 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 cliapp
import glob
import json
import os

import morphlib

from morphlib.bins import call_in_artifact_directory
from morphlib.extractedtarball import ExtractedTarball
from morphlib.mountableimage import MountableImage


class NotASystemArtifactError(cliapp.AppException):

    def __init__(self, artifact):
        cliapp.AppException.__init__(
                self, '%s is not a system artifact' % artifact)


class ManifestGenerator(object):

    def __init__(self, app):
        self.app = app

    def generate(self, artifact, dirname):
        # Try to find a directory with baserock metadata files.
        metadirs = [
            os.path.join(dirname, 'factory', 'baserock'),
            os.path.join(dirname, 'baserock')
        ]
        existing_metadirs = [x for x in metadirs if os.path.isdir(x)]
        if not existing_metadirs:
            raise NotASystemArtifactError(artifact)
        metadir = existing_metadirs[0]

        # Collect all meta information about the system, its strata
        # and its chunks that we are interested in.
        artifacts = []
        for basename in glob.glob(os.path.join(metadir, '*.meta')):
            metafile = os.path.join(metadir, basename)
            metadata = json.load(open(metafile))
        
            artifacts.append({
                'cache-key': metadata['cache-key'],
                'name': metadata['artifact-name'],
                'kind': metadata['kind'],
                'sha1': metadata['sha1'],
                'original_ref': metadata['original_ref'],
                'repo': metadata['repo'],
                'morphology': metadata['morphology']
            })
        
        # Generate a format string for dumping the information.
        fmt = self._generate_output_format(artifacts)
        
        # Print information about system, strata and chunks.
        self._print_artifacts(fmt, artifacts, 'system')
        self._print_artifacts(fmt, artifacts, 'stratum')
        self._print_artifacts(fmt, artifacts, 'chunk')

    def _generate_output_format(self, artifacts):
        colwidths = {}
        for artifact in artifacts:
            for key, value in artifact.iteritems():
                colwidths[key] = max(colwidths.get(key, 0), len(value))

        colwidths['first'] = sum([colwidths['cache-key'],
                                  colwidths['kind'],
                                  colwidths['name']]) + 1

        return 'artifact=%%-%is\t' \
               'version=%%-%is\t' \
               'commit=%%-%is\t' \
               'repository=%%-%is\t' \
               'ref=%%-%is\t' \
               'morphology=%%-%is\n' % (
                len('artifact=') + colwidths['first'],
                len('version=') + colwidths['version'],
                len('commit=') + colwidths['sha1'],
                len('repository=') + colwidths['repo'],
                len('ref=') + colwidths['original_ref'],
                len('morphology=') + colwidths['morphology'])

    def _print_artifacts(self, fmt, artifacts, kind):
        for artifact in sorted(artifacts, key=lambda x: x['name']):
            if artifact['kind'] == kind:
                self.app.output.write(fmt % (
                    '%s.%s.%s' % (artifact['cache-key'],
                                  artifact['kind'],
                                  artifact['name']),
                    artifact['version'],
                    artifact['sha1'],
                    artifact['repo'],
                    artifact['original_ref'],
                    artifact['morphology']))


class ArtifactInspectionPlugin(cliapp.Plugin):

    def enable(self):
        self.app.add_subcommand('run-in-artifact',
                                self.run_in_artifact,
                                arg_synopsis='ARTIFACT CMD')
        self.app.add_subcommand('generate-manifest',
                                self.generate_manifest,
                                arg_synopsis='ROOTFS_ARTIFACT')

    def disable(self):
        pass

    def run_in_artifact(self, args):
        '''Run a command inside an extracted/mounted chunk or system.'''

        if len(args) < 2:
            raise cliapp.AppException(
                    'run-in-artifact requires arguments: a chunk or '
                    'system artifact and a a shell command')

        artifact, cmd = args[0], args[1:]

        def run_command_in_dir(dirname):
            output = self.app.runcmd(cmd, cwd=dirname)
            self.app.output.write(output)

        call_in_artifact_directory(self.app, artifact, run_command_in_dir)

    def generate_manifest(self, args):
        '''Generate a content manifest for a system image.'''

        if len(args) != 1:
            raise cliapp.AppException('morph generate-manifest expects '
                                      'a system image as its input')

        artifact = args[0]

        def generate_manifest(dirname):
            generator = ManifestGenerator(self.app)
            generator.generate(artifact, dirname)

        call_in_artifact_directory(self.app, artifact, generate_manifest)