Add Output module for dialog-based output
[snf-image-creator] / image_creator / main.py
old mode 100755 (executable)
new mode 100644 (file)
index 26a6675..8857eb8
@@ -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.util import get_command, 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
 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)
@@ -92,6 +91,10 @@ def parse_options(input_args):
         help="Use this ACCOUNT when uploading/registring 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]"\
@@ -119,6 +122,7 @@ def parse_options(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)
@@ -134,21 +138,36 @@ def parse_options(input_args):
         raise FatalError("Image uploading cannot be performed. No ~okeanos "
         "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
 
 
 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")
+        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" \
@@ -161,18 +180,16 @@ def image_creator():
                 raise FatalError("Output file %s exists "
                     "(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()
-
-        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)
@@ -182,7 +199,7 @@ def image_creator():
 
         if options.print_sysprep:
             image_os.print_syspreps()
-            output()
+            out.output()
 
         if options.outfile is None and not options.upload:
             return 0
@@ -190,68 +207,73 @@ 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.meta['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()])
+                ['%s=%s' % (key, value) for (key, value) in metadata.items()])
         metastring += '\n'
 
         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()
+        out.output()
 
         uploaded_obj = ""
         if options.upload:
-            output("Uploading image to pithos:")
-            kamaki = Kamaki(options.account, options.token)
+            out.output("Uploading image to pithos:")
+            kamaki = Kamaki(options.account, options.token, out)
             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)
+            out.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)
+            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'))
-            success('done')
-            output()
+            out.success('done')
+            out.output()
 
         if options.register:
-            output('Registring image to ~okeanos...', False)
+            out.output('Registring image to ~okeanos...', False)
             kamaki.register(options.register, uploaded_obj, metadata)
-            success('done')
-            output()
+            out.success('done')
+            out.output()
 
     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,7 +283,8 @@ 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)