Populate image properties with task_metadata
[snf-image-creator] / image_creator / dialog_main.py
index 33d399f..fa5addc 100644 (file)
@@ -54,22 +54,23 @@ MENU_WIDTH = 70
 INPUTBOX_WIDTH = 70
 CHECKBOX_WIDTH = 70
 HELP_WIDTH = 70
+INFOBOX_WIDTH = 70
 
 CONFIGURATION_TASKS = [
- ("Partition table manipulation", ["FixPartitionTable"],
-  ["linux", "windows"]),
- ("File system resize",
-  ["FilesystemResizeUnmounted", "FilesystemResizeMounted"],
-  ["linux", "windows"]),
- ("Swap partition configuration", ["AddSwap"], ["linux"]),
- ("SSH keys removal", ["DeleteSSHKeys"], ["linux"]),
- ("Temporal RDP disabling", ["DisableRemoteDesktopConnections"], ["windows"]),
- ("SELinux relabeling at next boot", ["SELinuxAutorelabel"],
-  ["linux"]),
- ("Hostname/Computer Name assignment", ["AssignHostname"],
-  ["windows", "linux"]),
- ("Password change", ["ChangePassword"], ["windows", "linux"]),
- ("File injection", ["EnforcePersonality"], ["windows", "linux"])
+    ("Partition table manipulation", ["FixPartitionTable"],
+        ["linux", "windows"]),
+    ("File system resize",
+        ["FilesystemResizeUnmounted", "FilesystemResizeMounted"],
+        ["linux", "windows"]),
+    ("Swap partition configuration", ["AddSwap"], ["linux"]),
+    ("SSH keys removal", ["DeleteSSHKeys"], ["linux"]),
+    ("Temporal RDP disabling", ["DisableRemoteDesktopConnections"],
+        ["windows"]),
+    ("SELinux relabeling at next boot", ["SELinuxAutorelabel"], ["linux"]),
+    ("Hostname/Computer Name assignment", ["AssignHostname"],
+        ["windows", "linux"]),
+    ("Password change", ["ChangePassword"], ["windows", "linux"]),
+    ("File injection", ["EnforcePersonality"], ["windows", "linux"])
 ]
 
 
@@ -77,14 +78,64 @@ class Reset(Exception):
     pass
 
 
+class metadata_monitor(object):
+    def __init__(self, session, meta):
+        self.session = session
+        self.meta = meta
+
+    def __enter__(self):
+        self.old = {}
+        for (k, v) in self.meta.items():
+            self.old[k] = v
+
+    def __exit__(self, type, value, traceback):
+        d = self.session['dialog']
+
+        altered = {}
+        added = {}
+
+        for (k, v) in self.meta.items():
+            if k not in self.old:
+                added[k] = v
+            elif self.old[k] != v:
+                altered[k] = v
+
+        if not (len(added) or len(altered)):
+            return
+
+        msg = "The last action has changed some image properties:\n\n"
+        if len(added):
+            msg += "New image properties:\n"
+            for (k, v) in added.items():
+                msg += '    %s: "%s"\n' % (k, v)
+            msg += "\n"
+        if len(altered):
+            msg += "Updated image properties:\n"
+            for (k, v) in altered.items():
+                msg += '    %s: "%s" -> "%s"\n' % (k, self.old[k], v)
+            msg += "\n"
+
+        self.session['metadata'].update(added)
+        self.session['metadata'].update(altered)
+        d.msgbox(msg, title="Image Property Changes", width=MSGBOX_WIDTH)
+
+
+def extract_metadata_string(session):
+    metadata = ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()]
+
+    if 'task_metadata' in session:
+        metadata.extend("%s=yes" % m for m in session['task_metadata'])
+
+    return '\n'.join(metadata) + '\n'
+
+
 def confirm_exit(d, msg=''):
     return not d.yesno("%s Do you want to exit?" % msg, width=YESNO_WIDTH)
 
 
 def confirm_reset(d):
-    return not d.yesno(
-        "Are you sure you want to reset everything?",
-        width=YESNO_WIDTH)
+    return not d.yesno("Are you sure you want to reset everything?",
+                       width=YESNO_WIDTH, defaultno=1)
 
 
 def update_background_title(session):
@@ -94,7 +145,11 @@ def update_background_title(session):
     MB = 2 ** 20
 
     size = (dev.meta['SIZE'] + MB - 1) // MB
-    title = "OS: %s, Distro: %s, Size: %dMB" % (dev.ostype, dev.distro, size)
+    shrinked = 'shrinked' in session and session['shrinked'] == True
+    postfix = " (shrinked)" if shrinked else ''
+
+    title = "OS: %s, Distro: %s, Size: %dMB%s" % \
+            (dev.ostype, dev.distro, size, postfix)
 
     d.setBackgroundTitle(title)
 
@@ -140,8 +195,8 @@ def extract_image(session):
 
         if len(overwrite) > 0:
             if d.yesno("The following file(s) exist:\n"
-                        "%s\nDo you want to overwrite them?" %
-                        "\n".join(overwrite), width=YESNO_WIDTH):
+                       "%s\nDo you want to overwrite them?" %
+                       "\n".join(overwrite), width=YESNO_WIDTH):
                 continue
 
         out = GaugeOutput(d, "Image Extraction", "Extracting image...")
@@ -158,11 +213,8 @@ def extract_image(session):
 
             # Extract metadata file
             out.output("Extracting metadata file...")
-            metastring = '\n'.join(
-                ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()])
-            metastring += '\n'
             with open('%s.meta' % path, 'w') as f:
-                f.write(metastring)
+                f.write(extract_metadata_string(session))
             out.success('done')
 
             # Extract md5sum file
@@ -225,9 +277,7 @@ def upload_image(session):
                                                   "Uploading missing blocks")
             # Upload metadata file
             out.output("Uploading metadata file...")
-            metastring = '\n'.join(
-                ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()])
-            metastring += '\n'
+            metastring = extract_metadata_string(session)
             kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
                           remote_path="%s.meta" % filename)
             out.success("done")
@@ -270,14 +320,13 @@ def register_image(session):
         return False
 
     if "upload" not in session:
-        d.msgbox("You need to have an image uploaded to pithos+ before you "
-                 "can register it to cyclades",
-                 width=MSGBOX_WIDTH)
+        d.msgbox("You need to upload the image to pithos+ before you can "
+                 "register it to cyclades", width=MSGBOX_WIDTH)
         return False
 
     while 1:
-        (code, answer) = d.inputbox("Please provide a registration name:"
-                                " be registered:", width=INPUTBOX_WIDTH)
+        (code, answer) = d.inputbox("Please provide a registration name:",
+                                    width=INPUTBOX_WIDTH)
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
             return False
 
@@ -287,12 +336,18 @@ def register_image(session):
             continue
         break
 
+    metadata = {}
+    metadata.update(session['metadata'])
+    if 'task_metadata' in session:
+        for key in session['task_metadata']:
+            metadata[key] = 'yes'
+
     out = GaugeOutput(d, "Image Registration", "Registrating image...")
     try:
         out.output("Registring image to cyclades...")
         try:
             kamaki = Kamaki(session['account'], session['token'], out)
-            kamaki.register(name, session['upload'], session['metadata'])
+            kamaki.register(name, session['upload'], metadata)
             out.success('done')
         except ClientError as e:
             d.msgbox("Error in pithos+ client: %s" % e.message)
@@ -316,11 +371,11 @@ def kamaki_menu(session):
         choices = [("Account", "Change your ~okeanos username: %s" % account),
                    ("Token", "Change your ~okeanos token: %s" % token),
                    ("Upload", "Upload image to pithos+"),
-                   ("Register", "Register image to cyclades: %s" % upload)]
+                   ("Register", "Register the image to cyclades: %s" % upload)]
 
         (code, choice) = d.menu(
             text="Choose one of the following or press <Back> to go back.",
-            width=MENU_WIDTH, choices=choices, cancel="Back", help_button=1,
+            width=MENU_WIDTH, choices=choices, cancel="Back",
             default_item=default_item, title="Image Registration Menu")
 
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
@@ -382,7 +437,7 @@ def add_property(session):
 
     while 1:
         (code, answer) = d.inputbox("Please provide a value for image "
-                                   "property %s" % name, width=INPUTBOX_WIDTH)
+                                    "property %s" % name, width=INPUTBOX_WIDTH)
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
             return False
 
@@ -408,20 +463,22 @@ def modify_properties(session):
 
         (code, choice) = d.menu(
             "In this menu you can edit existing image properties or add new "
-            "ones. Be carefull! Most properties have special meaning and "
+            "ones. Be careful! Most properties have special meaning and "
             "alter the image deployment behaviour. Press <HELP> to see more "
             "information about image properties. Press <BACK> when done.",
             height=18, width=MENU_WIDTH, choices=choices, menu_height=10,
             ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
-            help_button=1, title="Image Metadata")
+            help_button=1, title="Image Properties")
 
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
-            break
+            return True
         # Edit button
         elif code == d.DIALOG_OK:
-            (code, answer) = d.inputbox("Please provide a new value for "
-                    "the image property with name `%s':" % choice,
-                    init=session['metadata'][choice], width=INPUTBOX_WIDTH)
+            (code, answer) = d.inputbox("Please provide a new value for the "
+                                        "image property with name `%s':" %
+                                        choice,
+                                        init=session['metadata'][choice],
+                                        width=INPUTBOX_WIDTH)
             if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
                 value = answer.strip()
                 if len(value) == 0:
@@ -432,6 +489,10 @@ def modify_properties(session):
         # ADD button
         elif code == d.DIALOG_EXTRA:
             add_property(session)
+        elif code == 'help':
+            help_file = get_help_file("image_properties")
+            assert os.path.exists(help_file)
+            d.textbox(help_file, title="Image Properties", width=70, height=40)
 
 
 def delete_properties(session):
@@ -451,6 +512,9 @@ def delete_properties(session):
     cnt = len(to_delete)
     if cnt > 0:
         d.msgbox("%d image properties were deleted." % cnt, width=MSGBOX_WIDTH)
+        return True
+    else:
+        return False
 
 
 def exclude_tasks(session):
@@ -468,7 +532,7 @@ def exclude_tasks(session):
                        "Do you wish to enable it?", width=YESNO_WIDTH):
             session['excluded_tasks'].remove(-1)
         else:
-            return
+            return False
 
     for (msg, task, osfamily) in CONFIGURATION_TASKS:
         if session['metadata']['OSFAMILY'] in osfamily:
@@ -490,7 +554,7 @@ def exclude_tasks(session):
             title="Exclude Configuration Tasks")
 
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
-            break
+            return False
         elif code == d.DIALOG_HELP:
             help_file = get_help_file("configuration_tasks")
             assert os.path.exists(help_file)
@@ -510,15 +574,26 @@ def exclude_tasks(session):
             for task in session['excluded_tasks']:
                 exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
 
-            session['task_metadata'] = \
-                        map(lambda x: "EXCLUDE_TASK_%s" % x, exclude_metadata)
+            session['task_metadata'] = map(lambda x: "EXCLUDE_TASK_%s" % x,
+                                           exclude_metadata)
             break
 
+    return True
+
 
 def sysprep(session):
     d = session['dialog']
     image_os = session['image_os']
 
+    # Is the image already shrinked?
+    if 'shrinked' in session and session['shrinked'] == True:
+        msg = "It seems you have shrinked the image. Running system " \
+              "preparation tasks on a shrinked image is dangerous."
+
+        if d.yesno("%s\n\nDo you really want to continue?" % msg,
+                   width=YESNO_WIDTH, defaultno=1):
+            return
+
     wrapper = textwrap.TextWrapper(width=65)
 
     help_title = "System Preperation Tasks"
@@ -531,6 +606,10 @@ def sysprep(session):
     # Only give the user the choice between syspreps that have not ran yet
     syspreps = [s for s in all_syspreps if s not in session['exec_syspreps']]
 
+    if len(syspreps) == 0:
+        d.msgbox("No system preparation task left to run!", width=MSGBOX_WIDTH)
+        return
+
     while 1:
         choices = []
         index = 0
@@ -551,7 +630,7 @@ def sysprep(session):
             choices=choices, width=70, ok_label="Run", help_button=1)
 
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
-            break
+            return False
         elif code == d.DIALOG_HELP:
             d.scrollbox(sysprep_help, width=HELP_WIDTH)
         elif code == d.DIALOG_OK:
@@ -573,22 +652,56 @@ def sysprep(session):
                     if 'checksum' in session:
                         del session['checksum']
 
-                    image_os.out = out
-                    image_os.do_sysprep()
+                    # Monitor the metadata changes during syspreps
+                    with metadata_monitor(session, image_os.meta):
+                        image_os.out = out
+                        image_os.do_sysprep()
+                        image_os.out.finalize()
 
                     # Disable syspreps that have ran
                     for sysprep in session['exec_syspreps']:
                         image_os.disable_sysprep(sysprep)
 
-                    image_os.out.finalize()
                 finally:
                     dev.umount()
             finally:
                 out.cleanup()
             break
+    return True
+
+
+def shrink(session):
+    d = session['dialog']
+    dev = session['device']
+
+    shrinked = 'shrinked' in session and session['shrinked'] == True
+
+    if shrinked:
+        d.msgbox("You have already shrinked your image!")
+        return True
+
+    msg = "This operation will shrink the last partition of the image to " \
+          "reduce the total image size. If the last partition is a swap " \
+          "partition, then this partition is removed and the partition " \
+          "before that is shrinked. The removed swap partition will be " \
+          "recreated during image deployment."
+
+    if not d.yesno("%s\n\nDo you want to continue?" % msg, width=70,
+                   height=12, title="Image Shrinking"):
+        with metadata_monitor(session, dev.meta):
+            dev.out = InfoBoxOutput(d, "Image Shrinking", height=4)
+            dev.shrink()
+            dev.out.finalize()
+
+        session['shrinked'] = True
+        update_background_title(session)
+    else:
+        return False
+
+    return True
 
 
-def customize_menu(session):
+def customization_menu(session):
     d = session['dialog']
 
     choices = [("Sysprep", "Run various image preperation tasks"),
@@ -597,9 +710,10 @@ def customize_menu(session):
                ("Delete", "Delete image properties"),
                ("Exclude", "Exclude various deployment tasks from running")]
 
-    default_item = "Sysprep"
+    default_item = 0
 
     actions = {"Sysprep": sysprep,
+               "Shrink": shrink,
                "View/Modify": modify_properties,
                "Delete": delete_properties,
                "Exclude": exclude_tasks}
@@ -607,14 +721,15 @@ def customize_menu(session):
         (code, choice) = d.menu(
             text="Choose one of the following or press <Back> to exit.",
             width=MENU_WIDTH, choices=choices, cancel="Back", height=13,
-            menu_height=len(choices), default_item=default_item,
+            menu_height=len(choices), default_item=choices[default_item][0],
             title="Image Customization Menu")
 
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
             break
         elif choice in actions:
-            default_item = choice
-            actions[choice](session)
+            default_item = [entry[0] for entry in choices].index(choice)
+            if actions[choice](session):
+                default_item = (default_item + 1) % len(choices)
 
 
 def main_menu(session):
@@ -631,7 +746,7 @@ def main_menu(session):
 
     default_item = "Customize"
 
-    actions = {"Customize": customize_menu, "Register": kamaki_menu,
+    actions = {"Customize": customization_menu, "Register": kamaki_menu,
                "Extract": extract_image}
     while 1:
         (code, choice) = d.menu(
@@ -646,7 +761,8 @@ def main_menu(session):
                 break
         elif choice == "Reset":
             if confirm_reset(d):
-                d.infobox("Resetting snf-image-creator. Please wait...")
+                d.infobox("Resetting snf-image-creator. Please wait...",
+                          width=INFOBOX_WIDTH)
                 raise Reset
         elif choice in actions:
             actions[choice](session)
@@ -663,7 +779,7 @@ def select_file(d, media):
                 break
 
         (code, media) = d.fselect(root, 10, 50,
-                                 title="Please select input media")
+                                  title="Please select input media")
         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
             if confirm_exit(d, "You canceled the media selection dialog box."):
                 sys.exit(0)
@@ -681,13 +797,13 @@ def image_creator(d):
         sys.stderr.write("%s\n" % usage)
         return 1
 
+    d.setBackgroundTitle('snf-image-creator')
+
     if os.geteuid() != 0:
         raise FatalError("You must run %s as root" % basename)
 
     media = select_file(d, sys.argv[1] if len(sys.argv) == 2 else None)
 
-    d.setBackgroundTitle('snf-image-creator')
-
     out = GaugeOutput(d, "Initialization", "Initializing...")
     disk = Disk(media, out)
 
@@ -700,13 +816,20 @@ def image_creator(d):
         snapshot = disk.snapshot()
         dev = disk.get_device(snapshot)
 
-        out.output("Collecting image metadata...")
-        metadata = dev.meta
+
+        metadata = {}
+        for (key, value) in dev.meta.items():
+            metadata[str(key)] = str(value)
+
         dev.mount(readonly=True)
+        out.output("Collecting image metadata...")
         cls = os_cls(dev.distro, dev.ostype)
         image_os = cls(dev.root, dev.g, out)
         dev.umount()
-        metadata.update(image_os.meta)
+
+        for (key, value) in image_os.meta.items():
+            metadata[str(key)] = str(value)
+
         out.success("done")
         out.cleanup()
 
@@ -748,7 +871,7 @@ def main():
                 sys.exit(ret)
             except FatalError as e:
                 msg = textwrap.fill(str(e), width=70)
-                d.infobox(msg, width=70, title="Fatal Error")
+                d.infobox(msg, width=INFOBOX_WIDTH, title="Fatal Error")
                 sys.exit(1)
         except Reset:
             continue