Add export/import capabilities to/from IBM Cloud Object Storage

Change image manager to include IBM Cloud Object Storage support and add unit tests for it.

Author: mikewurtz

SoftLayer/fixtures/SoftLayer_Virtual_Guest_Block_Device_Template_Group.py

@@ -29,5 +29,11 @@
     'id': 100,
     'name': 'test_image',
 }]
-
+createFromIcos = [{
+    'createDate': '2013-12-05T21:53:03-06:00',
+    'globalIdentifier': '0B5DEAF4-643D-46CA-A695-CECBE8832C9D',
+    'id': 100,
+    'name': 'test_image',
+}]
 copyToExternalSource = True
+copyToIcos = True

SoftLayer/managers/image.py

@@ -120,28 +120,68 @@ def edit(self, image_id, name=None, note=None, tag=None):
 
         return bool(name or note or tag)
 
-    def import_image_from_uri(self, name, uri, os_code=None, note=None):
+    def import_image_from_uri(self, name, uri, os_code=None, note=None,
+                              ibm_api_key=None, root_key_id=None,
+                              wrapped_dek=None, kp_id=None, cloud_init=None,
+                              byol=None, is_encrypted=None):
         """Import a new image from object storage.
 
         :param string name: Name of the new image
         :param string uri: The URI for an object storage object
             (.vhd/.iso file) of the format:
             swift://<objectStorageAccount>@<cluster>/<container>/<objectPath>
+            or (.vhd/.iso/.raw file) of the format:
+            cos://<clusterName>/<bucketName>/<objectPath> if using IBM Cloud
+            Object Storage
         :param string os_code: The reference code of the operating system
         :param string note: Note to add to the image
+        :param string ibm_api_key: Ibm Api Key needed to communicate with ICOS
+        and Key Protect
+        :param string root_key_id: ID of the root key in Key Protect
+        :param string wrapped_dek: Wrapped Decryption Key provided by IBM
+         KeyProtect
+        :param string kp_id: ID of the IBM Key Protect Instance
+        :param bool cloud_init: Specifies if image is cloud init
+        :param bool byol: Specifies if image is bring your own license
+        :param bool is_encrypted: Specifies if image is encrypted
         """
-        return self.vgbdtg.createFromExternalSource({
-            'name': name,
-            'note': note,
-            'operatingSystemReferenceCode': os_code,
-            'uri': uri,
-        })
-
-    def export_image_to_uri(self, image_id, uri):
+        if 'cos://' in uri:
+            return self.vgbdtg.createFromIcos({
+                'name': name,
+                'note': note,
+                'operatingSystemReferenceCode': os_code,
+                'uri': uri,
+                'ibmApiKey': ibm_api_key,
+                'rootKeyid': root_key_id,
+                'wrappedDek': wrapped_dek,
+                'keyProtectId': kp_id,
+                'cloudInit': cloud_init,
+                'byol': byol,
+                'isEncrypted': is_encrypted
+            })
+        else:
+            return self.vgbdtg.createFromExternalSource({
+                'name': name,
+                'note': note,
+                'operatingSystemReferenceCode': os_code,
+                'uri': uri,
+            })
+
+    def export_image_to_uri(self, image_id, uri, ibm_api_key=None):
         """Export image into the given object storage
 
         :param int image_id: The ID of the image
         :param string uri: The URI for object storage of the format
             swift://<objectStorageAccount>@<cluster>/<container>/<objectPath>
+            or cos://<clusterName>/<bucketName>/<objectPath> if using IBM Cloud
+            Object Storage
+        :param string ibm_api_key: Ibm Api Key needed to communicate with IBM
+        Cloud Object Storage
         """
-        return self.vgbdtg.copyToExternalSource({'uri': uri}, id=image_id)
+        if 'cos://' in uri:
+            return self.vgbdtg.copyToIcos({
+                'uri': uri,
+                'ibmApiKey': ibm_api_key
+            }, id=image_id)
+        else:
+            return self.vgbdtg.copyToExternalSource({'uri': uri}, id=image_id)

tests/managers/image_tests.py

@@ -145,6 +145,36 @@ def test_import_image(self):
                    'uri': 'someuri',
                    'operatingSystemReferenceCode': 'UBUNTU_LATEST'},))
 
+    def test_import_image_cos(self):
+        self.image.import_image_from_uri(name='test_image',
+                                         note='testimage',
+                                         uri='cos://some_uri',
+                                         os_code='UBUNTU_LATEST',
+                                         ibm_api_key='some_ibm_key',
+                                         root_key_id='some_root_key_id',
+                                         wrapped_dek='some_dek',
+                                         kp_id='some_id',
+                                         cloud_init=False,
+                                         byol=False,
+                                         is_encrypted=False
+                                         )
+
+        self.assert_called_with(
+            IMAGE_SERVICE,
+            'createFromIcos',
+            args=({'name': 'test_image',
+                   'note': 'testimage',
+                   'operatingSystemReferenceCode': 'UBUNTU_LATEST',
+                   'uri': 'cos://some_uri',
+                   'ibmApiKey': 'some_ibm_key',
+                   'rootKeyid': 'some_root_key_id',
+                   'wrappedDek': 'some_dek',
+                   'keyProtectId': 'some_id',
+                   'cloudInit': False,
+                   'byol': False,
+                   'isEncrypted': False
+                   },))
+
     def test_export_image(self):
         self.image.export_image_to_uri(1234, 'someuri')
 
@@ -153,3 +183,14 @@ def test_export_image(self):
             'copyToExternalSource',
             args=({'uri': 'someuri'},),
             identifier=1234)
+
+    def test_export_image_cos(self):
+        self.image.export_image_to_uri(1234,
+                                       'cos://someuri',
+                                       ibm_api_key='someApiKey')
+
+        self.assert_called_with(
+            IMAGE_SERVICE,
+            'copyToIcos',
+            args=({'uri': 'cos://someuri', 'ibmApiKey': 'someApiKey'},),
+            identifier=1234)