Feature: Add vSwitch support to add_subnet on NetworksClient (#106)

Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>

Author: LKaemmerling

CHANGELOG.rst

@@ -6,6 +6,8 @@ master (XXXX-XX-XX)
 -------------------
 
 * Feature: Add `include_deprecated` filter to `get_list` and `get_all` on `ImagesClient`
+* Feature: Add vSwitch support to `add_subnet` on `NetworksClient`
+* Feature: Add subnet type constants to `NetworkSubnet` domain (`NetworkSubnet.TYPE_CLOUD`, `NetworkSubnet.TYPE_VSWITCH`)
 
 v1.9.1 (2020-08-11)
 --------------------

hcloud/networks/client.py

@@ -351,6 +351,8 @@ def add_subnet(self, network, subnet):
         }
         if subnet.ip_range is not None:
             data["ip_range"] = subnet.ip_range
+        if subnet.vswitch_id is not None:
+            data["vswitch_id"] = subnet.vswitch_id
 
         response = self._client.request(
             url="/networks/{network_id}/actions/add_subnet".format(network_id=network.id),

hcloud/networks/domain.py

@@ -71,14 +71,23 @@ class NetworkSubnet(BaseDomain):
               Name of network zone.
     :param gateway: str
               Gateway for the route.
+    :param vswitch_id: int
+              ID of the vSwitch.
     """
-    __slots__ = ("type", "ip_range", "network_zone", "gateway")
-
-    def __init__(self, ip_range, type=None, network_zone=None, gateway=None):
+    TYPE_SERVER = "server"
+    """Subnet Type server, deprecated, use TYPE_CLOUD instead"""
+    TYPE_CLOUD = "cloud"
+    """Subnet Type cloud"""
+    TYPE_VSWITCH = "vswitch"
+    """Subnet Type vSwitch"""
+    __slots__ = ("type", "ip_range", "network_zone", "gateway", "vswitch_id")
+
+    def __init__(self, ip_range, type=None, network_zone=None, gateway=None, vswitch_id=None):
         self.type = type
         self.ip_range = ip_range
         self.network_zone = network_zone
         self.gateway = gateway
+        self.vswitch_id = vswitch_id
 
 
 class NetworkRoute(BaseDomain):

tests/unit/networks/test_client.py

@@ -33,7 +33,7 @@ def test_bound_network_init(self, network_response):
 
         assert len(bound_network.subnets) == 2
         assert isinstance(bound_network.subnets[0], NetworkSubnet)
-        assert bound_network.subnets[0].type == "cloud"
+        assert bound_network.subnets[0].type == NetworkSubnet.TYPE_CLOUD
         assert bound_network.subnets[0].ip_range == "10.0.1.0/24"
         assert bound_network.subnets[0].network_zone == "eu-central"
         assert bound_network.subnets[0].gateway == "10.0.0.1"
@@ -80,10 +80,10 @@ def test_change_protection(self, hetzner_client, bound_network, generic_action):
 
     def test_add_subnet(self, hetzner_client, bound_network, generic_action):
         hetzner_client.request.return_value = generic_action
-        subnet = NetworkSubnet(type="cloud", ip_range="10.0.1.0/24", network_zone="eu-central")
+        subnet = NetworkSubnet(type=NetworkSubnet.TYPE_CLOUD, ip_range="10.0.1.0/24", network_zone="eu-central")
         action = bound_network.add_subnet(subnet)
         hetzner_client.request.assert_called_with(url="/networks/14/actions/add_subnet", method="POST",
-                                                  json={"type": "cloud", "ip_range": "10.0.1.0/24",
+                                                  json={"type": NetworkSubnet.TYPE_CLOUD, "ip_range": "10.0.1.0/24",
                                                         "network_zone": "eu-central"})
 
         assert action.id == 1
@@ -137,7 +137,11 @@ def networks_client(self):
 
     @pytest.fixture()
     def network_subnet(self):
-        return NetworkSubnet(type="cloud", ip_range="10.0.1.0/24", network_zone="eu-central")
+        return NetworkSubnet(type=NetworkSubnet.TYPE_CLOUD, ip_range="10.0.1.0/24", network_zone="eu-central")
+
+    @pytest.fixture()
+    def network_vswitch_subnet(self):
+        return NetworkSubnet(type=NetworkSubnet.TYPE_VSWITCH, ip_range="10.0.1.0/24", network_zone="eu-central", vswitch_id=123)
 
     @pytest.fixture()
     def network_route(self):
@@ -244,7 +248,7 @@ def test_create_with_subnet(self, networks_client, network_subnet, network_creat
                 'ip_range': "10.0.0.0/8",
                 'subnets': [
                     {
-                        'type': "cloud",
+                        'type': NetworkSubnet.TYPE_CLOUD,
                         'ip_range': "10.0.1.0/24",
                         'network_zone': "eu-central"
                     }
@@ -291,7 +295,7 @@ def test_create_with_route_and_subnet(self, networks_client, network_subnet, net
                 'ip_range': "10.0.0.0/8",
                 'subnets': [
                     {
-                        'type': "cloud",
+                        'type': NetworkSubnet.TYPE_CLOUD,
                         'ip_range': "10.0.1.0/24",
                         'network_zone': "eu-central"
                     }
@@ -353,12 +357,24 @@ def test_add_subnet(self, networks_client, network, generic_action, network_subn
 
         action = networks_client.add_subnet(network, network_subnet)
         networks_client._client.request.assert_called_with(url="/networks/1/actions/add_subnet", method="POST",
-                                                           json={"type": "cloud", "ip_range": "10.0.1.0/24",
+                                                           json={"type": NetworkSubnet.TYPE_CLOUD, "ip_range": "10.0.1.0/24",
                                                                  "network_zone": "eu-central"})
 
         assert action.id == 1
         assert action.progress == 0
 
+    @pytest.mark.parametrize("network", [Network(id=1), BoundNetwork(mock.MagicMock(), dict(id=1))])
+    def test_add_subnet_vswitch(self, networks_client, network, generic_action, network_vswitch_subnet):
+        networks_client._client.request.return_value = generic_action
+
+        action = networks_client.add_subnet(network, network_vswitch_subnet)
+        networks_client._client.request.assert_called_with(url="/networks/1/actions/add_subnet", method="POST",
+                                                           json={"type": NetworkSubnet.TYPE_VSWITCH, "ip_range": "10.0.1.0/24",
+                                                                 "network_zone": "eu-central", "vswitch_id": 123})
+
+        assert action.id == 1
+        assert action.progress == 0
+
     @pytest.mark.parametrize("network", [Network(id=1), BoundNetwork(mock.MagicMock(), dict(id=1))])
     def test_delete_subnet(self, networks_client, network, generic_action, network_subnet):
         networks_client._client.request.return_value = generic_action