Statistics
| Branch: | Tag: | Revision:

root / image_creator / main.py @ c2cf27e8

History | View | Annotate | Download (12.1 kB)

1
#!/usr/bin/env python
2

    
3
# Copyright 2012 GRNET S.A. All rights reserved.
4
#
5
# Redistribution and use in source and binary forms, with or
6
# without modification, are permitted provided that the following
7
# conditions are met:
8
#
9
#   1. Redistributions of source code must retain the above
10
#      copyright notice, this list of conditions and the following
11
#      disclaimer.
12
#
13
#   2. Redistributions in binary form must reproduce the above
14
#      copyright notice, this list of conditions and the following
15
#      disclaimer in the documentation and/or other materials
16
#      provided with the distribution.
17
#
18
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29
# POSSIBILITY OF SUCH DAMAGE.
30
#
31
# The views and conclusions contained in the software and
32
# documentation are those of the authors and should not be
33
# interpreted as representing official policies, either expressed
34
# or implied, of GRNET S.A.
35

    
36
from image_creator import __version__ as version
37
from image_creator import util
38
from image_creator.disk import Disk
39
from image_creator.util import FatalError, MD5
40
from image_creator.output.cli import SilentOutput, SimpleOutput, \
41
    OutputWthProgress
42
from image_creator.os_type import os_cls
43
from image_creator.kamaki_wrapper import Kamaki, ClientError
44
import sys
45
import os
46
import optparse
47
import StringIO
48
import signal
49

    
50

    
51
def check_writable_dir(option, opt_str, value, parser):
52
    dirname = os.path.dirname(value)
53
    name = os.path.basename(value)
54
    if dirname and not os.path.isdir(dirname):
55
        raise FatalError("`%s' is not an existing directory" % dirname)
56

    
57
    if not name:
58
        raise FatalError("`%s' is not a valid file name" % dirname)
59

    
60
    setattr(parser.values, option.dest, value)
61

    
62

    
63
def parse_options(input_args):
64
    usage = "Usage: %prog [options] <input_media>"
65
    parser = optparse.OptionParser(version=version, usage=usage)
66

    
67
    parser.add_option("-o", "--outfile", type="string", dest="outfile",
68
                      default=None, action="callback",
69
                      callback=check_writable_dir, help="dump image to FILE",
70
                      metavar="FILE")
71

    
72
    parser.add_option("-f", "--force", dest="force", default=False,
73
                      action="store_true",
74
                      help="overwrite output files if they exist")
75

    
76
    parser.add_option("-s", "--silent", dest="silent", default=False,
77
                      help="output only errors",
78
                      action="store_true")
79

    
80
    parser.add_option("-u", "--upload", dest="upload", type="string",
81
                      default=False,
82
                      help="upload the image to pithos with name FILENAME",
83
                      metavar="FILENAME")
84

    
85
    parser.add_option("-r", "--register", dest="register", type="string",
86
                      default=False,
87
                      help="register the image with ~okeanos as IMAGENAME",
88
                      metavar="IMAGENAME")
89

    
90
    parser.add_option("-m", "--metadata", dest="metadata", default=[],
91
                      help="add custom KEY=VALUE metadata to the image",
92
                      action="append", metavar="KEY=VALUE")
93

    
94
    parser.add_option("-t", "--token", dest="token", type="string",
95
                      default=None, help="use this authentication token when "
96
                      "uploading/registering images")
97

    
98
    parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
99
                      help="print the enabled and disabled system preparation "
100
                      "operations for this input media", action="store_true")
101

    
102
    parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
103
                      help="run SYSPREP operation on the input media",
104
                      action="append", metavar="SYSPREP")
105

    
106
    parser.add_option("--disable-sysprep", dest="disabled_syspreps",
107
                      help="prevent SYSPREP operation from running on the "
108
                      "input media", default=[], action="append",
109
                      metavar="SYSPREP")
110

    
111
    parser.add_option("--no-sysprep", dest="sysprep", default=True,
112
                      help="don't perform any system preparation operation",
113
                      action="store_false")
114

    
115
    parser.add_option("--no-shrink", dest="shrink", default=True,
116
                      help="don't shrink any partition", action="store_false")
117

    
118
    parser.add_option("--public", dest="public", default=False,
119
                      help="register image with cyclades as public",
120
                      action="store_true")
121

    
122
    parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
123
                      help="create large temporary image files under DIR",
124
                      metavar="DIR")
125

    
126
    options, args = parser.parse_args(input_args)
127

    
128
    if len(args) != 1:
129
        parser.error('Wrong number of arguments')
130

    
131
    options.source = args[0]
132
    if not os.path.exists(options.source):
133
        raise FatalError("Input media `%s' is not accessible" % options.source)
134

    
135
    if options.register and not options.upload:
136
        raise FatalError("You also need to set -u when -r option is set")
137

    
138
    if options.upload and options.token is None:
139
        raise FatalError(
140
            "Image uploading cannot be performed. "
141
            "No authentication token is specified. Use -t to set a token")
142

    
143
    if options.tmp is not None and not os.path.isdir(options.tmp):
144
        raise FatalError("The directory `%s' specified with --tmpdir is not "
145
                         "valid" % options.tmp)
146

    
147
    meta = {}
148
    for m in options.metadata:
149
        try:
150
            key, value = m.split('=', 1)
151
        except ValueError:
152
            raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
153
                             "format." % m)
154
        meta[key] = value
155
    options.metadata = meta
156

    
157
    return options
158

    
159

    
160
def image_creator():
161
    options = parse_options(sys.argv[1:])
162

    
163
    if options.outfile is None and not options.upload and not \
164
            options.print_sysprep:
165
        raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
166
                         "must be set")
167

    
168
    if options.silent:
169
        out = SilentOutput()
170
    else:
171
        out = OutputWthProgress(True) if sys.stderr.isatty() else \
172
            SimpleOutput(False)
173

    
174
    title = 'snf-image-creator %s' % version
175
    out.output(title)
176
    out.output('=' * len(title))
177

    
178
    if os.geteuid() != 0:
179
        raise FatalError("You must run %s as root"
180
                         % os.path.basename(sys.argv[0]))
181

    
182
    if not options.force and options.outfile is not None:
183
        for extension in ('', '.meta', '.md5sum'):
184
            filename = "%s%s" % (options.outfile, extension)
185
            if os.path.exists(filename):
186
                raise FatalError("Output file %s exists "
187
                                 "(use --force to overwrite it)" % filename)
188

    
189
    # Check if the authentication token is valid. The earlier the better
190
    if options.token is not None:
191
        try:
192
            account = Kamaki.get_account(options.token)
193
            if account is None:
194
                raise FatalError("The authentication token you provided is not"
195
                                 " valid!")
196
        except ClientError as e:
197
            raise FatalError("Astakos client: %d %s" % (e.status, e.message))
198

    
199

    
200
    disk = Disk(options.source, out, options.tmp)
201

    
202
    def signal_handler(signum, frame):
203
        disk.cleanup()
204

    
205
    signal.signal(signal.SIGINT, signal_handler)
206
    signal.signal(signal.SIGTERM, signal_handler)
207
    try:
208
        snapshot = disk.snapshot()
209

    
210
        dev = disk.get_device(snapshot)
211

    
212
        # If no customization is to be applied, the image should be mounted ro
213
        readonly = (not (options.sysprep or options.shrink) or
214
                    options.print_sysprep)
215
        dev.mount(readonly)
216

    
217
        cls = os_cls(dev.distro, dev.ostype)
218
        image_os = cls(dev.root, dev.g, out)
219
        out.output()
220

    
221
        for sysprep in options.disabled_syspreps:
222
            image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
223

    
224
        for sysprep in options.enabled_syspreps:
225
            image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
226

    
227
        if options.print_sysprep:
228
            image_os.print_syspreps()
229
            out.output()
230

    
231
        if options.outfile is None and not options.upload:
232
            return 0
233

    
234
        if options.sysprep:
235
            image_os.do_sysprep()
236

    
237
        metadata = image_os.meta
238
        dev.umount()
239

    
240
        size = options.shrink and dev.shrink() or dev.size
241
        metadata.update(dev.meta)
242

    
243
        # Add command line metadata to the collected ones...
244
        metadata.update(options.metadata)
245

    
246
        md5 = MD5(out)
247
        checksum = md5.compute(snapshot, size)
248

    
249
        metastring = '\n'.join(
250
            ['%s=%s' % (key, value) for (key, value) in metadata.items()])
251
        metastring += '\n'
252

    
253
        if options.outfile is not None:
254
            dev.dump(options.outfile)
255

    
256
            out.output('Dumping metadata file ...', False)
257
            with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
258
                f.write(metastring)
259
            out.success('done')
260

    
261
            out.output('Dumping md5sum file ...', False)
262
            with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
263
                f.write('%s %s\n' % (checksum,
264
                                     os.path.basename(options.outfile)))
265
            out.success('done')
266

    
267
        # Destroy the device. We only need the snapshot from now on
268
        disk.destroy_device(dev)
269

    
270
        out.output()
271
        try:
272
            uploaded_obj = ""
273
            if options.upload:
274
                out.output("Uploading image to pithos:")
275
                kamaki = Kamaki(account, out)
276
                with open(snapshot, 'rb') as f:
277
                    uploaded_obj = kamaki.upload(
278
                        f, size, options.upload,
279
                        "(1/4)  Calculating block hashes",
280
                        "(2/4)  Uploading missing blocks")
281

    
282
                out.output("(3/4)  Uploading metadata file ...", False)
283
                kamaki.upload(StringIO.StringIO(metastring),
284
                              size=len(metastring),
285
                              remote_path="%s.%s" % (options.upload, 'meta'))
286
                out.success('done')
287
                out.output("(4/4)  Uploading md5sum file ...", False)
288
                md5sumstr = '%s %s\n' % (checksum,
289
                                         os.path.basename(options.upload))
290
                kamaki.upload(StringIO.StringIO(md5sumstr),
291
                              size=len(md5sumstr),
292
                              remote_path="%s.%s" % (options.upload, 'md5sum'))
293
                out.success('done')
294
                out.output()
295

    
296
            if options.register:
297
                img_type = 'public' if options.public else 'private'
298
                out.output('Registering %s image with ~okeanos ...' % img_type,
299
                           False)
300
                kamaki.register(options.register, uploaded_obj, metadata,
301
                                options.public)
302
                out.success('done')
303
                out.output()
304
        except ClientError as e:
305
            raise FatalError("Pithos client: %d %s" % (e.status, e.message))
306

    
307
    finally:
308
        out.output('cleaning up ...')
309
        disk.cleanup()
310

    
311
    out.success("snf-image-creator exited without errors")
312

    
313
    return 0
314

    
315

    
316
def main():
317
    try:
318
        ret = image_creator()
319
        sys.exit(ret)
320
    except FatalError as e:
321
        colored = sys.stderr.isatty()
322
        SimpleOutput(colored).error(e)
323
        sys.exit(1)
324

    
325
if __name__ == '__main__':
326
    main()
327

    
328
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :