Update version.py and ChangeLog for 0.6.1
[snf-image-creator] / image_creator / kamaki_wrapper.py
index e3c249e..07df8d9 100644 (file)
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2012 GRNET S.A. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
+"""This modules provides the interface for working with the ./kamaki library.
+The library is used to upload images to and register them with a Synnefo
+deployment.
+"""
+
+import sys
+
 from os.path import basename
 
-from kamaki.config import Config
+from kamaki.cli.config import Config
 from kamaki.clients import ClientError
 from kamaki.clients.image import ImageClient
 from kamaki.clients.pithos import PithosClient
-from progress.bar import Bar
-
-from image_creator.util import FatalError, output, success
-
-CONTAINER = "images"
-
+from kamaki.clients.astakos import CachedAstakosClient as AstakosClient
+
+try:
+    config = Config()
+except Exception as e:
+    sys.stderr.write("Kamaki config error: %s\n" % str(e))
+    sys.exit(1)
+
+
+class Kamaki(object):
+    """Wrapper class for the ./kamaki library"""
+    CONTAINER = "images"
+
+    @staticmethod
+    def get_default_cloud_name():
+        """Returns the name of the default cloud"""
+        clouds = config.keys('cloud')
+        default = config.get('global', 'default_cloud')
+        if not default:
+            return clouds[0] if len(clouds) else ""
+        return default if default in clouds else ""
+
+    @staticmethod
+    def set_default_cloud(name):
+        """Sets a cloud account as default"""
+        config.set('global', 'default_cloud', name)
+        config.write()
+
+    @staticmethod
+    def get_clouds():
+        """Returns the list of available clouds"""
+        names = config.keys('cloud')
+
+        clouds = {}
+        for name in names:
+            clouds[name] = config.get('cloud', name)
+
+        return clouds
+
+    @staticmethod
+    def get_cloud_by_name(name):
+        """Returns a dict with cloud info"""
+        return config.get('cloud', name)
+
+    @staticmethod
+    def save_cloud(name, url, token, description=""):
+        """Save a new cloud account"""
+        cloud = {'url': url, 'token': token}
+        if len(description):
+            cloud['description'] = description
+        config.set('cloud', name, cloud)
+
+        # Make the saved cloud the default one
+        config.set('global', 'default_cloud', name)
+        config.write()
+
+    @staticmethod
+    def remove_cloud(name):
+        """Deletes an existing cloud from the Kamaki configuration file"""
+        config.remove_option('cloud', name)
+        config.write()
+
+    @staticmethod
+    def create_account(url, token):
+        """Given a valid (URL, tokens) pair this method returns an Astakos
+        client instance
+        """
+        client = AstakosClient(url, token)
+        try:
+            client.authenticate()
+        except ClientError:
+            return None
+
+        return client
+
+    @staticmethod
+    def get_account(cloud_name):
+        """Given a saved cloud name this method returns an Astakos client
+        instance
+        """
+        cloud = config.get('cloud', cloud_name)
+        assert cloud, "cloud: `%s' does not exist" % cloud_name
+        assert 'url' in cloud, "url attr is missing in %s" % cloud_name
+        assert 'token' in cloud, "token attr is missing in %s" % cloud_name
+
+        return Kamaki.create_account(cloud['url'], cloud['token'])
+
+    def __init__(self, account, output):
+        """Create a Kamaki instance"""
+        self.account = account
+        self.out = output
 
-def progress(message):
+        self.pithos = PithosClient(
+            self.account.get_service_endpoints('object-store')['publicURL'],
+            self.account.token,
+            self.account.user_info()['id'],
+            self.CONTAINER)
 
-    MSG_LENGTH = 30
+        self.image = ImageClient(
+            self.account.get_service_endpoints('image')['publicURL'],
+            self.account.token)
 
-    def progress_gen(n):
-        msg = "%s:" % message
+    def upload(self, file_obj, size=None, remote_path=None, hp=None, up=None):
+        """Upload a file to pithos"""
 
-        progressbar = Bar(msg.ljust(MSG_LENGTH))
-        progressbar.max = n
-        progressbar.fill = '#'
-        progressbar.bar_prefix = ' ['
-        progressbar.bar_suffix = '] '
+        path = basename(file_obj.name) if remote_path is None else remote_path
 
-        for _ in range(n):
-            yield
-            progressbar.next()
-        output("\r%s...\033[K" % message, False)
-        success("done")
-        yield
-    return progress_gen
+        try:
+            self.pithos.create_container(self.CONTAINER)
+        except ClientError as e:
+            if e.status != 202:  # Ignore container already exists errors
+                raise e
 
+        hash_cb = self.out.progress_generator(hp) if hp is not None else None
+        upload_cb = self.out.progress_generator(up) if up is not None else None
 
-class Kamaki:
-    def __init__(self, account, token):
-        self.account = account
-        self.token = token
+        self.pithos.upload_object(path, file_obj, size, hash_cb, upload_cb)
 
-        config = Config()
+        return "pithos://%s/%s/%s" % (self.account.user_info()['id'],
+                                      self.CONTAINER, path)
 
-        pithos_url = config.get('storage', 'url')
-        self.container = CONTAINER
-        self.pithos_client = PithosClient(pithos_url, token, self.account,
-                                                                self.container)
+    def register(self, name, location, metadata, public=False):
+        """Register an image with cyclades"""
 
-        image_url = config.get('image', 'url')
-        self.image_client = ImageClient(image_url, token)
+        # Convert all metadata to strings
+        str_metadata = {}
+        for (key, value) in metadata.iteritems():
+            str_metadata[str(key)] = str(value)
+        is_public = 'true' if public else 'false'
+        params = {'is_public': is_public, 'disk_format': 'diskdump'}
+        return self.image.register(name, location, params, str_metadata)
 
-        self.uploaded_object = None
+    def share(self, location):
+        """Share this file with all the users"""
 
-    def upload(self, file_obj, size=None, remote_path=None, hp=None, up=None):
-        """Upload a file to pithos"""
-        if remote_path is None:
-            remote_path = basename(filename)
+        self.pithos.set_object_sharing(location, "*")
 
-        try:
-            self.pithos_client.create_container(self.container)
-        except ClientError as e:
-            if e.status != 202:  # Ignore container already exists errors
-                raise FatalError("Pithos client: %d %s" % \
-                                                    (e.status, e.message))
-        try:
-            hash_cb = progress(hp) if hp is not None else None
-            upload_cb = progress(up) if up is not None else None
-            self.pithos_client.create_object(remote_path, file_obj, size,
-                                                            hash_cb, upload_cb)
-            return "pithos://%s/%s/%s" % \
-                            (self.account, self.container, remote_path)
-        except ClientError as e:
-            raise FatalError("Pithos client: %d %s" % (e.status, e.message))
+    def object_exists(self, location):
+        """Check if an object exists in pythos"""
 
-    def register(self, name, location, metadata):
-        """Register an image to ~okeanos"""
-        params = {'is_public': 'true', 'disk_format': 'diskdump'}
         try:
-            self.image_client.register(name, location, params, metadata)
+            self.pithos.get_object_info(location)
         except ClientError as e:
-            raise FatalError("Image client: %d %s" % (e.status, e.message))
+            if e.status == 404:  # Object not found error
+                return False
+            else:
+                raise
+        return True
 
 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :