snaps/openstack/utils/glance_utils.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 import logging
  16 import os
  17 import uuid
  18
  19 from snaps import file_utils
  20 from glanceclient.client import Client
  21
  22 from snaps.domain.image import Image
  23 from snaps.openstack.utils import keystone_utils
  24
  25 __author__ = 'spisarski'
  26
  27 logger = logging.getLogger('glance_utils')
  28
  29 VERSION_1 = 1.0
  30 VERSION_2 = 2.0
  31
  32 """
  33 Utilities for basic neutron API calls
  34 """
  35
  36
  37 def glance_client(os_creds):
  38     """
  39     Creates and returns a glance client object
  40     :return: the glance client
  41     """
  42     return Client(version=os_creds.image_api_version,
  43                   session=keystone_utils.keystone_session(os_creds))
  44
  45
  46 def get_image(glance, image_name=None):
  47     """
  48     Returns an OpenStack image object for a given name
  49     :param glance: the Glance client
  50     :param image_name: the image name to lookup
  51     :return: the image object or None
  52     """
  53     images = glance.images.list()
  54     for image in images:
  55         if glance.version == VERSION_1:
  56             if image.name == image_name:
  57                 image = glance.images.get(image.id)
  58                 return Image(name=image.name, image_id=image.id,
  59                              size=image.size, properties=image.properties)
  60         elif glance.version == VERSION_2:
  61             if image['name'] == image_name:
  62                 return Image(
  63                     name=image['name'], image_id=image['id'],
  64                     size=image['size'], properties=image.get('properties'))
  65     return None
  66
  67
  68 def get_image_status(glance, image):
  69     """
  70     Returns a new OpenStack Image object for a given OpenStack image object
  71     :param glance: the Glance client
  72     :param image: the domain Image object
  73     :return: the OpenStack Image object
  74     """
  75     if glance.version == VERSION_1:
  76         os_image = glance.images.get(image.id)
  77         return os_image.status
  78     elif glance.version == VERSION_2:
  79         os_image = glance.images.get(image.id)
  80         return os_image['status']
  81     else:
  82         raise GlanceException('Unsupported glance client version')
  83
  84
  85 def create_image(glance, image_settings):
  86     """
  87     Creates and returns OpenStack image object with an external URL
  88     :param glance: the glance client
  89     :param image_settings: the image settings object
  90     :return: the OpenStack image object
  91     :raise Exception if using a file and it cannot be found
  92     """
  93     if glance.version == VERSION_1:
  94         return __create_image_v1(glance, image_settings)
  95     elif glance.version == VERSION_2:
  96         return __create_image_v2(glance, image_settings)
  97     else:
  98         raise GlanceException('Unsupported glance client version')
  99
 100
 101 def __create_image_v1(glance, image_settings):
 102     """
 103     Creates and returns OpenStack image object with an external URL
 104     :param glance: the glance client
 105     :param image_settings: the image settings object
 106     :return: the OpenStack image object
 107     :raise exceptions from the Glance client or IOError when opening a file
 108     """
 109     kwargs = {
 110         'name': image_settings.name, 'disk_format': image_settings.format,
 111         'container_format': 'bare', 'is_public': image_settings.public}
 112
 113     if image_settings.extra_properties:
 114         kwargs['properties'] = image_settings.extra_properties
 115
 116     if image_settings.url:
 117         kwargs['location'] = image_settings.url
 118     elif image_settings.image_file:
 119         image_file = open(image_settings.image_file, 'rb')
 120         kwargs['data'] = image_file
 121     else:
 122         logger.warn('Unable to create image with name - %s. No file or URL',
 123                     image_settings.name)
 124         return None
 125
 126     created_image = glance.images.create(**kwargs)
 127     return Image(name=image_settings.name, image_id=created_image.id,
 128                  size=created_image.size, properties=created_image.properties)
 129
 130
 131 def __create_image_v2(glance, image_settings):
 132     """
 133     Creates and returns OpenStack image object with an external URL
 134     :param glance: the glance client v2
 135     :param image_settings: the image settings object
 136     :return: the OpenStack image object
 137     :raise GlanceException or IOException or URLError
 138     """
 139     cleanup_temp_file = False
 140     image_file = None
 141     if image_settings.image_file:
 142         image_filename = image_settings.image_file
 143     elif image_settings.url:
 144         file_name = str(uuid.uuid4())
 145         try:
 146             image_file = file_utils.download(
 147                 image_settings.url, './tmp', file_name)
 148             image_filename = image_file.name
 149         except:
 150             os.remove('./tmp/' + file_name)
 151             raise
 152
 153         cleanup_temp_file = True
 154     else:
 155         raise GlanceException('Filename or URL of image not configured')
 156
 157     created_image = None
 158     try:
 159         kwargs = dict()
 160         kwargs['name'] = image_settings.name
 161         kwargs['disk_format'] = image_settings.format
 162         kwargs['container_format'] = 'bare'
 163
 164         if image_settings.public:
 165             kwargs['visibility'] = 'public'
 166
 167         if image_settings.extra_properties:
 168             kwargs.update(image_settings.extra_properties)
 169
 170         created_image = glance.images.create(**kwargs)
 171         image_file = open(image_filename, 'rb')
 172         glance.images.upload(created_image['id'], image_file)
 173     except:
 174         logger.error('Unexpected exception creating image. Rolling back')
 175         if created_image:
 176             delete_image(glance, created_image)
 177         raise
 178     finally:
 179         if image_file:
 180             image_file.close()
 181         if cleanup_temp_file:
 182             os.remove(image_filename)
 183
 184     updated_image = glance.images.get(created_image['id'])
 185     return Image(
 186         name=updated_image['name'], image_id=updated_image['id'],
 187         size=updated_image['size'], properties=updated_image.get('properties'))
 188
 189
 190 def delete_image(glance, image):
 191     """
 192     Deletes an image from OpenStack
 193     :param glance: the glance client
 194     :param image: the image to delete
 195     """
 196     if glance.version == VERSION_1:
 197         glance.images.delete(image)
 198     elif glance.version == VERSION_2:
 199         glance.images.delete(image.id)
 200     else:
 201         raise GlanceException('Unsupported glance client version')
 202
 203
 204 class GlanceException(Exception):
 205     """
 206     Exception when calls to the Glance client cannot be served properly
 207     """