Merge pull request #72 from TechConsult/storage_methods

Update ReadMe and refactor storage methods

Author: Trdls

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')
+
+```

docs/server-mixin.md

@@ -20,7 +20,7 @@ manager.method()
 ```python
 def get_servers(self, populate=False):
 	"""
-	Returns a list of (populated or unpopulated) Server instances. 
+	Returns a list of (populated or unpopulated) Server instances.
 	Populate = False (default) => 1 API request, returns unpopulated Server instances.
 	Populate = True => Does 1 + n API requests (n = # of servers), returns populated Server instances.
 	"""
@@ -36,14 +36,14 @@ def get_server(self, UUID):
 ```python
 def create_server(self, server):
 	"""
-	Creates a server and its storages based on a (locally created) Server object. 
+	Creates a server and its storages based on a (locally created) Server object.
 	Populates the given Server instance with the API response.
 
 	Example:
 	server1 = Server( core_number = 1,
-				memory_amount = 1024, 
-				hostname = "my.example.1", 
-				zone = ZONE.London, 
+				memory_amount = 1024,
+				hostname = "my.example.1",
+				zone = ZONE.London,
 				storage_devices = [
 					Storage(os = "Ubuntu 14.04", size=10, tier=maxiops, title='The OS drive'),
 					Storage(size=10),
@@ -56,7 +56,7 @@ def create_server(self, server):
 	- size defaults to 10,
 	- title defaults to hostname + " OS disk" and hostname + " storage disk id" (id is a running starting from 1)
 	- tier defaults to maxiops
-	- valid operating systems are: 
+	- valid operating systems are:
 		"CentOS 6.5", "CentOS 7.0"
 		"Debian 7.8"
 		"Ubuntu 12.04", "Ubuntu 14.04"
@@ -76,17 +76,25 @@ def modify_server(self, UUID, **kwargs):
 ```python
 def delete_server(self, UUID):
 	"""
-	DELETE '/server/UUID'. Permanently destroys the virtual machine. 
+	DELETE '/server/UUID'. Permanently destroys the virtual machine.
 	DOES NOT remove the storage disks.
 
 	Returns an empty object.
 	"""
 ```
 
+```python
+def get_server_by_ip(self, ip_address):
+		"""
+		Return a (populated) Server instance by its IP.
+		Uses GET '/ip_address/x.x.x.x' to retrieve machine UUID using IP-address.
+		"""
+```
+
 ```python
 def get_server_data(self, UUID):
 	"""
-	Returns '/server/uuid' data in Python dict. 
+	Returns '/server/uuid' data in Python dict.
 	Creates object representations of any IP-address and Storage.
 	"""
-```
+```

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/storage.py

@@ -80,6 +80,39 @@ def update(self, size, title):
         self.title = title
         self.save()
 
+    def clone(self, title, zone, tier=None):
+        """
+        Clone the storage using StorageManager.
+        Returns an object based on the API's response.
+        """
+        return self.cloud_manager.clone_storage(self.uuid, title, zone, tier)
+
+    def cancel_cloning(self):
+        """
+        Cancels a running cloning operation and deletes the incomplete copy using StorageManager.
+        Needs to be called from the cloned storage and not the storage that is being cloned.
+        """
+        return self.cloud_manager.cancel_clone_storage(self.uuid)
+
+    def create_backup(self, title):
+        """
+        Creates a point-in-time backup of a storage resource using StorageManager.
+        """
+        return self.cloud_manager.create_storage_backup(self.uuid, title)
+
+    def restore_backup(self):
+        """
+        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.
+        """
+        return self.cloud_manager.restore_storage_backup(self.uuid)
+
+    def templatize(self, title):
+        """
+        Creates an exact copy of an existing storage resource which can be used as a template for creating new servers using StorageManager.
+        """
+        return self.cloud_manager.templatize_storage(self.uuid, title)
+
     def __str__(self):
         """
         String representation of Storage.