X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/f165adc0d7dd0816def505588dd184ed8c2d805f..bf3a282cb4ca85db501f8a925cd604a1600f25cc:/image_creator/main.py diff --git a/image_creator/main.py b/image_creator/main.py old mode 100755 new mode 100644 index f2aba56..10fc0b5 --- a/image_creator/main.py +++ b/image_creator/main.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright 2011 GRNET S.A. All rights reserved. +# Copyright 2012 GRNET S.A. All rights reserved. # # Redistribution and use in source and binary forms, with or # without modification, are permitted provided that the following @@ -33,26 +33,27 @@ # interpreted as representing official policies, either expressed # or implied, of GRNET S.A. -from image_creator import get_os_class from image_creator import __version__ as version from image_creator.disk import Disk -from image_creator.util import get_command, error, success, output, FatalError -from image_creator import util +from image_creator.util import FatalError, MD5 +from image_creator.output.cli import SilentOutput, SimpleOutput, \ + OutputWthProgress +from image_creator.kamaki_wrapper import Kamaki, ClientError import sys import os import optparse - -dd = get_command('dd') +import StringIO +import signal def check_writable_dir(option, opt_str, value, parser): dirname = os.path.dirname(value) name = os.path.basename(value) if dirname and not os.path.isdir(dirname): - parser.error("`%s' is not an existing directory" % dirname) + raise FatalError("`%s' is not an existing directory" % dirname) if not name: - parser.error("`%s' is not a valid file name" % dirname) + raise FatalError("`%s' is not a valid file name" % dirname) setattr(parser.values, option.dest, value) @@ -61,50 +62,95 @@ def parse_options(input_args): usage = "Usage: %prog [options] " parser = optparse.OptionParser(version=version, usage=usage) + parser.add_option("-o", "--outfile", type="string", dest="outfile", + default=None, action="callback", + callback=check_writable_dir, help="dump image to FILE", + metavar="FILE") + parser.add_option("-f", "--force", dest="force", default=False, - action="store_true", help="overwrite output files if they exist") + action="store_true", + help="overwrite output files if they exist") - parser.add_option("--no-sysprep", dest="sysprep", default=True, - help="don't perform system preperation", action="store_false") + parser.add_option("-s", "--silent", dest="silent", default=False, + help="output only errors", + action="store_true") - parser.add_option("--no-shrink", dest="shrink", default=True, - help="don't shrink any partition", action="store_false") + parser.add_option("-u", "--upload", dest="upload", type="string", + default=False, + help="upload the image to pithos with name FILENAME", + metavar="FILENAME") - parser.add_option("-o", "--outfile", type="string", dest="outfile", - default=None, action="callback", callback=check_writable_dir, - help="dump image to FILE", metavar="FILE") + parser.add_option("-r", "--register", dest="register", type="string", + default=False, + help="register the image with ~okeanos as IMAGENAME", + metavar="IMAGENAME") + + parser.add_option("-m", "--metadata", dest="metadata", default=[], + help="add custom KEY=VALUE metadata to the image", + action="append", metavar="KEY=VALUE") + + parser.add_option("-t", "--token", dest="token", type="string", + default=None, help="use this authentication token when " + "uploading/registering images") + + parser.add_option("--print-sysprep", dest="print_sysprep", default=False, + help="print the enabled and disabled system preparation " + "operations for this input media", action="store_true") parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[], - help="Run SYSPREP operation on the input media", - action="append", metavar="SYSPREP") + help="run SYSPREP operation on the input media", + action="append", metavar="SYSPREP") parser.add_option("--disable-sysprep", dest="disabled_syspreps", - help="Prevent SYSPREP operation from running on the input media", - default=[], action="append", metavar="SYSPREP") + help="prevent SYSPREP operation from running on the " + "input media", default=[], action="append", + metavar="SYSPREP") - parser.add_option("--print-sysprep", dest="print_sysprep", default=False, - help="Print the enabled and disabled sysprep operations for this " - "input media", action="store_true") + parser.add_option("--no-sysprep", dest="sysprep", default=True, + help="don't perform any system preparation operation", + action="store_false") - parser.add_option("-s", "--silent", dest="silent", default=False, - help="silent mode, only output errors", action="store_true") + parser.add_option("--no-shrink", dest="shrink", default=True, + help="don't shrink any partition", action="store_false") - parser.add_option("-u", "--upload", dest="upload", default=False, - help="upload the image to pithos", action="store_true") + parser.add_option("--public", dest="public", default=False, + help="register image with cyclades as public", + action="store_true") - parser.add_option("-r", "--register", dest="register", default=False, - help="register the image to ~okeanos", action="store_true") + parser.add_option("--tmpdir", dest="tmp", type="string", default=None, + help="create large temporary image files under DIR", + metavar="DIR") options, args = parser.parse_args(input_args) if len(args) != 1: parser.error('Wrong number of arguments') + options.source = args[0] if not os.path.exists(options.source): - parser.error('input media is not accessible') - - if options.register: - options.upload = True + raise FatalError("Input media `%s' is not accessible" % options.source) + + if options.register and not options.upload: + raise FatalError("You also need to set -u when -r option is set") + + if options.upload and options.token is None: + raise FatalError( + "Image uploading cannot be performed. " + "No authentication token is specified. Use -t to set a token") + + if options.tmp is not None and not os.path.isdir(options.tmp): + raise FatalError("The directory `%s' specified with --tmpdir is not " + "valid" % options.tmp) + + meta = {} + for m in options.metadata: + try: + key, value = m.split('=', 1) + except ValueError: + raise FatalError("Metadata option: `%s' is not in KEY=VALUE " + "format." % m) + meta[key] = value + options.metadata = meta return options @@ -112,72 +158,179 @@ def parse_options(input_args): def image_creator(): options = parse_options(sys.argv[1:]) - if options.silent: - util.silent = True + if options.outfile is None and not options.upload and not \ + options.print_sysprep: + raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " + "must be set") - if options.outfile is None and not options.upload \ - and not options.print_sysprep: - raise FatalError("At least one of `-o', `-u' or" \ - "`--print-sysprep' must be set") + if options.silent: + out = SilentOutput() + else: + out = OutputWthProgress(True) if sys.stderr.isatty() else \ + SimpleOutput(False) - output('snf-image-creator %s\n' % version) + title = 'snf-image-creator %s' % version + out.output(title) + out.output('=' * len(title)) if os.geteuid() != 0: - raise FatalError("You must run %s as root" \ - % os.path.basename(sys.argv[0])) + raise FatalError("You must run %s as root" + % os.path.basename(sys.argv[0])) if not options.force and options.outfile is not None: - for extension in ('', '.meta'): + for extension in ('', '.meta', '.md5sum'): filename = "%s%s" % (options.outfile, extension) if os.path.exists(filename): - raise FatalError("Output file %s exists " - "(use --force to overwrite it)." % filename) + raise FatalError("Output file `%s' exists " + "(use --force to overwrite it)." % filename) + + # Check if the authentication token is valid. The earlier the better + if options.token is not None: + try: + account = Kamaki.get_account(options.token) + if account is None: + raise FatalError("The authentication token you provided is not" + " valid!") + else: + kamaki = Kamaki(account, out) + except ClientError as e: + raise FatalError("Astakos client: %d %s" % (e.status, e.message)) + + if options.upload and not options.force: + if kamaki.object_exists(options.upload): + raise FatalError("Remote pithos object `%s' exists " + "(use --force to overwrite it)." % options.upload) + if kamaki.object_exists("%s.md5sum" % options.upload): + raise FatalError("Remote pithos object `%s.md5sum' exists " + "(use --force to overwrite it)." % options.upload) + + if options.register and not options.force: + if kamaki.object_exists("%s.meta" % options.upload): + raise FatalError("Remote pithos object `%s.meta' exists " + "(use --force to overwrite it)." % options.upload) + + disk = Disk(options.source, out, options.tmp) + + def signal_handler(signum, frame): + disk.cleanup() - disk = Disk(options.source) + signal.signal(signal.SIGINT, signal_handler) + signal.signal(signal.SIGTERM, signal_handler) try: - dev = disk.get_device() - dev.mount() + snapshot = disk.snapshot() + + image = disk.get_image(snapshot) + + # If no customization is to be done, the image should be mounted ro + ro = (not (options.sysprep or options.shrink) or options.print_sysprep) + image.mount(ro) + try: + for sysprep in options.disabled_syspreps: + image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep)) - osclass = get_os_class(dev.distro, dev.ostype) - image_os = osclass(dev.root, dev.g) - metadata = image_os.get_metadata() + for sysprep in options.enabled_syspreps: + image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep)) - output() + if options.print_sysprep: + image.os.print_syspreps() + out.output() - for sysprep in options.disabled_syspreps: - image_os.disable_sysprep(sysprep) + if options.outfile is None and not options.upload: + return 0 - for sysprep in options.enabled_syspreps: - image_os.enable_sysprep(sysprep) + if options.sysprep: + err_msg = "Unable to perform the system preparation tasks. " \ + "Couldn't mount the media%s. Use --no-sysprep if you " \ + "don't won't to perform any system preparation task." + if not image.mounted: + raise FatalError(err_msg % "") + elif image.mounted_ro: + raise FatalError(err_msg % " read-write") + image.os.do_sysprep() - if options.print_sysprep: - image_os.print_syspreps() - output() + metadata = image.os.meta + finally: + image.umount() - if options.outfile is None and not options.upload: - return 0 + size = options.shrink and image.shrink() or image.size + metadata.update(image.meta) - if options.sysprep: - image_os.do_sysprep() + # Add command line metadata to the collected ones... + metadata.update(options.metadata) - dev.umount() + md5 = MD5(out) + checksum = md5.compute(image.device, size) - size = options.shrink and dev.shrink() or dev.size() - metadata['SIZE'] = str(size // 2 ** 20) + metastring = '\n'.join( + ['%s=%s' % (key, value) for (key, value) in metadata.items()]) + metastring += '\n' if options.outfile is not None: - f = open('%s.%s' % (options.outfile, 'meta'), 'w') - try: - for key in metadata.keys(): - f.write("%s=%s\n" % (key, metadata[key])) - finally: - f.close() - - dev.dump(options.outfile) + image.dump(options.outfile) + + out.output('Dumping metadata file ...', False) + with open('%s.%s' % (options.outfile, 'meta'), 'w') as f: + f.write(metastring) + out.success('done') + + out.output('Dumping md5sum file ...', False) + with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f: + f.write('%s %s\n' % (checksum, + os.path.basename(options.outfile))) + out.success('done') + + # Destroy the image instance. We only need the snapshot from now on + disk.destroy_image(image) + + out.output() + try: + uploaded_obj = "" + if options.upload: + out.output("Uploading image to pithos:") + with open(snapshot, 'rb') as f: + uploaded_obj = kamaki.upload( + f, size, options.upload, + "(1/3) Calculating block hashes", + "(2/3) Uploading missing blocks") + out.output("(3/3) Uploading md5sum file ...", False) + md5sumstr = '%s %s\n' % (checksum, + os.path.basename(options.upload)) + kamaki.upload(StringIO.StringIO(md5sumstr), + size=len(md5sumstr), + remote_path="%s.%s" % (options.upload, 'md5sum')) + out.success('done') + out.output() + + if options.register: + img_type = 'public' if options.public else 'private' + out.output('Registering %s image with ~okeanos ...' % img_type, + False) + kamaki.register(options.register, uploaded_obj, metadata, + options.public) + out.success('done') + out.output("Uploading metadata file ...", False) + kamaki.upload(StringIO.StringIO(metastring), + size=len(metastring), + remote_path="%s.%s" % (options.upload, 'meta')) + out.success('done') + if options.public: + out.output("Sharing md5sum file ...", False) + kamaki.share("%s.md5sum" % options.upload) + out.success('done') + out.output("Sharing metadata file ...", False) + kamaki.share("%s.meta" % options.upload) + out.success('done') + + out.output() + except ClientError as e: + raise FatalError("Pithos client: %d %s" % (e.status, e.message)) + finally: - output('cleaning up...') + out.output('cleaning up ...') disk.cleanup() + out.success("snf-image-creator exited without errors") + return 0 @@ -186,10 +339,10 @@ def main(): ret = image_creator() sys.exit(ret) except FatalError as e: - error(e) + colored = sys.stderr.isatty() + SimpleOutput(colored).error(e) sys.exit(1) - if __name__ == '__main__': main()