Statistics
| Branch: | Tag: | Revision:

root / image_creator / main.py @ 574f2712

History | View | Annotate | Download (10.6 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 get_command, FatalError, MD5
40
from image_creator.output import Output, Output_wth_progress, Silent, \
41
                                                    Silent_wth_colors, error
42
from image_creator.os_type import get_os_class
43
from image_creator.kamaki_wrapper import Kamaki
44
import sys
45
import os
46
import optparse
47
import StringIO
48

    
49

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

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

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

    
61

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

    
66
    account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \
67
        else None
68
    token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \
69
        else None
70

    
71
    parser.add_option("-o", "--outfile", type="string", dest="outfile",
72
        default=None, action="callback", callback=check_writable_dir,
73
        help="dump image to FILE", metavar="FILE")
74

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

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

    
81
    parser.add_option("-u", "--upload", dest="upload", type="string",
82
        default=False, 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, help="register the image to ~okeanos as IMAGENAME",
87
        metavar="IMAGENAME")
88

    
89
    parser.add_option("-a", "--account", dest="account", type="string",
90
        default=account,
91
        help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
92
        % account)
93

    
94
    parser.add_option("-m", "--metadata", dest="metadata", default=[],
95
        help="Add custom KEY=VALUE metadata to the image", action="append",
96
        metavar="KEY=VALUE")
97

    
98
    parser.add_option("-t", "--token", dest="token", type="string",
99
        default=token,
100
        help="Use this token when uploading/registring images [Default: %s]"\
101
        % token)
102

    
103
    parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
104
        help="print the enabled and disabled system preparation operations "
105
        "for this input media", action="store_true")
106

    
107
    parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
108
        help="run SYSPREP operation on the input media",
109
        action="append", metavar="SYSPREP")
110

    
111
    parser.add_option("--disable-sysprep", dest="disabled_syspreps",
112
        help="prevent SYSPREP operation from running on the input media",
113
        default=[], action="append", metavar="SYSPREP")
114

    
115
    parser.add_option("--no-sysprep", dest="sysprep", default=True,
116
        help="don't perform system preperation", action="store_false")
117

    
118
    parser.add_option("--no-shrink", dest="shrink", default=True,
119
        help="don't shrink any partition", action="store_false")
120

    
121
    options, args = parser.parse_args(input_args)
122

    
123
    if len(args) != 1:
124
        parser.error('Wrong number of arguments')
125

    
126
    options.source = args[0]
127
    if not os.path.exists(options.source):
128
        raise FatalError("Input media `%s' is not accessible" % options.source)
129

    
130
    if options.register and options.upload == False:
131
        raise FatalError("You also need to set -u when -r option is set")
132

    
133
    if options.upload and options.account is None:
134
        raise FatalError("Image uploading cannot be performed. No ~okeanos "
135
        "account name is specified. Use -a to set an account name.")
136

    
137
    if options.upload and options.token is None:
138
        raise FatalError("Image uploading cannot be performed. No ~okeanos "
139
        "token is specified. User -t to set a token.")
140

    
141
    meta = {}
142
    for m in options.metadata:
143
        try:
144
            key, value = m.split('=', 1)
145
        except ValueError:
146
            raise FatalError("Metadata option: `%s' is not in "\
147
                                                    "KEY=VALUE format." % m)
148
        meta[key] = value
149
    options.metadata = meta
150

    
151
    return options
152

    
153

    
154
def image_creator():
155
    options = parse_options(sys.argv[1:])
156

    
157
    if options.outfile is None and not options.upload \
158
                                            and not options.print_sysprep:
159
        raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " \
160
                                                                "must be set")
161

    
162
    if options.silent:
163
        out = Silent_wth_colors() if sys.stdout.isatty() else Silent()
164
    else:
165
        out = Output_wth_progress() if sys.stdout.isatty() else Output()
166

    
167
    title = 'snf-image-creator %s' % version
168
    out.output(title)
169
    out.output('=' * len(title))
170

    
171
    if os.geteuid() != 0:
172
        raise FatalError("You must run %s as root" \
173
                        % os.path.basename(sys.argv[0]))
174

    
175
    if not options.force and options.outfile is not None:
176
        for extension in ('', '.meta', '.md5sum'):
177
            filename = "%s%s" % (options.outfile, extension)
178
            if os.path.exists(filename):
179
                raise FatalError("Output file %s exists "
180
                    "(use --force to overwrite it)." % filename)
181

    
182
    disk = Disk(options.source, out)
183
    try:
184
        snapshot = disk.snapshot()
185

    
186
        dev = disk.get_device(snapshot)
187
        dev.mount()
188

    
189
        osclass = get_os_class(dev.distro, dev.ostype)
190
        image_os = osclass(dev.root, dev.g, out)
191
        out.output()
192

    
193
        for sysprep in options.disabled_syspreps:
194
            image_os.disable_sysprep(sysprep)
195

    
196
        for sysprep in options.enabled_syspreps:
197
            image_os.enable_sysprep(sysprep)
198

    
199
        if options.print_sysprep:
200
            image_os.print_syspreps()
201
            out.output()
202

    
203
        if options.outfile is None and not options.upload:
204
            return 0
205

    
206
        if options.sysprep:
207
            image_os.do_sysprep()
208

    
209
        metadata = image_os.meta
210
        dev.umount()
211

    
212
        size = options.shrink and dev.shrink() or dev.meta['SIZE']
213
        metadata.update(dev.meta)
214

    
215
        # Add command line metadata to the collected ones...
216
        metadata.update(options.metadata)
217

    
218
        md5 = MD5(out)
219
        checksum = md5.compute(snapshot, size)
220

    
221
        metastring = '\n'.join(
222
                ['%s=%s' % (key, value) for (key, value) in metadata.items()])
223
        metastring += '\n'
224

    
225
        if options.outfile is not None:
226
            dev.dump(options.outfile)
227

    
228
            out.output('Dumping metadata file...', False)
229
            with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
230
                f.write(metastring)
231
            out.success('done')
232

    
233
            out.output('Dumping md5sum file...', False)
234
            with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
235
                f.write('%s %s\n' % (checksum, \
236
                                            os.path.basename(options.outfile)))
237
            out.success('done')
238

    
239
        # Destroy the device. We only need the snapshot from now on
240
        disk.destroy_device(dev)
241

    
242
        out.output()
243

    
244
        uploaded_obj = ""
245
        if options.upload:
246
            out.output("Uploading image to pithos:")
247
            kamaki = Kamaki(options.account, options.token, out)
248
            with open(snapshot) as f:
249
                uploaded_obj = kamaki.upload(f, size, options.upload,
250
                                "(1/4)  Calculating block hashes",
251
                                "(2/4)  Uploading missing blocks")
252

    
253
            out.output("(3/4)  Uploading metadata file...", False)
254
            kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
255
                                remote_path="%s.%s" % (options.upload, 'meta'))
256
            out.success('done')
257
            out.output("(4/4)  Uploading md5sum file...", False)
258
            md5sumstr = '%s %s\n' % (
259
                checksum, os.path.basename(options.upload))
260
            kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
261
                            remote_path="%s.%s" % (options.upload, 'md5sum'))
262
            out.success('done')
263
            out.output()
264

    
265
        if options.register:
266
            out.output('Registring image to ~okeanos...', False)
267
            kamaki.register(options.register, uploaded_obj, metadata)
268
            out.success('done')
269
            out.output()
270

    
271
    finally:
272
        out.output('cleaning up...')
273
        disk.cleanup()
274

    
275
    out.success("snf-image-creator exited without errors")
276

    
277
    return 0
278

    
279

    
280
def main():
281
    try:
282
        ret = image_creator()
283
        sys.exit(ret)
284
    except FatalError as e:
285
        if sys.stdout.isatty():
286
            error(e)
287
        else:
288
            error(e, True, False)
289
        sys.exit(1)
290

    
291

    
292
if __name__ == '__main__':
293
    main()
294

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