3 # Copyright 2011 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 get_os_class
37 from image_creator import __version__ as version
38 from image_creator import util
39 from image_creator.disk import Disk
40 from image_creator.util import get_command, error, success, output, \
41 FatalError, progress, md5
42 from image_creator.kamaki_wrapper import Kamaki
48 dd = get_command('dd')
51 def check_writable_dir(option, opt_str, value, parser):
52 dirname = os.path.dirname(value)
53 name = os.path.basename(value)
54 if dirname and not os.path.isdir(dirname):
55 raise FatalError("`%s' is not an existing directory" % dirname)
58 raise FatalError("`%s' is not a valid file name" % dirname)
60 setattr(parser.values, option.dest, value)
63 def parse_options(input_args):
64 usage = "Usage: %prog [options] <input_media>"
65 parser = optparse.OptionParser(version=version, usage=usage)
67 account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \
69 token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \
72 parser.add_option("-o", "--outfile", type="string", dest="outfile",
73 default=None, action="callback", callback=check_writable_dir,
74 help="dump image to FILE", metavar="FILE")
76 parser.add_option("-f", "--force", dest="force", default=False,
77 action="store_true", help="overwrite output files if they exist")
79 parser.add_option("-s", "--silent", dest="silent", default=False,
80 help="silent mode, only output errors", action="store_true")
82 parser.add_option("-u", "--upload", dest="upload", type="string",
83 default=False, help="upload the image to pithos with name FILENAME",
86 parser.add_option("-r", "--register", dest="register", type="string",
87 default=False, help="register the image to ~okeanos as IMAGENAME",
90 parser.add_option("-a", "--account", dest="account", type="string",
92 help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
95 parser.add_option("-t", "--token", dest="token", type="string",
97 help="Use this token when uploading/registring images [Default: %s]"\
100 parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
101 help="print the enabled and disabled system preparation operations "
102 "for this input media", action="store_true")
104 parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
105 help="run SYSPREP operation on the input media",
106 action="append", metavar="SYSPREP")
108 parser.add_option("--disable-sysprep", dest="disabled_syspreps",
109 help="prevent SYSPREP operation from running on the input media",
110 default=[], action="append", metavar="SYSPREP")
112 parser.add_option("--no-sysprep", dest="sysprep", default=True,
113 help="don't perform system preperation", action="store_false")
115 parser.add_option("--no-shrink", dest="shrink", default=True,
116 help="don't shrink any partition", action="store_false")
118 options, args = parser.parse_args(input_args)
121 parser.error('Wrong number of arguments')
122 options.source = args[0]
123 if not os.path.exists(options.source):
124 raise FatalError("Input media `%s' is not accessible" % options.source)
126 if options.register and options.upload == False:
127 raise FatalError("You also need to set -u when -r option is set")
129 if options.upload and options.account is None:
130 raise FatalError("Image uploading cannot be performed. No ~okeanos "
131 "account name is specified. Use -a to set an account name.")
133 if options.upload and options.token is None:
134 raise FatalError("Image uploading cannot be performed. No ~okeanos "
135 "token is specified. User -t to set a token.")
141 options = parse_options(sys.argv[1:])
146 if options.outfile is None and not options.upload \
147 and not options.print_sysprep:
148 raise FatalError("At least one of `-o', `-u' or" \
149 "`--print-sysprep' must be set")
151 title = 'snf-image-creator %s' % version
153 output('=' * len(title))
155 if os.geteuid() != 0:
156 raise FatalError("You must run %s as root" \
157 % os.path.basename(sys.argv[0]))
159 if not options.force and options.outfile is not None:
160 for extension in ('', '.meta', '.md5sum'):
161 filename = "%s%s" % (options.outfile, extension)
162 if os.path.exists(filename):
163 raise FatalError("Output file %s exists "
164 "(use --force to overwrite it)." % filename)
166 disk = Disk(options.source)
168 snapshot = disk.snapshot()
170 dev = disk.get_device(snapshot)
173 osclass = get_os_class(dev.distro, dev.ostype)
174 image_os = osclass(dev.root, dev.g)
175 metadata = image_os.get_metadata()
178 for sysprep in options.disabled_syspreps:
179 image_os.disable_sysprep(sysprep)
181 for sysprep in options.enabled_syspreps:
182 image_os.enable_sysprep(sysprep)
184 if options.print_sysprep:
185 image_os.print_syspreps()
188 if options.outfile is None and not options.upload:
192 image_os.do_sysprep()
196 size = options.shrink and dev.shrink() or dev.size
197 metadata['SIZE'] = str(size // 2 ** 20)
199 checksum = md5(snapshot, size)
201 metastring = '\n'.join(
202 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
205 if options.outfile is not None:
206 dev.dump(options.outfile)
208 output('Dumping metadata file...', False)
209 with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
213 output('Dumping md5sum file...', False)
214 with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
215 f.write('%s %s\n' % (
216 checksum, os.path.basename(options.outfile)))
219 # Destroy the device. We only need the snapshot from now on
220 disk.destroy_device(dev)
226 output("Uploading image to pithos:")
227 kamaki = Kamaki(options.account, options.token)
228 with open(snapshot) as f:
229 uploaded_obj = kamaki.upload(f, size, options.upload,
230 "(1/4) Calculating block hashes",
231 "(2/4) Uploading missing blocks")
233 output("(3/4) Uploading metadata file...", False)
234 kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
235 remote_path="%s.%s" % (options.upload, 'meta'))
237 output("(4/4) Uploading md5sum file...", False)
238 md5sumstr = '%s %s\n' % (
239 checksum, os.path.basename(options.upload))
240 kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
241 remote_path="%s.%s" % (options.upload, 'md5sum'))
246 output('Registring image to ~okeanos...', False)
247 kamaki.register(options.register, uploaded_obj, metadata)
252 output('cleaning up...')
255 success("snf-image-creator exited without errors")
262 ret = image_creator()
264 except FatalError as e:
269 if __name__ == '__main__':
272 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :