project: VPC Dual Stack (#601)

* Enhanced Interfaces: Add support for Firewall templates (#529)

* Add support for Firewall Templates

* oops

* Add LA notices

* Enhanced Interfaces: Add account-related fields (#525)

* Enhanced Interfaces: Add account-related fields

* Add setting enum

* Add LA notice

* Drop residual print

* Enhanced Interfaces: Implement endpoints & fields related to VPCs and non-interface networking (#526)

* Implement endpoints & fields related to VPCs and non-interface networking

* Add LA notices

* Implement support for VPC Dual Stack (#524)

* Enhanced Interfaces: Add support for Linode-related endpoints and fields (#533)

* Add support for Linode-related endpoints and fields

* oops

* tiny fixes

* fix docsa

* Add docs examples

* Docs fixes

* oops

* Remove irrelevant test

* Add LA notices

* Fill in API documentation URLs

* Add return types

* Enable `include_none_values` in FirewallSettingsDefaultFirewallIDs (#558)

* VPC Dual Stack: Support changes related to Linode Interfaces (#559)

* Implementation; needs tests

* Add integration tests

* vpctest

* removeprint

* test

* Fix conflicts

* Fix missed conflict

---------

Co-authored-by: Zhiwei Liang <zliang@akamai.com>
Co-authored-by: Zhiwei Liang <121905282+zliang-akamai@users.noreply.github.com>
Co-authored-by: vshanthe <vshanthe@akamai.com>
Co-authored-by: Vinay <143587840+vshanthe@users.noreply.github.com>

Author: 3 people

linode_api4/groups/vpc.py

@@ -2,8 +2,10 @@
 
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
-from linode_api4.objects import VPC, Region, VPCIPAddress
+from linode_api4.objects import VPC, Region, VPCIPAddress, VPCIPv6RangeOptions
+from linode_api4.objects.base import _flatten_request_body_recursive
 from linode_api4.paginated_list import PaginatedList
+from linode_api4.util import drop_null_keys
 
 
 class VPCGroup(Group):
@@ -33,6 +35,7 @@ def create(
         region: Union[Region, str],
         description: Optional[str] = None,
         subnets: Optional[List[Dict[str, Any]]] = None,
+        ipv6: Optional[List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]] = None,
         **kwargs,
     ) -> VPC:
         """
@@ -48,30 +51,33 @@ def create(
         :type description: Optional[str]
         :param subnets: A list of subnets to create under this VPC.
         :type subnets: List[Dict[str, Any]]
+        :param ipv6: The IPv6 address ranges for this VPC.
+        :type ipv6: List[Union[VPCIPv6RangeOptions, Dict[str, Any]]]
 
         :returns: The new VPC object.
         :rtype: VPC
         """
         params = {
             "label": label,
             "region": region.id if isinstance(region, Region) else region,
+            "description": description,
+            "ipv6": ipv6,
+            "subnets": subnets,
         }
 
-        if description is not None:
-            params["description"] = description
-
         if subnets is not None and len(subnets) > 0:
             for subnet in subnets:
                 if not isinstance(subnet, dict):
                     raise ValueError(
                         f"Unsupported type for subnet: {type(subnet)}"
                     )
 
-            params["subnets"] = subnets
-
         params.update(kwargs)
 
-        result = self.client.post("/vpcs", data=params)
+        result = self.client.post(
+            "/vpcs",
+            data=drop_null_keys(_flatten_request_body_recursive(params)),
+        )
 
         if not "id" in result:
             raise UnexpectedResponseError(

linode_api4/objects/linode.py

@@ -300,10 +300,83 @@ def _populate(self, json):
 
 @dataclass
 class ConfigInterfaceIPv4(JSONObject):
+    """
+    ConfigInterfaceIPv4 represents the IPv4 configuration of a VPC interface.
+    """
+
     vpc: str = ""
     nat_1_1: str = ""
 
 
+@dataclass
+class ConfigInterfaceIPv6SLAACOptions(JSONObject):
+    """
+    ConfigInterfaceIPv6SLAACOptions is used to set a single IPv6 SLAAC configuration of a VPC interface.
+    """
+
+    range: str = ""
+
+
+@dataclass
+class ConfigInterfaceIPv6RangeOptions(JSONObject):
+    """
+    ConfigInterfaceIPv6RangeOptions is used to set a single IPv6 range configuration of a VPC interface.
+    """
+
+    range: str = ""
+
+
+@dataclass
+class ConfigInterfaceIPv6Options(JSONObject):
+    """
+    ConfigInterfaceIPv6Options is used to set the IPv6 configuration of a VPC interface.
+    """
+
+    slaac: List[ConfigInterfaceIPv6SLAACOptions] = field(
+        default_factory=lambda: []
+    )
+    ranges: List[ConfigInterfaceIPv6RangeOptions] = field(
+        default_factory=lambda: []
+    )
+    is_public: bool = False
+
+
+@dataclass
+class ConfigInterfaceIPv6SLAAC(JSONObject):
+    """
+    ConfigInterfaceIPv6SLAAC represents a single SLAAC address under a VPC interface's IPv6 configuration.
+    """
+
+    put_class = ConfigInterfaceIPv6SLAACOptions
+
+    range: str = ""
+    address: str = ""
+
+
+@dataclass
+class ConfigInterfaceIPv6Range(JSONObject):
+    """
+    ConfigInterfaceIPv6Range represents a single IPv6 address under a VPC interface's IPv6 configuration.
+    """
+
+    put_class = ConfigInterfaceIPv6RangeOptions
+
+    range: str = ""
+
+
+@dataclass
+class ConfigInterfaceIPv6(JSONObject):
+    """
+    ConfigInterfaceIPv6 represents the IPv6 configuration of a VPC interface.
+    """
+
+    put_class = ConfigInterfaceIPv6Options
+
+    slaac: List[ConfigInterfaceIPv6SLAAC] = field(default_factory=lambda: [])
+    ranges: List[ConfigInterfaceIPv6Range] = field(default_factory=lambda: [])
+    is_public: bool = False
+
+
 class NetworkInterface(DerivedBase):
     """
     This class represents a Configuration Profile's network interface object.
@@ -329,6 +402,7 @@ class NetworkInterface(DerivedBase):
         "vpc_id": Property(id_relationship=VPC),
         "subnet_id": Property(),
         "ipv4": Property(mutable=True, json_object=ConfigInterfaceIPv4),
+        "ipv6": Property(mutable=True, json_object=ConfigInterfaceIPv6),
         "ip_ranges": Property(mutable=True),
     }
 
@@ -400,7 +474,10 @@ class ConfigInterface(JSONObject):
     # VPC-specific
     vpc_id: Optional[int] = None
     subnet_id: Optional[int] = None
+
     ipv4: Optional[Union[ConfigInterfaceIPv4, Dict[str, Any]]] = None
+    ipv6: Optional[Union[ConfigInterfaceIPv6, Dict[str, Any]]] = None
+
     ip_ranges: Optional[List[str]] = None
 
     # Computed
@@ -409,7 +486,7 @@ class ConfigInterface(JSONObject):
     def __repr__(self):
         return f"Interface: {self.purpose}"
 
-    def _serialize(self, *args, **kwargs):
+    def _serialize(self, is_put: bool = False):
         purpose_formats = {
             "public": {"purpose": "public", "primary": self.primary},
             "vlan": {
@@ -421,11 +498,8 @@ def _serialize(self, *args, **kwargs):
                 "purpose": "vpc",
                 "primary": self.primary,
                 "subnet_id": self.subnet_id,
-                "ipv4": (
-                    self.ipv4.dict
-                    if isinstance(self.ipv4, ConfigInterfaceIPv4)
-                    else self.ipv4
-                ),
+                "ipv4": self.ipv4,
+                "ipv6": self.ipv6,
                 "ip_ranges": self.ip_ranges,
             },
         }
@@ -435,11 +509,14 @@ def _serialize(self, *args, **kwargs):
                 f"Unknown interface purpose: {self.purpose}",
             )
 
-        return {
-            k: v
-            for k, v in purpose_formats[self.purpose].items()
-            if v is not None
-        }
+        return _flatten_request_body_recursive(
+            {
+                k: v
+                for k, v in purpose_formats[self.purpose].items()
+                if v is not None
+            },
+            is_put=is_put,
+        )
 
 
 class Config(DerivedBase):
@@ -580,6 +657,7 @@ def interface_create_vpc(
         subnet: Union[int, VPCSubnet],
         primary=False,
         ipv4: Union[Dict[str, Any], ConfigInterfaceIPv4] = None,
+        ipv6: Union[Dict[str, Any], ConfigInterfaceIPv6Options] = None,
         ip_ranges: Optional[List[str]] = None,
     ) -> NetworkInterface:
         """
@@ -593,6 +671,8 @@ def interface_create_vpc(
         :type primary: bool
         :param ipv4: The IPv4 configuration of the interface for the associated subnet.
         :type ipv4: Dict or ConfigInterfaceIPv4
+        :param ipv6: The IPv6 configuration of the interface for the associated subnet.
+        :type ipv6: Dict or ConfigInterfaceIPv6Options
         :param ip_ranges: A list of IPs or IP ranges in the VPC subnet.
                           Packets to these CIDRs are routed through the
                           VPC network interface.
@@ -603,19 +683,16 @@ def interface_create_vpc(
         """
         params = {
             "purpose": "vpc",
-            "subnet_id": subnet.id if isinstance(subnet, VPCSubnet) else subnet,
+            "subnet_id": subnet,
             "primary": primary,
+            "ipv4": ipv4,
+            "ipv6": ipv6,
+            "ip_ranges": ip_ranges,
         }
 
-        if ipv4 is not None:
-            params["ipv4"] = (
-                ipv4.dict if isinstance(ipv4, ConfigInterfaceIPv4) else ipv4
-            )
-
-        if ip_ranges is not None:
-            params["ip_ranges"] = ip_ranges
-
-        return self._interface_create(params)
+        return self._interface_create(
+            drop_null_keys(_flatten_request_body_recursive(params))
+        )
 
     def interface_reorder(self, interfaces: List[Union[int, NetworkInterface]]):
         """
@@ -2018,6 +2095,7 @@ def linode_interfaces(self) -> Optional[list[LinodeInterface]]:
 
         if self.interface_generation != InterfaceGeneration.LINODE:
             return None
+
         if not hasattr(self, "_interfaces"):
             result = self._client.get(
                 "{}/interfaces".format(Instance.api_endpoint),

linode_api4/objects/linode_interfaces.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
-from typing import List, Optional, Union
+from typing import List, Optional
 
-from linode_api4.objects.base import Base, ExplicitNullValue, Property
+from linode_api4.objects.base import Base, Property
 from linode_api4.objects.dbase import DerivedBase
 from linode_api4.objects.networking import Firewall
 from linode_api4.objects.serializable import JSONObject
@@ -104,6 +104,41 @@ class LinodeInterfaceVPCIPv4Options(JSONObject):
     ranges: Optional[List[LinodeInterfaceVPCIPv4RangeOptions]] = None
 
 
+@dataclass
+class LinodeInterfaceVPCIPv6SLAACOptions(JSONObject):
+    """
+    Options accepted for a single SLAAC when creating or updating the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    range: Optional[str] = None
+
+
+@dataclass
+class LinodeInterfaceVPCIPv6RangeOptions(JSONObject):
+    """
+    Options accepted for a single range when creating or updating the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    range: Optional[str] = None
+
+
+@dataclass
+class LinodeInterfaceVPCIPv6Options(JSONObject):
+    """
+    Options accepted when creating or updating the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    is_public: Optional[bool] = None
+    slaac: Optional[List[LinodeInterfaceVPCIPv6SLAACOptions]] = None
+    ranges: Optional[List[LinodeInterfaceVPCIPv6RangeOptions]] = None
+
+
 @dataclass
 class LinodeInterfaceVPCOptions(JSONObject):
     """
@@ -114,6 +149,7 @@ class LinodeInterfaceVPCOptions(JSONObject):
 
     subnet_id: int = 0
     ipv4: Optional[LinodeInterfaceVPCIPv4Options] = None
+    ipv6: Optional[LinodeInterfaceVPCIPv6Options] = None
 
 
 @dataclass
@@ -193,13 +229,13 @@ class LinodeInterfaceOptions(JSONObject):
     NOTE: Linode interfaces may not currently be available to all users.
     """
 
-    # If a default firewall_id isn't configured, the API requires that
-    # firewall_id is defined in the LinodeInterface POST body.
-    #
-    # To create a Linode Interface without a firewall, this field should
-    # be set to `ExplicitNullValue()`.
-    firewall_id: Union[int, ExplicitNullValue, None] = None
+    always_include = {
+        # If a default firewall_id isn't configured, the API requires that
+        # firewall_id is defined in the LinodeInterface POST body.
+        "firewall_id"
+    }
 
+    firewall_id: Optional[int] = None
     default_route: Optional[LinodeInterfaceDefaultRouteOptions] = None
     vpc: Optional[LinodeInterfaceVPCOptions] = None
     public: Optional[LinodeInterfacePublicOptions] = None
@@ -265,6 +301,44 @@ class LinodeInterfaceVPCIPv4(JSONObject):
     ranges: List[LinodeInterfaceVPCIPv4Range] = field(default_factory=list)
 
 
+@dataclass
+class LinodeInterfaceVPCIPv6SLAAC(JSONObject):
+    """
+    A single SLAAC entry under the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    range: str = ""
+    address: str = ""
+
+
+@dataclass
+class LinodeInterfaceVPCIPv6Range(JSONObject):
+    """
+    A single range under the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    range: str = ""
+
+
+@dataclass
+class LinodeInterfaceVPCIPv6(JSONObject):
+    """
+    A single address under the IPv6 configuration of a VPC Linode Interface.
+
+    NOTE: Linode interfaces may not currently be available to all users.
+    """
+
+    put_class = LinodeInterfaceVPCIPv6Options
+
+    is_public: bool = False
+    slaac: List[LinodeInterfaceVPCIPv6SLAAC] = field(default_factory=list)
+    ranges: List[LinodeInterfaceVPCIPv6Range] = field(default_factory=list)
+
+
 @dataclass
 class LinodeInterfaceVPC(JSONObject):
     """
@@ -279,6 +353,7 @@ class LinodeInterfaceVPC(JSONObject):
     subnet_id: int = 0
 
     ipv4: Optional[LinodeInterfaceVPCIPv4] = None
+    ipv6: Optional[LinodeInterfaceVPCIPv6] = None
 
 
 @dataclass