get_servers by tags, refactor server reset and creation with a factory

Author: Elias Nygren

test/test_server_creation.py

@@ -119,6 +119,43 @@ def test_create_server(self, manager):
 		assert server1.core_number == "2"
 		assert server1.memory_amount == "1024"
 
+		# assert ips and storages have correct types
+		assert type(server1.storage_devices[0]).__name__ == "Storage"
+		assert type(server1.ip_addresses[0]).__name__ == "IP_address"
+
+		# assert new data was populated
+		assert server1.video_model ==  "cirrus"
+		assert server1.vnc ==  "off"
+		assert server1.vnc_password ==  "aabbccdd"
+
+	@responses.activate
+	def test_create_server_with_dict(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 = {
+			'core_number': 2, 'memory_amount': 1024, 'hostname': "my.example.com", 'zone': ZONE.Chicago,
+			'storage_devices': [
+				{ 'os': "Ubuntu 14.04", 'size': 10 },
+				{ 'size': 100, 'title': "storage disk 1" },
+			]}
+
+		server1 = 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 ips and storages have correct types
+		assert type(server1.storage_devices[0]).__name__ == "Storage"
+		assert type(server1.ip_addresses[0]).__name__ == "IP_address"
+
 		# assert new data was populated
 		assert server1.video_model ==  "cirrus"
 		assert server1.vnc ==  "off"

upcloud_api/cloud_manager/server_mixin.py

@@ -15,22 +15,38 @@ class ServerManager(object):
 	Functions for managing IP-addresses. Intended to be used as a mixin for CloudManager.
 	"""
 
-	def get_servers(self, populate=False):
+	def get_servers(self, populate=False, tags_has_one=None, tags_has_all=None):
 		"""
 		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.
+		- populate = False (default) => 1 API request, returns unpopulated Server instances.
+		- populate = True => Does 1 + n API requests (n = # of servers), returns populated Server instances.
+
+		New in 0.3.0: the list can be filtered with tags:
+		- tags_has_one: returns servers that have at least one of the given tags
+		- tags_has_all: returns servers that have all of the tags
 		"""
 
-		servers = self.get_request("/server")["servers"]["server"]
+		if tags_has_all and tags_has_one:
+			raise Exception("only one of (tags_has_all, tags_has_one) is allowed.")
+
+		request = "/server"
+		if tags_has_all:
+			taglist = tags_has_all.join(":")
+			request = "/server/tag/" + taglist
+
+		if tags_has_one:
+			taglist = tags_has_all.join(",")
+			request = "/server/tag/" + taglist
+
+		servers = self.get_request(request)["servers"]["server"]
 
 		server_list = list()
 		for server in servers:
 			# remove the extra "tag" dict to simplify accessing tags
 			server['tags'] = server['tags']['tag']
 			server_list.append( Server(server, cloud_manager = self) )
 
-		if( populate ):
+		if populate:
 			for server_instance in server_list:
 				server_instance.populate()
 
@@ -86,32 +102,17 @@ def create_server(self, server):
 		if isinstance(server, Server):
 			body = server.prepare_post_body()
 		else:
-			ip_data = server.pop("ip_addresses", None)
-			storage_data = server.pop("storage_devices", None)
-
-			server_dict = dict()
-			server_dict['cloud_manager'] = self
-			if ip_data: 	 server_dict['ip_addresses'] = IP_address._create_ip_address_objs( ip_data, cloud_manager = self )
-			if storage_data: server_dict['storage_devices'] = Storage._create_storage_objs( storage_data, cloud_manager = self )
-
-			server_from_dict = Server(server, **server_dict)
-			body = server_from_dict.prepare_post_body()
-
+			server = Server._create_server_obj(server, cloud_manager=self)
+			body = server.prepare_post_body()
 
 		res = self.post_request("/server", body)
 
-		# Populate subobjects
-		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 )
-
 		if isinstance(server, Server):
 			server_to_return = server
 		else:
 			server_to_return = server_from_dict
 
 		server_to_return._reset( res["server"],
-						ip_addresses = IP_addresses,
-						storage_devices = storages,
 						cloud_manager = self,
 						populated = True)
 		return server_to_return

upcloud_api/server.py

@@ -8,6 +8,7 @@
 standard_library.install_aliases()
 
 from upcloud_api.base import BaseAPI
+from upcloud import Storage, IP_address
 
 from time import sleep
 
@@ -28,9 +29,9 @@ class Server(BaseAPI):
 							"nic_model", "title", "timezone", "video_model", "vnc", "vnc_password" ]
 
 
-	def __init__(self, *initial_data, **kwargs):
+	def __init__(self, server=None, **kwargs):
 		object.__setattr__(self, "populated", False)
-		self._reset(*initial_data, **kwargs)
+		self._reset(server, **kwargs)
 
 		if not hasattr(self, "title"):
 			self.title = self.hostname
@@ -44,14 +45,21 @@ def __setattr__(self, name, value):
 		else:
 			object.__setattr__(self, name, value)
 
-	def _reset(self, *initial_data, **kwargs):
+	def _reset(self, server, **kwargs):
 		"""
-		Reset all given attributes.
-		May also be given
+		Resets the server object with new values given as params.
+		- server: a dict representing the server. e.g the API response.
+		- kwargs: any meta fields such as cloud_manager and populated.
+
+		Note: storage_devices and ip_addresses may be given in server as dicts or
+		in kwargs as lists containing Storage and IP_address objects.
 		"""
-		for dictionary in initial_data:
-			for key in dictionary:
-				object.__setattr__(self, key, dictionary[key])
+		if server:
+			# handle storage and ip_address dicts
+			Server._handle_server_subobjs(server, kwargs.get('cloud_manager'))
+
+			for key in server:
+				object.__setattr__(self, key, server[key])
 
 		for key in kwargs:
 			object.__setattr__(self, key, kwargs[key])
@@ -379,3 +387,28 @@ def destroy_storages():
 		else:
 			# something went wrong, fail explicitly
 			raise Exception('unknown server state: ' + self.state)
+
+
+	@classmethod
+	def _handle_server_subobjs(cls, server, cloud_manager):
+		ip_data = server.pop("ip_addresses", None)
+		storage_data = server.pop("storage_devices", None)
+
+		if ip_data:
+			ip_addresses = IP_address._create_ip_address_objs(ip_data, cloud_manager = cloud_manager)
+			server['ip_addresses'] = ip_addresses
+
+		if storage_data:
+			storages = Storage._create_storage_objs(storage_data, cloud_manager = cloud_manager)
+			server['storage_devices'] = storages
+
+	@classmethod
+	def _create_server_obj(cls, server, cloud_manager):
+
+		cls._handle_server_subobjs(server, cloud_manager)
+
+		server_dict = dict()
+		server_dict.update(server)
+		server_dict['cloud_manager'] = cloud_manager
+
+		return Server(**server_dict)