add tag functionality

Author: Elias Nygren

test/json_data/server_00798b85-efdc-41ca-8021-f6ef457b8531.json

@@ -33,7 +33,8 @@
 		},
 		"tags": {
 			"tag": [
-				"web1"
+				"web1",
+				"web2"
 			]
 		},
 		"timezone" : "UTC",

test/json_data/tag.json

@@ -0,0 +1,26 @@
+{
+  "tags" : {
+    "tag" : [
+      {
+        "description" : "Description of TheTestTag1",
+        "name" : "TheTestTag1",
+        "servers" : {
+          "server" : [
+            "0057e20a-6878-43a7-b2b3-530c4a4bdc55",
+            "00cc17bd-fe22-4305-a0d3-1b81da14de8a"
+          ]
+        }
+      },
+      {
+        "description" : "Description of TheTestTag2",
+        "name" : "TheTestTag2",
+        "servers" : {
+          "server" : [
+            "0057e20a-6878-43a7-b2b3-530c4a4bdc55",
+            "00cc17bd-fe22-4305-a0d3-1b81da14de8a"
+          ]
+        }
+      }
+    ]
+  }
+}

test/json_data/tag_TheTestTag.json

@@ -0,0 +1,12 @@
+{
+  "tag" : {
+    "description" : "Description of TheTestTag",
+    "name" : "TheTestTag",
+    "servers" : {
+      "server" : [
+        "0057e20a-6878-43a7-b2b3-530c4a4bdc55",
+        "00cc17bd-fe22-4305-a0d3-1b81da14de8a"
+      ]
+    }
+  }
+}

test/test_tags.py

@@ -0,0 +1,131 @@
+from __future__ import unicode_literals
+from __future__ import print_function
+from __future__ import division
+from __future__ import absolute_import
+from builtins import list, object, str
+from future import standard_library
+standard_library.install_aliases()
+
+from upcloud_api import FirewallRule, Tag
+
+from conftest import Mock
+import json, pytest, responses
+
+
+def tag_post_callback(request):
+    print(request.body)
+    request_body = json.loads(request.body)
+
+    if "name" not in request_body["tag"]:
+        raise Exception("required field missing")
+
+    if "servers" in request_body["tag"]:
+        assert isinstance(request_body["tag"]["servers"], dict)
+        assert isinstance(request_body["tag"]["servers"]["server"], list)
+        assert isinstance(request_body["tag"]["servers"]["server"][0], str)
+
+    if "description" in request_body["tag"]:
+        assert isinstance(request_body["tag"]["description"], str)
+
+    return(201, {}, json.dumps(request_body))
+
+
+class TestTags(object):
+
+    @responses.activate
+    def test_get_tag(self, manager):
+        Mock.mock_get("tag/TheTestTag")
+        tag = manager.get_tag("TheTestTag")
+
+        assert tag.name == "TheTestTag"
+        assert tag.description == "Description of TheTestTag"
+        assert len(tag.servers) == 2
+        assert tag.servers[0].uuid == "0057e20a-6878-43a7-b2b3-530c4a4bdc55"
+
+    @responses.activate
+    def test_get_tags(self, manager):
+        Mock.mock_get("tag")
+        tags = manager.get_tags()
+
+        assert len(tags) == 2
+        assert tags[0].name == "TheTestTag1"
+        assert tags[1].name == "TheTestTag2"
+        assert tags[0].servers[0].uuid == "0057e20a-6878-43a7-b2b3-530c4a4bdc55"
+
+    @responses.activate
+    def test_create_new_tag(self, manager):
+
+        for i in range(1,4):
+            responses.add_callback(
+                responses.POST,
+                Mock.base_url + "/tag",
+                content_type="application/json",
+                callback=tag_post_callback
+            )
+
+        tag1 = manager.create_tag("Tag1")
+        tag2 = manager.create_tag("Tag2", "a nice tag")
+        tag3 = manager.create_tag("Tag3", "a nicer tag", ["00798b85-efdc-41ca-8021-f6ef457b8531"])
+
+        assert tag1.name == "Tag1"
+        assert tag2.name == "Tag2"
+        assert tag3.name == "Tag3"
+        assert isinstance(tag3.servers, list)
+        assert tag3.servers[0].uuid == "00798b85-efdc-41ca-8021-f6ef457b8531"
+
+    @responses.activate
+    def test_edit_tag(self, manager):
+
+        Mock.mock_get("tag/TheTestTag")
+        tag = manager.get_tag("TheTestTag")
+
+        responses.add_callback(
+            responses.PUT,
+            Mock.base_url + "/tag/TheTestTag",
+            content_type="application/json",
+            callback=tag_post_callback
+        )
+
+        tag.name = 'AnotherTestTag'
+        assert tag._api_name == 'TheTestTag'
+
+        tag.save()
+
+        assert tag.name == 'AnotherTestTag'
+        assert tag._api_name == 'AnotherTestTag'
+
+    @responses.activate
+    def test_assign_tags_to_server(self, manager):
+        data = Mock.mock_get("server/00798b85-efdc-41ca-8021-f6ef457b8531")
+        server = manager.get_server("00798b85-efdc-41ca-8021-f6ef457b8531")
+
+        responses.add(
+            responses.POST,
+            Mock.base_url + "/server/00798b85-efdc-41ca-8021-f6ef457b8531/tag/tag1,tag2",
+            body = json.dumps({ 'foo': 'bar' }),
+            content_type="application/json",
+            status=200
+        )
+        server.add_tags(["tag1", Tag("tag2")])
+
+        for tag in ["web1", "tag1", "tag2"]:
+            assert tag in server.tags
+
+    @responses.activate
+    def test_remove_tags_from_server(self, manager):
+        data = Mock.mock_get("server/00798b85-efdc-41ca-8021-f6ef457b8531")
+        server = manager.get_server("00798b85-efdc-41ca-8021-f6ef457b8531")
+
+        responses.add(
+            responses.POST,
+            Mock.base_url + "/server/00798b85-efdc-41ca-8021-f6ef457b8531/untag/tag1,tag2",
+            body = json.dumps({ 'foo': 'bar' }),
+            content_type="application/json",
+            status=200
+        )
+        server.remove_tags(["tag1", Tag("tag2")])
+
+        for tag in ["tag1", "tag2"]:
+            assert tag not in server.tags
+        assert "web1" in server.tags
+

upcloud_api/__init__.py

@@ -21,4 +21,5 @@
 from upcloud_api.ip_address import IP_address
 from upcloud_api.firewall import FirewallRule
 from upcloud_api.tools import OperatingSystems, ZONE
+from upcloud_api.tag import Tag
 from upcloud_api.cloud_manager.cloud_manager import CloudManager

upcloud_api/cloud_manager/__init__.py

@@ -9,3 +9,4 @@
 from upcloud_api.cloud_manager.ip_address_mixin import IPManager
 from upcloud_api.cloud_manager.storage_mixin import StorageManager
 from upcloud_api.cloud_manager.firewall_mixin import FirewallManager
+from upcloud_api.cloud_manager.tag_mixin import TagManager

upcloud_api/cloud_manager/cloud_manager.py

@@ -6,15 +6,14 @@
 standard_library.install_aliases()
 
 from upcloud_api.base import BaseAPI
-from upcloud_api.cloud_manager import ServerManager
-from upcloud_api.cloud_manager import IPManager
-from upcloud_api.cloud_manager import StorageManager
-from upcloud_api.cloud_manager import FirewallManager
+from upcloud_api.cloud_manager import (
+	ServerManager, IPManager, StorageManager, FirewallManager, TagManager
+)
 
 import base64
 
 
-class CloudManager(BaseAPI, ServerManager, IPManager, StorageManager, FirewallManager):
+class CloudManager(BaseAPI, ServerManager, IPManager, StorageManager, FirewallManager, TagManager):
 	"""
 	CloudManager contains the core functionality of the upcloud API library.
 	All other managers are mixed in so code can be organized in corresponding submanager classes.

upcloud_api/cloud_manager/server_mixin.py

@@ -22,28 +22,31 @@ def get_servers(self, populate=False, tags_has_one=None, tags_has_all=None):
 		- 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
+		- tags_has_one: list of Tag objects or strings
+			returns servers that have at least one of the given tags
+
+		- tags_has_all: list of Tag objects or strings
+			returns servers that have all of the tags
 		"""
 
 		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(":")
+			tags_has_all = [ str(tag) for tag in tags_has_all]
+			taglist = ":".join(tags_has_all)
 			request = "/server/tag/" + taglist
 
 		if tags_has_one:
-			taglist = tags_has_all.join(",")
+			tags_has_one = [ str(tag) for tag in tags_has_one]
+			taglist = ",".join(tags_has_one)
 			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:
@@ -162,9 +165,6 @@ def get_server_data(self, UUID):
 		data = self.get_request("/server/" + UUID)
 		server = data["server"]
 
-		# remove the extra "tag" dict to simplify accessing tags
-		server['tags'] = server['tags']['tag']
-
 		# Populate subobjects
 		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 )

upcloud_api/cloud_manager/tag_mixin.py

@@ -0,0 +1,93 @@
+from __future__ import unicode_literals
+from __future__ import print_function
+from __future__ import division
+from __future__ import absolute_import
+from builtins import object, str
+from future import standard_library
+standard_library.install_aliases()
+
+from upcloud_api import Tag, Server
+
+class TagManager(object):
+    """
+    Functions for managing Tags. Intended to be used as a mixin for CloudManager.
+    """
+
+    def get_tags(self):
+        """ List all tags as Tag objects. """
+        res = self.get_request("/tag")
+        return [ Tag(cloud_manager=self, **tag) for tag in res['tags']['tag'] ]
+
+
+    def get_tag(self, name):
+        """ Return the tag as Tag object. """
+        res = self.get_request("/tag/" + name)
+        return Tag(cloud_manager=self, **res["tag"])
+
+
+    def create_tag(self, name, description=None, servers=[]):
+        """
+        Creates a new Tag. Only name is mandatory.
+        Returns the created Tag object.
+        """
+        servers = [ str(server) for server in servers ]
+        body = Tag._prepare_tag_body(name, description, servers)
+        res = self.request("POST", "/tag", body)
+
+        return Tag(cloud_manager=self, **res["tag"])
+
+
+    def _modify_tag(self, name, description, servers, new_name):
+        """
+        PUT /tag/name. Returns a dict that can be used to create a Tag object.
+        Private method used by the Tag class and TagManager.modify_tag.
+        """
+        body = Tag._prepare_tag_body(new_name, description, servers)
+        res = self.request("PUT", "/tag/" + name, body)
+        return res["tag"]
+
+    def modify_tag(self, name, description=None, servers=None, new_name=None):
+        """
+        PUT /tag/name. Returns a new Tag object based on the API response.
+        """
+        res = _modify_tag(name, description, servers, new_name)
+        return Tag(cloud_manager=self, **res["tag"])
+
+
+    def assign_tags(self, server, tags):
+        """
+        Assigns tags to a server.
+        - server: Server object or UUID string
+        - tags: list of Tag objects or strings
+        """
+
+        uuid = str(server)
+        tags = [ str(tag) for tag in tags ]
+
+        request = "/server/" + uuid + "/tag/" + ",".join(tags)
+        return self.post_request(request)
+
+
+    def remove_tags(self, server, tags):
+        """
+        Removes tags from a server.
+        - server: Server object or UUID string
+        - tags: list of Tag objects or strings
+        """
+
+        uuid = str(server)
+        tags = [ str(tag) for tag in tags ]
+
+        request = "/server/" + uuid + "/untag/" + ",".join(tags)
+        return self.post_request(request)
+
+
+    def delete_tag(self, tag):
+        """ Deletes the Tag. Returns and empty object. """
+        if not isinstance(tag, str):
+            tag = tag.name
+
+        return self.request("DELETE", "/tag/" + tag)
+
+
+