X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/dbf466eb438759595eda22952a7409ec0ab398c8..0eac025658a5fe7a995ad3f8a12930aa19758f49:/image_creator/dialog_wizard.py

diff --git a/image_creator/dialog_wizard.py b/image_creator/dialog_wizard.py
index 8e122a8..e5a39f8 100644
--- a/image_creator/dialog_wizard.py
+++ b/image_creator/dialog_wizard.py
@@ -1,5 +1,5 @@
-#!/usr/bin/env python
-
+# -*- coding: utf-8 -*-
+#
 # Copyright 2012 GRNET S.A. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or
@@ -33,200 +33,452 @@
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
-import dialog
+"""This module implements the "wizard" mode of the dialog-based version of
+snf-image-creator.
+"""
+
 import time
 import StringIO
+import json
 
 from image_creator.kamaki_wrapper import Kamaki, ClientError
 from image_creator.util import MD5, FatalError
 from image_creator.output.cli import OutputWthProgress
+from image_creator.dialog_util import extract_image, update_background_title, \
+    add_cloud, edit_cloud
 
 PAGE_WIDTH = 70
+PAGE_HEIGHT = 10
+
+
+class WizardExit(Exception):
+    """Exception used to exit the wizard"""
+    pass
+
+
+class WizardReloadPage(Exception):
+    """Exception that reloads the last WizardPage"""
+    pass
 
 
 class Wizard:
+    """Represents a dialog-based wizard
+
+    The wizard is a collection of pages that have a "Next" and a "Back" button
+    on them. The pages are used to collect user data.
+    """
+
     def __init__(self, session):
         self.session = session
         self.pages = []
         self.session['wizard'] = {}
+        self.d = session['dialog']
 
     def add_page(self, page):
+        """Add a new page to the wizard"""
         self.pages.append(page)
 
     def run(self):
+        """Run the wizard"""
         idx = 0
         while True:
-            idx += self.pages[idx].run(self.session, idx, len(self.pages))
+            try:
+                total = len(self.pages)
+                title = "(%d/%d) %s" % (idx + 1, total, self.pages[idx].title)
+                idx += self.pages[idx].run(self.session, title)
+            except WizardExit:
+                return False
+            except WizardReloadPage:
+                continue
 
             if idx >= len(self.pages):
-                break
+                text = "All necessary information has been gathered:\n\n"
+                for page in self.pages:
+                    text += " * %s\n" % page.info
+                text += "\nContinue with the image creation process?"
+
+                ret = self.d.yesno(
+                    text, width=PAGE_WIDTH, height=8 + len(self.pages),
+                    ok_label="Yes", cancel="Back", extra_button=1,
+                    extra_label="Quit", title="Confirmation")
+
+                if ret == self.d.DIALOG_CANCEL:
+                    idx -= 1
+                elif ret == self.d.DIALOG_EXTRA:
+                    return False
+                elif ret == self.d.DIALOG_OK:
+                    return True
 
             if idx < 0:
                 return False
-        return True
 
 
-class WizardPage:
+class WizardPage(object):
+    """Represents a page in a wizard"""
     NEXT = 1
     PREV = -1
-    EXIT = -255
 
-    def run(self, session, index, total):
+    def __init__(self, name, display_name, text, **kargs):
+        self.name = name
+        self.display_name = display_name
+        self.text = text
+
+        self.title = kargs['title'] if 'title' in kargs else ""
+        self.default = kargs['default'] if 'default' in kargs else ""
+        self.extra = kargs['extra'] if 'extra' in kargs else None
+        self.extra_label = \
+            kargs['extra_label'] if 'extra_label' in kargs else 'Extra'
+
+        self.info = "%s: <none>" % self.display_name
+
+        validate = kargs['validate'] if 'validate' in kargs else lambda x: x
+        setattr(self, "validate", validate)
+
+        display = kargs['display'] if 'display' in kargs else lambda x: x
+        setattr(self, "display", display)
+
+    def run(self, session, title):
+        """Display this wizard page
+
+        This function is used by the wizard program when accessing a page.
+        """
         raise NotImplementedError
 
 
-class WizardInputPage(WizardPage):
+class WizardPageWthChoices(WizardPage):
+    """Represents a Wizard Page that allows the user to select something from
+    a list of choices.
 
-    def __init__(self, name, message, **kargs):
-        self.name = name
-        self.message = message
-        self.title = kargs['title'] if 'title' in kargs else ''
-        self.init_value = kargs['init'] if 'init' in kargs else ''
-        self.allow_empty = kargs['empty'] if 'empty' in kargs else False
+    The available choices are created by a function passed to the class through
+    the choices variable. If the choices function returns an empty list, a
+    fallback funtion is executed if available.
+    """
+    def __init__(self, name, display_name, text, choices, **kargs):
+        super(WizardPageWthChoices, self).__init__(name, display_name, text,
+                                                   **kargs)
+        self.choices = choices
+        self.fallback = kargs['fallback'] if 'fallback' in kargs else None
+
+
+class WizardRadioListPage(WizardPageWthChoices):
+    """Represent a Radio List in a wizard"""
 
-    def run(self, session, index, total):
+    def run(self, session, title):
         d = session['dialog']
         w = session['wizard']
 
-        init = w[self.name] if self.name in w else self.init_value
-        while True:
-            (code, answer) = d.inputbox(self.message, init=init,
-                width=PAGE_WIDTH, ok_label="Next", cancel="Back",
-                title="(%d/%d) %s" % (index + 1, total, self.title))
+        choices = []
+        for choice in self.choices():
+            default = 1 if choice[0] == self.default else 0
+            choices.append((choice[0], choice[1], default))
 
-            if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
-                return self.PREV
+        (code, answer) = d.radiolist(
+            self.text, width=PAGE_WIDTH, ok_label="Next", cancel="Back",
+            choices=choices, height=PAGE_HEIGHT, title=title)
 
-            value = answer.strip()
-            if len(value) == 0 and self.allow_empty is False:
-                d.msgbox("The value cannot be empty!", width=PAGE_WIDTH)
-                continue
-            w[self.name] = value
-            break
+        if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+            return self.PREV
+
+        w[self.name] = self.validate(answer)
+        self.default = answer
+        self.info = "%s: %s" % (self.display_name, self.display(w[self.name]))
 
         return self.NEXT
 
 
-class WizardYesNoPage(WizardPage):
+class WizardInputPage(WizardPage):
+    """Represents an input field in a wizard"""
 
-    def __init__(self, message, **kargs):
-        self.message = message
-        self.title = kargs['title'] if 'title' in kargs else ''
+    def run(self, session, title):
+        d = session['dialog']
+        w = session['wizard']
 
-    def run(self, session, index, total):
+        (code, answer) = d.inputbox(
+            self.text, init=self.default, width=PAGE_WIDTH, ok_label="Next",
+            cancel="Back", height=PAGE_HEIGHT, title=title)
+
+        if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+            return self.PREV
+
+        value = answer.strip()
+        self.default = value
+        w[self.name] = self.validate(value)
+        self.info = "%s: %s" % (self.display_name, self.display(w[self.name]))
+
+        return self.NEXT
+
+
+class WizardFormPage(WizardPage):
+    """Represents a Form in a wizard"""
+
+    def __init__(self, name, display_name, text, fields, **kargs):
+        super(WizardFormPage, self).__init__(name, display_name, text, **kargs)
+        self.fields = fields
+
+    def run(self, session, title):
         d = session['dialog']
+        w = session['wizard']
 
-        while True:
-            ret = d.yesno(self.message, width=PAGE_WIDTH, ok_label="Yes",
-                    cancel="Back", extra_button=1, extra_label="Quit",
-                    title="(%d/%d) %s" % (index + 1, total, self.title))
+        field_lenght = len(self.fields())
+        form_height = field_lenght if field_lenght < PAGE_HEIGHT - 4 \
+            else PAGET_HEIGHT - 4
+
+        (code, output) = d.form(
+            self.text, width=PAGE_WIDTH, height=PAGE_HEIGHT,
+            form_height=form_height, ok_label="Next", cancel="Back",
+            fields=self.fields(), title=title)
+
+        if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+            return self.PREV
+
+        w[self.name] = self.validate(output)
+        self.default = output
+        self.info = "%s: %s" % (self.display_name, self.display(w[self.name]))
+
+        return self.NEXT
+
+
+class WizardMenuPage(WizardPageWthChoices):
+    """Represents a menu dialog with available choices in a wizard"""
 
-            if ret == d.DIALOG_CANCEL:
+    def run(self, session, title):
+        d = session['dialog']
+        w = session['wizard']
+
+        extra_button = 1 if self.extra else 0
+
+        choices = self.choices()
+
+        if len(choices) == 0:
+            assert self.fallback, "Zero choices and no fallback"
+            if self.fallback():
+                raise WizardReloadPage
+            else:
                 return self.PREV
-            elif ret == d.DIALOG_EXTRA:
-                return self.EXIT
-            elif ret == d.DIALOG_OK:
-                return self.NEXT
+
+        default_item = self.default if self.default else choices[0][0]
+
+        (code, choice) = d.menu(
+            self.text, width=PAGE_WIDTH, ok_label="Next", cancel="Back",
+            title=title, choices=choices, height=PAGE_HEIGHT,
+            default_item=default_item, extra_label=self.extra_label,
+            extra_button=extra_button)
+
+        if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+            return self.PREV
+        elif code == d.DIALOG_EXTRA:
+            self.extra()
+            raise WizardReloadPage
+
+        self.default = choice
+        w[self.name] = self.validate(choice)
+        self.info = "%s: %s" % (self.display_name, self.display(w[self.name]))
+
+        return self.NEXT
 
 
-def wizard(session):
+def start_wizard(session):
+    """Run the image creation wizard"""
 
-    name = WizardInputPage("ImageName", "Please provide a name for the image:",
-                      title="Image Name", init=session['device'].distro)
-    descr = WizardInputPage("ImageDescription",
+    image = session['image']
+    distro = image.distro
+    ostype = image.ostype
+
+    # Create Cloud Wizard Page
+    def cloud_choices():
+        choices = []
+        for (name, cloud) in Kamaki.get_clouds().items():
+            descr = cloud['description'] if 'description' in cloud else ''
+            choices.append((name, descr))
+
+        return choices
+
+    def cloud_add():
+        return add_cloud(session)
+
+    def cloud_none_available():
+        if not session['dialog'].yesno(
+                "No available clouds found. Would you like to add one now?",
+                width=PAGE_WIDTH, defaultno=0):
+            return add_cloud(session)
+        return False
+
+    def cloud_validate(cloud):
+        if not Kamaki.get_account(cloud):
+            if not session['dialog'].yesno(
+                    "The cloud you have selected is not valid! Would you "
+                    "like to edit it now?", width=PAGE_WIDTH, defaultno=0):
+                if edit_cloud(session, cloud):
+                    return cloud
+
+            raise WizardReloadPage
+
+        return cloud
+
+    cloud = WizardMenuPage(
+        "Cloud", "Cloud",
+        "Please select a cloud account or press <Add> to add a new one:",
+        choices=cloud_choices, extra_label="Add", extra=cloud_add,
+        title="Clouds", validate=cloud_validate, fallback=cloud_none_available)
+
+    # Create Image Name Wizard Page
+    name = WizardInputPage(
+        "ImageName", "Image Name", "Please provide a name for the image:",
+        title="Image Name", default=ostype if distro == "unknown" else distro)
+
+    # Create Image Description Wizard Page
+    descr = WizardInputPage(
+        "ImageDescription", "Image Description",
         "Please provide a description for the image:",
-        title="Image Description", empty=True,
-        init=session['metadata']['DESCRIPTION'] if 'DESCRIPTION' in
-        session['metadata'] else '')
-    account = WizardInputPage("account",
-        "Please provide your ~okeanos account e-mail:",
-        title="~okeanos account information", init=Kamaki.get_account())
-    token = WizardInputPage("token",
-        "Please provide your ~okeanos account token:",
-        title="~okeanos account token", init=Kamaki.get_token())
-
-    msg = "Do you wish to continue with the image extraction process?"
-    proceed = WizardYesNoPage(msg, title="Confirmation")
+        title="Image Description", default=session['metadata']['DESCRIPTION']
+        if 'DESCRIPTION' in session['metadata'] else '')
+
+    # Create Sysprep Params Wizard Page
+    needed = image.os.needed_sysprep_params()
+
+    def sysprep_params_fields():
+        fields = []
+        available = image.os.sysprep_params
+        for param in needed:
+            text = param.description
+            default = available[param.name] if param.name in available else ""
+            fields.append(("%s: " % text, default, param.length))
+        return fields
+
+    def sysprep_params_validate(answer):
+        params = {}
+        for i in range(len(answer)):
+            if needed[i].validator(answer):
+                params[needed[i].name] = answer[i]
+            else:
+                session['dialog'].msgbox("Invalid value for parameter `%s'" %
+                                         needed[i].name)
+                raise WizardReloadPage
+        return params
+
+    def sysprep_params_display(params):
+        return ",".join(["%s=%s" % (key, val) for key, val in params.items()])
+
+    sysprep_params = WizardFormPage(
+        "SysprepParams", "Sysprep Parameters",
+        "Prease fill in the following system preparation parameters:",
+        title="System Preparation Parameters", fields=sysprep_params_fields,
+        display=sysprep_params_display, validate=sysprep_params_validate
+    ) if len(needed) != 0 else None
+
+    # Create Image Registration Wizard Page
+    def registration_choices():
+        return [("Private", "Image is accessible only by this user"),
+                ("Public", "Everyone can create VMs from this image")]
+
+    registration = WizardRadioListPage(
+        "ImageRegistration", "Registration Type",
+        "Please provide a registration type:", registration_choices,
+        title="Registration Type", default="Private")
 
     w = Wizard(session)
 
+    w.add_page(cloud)
     w.add_page(name)
     w.add_page(descr)
-    w.add_page(account)
-    w.add_page(token)
-    w.add_page(proceed)
+    if sysprep_params is not None:
+        w.add_page(sysprep_params)
+    w.add_page(registration)
 
     if w.run():
-        extract_image(session)
+        create_image(session)
     else:
         return False
 
     return True
 
 
-def extract_image(session):
-    disk = session['disk']
-    device = session['device']
-    snapshot = session['snapshot']
-    image_os = session['image_os']
+def create_image(session):
+    """Create an image using the information collected by the wizard"""
+    d = session['dialog']
+    image = session['image']
     wizard = session['wizard']
 
-    out = OutputWthProgress(True)
-    #Initialize the output
-    disk.out = out
-    device.out = out
-    image_os.out = out
-
-    out.output()
-
-    #Sysprep
-    device.mount(False)
-    image_os.do_sysprep()
-    metadata = image_os.meta
-    device.umount()
+    with_progress = OutputWthProgress(True)
+    out = image.out
+    out.add(with_progress)
+    try:
+        out.clear()
 
-    #Shrink
-    size = device.shrink()
-    metadata.update(device.meta)
+        #Sysprep
+        image.os.sysprep_params.update(wizard['SysprepParams'])
+        image.os.do_sysprep()
+        metadata = image.os.meta
 
-    #MD5
-    md5 = MD5(out)
-    checksum = md5.compute(snapshot, size)
+        #Shrink
+        size = image.shrink()
+        session['shrinked'] = True
+        update_background_title(session)
 
-    #Metadata
-    metastring = '\n'.join(
-        ['%s=%s' % (key, value) for (key, value) in metadata.items()])
-    metastring += '\n'
+        metadata.update(image.meta)
+        metadata['DESCRIPTION'] = wizard['ImageDescription']
 
-    out.output()
-    try:
-        out.output("Uploading image to pithos:")
-        kamaki = Kamaki(wizard['account'], wizard['token'], out)
-
-        name = "%s-%s.diskdump" % (wizard['ImageName'],
-                                   time.strftime("%Y%m%d%H%M"))
-        pithos_file = ""
-        with open(snapshot, 'rb') as f:
-            pithos_file = kamaki.upload(f, size, name,
-                                         "(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" % (name, 'meta'))
-        out.success('done')
-        out.output("(4/4)  Uploading md5sum file...", False)
-        md5sumstr = '%s %s\n' % (checksum, name)
-        kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
-                      remote_path="%s.%s" % (name, 'md5sum'))
-        out.success('done')
-        out.output()
+        #MD5
+        md5 = MD5(out)
+        session['checksum'] = md5.compute(image.device, size)
 
-        out.output('Registring image to ~okeanos...', False)
-        kamaki.register(wizard['ImageName'], pithos_file, metadata)
-        out.success('done')
         out.output()
-    except ClientError as e:
-        raise FatalError("Pithos client: %d %s" % (e.status, e.message))
+        try:
+            out.output("Uploading image to the cloud:")
+            account = Kamaki.get_account(wizard['Cloud'])
+            assert account, "Cloud: %s is not valid" % wizard['Cloud']
+            kamaki = Kamaki(account, out)
+
+            name = "%s-%s.diskdump" % (wizard['ImageName'],
+                                       time.strftime("%Y%m%d%H%M"))
+            pithos_file = ""
+            with open(image.device, 'rb') as f:
+                pithos_file = kamaki.upload(f, size, name,
+                                            "(1/3)  Calculating block hashes",
+                                            "(2/3)  Uploading missing blocks")
+
+            out.output("(3/3)  Uploading md5sum file ...", False)
+            md5sumstr = '%s %s\n' % (session['checksum'], name)
+            kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
+                          remote_path="%s.%s" % (name, 'md5sum'))
+            out.success('done')
+            out.output()
+
+            is_public = True if wizard['ImageRegistration'] == "Public" else \
+                False
+            out.output('Registering %s image with the cloud ...' %
+                       wizard['ImageRegistration'].lower(), False)
+            result = kamaki.register(wizard['ImageName'], pithos_file,
+                                     metadata, is_public)
+            out.success('done')
+            out.output("Uploading metadata file ...", False)
+            metastring = unicode(json.dumps(result, ensure_ascii=False))
+            kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
+                          remote_path="%s.%s" % (name, 'meta'))
+            out.success('done')
+
+            if is_public:
+                out.output("Sharing md5sum file ...", False)
+                kamaki.share("%s.md5sum" % name)
+                out.success('done')
+                out.output("Sharing metadata file ...", False)
+                kamaki.share("%s.meta" % name)
+                out.success('done')
+
+            out.output()
+
+        except ClientError as e:
+            raise FatalError("Storage service client: %d %s" %
+                             (e.status, e.message))
+    finally:
+        out.remove(with_progress)
+
+    text = "The %s image was successfully uploaded to the storage service " \
+           "and registered with the compute service of %s. Would you like " \
+           "to keep a local copy?" % \
+           (wizard['Cloud'], wizard['ImageRegistration'].lower())
+
+    if not d.yesno(text, width=PAGE_WIDTH):
+        extract_image(session)
 
 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :