TPT-4126: Add support for NB Front-End IP in VPC-MTC + 40Gbps NB-MTC

linode_api4/common.py

@@ -81,3 +81,15 @@ class RegionPrice(JSONObject):
     id: int = 0
     hourly: int = 0
     monthly: int = 0
+
+
+@dataclass
+class LKECluster(JSONObject):
+    """
+    LKECluster contains the core fields of a lke_cluster object returned by various node balancer endpoints.
+    """
+
+    id: int = 0
+    label: str = ""
+    type: str = ""
+    url: str = ""

linode_api4/objects/nodebalancer.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from urllib import parse
 
-from linode_api4.common import Price, RegionPrice
+from linode_api4.common import LKECluster, Price, RegionPrice
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.objects.base import Base, MappedObject, Property
 from linode_api4.objects.dbase import DerivedBase
@@ -231,6 +231,28 @@ def load_ssl_data(self, cert_file, key_file):
                 self.ssl_key = f.read()
 
 
+class NodeBalancerVPCConfig(DerivedBase):
+    """
+    The VPC configuration for this NodeBalancer.
+
+    API documentation: https://techdocs.akamai.com/linode-api/reference/get-node-balancer-vpc-config
+    """
+
+    api_endpoint = "/nodebalancers/{nodebalancer_id}/vpcs/{id}"
+    derived_url_path = "vpcs"
+    parent_id_name = "nodebalancer_id"
+
+    properties = {
+        "id": Property(identifier=True),
+        "nodebalancer_id": Property(identifier=True),
+        "ipv4_range": Property(),
+        "ipv6_range": Property(),
+        "subnet_id": Property(),
+        "vpc_id": Property(),
+        "purpose": Property(),
+    }
+
+
 class NodeBalancer(Base):
     """
     A single NodeBalancer you can access.
@@ -255,6 +277,10 @@ class NodeBalancer(Base):
         "tags": Property(mutable=True, unordered=True),
         "client_udp_sess_throttle": Property(mutable=True),
         "locks": Property(unordered=True),
+        "type": Property(),
+        "lke_cluster": Property(json_object=LKECluster),
+        "frontend_address_type": Property(),
+        "frontend_vpc_subnet_id": Property(),
     }
 
     # create derived objects
@@ -358,3 +384,80 @@ def firewalls(self):
             Firewall(self._client, firewall["id"])
             for firewall in result["data"]
         ]
+
+    def vpcs(self):
+        """
+        View VPC information for VPCs associated with this NodeBalancer.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-node-balancer-vpcs
+
+        :returns: A List of NodeBalancerVPCConfig of the Linode NodeBalancer.
+        :rtype: List[NodeBalancerVPCConfig]
+        """
+        result = self._client.get(
+            "{}/vpcs".format(NodeBalancer.api_endpoint), model=self
+        )
+
+        return [
+            NodeBalancerVPCConfig(self._client, vpc["id"], self.id, json=vpc)
+            for vpc in result["data"]
+        ]
+
+    def vpc(self, id):
+        """
+        View VPC information for a VPC associated with this NodeBalancer.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-node-balancer-vpc-config
+
+        :param id: The ID of the NodeBalancer VPC Config to view.
+        :type id: int
+
+        :returns: A NodeBalancerVPCConfig of the Linode NodeBalancer.
+        :rtype: NodeBalancerVPCConfig
+        """
+        result = self._client.get(
+            "{}/vpcs/{}".format(
+                NodeBalancer.api_endpoint, parse.quote(str(id))
+            ),
+            model=self,
+        )
+
+        return NodeBalancerVPCConfig(
+            self._client, result["id"], self.id, json=result
+        )
+
+    def backend_vpcs(self):
+        """
+        View VPC information for backend VPCs associated with this NodeBalancer.
+
+        API Documentation: TODO
+
+        :returns: A List of NodeBalancerVPCConfig of the Linode NodeBalancer.
+        :rtype: List[NodeBalancerVPCConfig]
+        """
+        result = self._client.get(
+            "{}/backend_vpcs".format(NodeBalancer.api_endpoint), model=self
+        )
+
+        return [
+            NodeBalancerVPCConfig(self._client, vpc["id"], self.id, json=vpc)
+            for vpc in result["data"]
+        ]
+
+    def frontend_vpcs(self):
+        """
+        View VPC information for frontend VPCs associated with this NodeBalancer.
+
+        API Documentation: TODO
+
+        :returns: A List of NodeBalancerVPCConfig of the Linode NodeBalancer.
+        :rtype: List[NodeBalancerVPCConfig]
+        """
+        result = self._client.get(
+            "{}/frontend_vpcs".format(NodeBalancer.api_endpoint), model=self
+        )
+
+        return [
+            NodeBalancerVPCConfig(self._client, vpc["id"], self.id, json=vpc)
+            for vpc in result["data"]
+        ]

test/fixtures/nodebalancers.json

@@ -11,7 +11,16 @@
       "label": "balancer123456",
       "client_conn_throttle": 0,
       "tags": ["something"],
-      "locks": ["cannot_delete_with_subresources"]
+      "locks": ["cannot_delete_with_subresources"],
+      "type": "common",
+      "lke_cluster": {
+        "id": 1234,
+        "type": "lkecluster",
+        "label": "test-cluster",
+        "url": "/v4/lke/clusters/1234"
+      },
+      "frontend_address_type": "vpc",
+      "frontend_vpc_subnet_id": 5555
     },
     {
       "created": "2018-01-01T00:01:01",
@@ -24,10 +33,14 @@
       "label": "balancer123457",
       "client_conn_throttle": 0,
       "tags": [],
-      "locks": []
+      "locks": [],
+      "type": "premium_40gb",
+      "lke_cluster": null,
+      "frontend_address_type": "vpc",
+      "frontend_vpc_subnet_id": 6666
     }
   ],
   "results": 2,
   "page": 1,
   "pages": 1
-}
+}

test/fixtures/nodebalancers_123456.json

@@ -13,5 +13,14 @@
   ],
   "locks": [
     "cannot_delete_with_subresources"
-  ]
+  ],
+  "type": "common",
+  "lke_cluster": {
+    "id": 1234,
+    "type": "lkecluster",
+    "label": "test-cluster",
+    "url": "/v4/lke/clusters/1234"
+  },
+  "frontend_address_type": "vpc",
+  "frontend_vpc_subnet_id": 5555
 }

test/fixtures/nodebalancers_12345_backend__vpcs.json

@@ -0,0 +1,16 @@
+{
+    "data": [
+        {
+            "id": 101,
+            "nodebalancer_id": 12345,
+            "subnet_id": 6666,
+            "vpc_id": 222,
+            "ipv4_range": "10.200.1.0/24",
+            "ipv6_range": "2001:db8:2::/64",
+            "purpose": "backend"
+        }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+}

test/fixtures/nodebalancers_12345_frontend__vpcs.json

@@ -0,0 +1,16 @@
+{
+    "data": [
+        {
+            "id": 99,
+            "nodebalancer_id": 12345,
+            "subnet_id": 5555,
+            "vpc_id": 111,
+            "ipv4_range": "10.100.5.0/24",
+            "ipv6_range": "2001:db8::/64",
+            "purpose": "frontend"
+        }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 1
+}

test/fixtures/nodebalancers_12345_vpcs.json

@@ -0,0 +1,25 @@
+{
+    "data": [
+        {
+            "id": 99,
+            "nodebalancer_id": 12345,
+            "subnet_id": 5555,
+            "vpc_id": 111,
+            "ipv4_range": "10.100.5.0/24",
+            "ipv6_range": "2001:db8::/64",
+            "purpose": "frontend"
+        },
+        {
+            "id": 100,
+            "nodebalancer_id": 12345,
+            "subnet_id": 5556,
+            "vpc_id": 112,
+            "ipv4_range": "10.100.6.0/24",
+            "ipv6_range": "2001:db8:1::/64",
+            "purpose": "backend"
+        }
+    ],
+    "page": 1,
+    "pages": 1,
+    "results": 2
+}

test/fixtures/nodebalancers_12345_vpcs_99.json

@@ -0,0 +1,9 @@
+{
+    "id": 99,
+    "nodebalancer_id": 12345,
+    "subnet_id": 5555,
+    "vpc_id": 111,
+    "ipv4_range": "10.100.5.0/24",
+    "ipv6_range": "2001:db8::/64",
+    "purpose": "frontend"
+}

test/integration/conftest.py

@@ -10,7 +10,7 @@
     wait_for_condition,
 )
 from test.integration.models.database.helpers import get_db_engine_id
-from typing import Optional, Set
+from typing import List, Optional, Set
 
 import pytest
 import requests
@@ -115,9 +115,18 @@ def get_regions(
 
 
 def get_region(
-    client: LinodeClient, capabilities: Set[str] = None, site_type: str = "core"
+    client: LinodeClient,
+    capabilities: Set[str] = None,
+    site_type: str = "core",
+    valid_regions: List[str] = None,
 ):
-    return random.choice(get_regions(client, capabilities, site_type))
+    regions = get_regions(client, capabilities, site_type)
+
+    # To filter out regions that cannot be used for the Linode resource
+    if valid_regions:
+        regions = [reg for reg in regions if reg.id in valid_regions]
+
+    return random.choice(regions)
 
 
 def get_api_ca_file():
@@ -478,8 +487,10 @@ def create_vpc(test_linode_client):
             {
                 "VPCs",
                 "VPC IPv6 Stack",
+                "VPC Dual Stack",
                 "Linode Interfaces",
                 "Custom VPC IPv4 Ranges",
+                "NodeBalancers",
             },
         ),
         description="test description",
@@ -490,6 +501,24 @@ def create_vpc(test_linode_client):
     vpc.delete()
 
 
+@pytest.fixture(scope="session")
+def create_vpc_ipv4(test_linode_client):
+    client = test_linode_client
+
+    label = get_test_label(length=10) + "-ipv4"
+
+    vpc = client.vpcs.create(
+        label=label,
+        region=get_region(
+            test_linode_client, {"VPCs", "Linode Interfaces", "NodeBalancers"}
+        ),
+        description="test description",
+    )
+    yield vpc
+
+    vpc.delete()
+
+
 @pytest.fixture(scope="session")
 def create_vpc_with_subnet(test_linode_client, create_vpc):
     subnet = create_vpc.subnet_create(
@@ -503,6 +532,52 @@ def create_vpc_with_subnet(test_linode_client, create_vpc):
     subnet.delete()
 
 
+@pytest.fixture(scope="session")
+def create_vpc_with_subnet_ipv4(test_linode_client, create_vpc_ipv4):
+    subnet = create_vpc_ipv4.subnet_create(
+        label="test-subnet", ipv4="10.0.0.0/24"
+    )
+
+    yield create_vpc_ipv4, subnet
+
+    subnet.delete()
+
+
+@pytest.fixture(scope="function")
+def create_vpc_with_subnet_in_premium_region(request, test_linode_client):
+    premium_regions = getattr(request, "param")
+    client = test_linode_client
+    label = get_test_label(length=10)
+
+    vpc = client.vpcs.create(
+        label=label,
+        region=get_region(
+            client,
+            {
+                "VPCs",
+                "VPC IPv6 Stack",
+                "VPC Dual Stack",
+                "Linode Interfaces",
+                "NodeBalancers",
+            },
+            valid_regions=premium_regions,
+        ),
+        description="test description",
+        ipv6=[{"range": "auto"}],
+    )
+
+    subnet = vpc.subnet_create(
+        label="test-subnet",
+        ipv4="10.0.0.0/24",
+        ipv6=[{"range": "auto"}],
+    )
+
+    yield vpc, subnet
+
+    subnet.delete()
+    vpc.delete()
+
+
 @pytest.fixture(scope="session")
 def create_vpc_with_subnet_and_linode(
     test_linode_client, create_vpc_with_subnet, e2e_test_firewall