# -*- coding: utf-8 -*-
#
# 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
# conditions are met:
#
# 1. Redistributions of source code must retain the above
# copyright notice, this list of conditions and the following
# disclaimer.
#
# 2. Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials
# provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
"""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:
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):
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
class WizardPage(object):
"""Represents a page in a wizard"""
NEXT = 1
PREV = -1
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 WizardPageWthChoices(WizardPage):
"""Represents a Wizard Page that allows the user to select something from
a list of choices.
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, title):
d = session['dialog']
w = session['wizard']
choices = []
for choice in self.choices():
default = 1 if choice[0] == self.default else 0
choices.append((choice[0], choice[1], default))
(code, answer) = d.radiolist(
self.text, width=PAGE_WIDTH, ok_label="Next", cancel="Back",
choices=choices, height=PAGE_HEIGHT, title=title)
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 WizardInputPage(WizardPage):
"""Represents an input field in a wizard"""
def run(self, session, title):
d = session['dialog']
w = session['wizard']
(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 WizardMenuPage(WizardPageWthChoices):
"""Represents a menu dialog with available choices in a wizard"""
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
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 start_wizard(session):
"""Run the image creation wizard"""
distro = session['image'].distro
ostype = session['image'].ostype
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 WizardInvalidData
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)
name = WizardInputPage(
"ImageName", "Image Name", "Please provide a name for the image:",
title="Image Name", default=ostype if distro == "unknown" else distro)
descr = WizardInputPage(
"ImageDescription", "Image Description",
"Please provide a description for the image:",
title="Image Description", default=session['metadata']['DESCRIPTION']
if 'DESCRIPTION' in session['metadata'] else '')
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(registration)
if w.run():
create_image(session)
else:
return False
return True
def create_image(session):
"""Create an image using the information collected by the wizard"""
d = session['dialog']
image = session['image']
wizard = session['wizard']
with_progress = OutputWthProgress(True)
out = image.out
out.add(with_progress)
try:
out.clear()
#Sysprep
image.os.do_sysprep()
metadata = image.os.meta
#Shrink
size = image.shrink()
session['shrinked'] = True
update_background_title(session)
metadata.update(image.meta)
metadata['DESCRIPTION'] = wizard['ImageDescription']
#MD5
md5 = MD5(out)
session['checksum'] = md5.compute(image.device, size)
out.output()
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 :