When in wizard mode, allow local image dumping
[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 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
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",
73                       callback=check_writable_dir, help="dump image to FILE",
74                       metavar="FILE")
75
76     parser.add_option("-f", "--force", dest="force", default=False,
77                       action="store_true",
78                       help="overwrite output files if they exist")
79
80     parser.add_option("-s", "--silent", dest="silent", default=False,
81                       help="silent mode, only output errors",
82                       action="store_true")
83
84     parser.add_option("-u", "--upload", dest="upload", type="string",
85                       default=False,
86                       help="upload the image to pithos with name FILENAME",
87                       metavar="FILENAME")
88
89     parser.add_option("-r", "--register", dest="register", type="string",
90                       default=False,
91                       help="register the image to ~okeanos as IMAGENAME",
92                       metavar="IMAGENAME")
93
94     parser.add_option("-a", "--account", dest="account", type="string",
95                       default=account, help="Use this ACCOUNT when "
96                       "uploading/registring images [Default: %s]" % account)
97
98     parser.add_option("-m", "--metadata", dest="metadata", default=[],
99                       help="Add custom KEY=VALUE metadata to the image",
100                       action="append", metavar="KEY=VALUE")
101
102     parser.add_option("-t", "--token", dest="token", type="string",
103                       default=token, help="Use this token when "
104                       "uploading/registring images [Default: %s]" % token)
105
106     parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
107                       help="print the enabled and disabled system preparation "
108                       "operations for this input media", action="store_true")
109
110     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
111                       help="run SYSPREP operation on the input media",
112                       action="append", metavar="SYSPREP")
113
114     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
115                       help="prevent SYSPREP operation from running on the "
116                       "input media", default=[], action="append",
117                       metavar="SYSPREP")
118
119     parser.add_option("--no-sysprep", dest="sysprep", default=True,
120                       help="don't perform system preperation",
121                       action="store_false")
122
123     parser.add_option("--no-shrink", dest="shrink", default=True,
124                       help="don't shrink any partition", action="store_false")
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.account is None:
139         raise FatalError("Image uploading cannot be performed. No ~okeanos "
140                          "account name is specified. Use -a to set an account "
141                          "name.")
142
143     if options.upload and options.token is None:
144         raise FatalError("Image uploading cannot be performed. No ~okeanos "
145                          "token is specified. User -t to set a token.")
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 "
153                              "KEY=VALUE 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     disk = Disk(options.source, out)
190     try:
191         snapshot = disk.snapshot()
192
193         dev = disk.get_device(snapshot)
194
195         # If no customization is to be applied, the image should be mounted ro
196         readonly = not (options.sysprep or options.shrink)
197         dev.mount(readonly)
198
199         cls = os_cls(dev.distro, dev.ostype)
200         image_os = cls(dev.root, dev.g, out)
201         out.output()
202
203         for sysprep in options.disabled_syspreps:
204             image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
205
206         for sysprep in options.enabled_syspreps:
207             image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
208
209         if options.print_sysprep:
210             image_os.print_syspreps()
211             out.output()
212
213         if options.outfile is None and not options.upload:
214             return 0
215
216         if options.sysprep:
217             image_os.do_sysprep()
218
219         metadata = image_os.meta
220         dev.umount()
221
222         size = options.shrink and dev.shrink() or dev.size
223         metadata.update(dev.meta)
224
225         # Add command line metadata to the collected ones...
226         metadata.update(options.metadata)
227
228         md5 = MD5(out)
229         checksum = md5.compute(snapshot, size)
230
231         metastring = '\n'.join(
232             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
233         metastring += '\n'
234
235         if options.outfile is not None:
236             dev.dump(options.outfile)
237
238             out.output('Dumping metadata file...', False)
239             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
240                 f.write(metastring)
241             out.success('done')
242
243             out.output('Dumping md5sum file...', False)
244             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
245                 f.write('%s %s\n' % (checksum,
246                                      os.path.basename(options.outfile)))
247             out.success('done')
248
249         # Destroy the device. We only need the snapshot from now on
250         disk.destroy_device(dev)
251
252         out.output()
253         try:
254             uploaded_obj = ""
255             if options.upload:
256                 out.output("Uploading image to pithos:")
257                 kamaki = Kamaki(options.account, options.token, out)
258                 with open(snapshot, 'rb') as f:
259                     uploaded_obj = kamaki.upload(f, size, options.upload,
260                                                  "(1/4)  Calculating block "
261                                                  "hashes",
262                                                  "(2/4)  Uploading missing "
263                                                  "blocks")
264
265                 out.output("(3/4)  Uploading metadata file...", False)
266                 kamaki.upload(StringIO.StringIO(metastring),
267                               size=len(metastring),
268                               remote_path="%s.%s" % (options.upload, 'meta'))
269                 out.success('done')
270                 out.output("(4/4)  Uploading md5sum file...", False)
271                 md5sumstr = '%s %s\n' % (checksum,
272                                          os.path.basename(options.upload))
273                 kamaki.upload(StringIO.StringIO(md5sumstr),
274                               size=len(md5sumstr),
275                               remote_path="%s.%s" % (options.upload, 'md5sum'))
276                 out.success('done')
277                 out.output()
278
279             if options.register:
280                 out.output('Registring image to ~okeanos...', False)
281                 kamaki.register(options.register, uploaded_obj, metadata)
282                 out.success('done')
283                 out.output()
284         except ClientError as e:
285             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
286
287     finally:
288         out.output('cleaning up...')
289         disk.cleanup()
290
291     out.success("snf-image-creator exited without errors")
292
293     return 0
294
295
296 def main():
297     try:
298         ret = image_creator()
299         sys.exit(ret)
300     except FatalError as e:
301         colored = sys.stderr.isatty()
302         SimpleOutput(colored).error(e)
303         sys.exit(1)
304
305 if __name__ == '__main__':
306     main()
307
308 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :