Bump version to 0.2.8
[snf-image-creator] / image_creator / main.py
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.disk import Disk
38 from image_creator.util import FatalError, MD5
39 from image_creator.output.cli import SilentOutput, SimpleOutput, \
40     OutputWthProgress
41 from image_creator.kamaki_wrapper import Kamaki, ClientError
42 import sys
43 import os
44 import optparse
45 import StringIO
46 import signal
47
48
49 def check_writable_dir(option, opt_str, value, parser):
50     dirname = os.path.dirname(value)
51     name = os.path.basename(value)
52     if dirname and not os.path.isdir(dirname):
53         raise FatalError("`%s' is not an existing directory" % dirname)
54
55     if not name:
56         raise FatalError("`%s' is not a valid file name" % dirname)
57
58     setattr(parser.values, option.dest, value)
59
60
61 def parse_options(input_args):
62     usage = "Usage: %prog [options] <input_media>"
63     parser = optparse.OptionParser(version=version, usage=usage)
64
65     parser.add_option("-o", "--outfile", type="string", dest="outfile",
66                       default=None, action="callback",
67                       callback=check_writable_dir, help="dump image to FILE",
68                       metavar="FILE")
69
70     parser.add_option("-f", "--force", dest="force", default=False,
71                       action="store_true",
72                       help="overwrite output files if they exist")
73
74     parser.add_option("-s", "--silent", dest="silent", default=False,
75                       help="output only errors",
76                       action="store_true")
77
78     parser.add_option("-u", "--upload", dest="upload", type="string",
79                       default=False,
80                       help="upload the image to pithos with name FILENAME",
81                       metavar="FILENAME")
82
83     parser.add_option("-r", "--register", dest="register", type="string",
84                       default=False,
85                       help="register the image with ~okeanos as IMAGENAME",
86                       metavar="IMAGENAME")
87
88     parser.add_option("-m", "--metadata", dest="metadata", default=[],
89                       help="add custom KEY=VALUE metadata to the image",
90                       action="append", metavar="KEY=VALUE")
91
92     parser.add_option("-t", "--token", dest="token", type="string",
93                       default=None, help="use this authentication token when "
94                       "uploading/registering images")
95
96     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
97                       help="print the enabled and disabled system preparation "
98                       "operations for this input media", action="store_true")
99
100     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
101                       help="run SYSPREP operation on the input media",
102                       action="append", metavar="SYSPREP")
103
104     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
105                       help="prevent SYSPREP operation from running on the "
106                       "input media", default=[], action="append",
107                       metavar="SYSPREP")
108
109     parser.add_option("--no-sysprep", dest="sysprep", default=True,
110                       help="don't perform any system preparation operation",
111                       action="store_false")
112
113     parser.add_option("--no-shrink", dest="shrink", default=True,
114                       help="don't shrink any partition", action="store_false")
115
116     parser.add_option("--public", dest="public", default=False,
117                       help="register image with cyclades as public",
118                       action="store_true")
119
120     parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
121                       help="create large temporary image files under DIR",
122                       metavar="DIR")
123
124     options, args = parser.parse_args(input_args)
125
126     if len(args) != 1:
127         parser.error('Wrong number of arguments')
128
129     options.source = args[0]
130     if not os.path.exists(options.source):
131         raise FatalError("Input media `%s' is not accessible" % options.source)
132
133     if options.register and not options.upload:
134         raise FatalError("You also need to set -u when -r option is set")
135
136     if options.upload and options.token is None:
137         raise FatalError(
138             "Image uploading cannot be performed. "
139             "No authentication token is specified. Use -t to set a token")
140
141     if options.tmp is not None and not os.path.isdir(options.tmp):
142         raise FatalError("The directory `%s' specified with --tmpdir is not "
143                          "valid" % options.tmp)
144
145     meta = {}
146     for m in options.metadata:
147         try:
148             key, value = m.split('=', 1)
149         except ValueError:
150             raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
151                              "format." % m)
152         meta[key] = value
153     options.metadata = meta
154
155     return options
156
157
158 def image_creator():
159     options = parse_options(sys.argv[1:])
160
161     if options.outfile is None and not options.upload and not \
162             options.print_sysprep:
163         raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
164                          "must be set")
165
166     if options.silent:
167         out = SilentOutput()
168     else:
169         out = OutputWthProgress(True) if sys.stderr.isatty() else \
170             SimpleOutput(False)
171
172     title = 'snf-image-creator %s' % version
173     out.output(title)
174     out.output('=' * len(title))
175
176     if os.geteuid() != 0:
177         raise FatalError("You must run %s as root"
178                          % os.path.basename(sys.argv[0]))
179
180     if not options.force and options.outfile is not None:
181         for extension in ('', '.meta', '.md5sum'):
182             filename = "%s%s" % (options.outfile, extension)
183             if os.path.exists(filename):
184                 raise FatalError("Output file %s exists "
185                                  "(use --force to overwrite it)" % filename)
186
187     # Check if the authentication token is valid. The earlier the better
188     if options.token is not None:
189         try:
190             account = Kamaki.get_account(options.token)
191             if account is None:
192                 raise FatalError("The authentication token you provided is not"
193                                  " valid!")
194         except ClientError as e:
195             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
196
197     disk = Disk(options.source, out, options.tmp)
198
199     def signal_handler(signum, frame):
200         disk.cleanup()
201
202     signal.signal(signal.SIGINT, signal_handler)
203     signal.signal(signal.SIGTERM, signal_handler)
204     try:
205         snapshot = disk.snapshot()
206
207         image = disk.get_image(snapshot)
208
209         # If no customization is to be applied, the image should be mounted ro
210         ro = (not (options.sysprep or options.shrink) or options.print_sysprep)
211         image.mount(ro)
212         try:
213             for sysprep in options.disabled_syspreps:
214                 image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
215
216             for sysprep in options.enabled_syspreps:
217                 image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
218
219             if options.print_sysprep:
220                 image.os.print_syspreps()
221                 out.output()
222
223             if options.outfile is None and not options.upload:
224                 return 0
225
226             if options.sysprep:
227                 image.os.do_sysprep()
228
229             metadata = image.os.meta
230         finally:
231             image.umount()
232
233         size = options.shrink and image.shrink() or image.size
234         metadata.update(image.meta)
235
236         # Add command line metadata to the collected ones...
237         metadata.update(options.metadata)
238
239         md5 = MD5(out)
240         checksum = md5.compute(image.device, size)
241
242         metastring = '\n'.join(
243             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
244         metastring += '\n'
245
246         if options.outfile is not None:
247             image.dump(options.outfile)
248
249             out.output('Dumping metadata file ...', False)
250             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
251                 f.write(metastring)
252             out.success('done')
253
254             out.output('Dumping md5sum file ...', False)
255             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
256                 f.write('%s %s\n' % (checksum,
257                                      os.path.basename(options.outfile)))
258             out.success('done')
259
260         # Destroy the image instance. We only need the snapshot from now on
261         disk.destroy_image(image)
262
263         out.output()
264         try:
265             uploaded_obj = ""
266             if options.upload:
267                 out.output("Uploading image to pithos:")
268                 kamaki = Kamaki(account, out)
269                 with open(snapshot, 'rb') as f:
270                     uploaded_obj = kamaki.upload(
271                         f, size, options.upload,
272                         "(1/4)  Calculating block hashes",
273                         "(2/4)  Uploading missing blocks")
274
275                 out.output("(3/4)  Uploading metadata file ...", False)
276                 kamaki.upload(StringIO.StringIO(metastring),
277                               size=len(metastring),
278                               remote_path="%s.%s" % (options.upload, 'meta'))
279                 out.success('done')
280                 out.output("(4/4)  Uploading md5sum file ...", False)
281                 md5sumstr = '%s %s\n' % (checksum,
282                                          os.path.basename(options.upload))
283                 kamaki.upload(StringIO.StringIO(md5sumstr),
284                               size=len(md5sumstr),
285                               remote_path="%s.%s" % (options.upload, 'md5sum'))
286                 out.success('done')
287                 out.output()
288
289             if options.register:
290                 img_type = 'public' if options.public else 'private'
291                 out.output('Registering %s image with ~okeanos ...' % img_type,
292                            False)
293                 kamaki.register(options.register, uploaded_obj, metadata,
294                                 options.public)
295                 out.success('done')
296                 out.output()
297         except ClientError as e:
298             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
299
300     finally:
301         out.output('cleaning up ...')
302         disk.cleanup()
303
304     out.success("snf-image-creator exited without errors")
305
306     return 0
307
308
309 def main():
310     try:
311         ret = image_creator()
312         sys.exit(ret)
313     except FatalError as e:
314         colored = sys.stderr.isatty()
315         SimpleOutput(colored).error(e)
316         sys.exit(1)
317
318 if __name__ == '__main__':
319     main()
320
321 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :