Add change_type to LoadBalancersClient and BoundLoadBalancer (#98)

Author: LKaemmerling

CHANGELOG.rst

@@ -4,7 +4,8 @@ History
 master (XXXX-XX-XX)
 --------------------
 
-* Add `included_traffic`, `outgoing_traffic` and `ingoing_traffic` properties to Load Balancer domain
+* Feature:Add `included_traffic`, `outgoing_traffic` and `ingoing_traffic` properties to Load Balancer domain
+* Feature: Add `change_type`-method to `LoadBalancersClient`
 
 v1.8.2 (2020-07-20)
 --------------------

hcloud/load_balancers/client.py

@@ -234,13 +234,23 @@ def enable_public_interface(self):
         return self._client.enable_public_interface(self)
 
     def disable_public_interface(self):
-        # type: ( Union[Network,BoundNetwork]) -> BoundAction
+        # type: () -> BoundAction
         """Disables the public interface of a Load Balancer.
 
         :return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
         """
         return self._client.disable_public_interface(self)
 
+    def change_type(self, load_balancer_type):
+        # type: (Union[LoadBalancerType,BoundLoadBalancerType]) -> BoundAction
+        """Changes the type of a Load Balancer.
+
+        :param load_balancer_type: :class:`BoundLoadBalancerType <hcloud.load_balancer_types.client.BoundLoadBalancerType>` or :class:`LoadBalancerType <hcloud.load_balancer_types.domain.LoadBalancerType>`
+               Load Balancer type the Load Balancer should migrate to
+        :return:  :class:`BoundAction <hcloud.actions.client.BoundAction>`
+        """
+        return self._client.change_type(self, load_balancer_type)
+
 
 class LoadBalancersClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = "load_balancers"
@@ -731,3 +741,19 @@ def disable_public_interface(self, load_balancer):
                 load_balancer_id=load_balancer.id),
             method="POST")
         return BoundAction(self._client.actions, response['action'])
+
+    def change_type(self, load_balancer, load_balancer_type):
+        # type: ([LoadBalancer, BoundLoadBalancer], [LoadBalancerType, BoundLoadBalancerType]) ->BoundAction
+        """Changes the type of a Load Balancer.
+
+        :param load_balancer: :class:`BoundLoadBalancer <hcloud.load_balancers.client.BoundLoadBalancer>` or :class:`LoadBalancer <hcloud.load_balancers.domain.LoadBalancer>`
+        :param load_balancer_type: :class:`BoundLoadBalancerType <hcloud.load_balancer_types.client.BoundLoadBalancerType>` or :class:`LoadBalancerType <hcloud.load_balancer_types.domain.LoadBalancerType>`
+               Load Balancer type the Load Balancer should migrate to
+        :return:  :class:`BoundAction <hcloud.actions.client.BoundAction>`
+        """
+        data = {
+            "load_balancer_type": load_balancer_type.id_or_name,
+        }
+        response = self._client.request(url="/load_balancers/{load_balancer_id}/actions/change_type".format(load_balancer_id=load_balancer.id),
+                                        method="POST", json=data)
+        return BoundAction(self._client.actions, response['action'])

tests/integration/load_balancers/test_load_balancers.py

@@ -20,6 +20,11 @@ def test_get_actions_list(self, bound_load_balancer):
         assert actions[0].id == 13
         assert actions[0].command == "add_service"
 
+    def test_change_type(self, bound_load_balancer):
+        action = bound_load_balancer.change_type(LoadBalancerType(name="lb211"))
+        assert action.id == 13
+        assert action.command == "change_load_balancer_type"
+
 
 class TestLoadBalancersClient(object):
     def test_get_by_id(self, hetzner_client):
@@ -115,3 +120,10 @@ def test_update_service(self, hetzner_client, load_balancer):
     def test_change_protection(self, hetzner_client, load_balancer):
         action = hetzner_client.load_balancers.change_protection(load_balancer, {"delete": True})
         assert action.command == "change_protection"
+
+    @pytest.mark.parametrize("load_balancer", [LoadBalancer(id=1), BoundLoadBalancer(mock.MagicMock(), dict(id=1))])
+    def test_change_type(self, hetzner_client, load_balancer):
+        action = hetzner_client.load_balancers.change_type(load_balancer, LoadBalancerType(name="lb21"))
+
+        assert action.id == 13
+        assert action.command == "change_load_balancer_type"

tests/unit/load_balancers/test_client.py

@@ -9,7 +9,7 @@
 from hcloud.load_balancers.client import BoundLoadBalancer, LoadBalancersClient
 
 from hcloud.load_balancers.domain import LoadBalancerAlgorithm, LoadBalancerHealthCheck, \
-    LoadBalancerService, LoadBalancerTarget
+    LoadBalancerService, LoadBalancerTarget, LoadBalancer
 from hcloud.actions.client import BoundAction
 
 
@@ -206,6 +206,14 @@ def test_detach_from_network(self, response_detach_from_network, hetzner_client,
         assert action.progress == 100
         assert action.command == "detach_from_network"
 
+    def test_change_type(self, hetzner_client, bound_load_balancer, generic_action):
+        hetzner_client.request.return_value = generic_action
+        action = bound_load_balancer.change_type(LoadBalancerType(name="lb21"))
+        hetzner_client.request.assert_called_with(url="/load_balancers/14/actions/change_type", method="POST", json={"load_balancer_type": "lb21"})
+
+        assert action.id == 1
+        assert action.progress == 0
+
 
 class TestLoadBalancerslient(object):
 
@@ -315,3 +323,21 @@ def test_create(self, load_balancers_client, response_create_load_balancer):
         assert bound_load_balancer._client is load_balancers_client
         assert bound_load_balancer.id == 1
         assert bound_load_balancer.name == "my-balancer"
+
+    @pytest.mark.parametrize("load_balancer", [LoadBalancer(id=1), BoundLoadBalancer(mock.MagicMock(), dict(id=1))])
+    def test_change_type_with_load_balancer_type_name(self, load_balancers_client, load_balancer, generic_action):
+        load_balancers_client._client.request.return_value = generic_action
+        action = load_balancers_client.change_type(load_balancer, LoadBalancerType(name="lb11"))
+        load_balancers_client._client.request.assert_called_with(url="/load_balancers/1/actions/change_type", method="POST", json={"load_balancer_type": "lb11"})
+
+        assert action.id == 1
+        assert action.progress == 0
+
+    @pytest.mark.parametrize("load_balancer", [LoadBalancer(id=1), BoundLoadBalancer(mock.MagicMock(), dict(id=1))])
+    def test_change_type_with_load_balancer_type_id(self, load_balancers_client, load_balancer, generic_action):
+        load_balancers_client._client.request.return_value = generic_action
+        action = load_balancers_client.change_type(load_balancer, LoadBalancerType(id=1))
+        load_balancers_client._client.request.assert_called_with(url="/load_balancers/1/actions/change_type", method="POST", json={"load_balancer_type": 1})
+
+        assert action.id == 1
+        assert action.progress == 0