refactor storages

Author: Elias Nygren

test/test_server.py

@@ -114,7 +114,6 @@ def test_attach_and_detach_storage(self, manager):
       status = 200,
       content_type='application/json'
     )
-
     server.remove_storage(server.storage_devices[1])
 
     assert len(server.storage_devices) == 1

test/test_server_creation.py

@@ -15,32 +15,22 @@ class TestCreateServer(object):
 
     def test_storage_prepare_post_body(self, manager):
         s1 = Storage(os='Ubuntu 14.04', size=10)
-        body1 = s1.prepare_post_body('my.example.com', 1)
-
-        assert body1['title'] == 'my.example.com OS disk'
+        body1 = s1.to_dict()
         assert body1['tier'] == 'maxiops'
         assert body1['size'] == 10
-        assert body1['storage'] == '01000000-0000-4000-8000-000030040200'
-        assert body1['action'] == 'clone'
 
         s2 = Storage(size=100)
-        body2 = s2.prepare_post_body('my.example.com', 1)
-
-        assert body2['title'] == 'my.example.com storage disk 1'
+        body2 = s2.to_dict()
         assert body2['tier'] == 'maxiops'
-        assert body2['action'] == 'create'
         assert body2['size'] == 100
 
     def test_storage_prepare_post_body_optional_attributes(self, manager):
-        s2 = Storage(size=100, address='virtio:0', type='disk')
-        body2 = s2.prepare_post_body('my.example.com', 1)
+        s2 = Storage(size=100, address='virtio:0')
+        body2 = s2.to_dict()
 
-        assert body2['title'] == 'my.example.com storage disk 1'
         assert body2['tier'] == 'maxiops'
-        assert body2['action'] == 'create'
         assert body2['size'] == 100
         assert body2['address'] == 'virtio:0'
-        assert body2['type'] == 'disk'
 
     def test_server_init(self, manager):
         server1 = Server(

test/test_storage.py

@@ -49,7 +49,9 @@ def test_storage_update_oop(self, manager):
         storage = manager.get_storage("01d4fcd4-e446-433b-8a9c-551a1284952e")
 
         Mock.mock_put("storage/01d4fcd4-e446-433b-8a9c-551a1284952e")
-        storage.update(title="my bigger data collection", size=15)
+        storage.title = "my bigger data collection"
+        storage.size = 15
+        storage.save()
         assert storage.title == "my bigger data collection"
         assert storage.size == 15
 

upcloud_api/cloud_manager/storage_mixin.py

@@ -20,64 +20,72 @@ def get_storages(self, storage_type='normal'):
         res = self.get_request('/storage/' + storage_type)
         return Storage._create_storage_objs(res['storages'], cloud_manager=self)
 
-    def get_storage(self, UUID):
+    def get_storage(self, storage):
         """
         Return a Storage object from the API.
         """
-        res = self.get_request('/storage/' + UUID)
-        return Storage._create_storage_obj(res['storage'], cloud_manager=self)
+        res = self.get_request('/storage/' + str(storage))
+        return Storage(cloud_manager=self, **res['storage'])
 
     def create_storage(self, size=10, tier='maxiops', title='Storage disk', zone='fi-hel1'):
         """
         Create a Storage object. Returns an object based on the API's response.
         """
-        body = dict()
-        body['storage'] = {
-            'size': size,
-            'tier': tier,
-            'title': title,
-            'zone': zone
+        body = {
+            'storage': {
+                'size': size,
+                'tier': tier,
+                'title': title,
+                'zone': zone
+            }
         }
         res = self.post_request('/storage', body)
-        return Storage._create_storage_obj(res['storage'], cloud_manager=self)
+        return Storage(cloud_manager=self, **res['storage'])
 
-    def modify_storage(self, UUID, size, title):
+    def _modify_storage(self, storage, size, title):
+        body = {'storage': {}}
+        if size:
+            body['storage']['size'] = size
+        if title:
+            body['storage']['title'] = title
+        return self.request('PUT', '/storage/' + str(storage), body)
+
+    def modify_storage(self, storage, size, title):
         """
         Modify a Storage object. Returns an object based on the API's response.
         """
-        body = Storage.prepare_put_body(size, title)
-        res = self.request('PUT', '/storage/' + UUID, body)
-        return Storage._create_storage_obj(res['storage'], cloud_manager=self)
+        res = self._modify_storage(str(storage), size, title)
+        return Storage(cloud_manager=self, **res['storage'])
 
     def delete_storage(self, UUID):
         """
         Destroy a Storage object.
         """
         return self.request('DELETE', '/storage/' + UUID)
 
-    def attach_storage(self, server_uuid, storage_uuid, storage_type, address):
+    def attach_storage(self, server, storage, storage_type, address):
         """
         Attach a Storage object to a Server. Return a list of the server's storages.
         """
         body = {'storage_device': {}}
-        if storage_uuid:
-            body['storage_device']['storage'] = storage_uuid
+        if storage:
+            body['storage_device']['storage'] = str(storage)
 
         if storage_type:
             body['storage_device']['type'] = storage_type
 
         if address:
             body['storage_device']['address'] = address
 
-        url = '/server/{0}/storage/attach'.format(server_uuid)
+        url = '/server/{0}/storage/attach'.format(server)
         res = self.post_request(url, body)
         return Storage._create_storage_objs(res['server']['storage_devices'], cloud_manager=self)
 
-    def detach_storage(self, server_uuid, address):
+    def detach_storage(self, server, address):
         """
         Detach a Storage object to a Server. Return a list of the server's storages.
         """
         body = {'storage_device': {'address': address}}
-        url = '/server/{0}/storage/detach'.format(server_uuid)
+        url = '/server/{0}/storage/detach'.format(server)
         res = self.post_request(url, body)
         return Storage._create_storage_objs(res['server']['storage_devices'], cloud_manager=self)

upcloud_api/errors.py

@@ -1,5 +1,11 @@
 
 class UpCloudClientError(Exception):
+    """
+    Base exception for UpCloud API client.
+
+    All exceptions thrown by the client should be of the type UpCloudClientError
+    or at least one of its subclasses.
+    """
     pass
 
 class UpCloudAPIError(UpCloudClientError):

upcloud_api/server.py

@@ -4,7 +4,7 @@
 import itertools
 from time import sleep
 
-from upcloud_api import Storage, IPAddress, UpCloudAPIError
+from upcloud_api import Storage, IPAddress, UpCloudAPIError, OperatingSystems
 from upcloud_api.utils import try_it_n_times
 
 
@@ -208,19 +208,21 @@ def remove_ip(self, IPAddress):
         self.cloud_manager.release_ip(IPAddress.address)
         self.ip_addresses.remove(IPAddress)
 
-    def add_storage(self, Storage=None, type='disk', address=None):
+    def add_storage(self, storage=None, type='disk', address=None):
         """
-        Attach the given Storage to the Server.
+        Attach the given storage to the Server.
 
-        Default address is next available. To add a CDROM slot: add_storage('cdrom').
+        Default address is next available.
         """
-        self.cloud_manager.attach_storage(server_uuid=self.uuid,
-                                          storage_uuid=Storage.uuid,
+        self.cloud_manager.attach_storage(server=self.uuid,
+                                          storage=storage.uuid,
                                           storage_type=type,
                                           address=address)
-        self.storage_devices.append(Storage)
+        storage.address = address
+        storage.type = type
+        self.storage_devices.append(storage)
 
-    def remove_storage(self, Storage):
+    def remove_storage(self, storage):
         """
         Remove Storage from a Server.
 
@@ -229,16 +231,16 @@ def remove_storage(self, Storage):
 
         A Storage from get_storage(uuid) will not work as it is missing the 'address' property.
         """
-        if not hasattr(Storage, 'address'):
+        if not hasattr(storage, 'address'):
             raise Exception(
                 ('Storage does not have an address. '
                  'Access the Storage via Server.storage_devices '
                  'so they include an address. '
                  '(This is due how the API handles Storages)')
             )
 
-        self.cloud_manager.detach_storage(server_uuid=self.uuid, address=Storage.address)
-        self.storage_devices.remove(Storage)
+        self.cloud_manager.detach_storage(server=self.uuid, address=storage.address)
+        self.storage_devices.remove(storage)
 
     def add_firewall_rule(self, FirewallRule):
         """
@@ -326,9 +328,26 @@ def prepare_post_body(self):
 
         storage_title_id = 0  # running number for unique storage titles
         for storage in self.storage_devices:
-            if storage.os is None:
+            if not hasattr(storage, 'os') or storage.os is None:
                 storage_title_id += 1
-            storage_body = storage.prepare_post_body(self.hostname, storage_title_id)
+            storage_body = storage.to_dict()
+
+            # setup default titles for storages unless use has specified them
+            # at storage.title
+            if not hasattr(storage, 'title') or not storage.title:
+                if hasattr(storage, 'os') and storage.os:
+                    storage_body['title'] = self.hostname + ' OS disk'
+                else:
+                    storage_body['title'] = self.hostname + ' storage disk ' + str(storage_title_id)
+
+
+            # clone from public template OR create empty storage
+            if hasattr(storage, 'os') and storage.os:
+                storage_body['action'] = 'clone'
+                storage_body['storage'] = OperatingSystems.get_OS_UUID(storage.os)
+            else:
+                storage_body['action'] = 'create'
+
             body['server']['storage_devices']['storage_device'].append(storage_body)
 
         return body