Add support for names on Floating IPs (#59)

Author: LKaemmerling

CHANGELOG.rst

@@ -6,6 +6,7 @@ master (XXXX-XX-XX)
 -------------------
 
 * Fix: ServersClient.create_image fails when specifying the `labels`
+* Feature: Add support for `name` on Floating IPs
 
 1.4.1 (2019-08-19)
 ------------------

hcloud/floating_ips/client.py

@@ -51,17 +51,19 @@ def get_actions(self, status=None, sort=None):
         """
         return self._client.get_actions(self, status, sort)
 
-    def update(self, description=None, labels=None):
-        # type: (Optional[str], Optional[Dict[str, str]]) -> BoundFloatingIP
+    def update(self, description=None, labels=None, name=None):
+        # type: (Optional[str], Optional[Dict[str, str]], Optional[str]) -> BoundFloatingIP
         """Updates the description or labels of a Floating IP.
 
         :param description: str (optional)
                New Description to set
         :param labels: Dict[str, str] (optional)
                User-defined labels (key-value pairs)
+        :param name: str (optional)
+               New Name to set
         :return: :class:`BoundFloatingIP <hcloud.floating_ips.client.BoundFloatingIP>`
         """
-        return self._client.update(self, description, labels)
+        return self._client.update(self, description, labels, name)
 
     def delete(self):
         # type: () -> bool
@@ -225,6 +227,7 @@ def create(self,
                labels=None,  # type: Optional[str]
                home_location=None,  # type: Optional[Location]
                server=None,  # type: Optional[Server]
+               name=None,  # type: Optinal[str]
                ):
         # type: (...) -> CreateFloatingIPResponse
         """Creates a new Floating IP assigned to a server.
@@ -238,6 +241,7 @@ def create(self,
                Home location (routing is optimized for that location). Only optional if server argument is passed.
         :param server: :class:`BoundServer <hcloud.servers.client.BoundServer>` or  :class:`Server <hcloud.servers.domain.Server>`
                Server to assign the Floating IP to
+        :param name: str (optional)
         :return: :class:`CreateFloatingIPResponse <hcloud.floating_ips.domain.CreateFloatingIPResponse>`
         """
 
@@ -252,6 +256,8 @@ def create(self,
             data['home_location'] = home_location.id_or_name
         if server is not None:
             data['server'] = server.id
+        if name is not None:
+            data['name'] = name
 
         response = self._client.request(url="/floating_ips", json=data, method="POST")
 
@@ -265,22 +271,26 @@ def create(self,
         )
         return result
 
-    def update(self, floating_ip, description=None, labels=None):
-        # type: (FloatingIP,  Optional[str], Optional[Dict[str, str]]) -> BoundFloatingIP
+    def update(self, floating_ip, description=None, labels=None, name=None):
+        # type: (FloatingIP,  Optional[str], Optional[Dict[str, str]], Optional[str]) -> BoundFloatingIP
         """Updates the description or labels of a Floating IP.
 
         :param floating_ip: :class:`BoundFloatingIP <hcloud.floating_ips.client.BoundFloatingIP>` or  :class:`FloatingIP <hcloud.floating_ips.domain.FloatingIP>`
         :param description: str (optional)
                New Description to set
         :param labels: Dict[str, str] (optional)
                User-defined labels (key-value pairs)
+        :param name: str (optional)
+               New name to set
         :return: :class:`BoundFloatingIP <hcloud.floating_ips.client.BoundFloatingIP>`
         """
         data = {}
         if description is not None:
             data['description'] = description
         if labels is not None:
             data['labels'] = labels
+        if name is not None:
+            data['name'] = name
 
         response = self._client.request(url="/floating_ips/{floating_ip_id}".format(floating_ip_id=floating_ip.id),
                                         method="PUT", json=data)

hcloud/floating_ips/domain.py

@@ -29,6 +29,8 @@ class FloatingIP(BaseDomain):
            User-defined labels (key-value pairs)
     :param created: datetime
            Point in time when the Floating IP was created
+    :param name: str
+           Name of the Floating IP
     """
     __slots__ = (
         "id",
@@ -40,7 +42,8 @@ class FloatingIP(BaseDomain):
         "home_location",
         "blocked",
         "protection",
-        "labels"
+        "labels",
+        "name"
     )
     created = ISODateTime()
     supported_fields = ("created",)
@@ -57,7 +60,8 @@ def __init__(
         blocked=None,
         protection=None,
         labels=None,
-        created=None
+        created=None,
+        name=None
     ):
         self.id = id
         self.type = type
@@ -70,6 +74,7 @@ def __init__(
         self.protection = protection
         self.labels = labels
         self.created = created
+        self.name = name
 
 
 class CreateFloatingIPResponse(BaseDomain):

tests/integration/floating_ips/test_floating_ips.py

@@ -21,29 +21,30 @@ def test_get_actions(self, bound_floating_ip):
         assert actions[0].command == "assign_floating_ip"
 
     def test_update(self, bound_floating_ip):
-        floating_ip = bound_floating_ip.update(description="New description", labels={})
+        floating_ip = bound_floating_ip.update(description="New description", labels={}, name="Web Frontend")
         assert floating_ip.id == 4711
         assert floating_ip.description == "New description"
+        assert floating_ip.name == "Web Frontend"
 
     def test_delete(self, bound_floating_ip):
         delete_success = bound_floating_ip.delete()
         assert delete_success is True
 
     @pytest.mark.parametrize("server",
                              (Server(id=1), BoundServer(mock.MagicMock(), dict(id=1))))
-    def test_assign(self, hetzner_client, bound_floating_ip, server):
+    def test_assign(self, bound_floating_ip, server):
         action = bound_floating_ip.assign(server)
         assert action.id == 13
         assert action.progress == 0
         assert action.command == "assign_floating_ip"
 
-    def test_unassign(self, hetzner_client, bound_floating_ip):
+    def test_unassign(self, bound_floating_ip):
         action = bound_floating_ip.unassign()
         assert action.id == 13
         assert action.progress == 0
         assert action.command == "unassign_floating_ip"
 
-    def test_change_dns_ptr(self, hetzner_client, bound_floating_ip):
+    def test_change_dns_ptr(self, bound_floating_ip):
         action = bound_floating_ip.change_dns_ptr("1.2.3.4", "server02.example.com")
         assert action.id == 13
         assert action.progress == 0
@@ -71,7 +72,8 @@ def test_create(self, hetzner_client, server):
             type="ipv4",
             description="Web Frontend",
             # home_location=Location(description="fsn1"),
-            server=server
+            server=server,
+            name="Web Frontend"
         )
 
         floating_ip = response.floating_ip
@@ -80,6 +82,7 @@ def test_create(self, hetzner_client, server):
         assert floating_ip.id == 4711
         assert floating_ip.description == "Web Frontend"
         assert floating_ip.type == "ipv4"
+        assert floating_ip.name == "Web Frontend"
 
         assert action.id == 13
         assert action.command == "assign_floating_ip"
@@ -94,10 +97,11 @@ def test_get_actions(self, hetzner_client, floating_ip):
 
     @pytest.mark.parametrize("floating_ip", [FloatingIP(id=1), BoundFloatingIP(mock.MagicMock(), dict(id=1))])
     def test_update(self, hetzner_client, floating_ip):
-        floating_ip = hetzner_client.floating_ips.update(floating_ip, description="New description", labels={})
+        floating_ip = hetzner_client.floating_ips.update(floating_ip, description="New description", labels={}, name="Web Frontend")
 
         assert floating_ip.id == 4711
         assert floating_ip.description == "New description"
+        assert floating_ip.name == "Web Frontend"
 
     @pytest.mark.parametrize("floating_ip", [FloatingIP(id=1), BoundFloatingIP(mock.MagicMock(), dict(id=1))])
     def test_delete(self, hetzner_client, floating_ip):

tests/unit/floating_ips/conftest.py

@@ -7,6 +7,7 @@ def floating_ip_response():
         "floating_ip": {
             "id": 4711,
             "description": "Web Frontend",
+            "name": "Web Frontend",
             "created": "2016-01-30T23:50+00:00",
             "ip": "131.232.99.1",
             "type": "ipv4",
@@ -42,6 +43,7 @@ def two_floating_ips_response():
             {
                 "id": 4711,
                 "description": "Web Frontend",
+                "name": "Web Frontend",
                 "created": "2016-01-30T23:50+00:00",
                 "ip": "131.232.99.1",
                 "type": "ipv4",
@@ -70,6 +72,7 @@ def two_floating_ips_response():
             {
                 "id": 4712,
                 "description": "Web Backend",
+                "name": "Web Backend",
                 "created": "2016-01-30T23:50+00:00",
                 "ip": "131.232.99.2",
                 "type": "ipv4",
@@ -105,6 +108,7 @@ def floating_ip_create_response():
         "floating_ip": {
             "id": 4711,
             "description": "Web Frontend",
+            "name": "Web Frontend",
             "created": "2016-01-30T23:50+00:00",
             "ip": "131.232.99.1",
             "type": "ipv4",
@@ -155,9 +159,9 @@ def floating_ip_create_response():
 def response_update_floating_ip():
     return {
         "floating_ip": {
-
             "id": 4711,
             "description": "New description",
+            "name": "New name",
             "created": "2016-01-30T23:50+00:00",
             "ip": "131.232.99.1",
             "type": "ipv4",

tests/unit/floating_ips/test_client.py

@@ -24,6 +24,7 @@ def test_bound_floating_ip_init(self, floating_ip_response):
 
         assert bound_floating_ip.id == 4711
         assert bound_floating_ip.description == "Web Frontend"
+        assert bound_floating_ip.name == "Web Frontend"
         assert bound_floating_ip.ip == "131.232.99.1"
         assert bound_floating_ip.type == "ipv4"
         assert bound_floating_ip.protection == {"delete": False}
@@ -55,12 +56,13 @@ def test_get_actions(self, hetzner_client, bound_floating_ip, response_get_actio
 
     def test_update(self, hetzner_client, bound_floating_ip, response_update_floating_ip):
         hetzner_client.request.return_value = response_update_floating_ip
-        floating_ip = bound_floating_ip.update(description="New description")
+        floating_ip = bound_floating_ip.update(description="New description", name="New name")
         hetzner_client.request.assert_called_with(url="/floating_ips/14", method="PUT",
-                                                  json={"description": "New description"})
+                                                  json={"description": "New description", "name": "New name"})
 
         assert floating_ip.id == 4711
         assert floating_ip.description == "New description"
+        assert floating_ip.name == "New name"
 
     def test_delete(self, hetzner_client, bound_floating_ip, generic_action):
         hetzner_client.request.return_value = generic_action
@@ -221,6 +223,32 @@ def test_create_with_server(self, floating_ips_client, server, floating_ip_creat
         assert bound_floating_ip.description == "Web Frontend"
         assert action.id == 13
 
+    @pytest.mark.parametrize("server", [Server(id=1), BoundServer(mock.MagicMock(), dict(id=1))])
+    def test_create_with_name(self, floating_ips_client, server, floating_ip_create_response):
+        floating_ips_client._client.request.return_value = floating_ip_create_response
+        response = floating_ips_client.create(
+            type="ipv6",
+            description="Web Frontend",
+            name="Web Frontend"
+        )
+        floating_ips_client._client.request.assert_called_with(
+            url="/floating_ips",
+            method="POST",
+            json={
+                'description': "Web Frontend",
+                'type': "ipv6",
+                'name': "Web Frontend"
+            }
+        )
+        bound_floating_ip = response.floating_ip
+        action = response.action
+
+        assert bound_floating_ip._client is floating_ips_client
+        assert bound_floating_ip.id == 4711
+        assert bound_floating_ip.description == "Web Frontend"
+        assert bound_floating_ip.name == "Web Frontend"
+        assert action.id == 13
+
     @pytest.mark.parametrize("floating_ip", [FloatingIP(id=1), BoundFloatingIP(mock.MagicMock(), dict(id=1))])
     def test_get_actions(self, floating_ips_client, floating_ip, response_get_actions):
         floating_ips_client._client.request.return_value = response_get_actions
@@ -238,12 +266,13 @@ def test_get_actions(self, floating_ips_client, floating_ip, response_get_action
     @pytest.mark.parametrize("floating_ip", [FloatingIP(id=1), BoundFloatingIP(mock.MagicMock(), dict(id=1))])
     def test_update(self, floating_ips_client, floating_ip, response_update_floating_ip):
         floating_ips_client._client.request.return_value = response_update_floating_ip
-        floating_ip = floating_ips_client.update(floating_ip, description="New description")
+        floating_ip = floating_ips_client.update(floating_ip, description="New description", name="New name")
         floating_ips_client._client.request.assert_called_with(url="/floating_ips/1", method="PUT",
-                                                               json={"description": "New description"})
+                                                               json={"description": "New description", "name": "New name"})
 
         assert floating_ip.id == 4711
         assert floating_ip.description == "New description"
+        assert floating_ip.name == "New name"
 
     @pytest.mark.parametrize("floating_ip", [FloatingIP(id=1), BoundFloatingIP(mock.MagicMock(), dict(id=1))])
     def test_change_protection(self, floating_ips_client, floating_ip, generic_action):