Storage methods

Author: faustas@techconsult.lt

README.md

@@ -233,21 +233,21 @@ Set up environment and install dependencies:
 # run at project root, python3 and virtualenv must be installed
 virtualenv ENV
 source ENV/bin/activate
-pip install -r requirements.txt
+pip install -r requirements.txt or pip install -r requirements-dev.txt if changes to the api need to be made
 ```
 
 Install the package in editable mode, as mentioned in
-[https://pytest.org/latest/goodpractises.html](https://pytest.org/latest/goodpractises.html)
+[https://docs.pytest.org/en/stable/goodpractices.html](https://docs.pytest.org/en/stable/goodpractices.html)
 
 ```python
 # run at project root
 pip install -e .
 ```
 
-Tests located in `project_root/tests/` directory. Run with:
+Tests located in `project_root/test/` directory. Run with:
 
 ```python
-py.test tests/
+py.test test/
 ```
 
 To test against all supported python versions, run:

docs/Storage.md

@@ -81,3 +81,64 @@ Warning: data loss is permanent.
 storage.destroy()
 
 ```
+
+
+## Clone
+
+Clone the storage using StorageManager.
+Returns an object based on the API's response.
+Method requires title and zone to be passed while tier is optional.
+
+```python
+
+storage_clone = storage.clone(title='title of storage clone', zone=ZONE.Helsinki, tier=None)
+
+```
+
+
+## Cancel clone operation
+
+Cancels a running cloning operation and deletes the incomplete copy using StorageManager.
+Needs to be called from the cloned storage (object returned by clone operation) and not the storage that is being cloned.
+
+```python
+
+storage_clone.cancel_cloning()
+
+```
+
+
+## Create backup
+
+Creates a point-in-time backup of a storage resource using StorageManager.
+Method requires title to be passed.
+
+```python
+
+storage_backup = storage.create_backup('Backup title')
+
+```
+
+
+## Restore backup
+
+Restores the origin storage with data from the specified backup storage using StorageManager.
+Must be called from a storage object created by create_backup and not the original one.
+
+```python
+
+storage_backup.restore_backup()
+
+```
+
+
+## Templatize storage
+
+Creates an exact copy of an existing storage resource which can be used as a template for creating new servers using StorageManager.
+Method requires title to be passed.
+
+```python
+
+storage.templatize('Template title')
+
+```

test/json_data/storage_01350eec-6ebf-4418-abe4-e8bb1d5c9643.json

@@ -0,0 +1,16 @@
+{"storage":
+  {
+  "access": "private",
+  "created": "2020-09-21T17:36:50Z",
+  "license": 0,
+  "origin": "01ec5c26-a25d-4752-94e4-27bd88b62816",
+  "progress": "0",
+  "servers": {"server": []},
+  "size": 666,
+  "state": "maintenance",
+  "title": "test-backup",
+  "type": "backup",
+  "uuid": "01350eec-6ebf-4418-abe4-e8bb1d5c9643",
+  "zone": "fi-hel1"
+  }
+}

test/test_storage.py

@@ -40,7 +40,7 @@ def test_clone_storage(self, manager):
         storage = manager.get_storage("01d4fcd4-e446-433b-8a9c-551a1284952e")
 
         Mock.mock_post("storage/01d4fcd4-e446-433b-8a9c-551a1284952e/clone")
-        cloned_storage = manager.clone_storage(storage, 'cloned-storage-test', 'fi-hel1')
+        cloned_storage = storage.clone('cloned-storage-test', 'fi-hel1')
         assert type(cloned_storage).__name__ == "Storage"
         assert cloned_storage.size == 666
         assert cloned_storage.tier == "maxiops"
@@ -56,7 +56,7 @@ def test_cancel_clone_storage(self, manager):
         cloned_storage = manager.clone_storage(storage, 'cloned-storage-test', 'fi-hel1')
 
         Mock.mock_post("storage/01d3e9ad-8ff5-4a52-9fa2-48938e488e78/cancel", empty_content=True)
-        res = manager.cancel_clone_storage(cloned_storage)
+        res = cloned_storage.cancel_cloning()
         assert res == {}
 
     @responses.activate
@@ -73,24 +73,33 @@ def test_eject_cd_rom(self, manager):
 
     @responses.activate
     def test_create_storage_backup(self, manager):
+        data = Mock.mock_get("storage/01d4fcd4-e446-433b-8a9c-551a1284952e")
+        storage = manager.get_storage("01d4fcd4-e446-433b-8a9c-551a1284952e")
+
         data = Mock.mock_post("storage/01d4fcd4-e446-433b-8a9c-551a1284952e/backup")
-        storage = manager.create_storage_backup("01d4fcd4-e446-433b-8a9c-551a1284952e", "test-backup")
-        assert storage.title == "test-backup"
-        assert storage.size == 666
-        assert storage.zone == "fi-hel1"
+        storage_backup = storage.create_backup("test-backup")
+        assert storage_backup.title == "test-backup"
+        assert storage_backup.size == 666
+        assert storage_backup.zone == "fi-hel1"
 
     @responses.activate
     def test_restore_storage_backup(self, manager):
+        data = Mock.mock_get("storage/01350eec-6ebf-4418-abe4-e8bb1d5c9643")
+        storage_backup = manager.get_storage("01350eec-6ebf-4418-abe4-e8bb1d5c9643")
+
         data = Mock.mock_post("storage/01350eec-6ebf-4418-abe4-e8bb1d5c9643/restore", empty_content=True)
-        res = manager.restore_storage_backup("01350eec-6ebf-4418-abe4-e8bb1d5c9643")
+        res = storage_backup.restore_backup()
         assert res == {}
 
     @responses.activate
     def test_templatize_storage(self, manager):
+        data = Mock.mock_get("storage/01d4fcd4-e446-433b-8a9c-551a1284952e")
+        storage = manager.get_storage("01d4fcd4-e446-433b-8a9c-551a1284952e")
+
         data = Mock.mock_post("storage/01d4fcd4-e446-433b-8a9c-551a1284952e/templatize")
-        storage = manager.templatize_storage("01d4fcd4-e446-433b-8a9c-551a1284952e", "my server template")
-        assert storage.title == "my server template"
-        assert storage.type == "template"
+        storage_template = storage.templatize("my server template")
+        assert storage_template.title == "my server template"
+        assert storage_template.type == "template"
 
     @responses.activate
     def test_create_storage_import(self, manager):

upcloud_api/cloud_manager/base.py

@@ -74,6 +74,12 @@ def put_request(self, endpoint, body=None, timeout=-1, request_to_api=True):
         """
         return self.request('PUT', endpoint, body, timeout, request_to_api=request_to_api)
 
+    def delete_request(self, endpoint, body=None, timeout=-1):
+        """
+        Perform a DELETE request to a given endpoint in UpCloud's API.
+        """
+        return self.request('DELETE', endpoint, body, timeout)
+
     def __error_middleware(self, res, res_json):
         """
         Middleware that raises an exception when HTTP statuscode is an error code.

upcloud_api/cloud_manager/firewall_mixin.py

@@ -59,7 +59,7 @@ def delete_firewall_rule(self, server_uuid, firewall_rule_position):
         Delete a firewall rule based on a server uuid and rule position.
         """
         url = '/server/{0}/firewall_rule/{1}'.format(server_uuid, firewall_rule_position)
-        return self.request('DELETE', url)
+        return self.delete_request(url)
 
     def configure_firewall(self, server, firewall_rule_bodies):
         """

upcloud_api/cloud_manager/ip_address_mixin.py

@@ -41,7 +41,7 @@ def attach_ip(self, server, family='IPv4'):
             }
         }
 
-        res = self.request('POST', '/ip_address', body)
+        res = self.post_request('/ip_address', body)
         return IPAddress(cloud_manager=self, **res['ip_address'])
 
     def modify_ip(self, ip_addr, ptr_record):
@@ -56,7 +56,7 @@ def modify_ip(self, ip_addr, ptr_record):
             }
         }
 
-        res = self.request('PUT', '/ip_address/' + str(ip_addr), body)
+        res = self.put_request('/ip_address/' + str(ip_addr), body)
         return IPAddress(cloud_manager=self, **res['ip_address'])
 
     def release_ip(self, ip_addr):
@@ -65,4 +65,4 @@ def release_ip(self, ip_addr):
 
         Accepts an IPAddress instance (object) or its address (string).
         """
-        return self.request('DELETE', '/ip_address/' + str(ip_addr))
+        return self.delete_request('/ip_address/' + str(ip_addr))

upcloud_api/cloud_manager/server_mixin.py

@@ -138,7 +138,7 @@ def modify_server(self, UUID, **kwargs):
                 Exception('{0} is not an updateable field'.format(arg))
             body['server'][arg] = kwargs[arg]
 
-        res = self.request('PUT', '/server/{0}'.format(UUID), body)
+        res = self.put_request('/server/{0}'.format(UUID), body)
         server = res['server']
 
         # Populate subobjects
@@ -164,7 +164,7 @@ def delete_server(self, UUID):
 
         Returns an empty object.
         """
-        return self.request('DELETE', '/server/{0}'.format(UUID))
+        return self.delete_request('/server/{0}'.format(UUID))
 
     def get_server_data(self, UUID):
         """

upcloud_api/cloud_manager/storage_mixin.py

@@ -52,7 +52,7 @@ def _modify_storage(self, storage, size, title, backup_rule={}):
             body['storage']['title'] = title
         if backup_rule:
             body['storage']['backup_rule'] = backup_rule
-        return self.request('PUT', '/storage/' + str(storage), body)
+        return self.put_request('/storage/' + str(storage), body)
 
     def modify_storage(self, storage, size, title, backup_rule={}):
         """
@@ -65,7 +65,7 @@ def delete_storage(self, UUID):
         """
         Destroy a Storage object.
         """
-        return self.request('DELETE', '/storage/' + UUID)
+        return self.delete_request('/storage/' + UUID)
 
     def clone_storage(self, storage, title, zone, tier=None):
         """
@@ -74,14 +74,14 @@ def clone_storage(self, storage, title, zone, tier=None):
         body = {'storage': {'title': title, 'zone': zone}}
         if tier:
             body['storage']['tier'] = tier
-        res = self.request('POST', '/storage/{0}/clone'.format(str(storage)), body)
+        res = self.post_request('/storage/{0}/clone'.format(str(storage)), body)
         return Storage(cloud_manager=self, **res['storage'])
 
     def cancel_clone_storage(self, storage):
         """
         Cancels a running cloning operation and deletes the incomplete copy.
         """
-        return self.request('POST', '/storage/{0}/cancel'.format(str(storage)))
+        return self.post_request('/storage/{0}/cancel'.format(str(storage)))
 
     def attach_storage(self, server, storage, storage_type, address):
         """

upcloud_api/cloud_manager/tag_mixin.py

@@ -33,7 +33,7 @@ def create_tag(self, name, description=None, servers=[]):
         """
         servers = [str(server) for server in servers]
         body = {'tag': Tag(name, description, servers).to_dict()}
-        res = self.request('POST', '/tag', body)
+        res = self.post_request('/tag', body)
 
         return Tag(cloud_manager=self, **res['tag'])
 
@@ -44,7 +44,7 @@ def _modify_tag(self, name, description, servers, new_name):
         Private method used by the Tag class and TagManager.modify_tag.
         """
         body = {'tag': Tag(new_name, description, servers).to_dict()}
-        res = self.request('PUT', '/tag/' + name, body)
+        res = self.put_request('/tag/' + name, body)
         return res['tag']
 
     def modify_tag(self, name, description=None, servers=None, new_name=None):
@@ -82,4 +82,4 @@ def remove_tags(self, server, tags):
 
     def delete_tag(self, tag):
         """Delete the Tag. Returns and empty object."""
-        return self.request('DELETE', '/tag/' + str(tag))
+        return self.delete_request('/tag/' + str(tag))