Fix a warning message in linux fix_acpid sysprep
[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 get_command, 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", 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 = SilentOutput()
164     else:
165         out = OutputWthProgress(True) if sys.stderr.isatty() else \
166                                                             SimpleOutput(False)
167
168     title = 'snf-image-creator %s' % version
169     out.output(title)
170     out.output('=' * len(title))
171
172     if os.geteuid() != 0:
173         raise FatalError("You must run %s as root" \
174                         % os.path.basename(sys.argv[0]))
175
176     if not options.force and options.outfile is not None:
177         for extension in ('', '.meta', '.md5sum'):
178             filename = "%s%s" % (options.outfile, extension)
179             if os.path.exists(filename):
180                 raise FatalError("Output file %s exists "
181                     "(use --force to overwrite it)." % filename)
182
183     disk = Disk(options.source, out)
184     try:
185         snapshot = disk.snapshot()
186
187         dev = disk.get_device(snapshot)
188
189         # If no customization is to be applied, the image should be mounted ro
190         readonly = not (options.sysprep or options.shrink)
191         dev.mount(readonly)
192
193         cls = os_cls(dev.distro, dev.ostype)
194         image_os = cls(dev.root, dev.g, out)
195         out.output()
196
197         for sysprep in options.disabled_syspreps:
198             image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
199
200         for sysprep in options.enabled_syspreps:
201             image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
202
203         if options.print_sysprep:
204             image_os.print_syspreps()
205             out.output()
206
207         if options.outfile is None and not options.upload:
208             return 0
209
210         if options.sysprep:
211             image_os.do_sysprep()
212
213         metadata = image_os.meta
214         dev.umount()
215
216         size = options.shrink and dev.shrink() or dev.meta['SIZE']
217         metadata.update(dev.meta)
218
219         # Add command line metadata to the collected ones...
220         metadata.update(options.metadata)
221
222         md5 = MD5(out)
223         checksum = md5.compute(snapshot, size)
224
225         metastring = '\n'.join(
226                 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
227         metastring += '\n'
228
229         if options.outfile is not None:
230             dev.dump(options.outfile)
231
232             out.output('Dumping metadata file...', False)
233             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
234                 f.write(metastring)
235             out.success('done')
236
237             out.output('Dumping md5sum file...', False)
238             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
239                 f.write('%s %s\n' % (checksum, \
240                                             os.path.basename(options.outfile)))
241             out.success('done')
242
243         # Destroy the device. We only need the snapshot from now on
244         disk.destroy_device(dev)
245
246         out.output()
247         try:
248             uploaded_obj = ""
249             if options.upload:
250                 out.output("Uploading image to pithos:")
251                 kamaki = Kamaki(options.account, options.token, out)
252                 with open(snapshot, 'rb') as f:
253                     uploaded_obj = kamaki.upload(f, size, options.upload,
254                                             "(1/4)  Calculating block hashes",
255                                             "(2/4)  Uploading missing blocks")
256
257                 out.output("(3/4)  Uploading metadata file...", False)
258                 kamaki.upload(StringIO.StringIO(metastring),
259                               size=len(metastring),
260                               remote_path="%s.%s" % (options.upload, 'meta'))
261                 out.success('done')
262                 out.output("(4/4)  Uploading md5sum file...", False)
263                 md5sumstr = '%s %s\n' % (
264                                     checksum, os.path.basename(options.upload))
265                 kamaki.upload(StringIO.StringIO(md5sumstr),
266                               size=len(md5sumstr),
267                               remote_path="%s.%s" % (options.upload, 'md5sum'))
268                 out.success('done')
269                 out.output()
270
271             if options.register:
272                 out.output('Registring image to ~okeanos...', False)
273                 kamaki.register(options.register, uploaded_obj, metadata)
274                 out.success('done')
275                 out.output()
276         except ClientError as e:
277             raise FatalError("Pithos client: %d %s" % (e.status, e.message))
278
279     finally:
280         out.output('cleaning up...')
281         disk.cleanup()
282
283     out.success("snf-image-creator exited without errors")
284
285     return 0
286
287
288 def main():
289     try:
290         ret = image_creator()
291         sys.exit(ret)
292     except FatalError as e:
293         colored = sys.stderr.isatty()
294         SimpleOutput(colored).error(e)
295         sys.exit(1)
296
297 if __name__ == '__main__':
298     main()
299
300 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :