much leaner way to define servers and storages

Author: Elias Nygren

tests/json_data/server_create.json

@@ -0,0 +1,49 @@
+{
+	"server" : {
+		"boot_order" : "disk",
+		"core_number" : "2",
+		"firewall" : "off",
+		"hostname" : "my.example.com",
+		"ip_addresses" : {
+			"ip_address" : [
+				{
+					"access" : "private",
+					"address" : "10.3.0.49"
+				},
+				{
+					"access" : "public",
+					"address" : "38.100.118.31"
+				}
+			]
+		},
+		"license" : 0,
+		"memory_amount" : "1024",
+		"nic_model" : "virtio",
+		"state" : "started",
+		"storage_devices" : {
+			"storage_device" : [
+				{
+					"address" : "virtio:0",
+					"storage" : "01215a5a-c330-4565-81ca-0e0e22eac672",
+					"storage_size" : 20,
+					"storage_title" : "Ubuntu 14.04 from template",
+					"type" : "disk"
+				},
+				{
+					"address" : "virtio:1",
+					"storage" : "01a8fc6b-8aa3-42ff-bbce-ed5c544bbd74",
+					"storage_size" : 100,
+					"storage_title" : "storage disk 1",
+					"type" : "disk"
+				}
+			]
+		},
+		"timezone" : "UTC",
+		"title" : "my.example.com",
+		"uuid" : "00825599-2df7-4a83-99b4-c9a9c6812f59",
+		"video_model" : "cirrus",
+		"vnc" : "off",
+		"vnc_password" : "aabbccdd",
+		"zone" : "us-chi1"
+	}
+}

tests/test_server_creation.py

@@ -0,0 +1,95 @@
+from conftest import Mock
+from upcloud import ZONE
+from upcloud import Server
+from upcloud import Storage
+import responses
+import json
+import pytest
+
+class TestCreateServer():	
+
+
+	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"
+		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'
+		assert body2['tier'] == 'maxiops'
+		assert body2['action'] == 'create'
+		assert body2['size'] == 100	
+
+	def test_server_init(self, manager):
+		server1 = Server(core_number=2, memory_amount=1024, hostname="my.example.com",zone=ZONE.Chicago, storage_devices=[
+				Storage(os="Ubuntu 14.04", size=10),
+				Storage(size=100, title="storage disk 1")
+			])
+
+		assert server1.title == "my.example.com"
+		assert server1.core_number == 2
+		assert server1.memory_amount == 1024
+		assert server1.hostname == server1.title
+		assert server1.zone == "us-chi1"
+
+
+	def test_server_prepare_post_body(self):
+		server = Server(core_number=2, memory_amount=1024, hostname="my.example.com",zone=ZONE.Chicago, storage_devices=[
+				Storage(os="Ubuntu 14.04", size=10),
+				Storage()
+			])
+		body = server.prepare_post_body()
+
+		s1 = body["server"]["storage_devices"]["storage_device"][0]
+		assert s1['title'] == "my.example.com OS disk"
+		assert s1['tier'] == "maxiops"
+		assert s1['size'] == 10
+		assert s1['storage'] == '01000000-0000-4000-8000-000030040200'
+		assert s1['action'] == 'clone'
+		s2 = body["server"]["storage_devices"]["storage_device"][1]
+		assert s2['title'] == 'my.example.com storage disk 1'
+		assert s2['tier'] == 'maxiops'
+		assert s2['action'] == 'create'
+		assert s2['size'] == 10
+
+		assert body["server"]["title"] == "my.example.com"
+		assert body["server"]["core_number"] == 2
+		assert body["server"]["memory_amount"] == 1024
+		assert body["server"]["hostname"] == server.title
+		assert body["server"]["zone"] == "us-chi1"
+
+	@responses.activate
+	def test_create_server(self, manager):
+		
+		responses.add(
+			responses.POST, 
+			Mock.base_url + "/server",
+			body = Mock.read_from_file("server_create.json"),
+			status = 202,
+			content_type='application/json'
+		)
+
+		server1 = Server(core_number=2, memory_amount=1024, hostname="my.example.com",zone=ZONE.Chicago, storage_devices=[
+				Storage(os="Ubuntu 14.04", size=10),
+				Storage(size=100, title="storage disk 1")
+			])
+
+		manager.create_server(server1)
+		
+		# assert correct values in response
+		assert type(server1).__name__ == "Server"
+		assert server1.core_number == "2"
+		assert server1.memory_amount == "1024"
+
+		# assert new data was populated
+		assert server1.video_model ==  "cirrus"
+		assert server1.vnc ==  "off"
+		assert server1.vnc_password ==  "aabbccdd"
+

upcloud/__init__.py

@@ -14,3 +14,5 @@
 from .ip_address import IP_address
 from .firewall import Firewall
 from .cloud_manager import CloudManager
+from .tools import OperatingSystems
+from .tools import ZONE

upcloud/cloud_manager/ip_address_mixin.py

@@ -1,6 +1,4 @@
 from ..ip_address import IP_address
-from ..tools import _create_ip_address_obj
-from ..tools import _create_ip_address_objs
 
 
 class IPManager():
@@ -10,12 +8,12 @@ class IPManager():
 
 	def get_IP(self, UUID):
 		res = self.get_request("/ip_address/" + UUID)
-		IP = _create_ip_address_obj( res["ip_address"], cloud_manager=self )
+		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
 		return IP
 
 	def get_IPs(self):
 		res = self.get_request("/ip_address")
-		IPs = _create_ip_address_objs( res["ip_addresses"], cloud_manager=self )
+		IPs = IP_address._create_ip_address_objs( res["ip_addresses"], cloud_manager=self )
 		return IPs
 
 	def attach_IP(self, server_UUID):
@@ -25,7 +23,7 @@ def attach_IP(self, server_UUID):
 		}
 
 		res = self.request("POST", "/ip_address", body)
-		IP = _create_ip_address_obj( res["ip_address"], cloud_manager=self )
+		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
 		return IP
 
 	def modify_IP(self, IP_addr, ptr_record):
@@ -35,7 +33,7 @@ def modify_IP(self, IP_addr, ptr_record):
 		}
 
 		res = self.request("PUT", "/ip_address/" + IP_addr, body)
-		IP = _create_ip_address_obj( res["ip_address"], cloud_manager=self )
+		IP = IP_address._create_ip_address_obj( res["ip_address"], cloud_manager=self )
 		return IP
 
 	def release_IP(self, IP_addr):

upcloud/cloud_manager/server_mixin.py

@@ -1,8 +1,11 @@
-from ..tools import _create_ip_address_objs
-from ..tools import _create_storage_objs
+from ..ip_address import IP_address
+from ..storage import Storage 
 
 from ..server import Server
 
+from ..tools import assignIfExists
+
+
 class ServerManager():
 	"""
 	Functions for managing IP-addresses. Intended to be used as a mixin for CloudManager.
@@ -40,52 +43,58 @@ def get_server(self, UUID):
 						cloud_manager = self )
 
 
-	def create_server(self, VM, storage_devices):
-		body = dict()
-		body["server"] = {
-			"core_number": VM["cores"],
-			"memory_amount": VM["ram"],
-			"hostname": VM["hostname"],
-			"zone": VM["zone"],
-			"title": VM["title"],
-			"storage_devices": {}
-		}
-		body["server"]["storage_devices"] = {
-			"storage_device": []
-		}
-
-		for storage in storage_devices:
-			device = dict()
-			device["action"] = storage["action"]
-			device["tier"] = storage["tier"]
-			device["title"] = storage["title"]
-
-			if device["action"] == "create" or device["action"] == "clone":
-				device["size"] = storage["size"]
-
-			if device["action"] == "attach" or device["action"] == "clone":
-				device["storage"] = storage["storage"]
-
-			if "type" in storage:
-				device["type"] = storage["type"]
-
-			body["server"]["storage_devices"]["storage_device"].append(device)
+	def create_server(self, server):
+		"""
+		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 = 512, 
+					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),
+						Storage()
+					title = "My Example Server"
+				])
+		manager.create_server(server1)
+
+		All Server fields are mandatory except title (defaults to hostname).
+
+		One storage should contain an OS. Otherwise storage fields are optional.
+		- 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: 
+			"CentOS 6.5", "CentOS 7.0"
+			"Debian 7.8"
+			"Ubuntu 12.04", "Ubuntu 14.04"
+			"Windows 2003","Windows 2008" ,"Windows 2012"
+
+		"""
+
+		body = server.prepare_post_body()
 
 		res = self.post_request("/server", body)
-		server = res["server"]
 
 		# Populate subobjects
-		IP_addresses = _create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
-		storages = _create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
+		IP_addresses = IP_address._create_ip_address_objs( res["server"].pop("ip_addresses"), cloud_manager = self )
+		storages = Storage._create_storage_objs( res["server"].pop("storage_devices"), cloud_manager = self )
 
-		return Server(	server, 
-						ip_addresses = IP_addresses, 
-						storage_devices = storages, 
-						populated = True,
-						cloud_manager = self )
+		server._reset( res["server"], 
+					ip_addresses = IP_addresses, 
+					storage_devices = storages, 
+					populated = True)
+		return server
 
 
 	def modify_server(self, UUID, **kwargs):
+		"""
+		modify_server allows updating the server's updateable_fields.
+		Note: Server's IP-addresses and Storages are managed by their own add/remove methods.
+		"""
 		body = dict()
 		body["server"] = {}
 		for arg in kwargs:
@@ -97,8 +106,8 @@ def modify_server(self, UUID, **kwargs):
 		server = res["server"]
 
 		# Populate subobjects
-		IP_addresses = _create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
-		storages = _create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
+		IP_addresses = IP_address._create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
+		storages = Storage._create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
 
 		return Server(	server, 
 						ip_addresses = IP_addresses, 
@@ -108,6 +117,10 @@ def modify_server(self, UUID, **kwargs):
 
 
 	def delete_server(self, UUID):
+		"""
+		DELETE '/server/UUID'. Permanently destroys the virtual machine. 
+		DOES NOT remove the storage disks.
+		"""
 		return self.request("DELETE", "/server/" + UUID)
 
 	def __fetch_servers(self):
@@ -127,7 +140,7 @@ def get_server_data(self, UUID):
 		server = data["server"]
 
 		# Populate subobjects
-		IP_addresses = _create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
-		storages = _create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
+		IP_addresses = IP_address._create_ip_address_objs( server.pop("ip_addresses"), cloud_manager = self )
+		storages = Storage._create_storage_objs( server.pop("storage_devices"), cloud_manager = self )
 
 		return server, IP_addresses, storages

upcloud/cloud_manager/storage_mixin.py

@@ -1,6 +1,4 @@
 from ..storage import Storage
-from ..tools import _create_storage_obj
-from ..tools import _create_storage_objs
 
 class StorageManager():
 	"""
@@ -13,14 +11,14 @@ def get_storages(self, storage_type=""):
 		Storage types: public, private, normal, backup, cdrom, template, favorite
 		"""
 		res = self.get_request("/storage/" + storage_type)
-		return _create_storage_objs( res["storages"], cloud_manager = self )
+		return Storage._create_storage_objs( res["storages"], cloud_manager = self )
 
 	def get_storage(self, UUID):
 		"""
 		Returns a Storage object from the API.
 		"""
 		res = self.get_request("/storage/" + UUID)
-		return _create_storage_obj( res["storage"], cloud_manager = self )
+		return Storage._create_storage_obj( res["storage"], cloud_manager = self )
 
 	def create_storage(self, size, tier, title, zone):
 		"""
@@ -34,7 +32,7 @@ def create_storage(self, size, tier, title, zone):
 			"zone": zone
 		}
 		res = self.post_request("/storage", body)
-		return _create_storage_obj( res["storage"], cloud_manager = self )
+		return Storage._create_storage_obj( res["storage"], cloud_manager = self )
 
 	def modify_storage(self, UUID, size, title):
 		"""
@@ -43,7 +41,7 @@ def modify_storage(self, UUID, size, title):
 
 		body = Storage.prepare_put_body(size, title)
 		res = self.request("PUT","/storage/" + UUID, body)
-		return _create_storage_obj( res["storage"], cloud_manager = self )
+		return Storage._create_storage_obj( res["storage"], cloud_manager = self )
 
 	def delete_storage(self, UUID):
 		"""
@@ -62,7 +60,7 @@ def attach_storage(self, server_uuid, storage_uuid, storage_type, address):
 
 		res = self.post_request("/server/" + server_uuid + "/storage/attach", body)
 		print(res)
-		return _create_storage_objs( res["server"]["storage_devices"], cloud_manager = self )
+		return Storage._create_storage_objs( res["server"]["storage_devices"], cloud_manager = self )
 
 	def detach_storage(self, server_uuid, address):
 		"""
@@ -71,4 +69,4 @@ def detach_storage(self, server_uuid, address):
 		body = { "storage_device": { "address": address } }
 		res = self.post_request("/server/" + server_uuid + "/storage/detach", body)
 		print(res)
-		return _create_storage_objs( res["server"]["storage_devices"], cloud_manager = self )
+		return Storage._create_storage_objs( res["server"]["storage_devices"], cloud_manager = self )