3 # Copyright 2012 GRNET S.A. All rights reserved.
5 # Redistribution and use in source and binary forms, with or
6 # without modification, are permitted provided that the following
9 # 1. Redistributions of source code must retain the above
10 # copyright notice, this list of conditions and the following
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.
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.
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.
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, \
42 from image_creator.os_type import os_cls
43 from image_creator.kamaki_wrapper import Kamaki, ClientError
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)
57 raise FatalError("`%s' is not a valid file name" % dirname)
59 setattr(parser.values, option.dest, value)
62 def parse_options(input_args):
63 usage = "Usage: %prog [options] <input_media>"
64 parser = optparse.OptionParser(version=version, usage=usage)
66 account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \
68 token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \
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",
76 parser.add_option("-f", "--force", dest="force", default=False,
78 help="overwrite output files if they exist")
80 parser.add_option("-s", "--silent", dest="silent", default=False,
81 help="silent mode, only output errors",
84 parser.add_option("-u", "--upload", dest="upload", type="string",
86 help="upload the image to pithos with name FILENAME",
89 parser.add_option("-r", "--register", dest="register", type="string",
91 help="register the image with ~okeanos as IMAGENAME",
94 parser.add_option("-a", "--account", dest="account", type="string",
95 default=account, help="Use this ACCOUNT when "
96 "uploading/registering images [Default: %s]" % account)
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")
102 parser.add_option("-t", "--token", dest="token", type="string",
103 default=token, help="Use this token when "
104 "uploading/registering images [Default: %s]" % token)
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")
110 parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
111 help="run SYSPREP operation on the input media",
112 action="append", metavar="SYSPREP")
114 parser.add_option("--disable-sysprep", dest="disabled_syspreps",
115 help="prevent SYSPREP operation from running on the "
116 "input media", default=[], action="append",
119 parser.add_option("--no-sysprep", dest="sysprep", default=True,
120 help="don't perform system preparation",
121 action="store_false")
123 parser.add_option("--no-shrink", dest="shrink", default=True,
124 help="don't shrink any partition", action="store_false")
126 options, args = parser.parse_args(input_args)
129 parser.error('Wrong number of arguments')
131 options.source = args[0]
132 if not os.path.exists(options.source):
133 raise FatalError("Input media `%s' is not accessible" % options.source)
135 if options.register and not options.upload:
136 raise FatalError("You also need to set -u when -r option is set")
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 "
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.")
148 for m in options.metadata:
150 key, value = m.split('=', 1)
152 raise FatalError("Metadata option: `%s' is not in "
153 "KEY=VALUE format." % m)
155 options.metadata = meta
161 options = parse_options(sys.argv[1:])
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' "
171 out = OutputWthProgress(True) if sys.stderr.isatty() else \
174 title = 'snf-image-creator %s' % version
176 out.output('=' * len(title))
178 if os.geteuid() != 0:
179 raise FatalError("You must run %s as root"
180 % os.path.basename(sys.argv[0]))
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)
189 disk = Disk(options.source, out)
191 snapshot = disk.snapshot()
193 dev = disk.get_device(snapshot)
195 # If no customization is to be applied, the image should be mounted ro
196 readonly = (not (options.sysprep or options.shrink) or
197 options.print_sysprep)
200 cls = os_cls(dev.distro, dev.ostype)
201 image_os = cls(dev.root, dev.g, out)
204 for sysprep in options.disabled_syspreps:
205 image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
207 for sysprep in options.enabled_syspreps:
208 image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
210 if options.print_sysprep:
211 image_os.print_syspreps()
214 if options.outfile is None and not options.upload:
218 image_os.do_sysprep()
220 metadata = image_os.meta
223 size = options.shrink and dev.shrink() or dev.size
224 metadata.update(dev.meta)
226 # Add command line metadata to the collected ones...
227 metadata.update(options.metadata)
230 checksum = md5.compute(snapshot, size)
232 metastring = '\n'.join(
233 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
236 if options.outfile is not None:
237 dev.dump(options.outfile)
239 out.output('Dumping metadata file...', False)
240 with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
244 out.output('Dumping md5sum file...', False)
245 with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
246 f.write('%s %s\n' % (checksum,
247 os.path.basename(options.outfile)))
250 # Destroy the device. We only need the snapshot from now on
251 disk.destroy_device(dev)
257 out.output("Uploading image to pithos:")
258 kamaki = Kamaki(options.account, options.token, out)
259 with open(snapshot, 'rb') as f:
260 uploaded_obj = kamaki.upload(f, size, options.upload,
261 "(1/4) Calculating block "
263 "(2/4) Uploading missing "
266 out.output("(3/4) Uploading metadata file...", False)
267 kamaki.upload(StringIO.StringIO(metastring),
268 size=len(metastring),
269 remote_path="%s.%s" % (options.upload, 'meta'))
271 out.output("(4/4) Uploading md5sum file...", False)
272 md5sumstr = '%s %s\n' % (checksum,
273 os.path.basename(options.upload))
274 kamaki.upload(StringIO.StringIO(md5sumstr),
276 remote_path="%s.%s" % (options.upload, 'md5sum'))
281 out.output('Registering image with ~okeanos...', False)
282 kamaki.register(options.register, uploaded_obj, metadata)
285 except ClientError as e:
286 raise FatalError("Pithos client: %d %s" % (e.status, e.message))
289 out.output('cleaning up...')
292 out.success("snf-image-creator exited without errors")
299 ret = image_creator()
301 except FatalError as e:
302 colored = sys.stderr.isatty()
303 SimpleOutput(colored).error(e)
306 if __name__ == '__main__':
309 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :