Address CoPilot fixes

Author: ezilber-akamai

linode_api4/groups/vpc.py

@@ -73,7 +73,6 @@ def create(
             "description": description,
             "ipv4": ipv4,
             "ipv6": ipv6,
-            "subnets": subnets,
         }
 
         if subnets is not None and len(subnets) > 0:
@@ -85,10 +84,19 @@ def create(
 
         params.update(kwargs)
 
-        result = self.client.post(
-            "/vpcs",
-            data=drop_null_keys(_flatten_request_body_recursive(params)),
-        )
+        data = drop_null_keys(_flatten_request_body_recursive(params))
+
+        # Preserve the ``{"id": null}`` detach signal on any subnet's
+        # ``natgateway`` field: ``drop_null_keys`` is recursive and would
+        # otherwise strip an explicit ``id: None`` inside ``natgateway``.
+        # Bypass ``drop_null_keys`` for the entire ``subnets`` payload -
+        # ``JSONObject`` values already strip their own optional ``None``
+        # fields via ``_serialize``, and raw-dict subnets are expected to
+        # be clean.
+        if subnets is not None:
+            data["subnets"] = _flatten_request_body_recursive(subnets)
+
+        result = self.client.post("/vpcs", data=data)
 
         if not "id" in result:
             raise UnexpectedResponseError(

linode_api4/objects/networking.py

@@ -583,6 +583,9 @@ class NATGatewayType(JSONObject):
     price: Optional[Price] = None
 
 
+# TODO: replace with base once the region_prices and transfer fields are in use and returned by the API
+
+
 @dataclass
 class NATGatewaySettings(JSONObject):
     allowed_ports_per_interface: List[int] = field(default_factory=list)
@@ -605,7 +608,7 @@ class NATGateway(Base):
 
     properties = {
         "id": Property(identifier=True),
-        "region": Property(),
+        "region": Property(slug_relationship=Region),
         "addresses": Property(json_object=NATGatewayAddress),
         "address_autoscale_max": Property(),
         "default_ports_per_interface": Property(),
@@ -677,6 +680,7 @@ def address_assignment_create(
             model=self,
             data={"address": address},
         )
+        self.invalidate()
 
         if "address" not in result:
             raise UnexpectedResponseError(
@@ -702,6 +706,7 @@ def address_assignment_delete(self, address: str) -> bool:
             "{}/addresses/{}".format(NATGateway.api_endpoint, address),
             model=self,
         )
+        self.invalidate()
 
         if "error" in resp:
             return False

linode_api4/objects/vpc.py

@@ -208,7 +208,9 @@ def subnet_create(
         ipv6: Optional[
             List[Union[VPCSubnetIPv6RangeOptions, Dict[str, Any]]]
         ] = None,
-        natgateway: Optional[VPCSubnetNATGatewayOptions] = None,
+        natgateway: Optional[
+            Union[VPCSubnetNATGatewayOptions, Dict[str, Any]]
+        ] = None,
         **kwargs,
     ) -> VPCSubnet:
         """
@@ -229,15 +231,22 @@ def subnet_create(
             "label": label,
             "ipv4": ipv4,
             "ipv6": ipv6,
-            "natgateway": natgateway,
         }
 
         params.update(kwargs)
 
+        data = drop_null_keys(_flatten_request_body_recursive(params))
+
+        # Preserve the ``{"id": null}`` detach signal separately: ``drop_null_keys``
+        # is recursive and would otherwise strip an explicit ``id: None`` inside
+        # ``natgateway``, collapsing the detach payload to ``{}``.
+        if natgateway is not None:
+            data["natgateway"] = _flatten_request_body_recursive(natgateway)
+
         result = self._client.post(
             "{}/subnets".format(VPC.api_endpoint),
             model=self,
-            data=drop_null_keys(_flatten_request_body_recursive(params)),
+            data=data,
         )
         self.invalidate()
 

test/fixtures/networking_natgateways_42_addresses.json

@@ -3,8 +3,8 @@
     {
       "address": "203.0.113.42",
       "in_use": true,
-      "interface_count": 2,
-      "interface_url": "/v4/linode/instances/123/interfaces/456",
+      "interface_count": 1,
+      "interface_url": "/v4/networking/natgateways/42/addresses/203.0.113.42/interfaces",
       "portset_assignments": 15,
       "portset_capacity": 30
     }

test/fixtures/networking_natgateways_42_addresses_203.0.113.42.json

@@ -1,8 +1,8 @@
 {
   "address": "203.0.113.42",
   "in_use": true,
-  "interface_count": 2,
-  "interface_url": "/v4/linode/instances/123/interfaces/456",
+  "interface_count": 1,
+  "interface_url": "/v4/networking/natgateways/42/addresses/203.0.113.42/interfaces",
   "portset_assignments": 15,
   "portset_capacity": 30
 }

test/fixtures/networking_natgateways_42_interfaces.json

@@ -8,10 +8,10 @@
         "type": "linode",
         "url": "/v4/linode/instances/1001"
       },
-      "addresses": ["172.24.213.144"],
+      "addresses": ["203.0.113.42"],
       "portsets": [
         {
-          "address": "172.24.213.144",
+          "address": "203.0.113.42",
           "ports": [{"start": 2048, "end": 3071}]
         }
       ]
@@ -24,10 +24,10 @@
         "type": "linode",
         "url": "/v4/linode/instances/1002"
       },
-      "addresses": ["172.24.213.144"],
+      "addresses": ["203.0.113.43"],
       "portsets": [
         {
-          "address": "172.24.213.144",
+          "address": "203.0.113.43",
           "ports": [{"start": 3072, "end": 4095}]
         }
       ]

test/fixtures/vpcs_123456_subnets_789.json

@@ -50,7 +50,7 @@
         ]
       }
     ]
-   },
+  },
   "created": "2018-01-01T00:01:01",
   "updated": "2018-01-01T00:01:01"
 }

test/fixtures/vpcs_123456_subnets_790.json

@@ -0,0 +1,11 @@
+{
+    "id": 790,
+    "label": "no-gateway-subnet",
+    "ipv4": "10.0.1.0/24",
+    "ipv6": [],
+    "linodes": [],
+    "databases": [],
+    "created": "2018-01-01T00:01:01",
+    "updated": "2018-01-01T00:01:01"
+}
+

test/unit/groups/vpc_test.py

@@ -102,6 +102,37 @@ def test_create_vpc_with_subnet_natgateway(self):
             self.assertEqual(vpc._populated, True)
             self.validate_vpc_123456(vpc)
 
+    def test_create_vpc_with_subnet_natgateway_detach_signal(self):
+        """
+        Tests that a subnet's ``natgateway`` set to
+        ``VPCSubnetNATGatewayOptions(id=None)`` on VPC create is preserved
+        as ``{"natgateway": {"id": null}}`` through ``drop_null_keys``.
+        """
+
+        with self.mock_post("/vpcs/123456") as m:
+            self.client.vpcs.create(
+                "test-vpc",
+                "us-southeast",
+                subnets=[
+                    {
+                        "label": "test-subnet",
+                        "ipv4": "10.0.0.0/24",
+                        "natgateway": VPCSubnetNATGatewayOptions(id=None),
+                    },
+                ],
+            )
+
+            self.assertEqual(
+                m.call_data.get("subnets"),
+                [
+                    {
+                        "label": "test-subnet",
+                        "ipv4": "10.0.0.0/24",
+                        "natgateway": {"id": None},
+                    },
+                ],
+            )
+
     def test_list_ips(self):
         """
         Validates that all VPC IPs can be listed.

test/unit/objects/networking_test.py

@@ -469,7 +469,7 @@ class NATGatewayTest(ClientBaseCase):
     def assert_natgateway_42(natgateway: NATGateway):
         assert natgateway.id == 42
         assert natgateway.label == "the-natgateway"
-        assert natgateway.region == "us-east"
+        assert natgateway.region.id == "us-east"
         assert natgateway.address_autoscale_max == 4
         assert natgateway.default_ports_per_interface == 4096
         assert natgateway.portset_assignments == 15
@@ -521,10 +521,10 @@ def test_delete_natgateway(self):
     def assert_address_assignment(assignment: NATGatewayAddressAssignment):
         assert assignment.address == "203.0.113.42"
         assert assignment.in_use is True
-        assert assignment.interface_count == 2
+        assert assignment.interface_count == 1
         assert (
             assignment.interface_url
-            == "/v4/linode/instances/123/interfaces/456"
+            == "/v4/networking/natgateways/42/addresses/203.0.113.42/interfaces"
         )
         assert assignment.portset_assignments == 15
         assert assignment.portset_capacity == 30
@@ -590,15 +590,17 @@ def assert_interfaces(interfaces):
         assert first.linode.label == "linode1001"
         assert first.linode.type == "linode"
         assert first.linode.url == "/v4/linode/instances/1001"
-        assert first.addresses == ["172.24.213.144"]
-        assert first.portsets[0].address == "172.24.213.144"
+        assert first.addresses == ["203.0.113.42"]
+        assert first.portsets[0].address == "203.0.113.42"
         assert first.portsets[0].ports[0].start == 2048
         assert first.portsets[0].ports[0].end == 3071
 
         second = interfaces[1]
         assert second.id == 143
         assert second.linode.id == 1002
         assert second.linode.label == "linode1002"
+        assert second.addresses == ["203.0.113.43"]
+        assert second.portsets[0].address == "203.0.113.43"
 
     def test_list_interfaces(self):
         """
@@ -612,8 +614,9 @@ def test_list_address_interfaces(self):
         """
         Tests GET /networking/natgateways/{id}/addresses/{address}/interfaces.
 
-        The per-address endpoint only returns interfaces actually using that
-        address, so the response is a subset of the gateway-wide list.
+        The per-address endpoint returns only the interfaces using that
+        specific address. In the fixture, only interface 142 uses
+        203.0.113.42; interface 143 uses 203.0.113.43.
         """
         natgateway = NATGateway(self.client, 42)
         interfaces = natgateway.address_interfaces("203.0.113.42")