Update image properties help page
[snf-image-creator] / image_creator / main.py
old mode 100755 (executable)
new mode 100644 (file)
index 26a6675..a12d863
@@ -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
 # 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 import util
 from image_creator.disk import Disk
-from image_creator.util import get_command, error, success, output, \
-                                                    FatalError, progress, md5
-from image_creator.kamaki_wrapper import Kamaki
+from image_creator.util import FatalError, MD5
+from image_creator.output.cli import SilentOutput, SimpleOutput, \
+    OutputWthProgress
+from image_creator.os_type import os_cls
+from image_creator.kamaki_wrapper import Kamaki, ClientError
 import sys
 import os
 import optparse
 import StringIO
 
-dd = get_command('dd')
-
 
 def check_writable_dir(option, opt_str, value, parser):
     dirname = os.path.dirname(value)
@@ -70,69 +69,90 @@ def parse_options(input_args):
         else None
 
     parser.add_option("-o", "--outfile", type="string", dest="outfile",
-        default=None, action="callback", callback=check_writable_dir,
-        help="dump image to FILE", metavar="FILE")
+                      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("-s", "--silent", dest="silent", default=False,
-        help="silent mode, only output errors", action="store_true")
+                      help="silent mode, only output errors",
+                      action="store_true")
 
     parser.add_option("-u", "--upload", dest="upload", type="string",
-        default=False, help="upload the image to pithos with name FILENAME",
-        metavar="FILENAME")
+                      default=False,
+                      help="upload the image to pithos with name FILENAME",
+                      metavar="FILENAME")
 
     parser.add_option("-r", "--register", dest="register", type="string",
-        default=False, help="register the image to ~okeanos as IMAGENAME",
-        metavar="IMAGENAME")
+                      default=False,
+                      help="register the image with ~okeanos as IMAGENAME",
+                      metavar="IMAGENAME")
 
     parser.add_option("-a", "--account", dest="account", type="string",
-        default=account,
-        help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
-        % account)
+                      default=account, help="Use this ACCOUNT when "
+                      "uploading/registering images [Default: %s]" % account)
+
+    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=token,
-        help="Use this token when uploading/registring images [Default: %s]"\
-        % token)
+                      default=token, help="Use this token when "
+                      "uploading/registering images [Default: %s]" % token)
 
     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")
+                      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("--no-sysprep", dest="sysprep", default=True,
-        help="don't perform system preperation", action="store_false")
+                      help="don't perform system preparation",
+                      action="store_false")
 
     parser.add_option("--no-shrink", dest="shrink", default=True,
-        help="don't shrink any partition", action="store_false")
+                      help="don't shrink any partition", action="store_false")
 
     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):
         raise FatalError("Input media `%s' is not accessible" % options.source)
 
-    if options.register and options.upload == False:
+    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.account is None:
         raise FatalError("Image uploading cannot be performed. No ~okeanos "
-        "account name is specified. Use -a to set an account name.")
+                         "account name is specified. Use -a to set an account "
+                         "name.")
 
     if options.upload and options.token is None:
         raise FatalError("Image uploading cannot be performed. No ~okeanos "
-        "token is specified. User -t to set a token.")
+                         "token is specified. User -t to set a token.")
+
+    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
 
@@ -140,49 +160,55 @@ 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', '.md5sum'):
             filename = "%s%s" % (options.outfile, extension)
             if os.path.exists(filename):
                 raise FatalError("Output file %s exists "
-                    "(use --force to overwrite it)." % filename)
+                                 "(use --force to overwrite it)." % filename)
 
-    disk = Disk(options.source)
+    disk = Disk(options.source, out)
     try:
         snapshot = disk.snapshot()
 
         dev = disk.get_device(snapshot)
-        dev.mount()
 
-        osclass = get_os_class(dev.distro, dev.ostype)
-        image_os = osclass(dev.root, dev.g)
-        metadata = image_os.get_metadata()
+        # If no customization is to be applied, the image should be mounted ro
+        readonly = not (options.sysprep or options.shrink)
+        dev.mount(readonly)
 
-        output()
+        cls = os_cls(dev.distro, dev.ostype)
+        image_os = cls(dev.root, dev.g, out)
+        out.output()
 
         for sysprep in options.disabled_syspreps:
-            image_os.disable_sysprep(sysprep)
+            image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
 
         for sysprep in options.enabled_syspreps:
-            image_os.enable_sysprep(sysprep)
+            image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
 
         if options.print_sysprep:
             image_os.print_syspreps()
-            output()
+            out.output()
 
         if options.outfile is None and not options.upload:
             return 0
@@ -190,12 +216,17 @@ def image_creator():
         if options.sysprep:
             image_os.do_sysprep()
 
+        metadata = image_os.meta
         dev.umount()
 
-        size = options.shrink and dev.shrink() or dev.size()
-        metadata['SIZE'] = str(size // 2 ** 20)
+        size = options.shrink and dev.shrink() or dev.size
+        metadata.update(dev.meta)
+
+        # Add command line metadata to the collected ones...
+        metadata.update(options.metadata)
 
-        checksum = md5(snapshot, size)
+        md5 = MD5(out)
+        checksum = md5.compute(snapshot, size)
 
         metastring = '\n'.join(
             ['%s=%s' % (key, value) for (key, value) in metadata.items()])
@@ -204,54 +235,60 @@ def image_creator():
         if options.outfile is not None:
             dev.dump(options.outfile)
 
-            output('Dumping metadata file...', False)
+            out.output('Dumping metadata file...', False)
             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
-                    f.write(metastring)
-            success('done')
+                f.write(metastring)
+            out.success('done')
 
-            output('Dumping md5sum file...', False)
+            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)))
-            success('done')
+                f.write('%s %s\n' % (checksum,
+                                     os.path.basename(options.outfile)))
+            out.success('done')
 
         # Destroy the device. We only need the snapshot from now on
         disk.destroy_device(dev)
 
-        output()
-
-        uploaded_obj = ""
-        if options.upload:
-            output("Uploading image to pithos:")
-            kamaki = Kamaki(options.account, options.token)
-            with open(snapshot) as f:
-                uploaded_obj = kamaki.upload(f, size, options.upload,
-                                "(1/4)  Calculating block hashes",
-                                "(2/4)  Uploading missing blocks")
-
-            output("(3/4)  Uploading metadata file...", False)
-            kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
-                                remote_path="%s.%s" % (options.upload, 'meta'))
-            success('done')
-            output("(4/4)  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'))
-            success('done')
-            output()
-
-        if options.register:
-            output('Registring image to ~okeanos...', False)
-            kamaki.register(options.register, uploaded_obj, metadata)
-            success('done')
-            output()
+        out.output()
+        try:
+            uploaded_obj = ""
+            if options.upload:
+                out.output("Uploading image to pithos:")
+                kamaki = Kamaki(options.account, options.token, out)
+                with open(snapshot, 'rb') as f:
+                    uploaded_obj = kamaki.upload(f, size, options.upload,
+                                                 "(1/4)  Calculating block "
+                                                 "hashes",
+                                                 "(2/4)  Uploading missing "
+                                                 "blocks")
+
+                out.output("(3/4)  Uploading metadata file...", False)
+                kamaki.upload(StringIO.StringIO(metastring),
+                              size=len(metastring),
+                              remote_path="%s.%s" % (options.upload, 'meta'))
+                out.success('done')
+                out.output("(4/4)  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:
+                out.output('Registering image with ~okeanos...', False)
+                kamaki.register(options.register, uploaded_obj, metadata)
+                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()
 
-    success("snf-image-creator exited without errors")
+    out.success("snf-image-creator exited without errors")
 
     return 0
 
@@ -261,10 +298,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()