new: Allow defining interfaces on Instance creation (#372)

* enable interfaces

* simplify code

Author: yec-akamai

linode_api4/groups/linode.py

@@ -265,6 +265,9 @@ def instance_create(
         :type metadata: dict
         :param firewall: The firewall to attach this Linode to.
         :type firewall: int or Firewall
+        :param interfaces: An array of Network Interfaces to add to this Linode’s Configuration Profile.
+                           At least one and up to three Interface objects can exist in this array.
+        :type interfaces: list[ConfigInterface] or list[dict[str, Any]]
 
         :returns: A new Instance object, or a tuple containing the new Instance and
                   the generated password.
@@ -303,6 +306,12 @@ def instance_create(
             fw = kwargs.pop("firewall")
             kwargs["firewall_id"] = fw.id if isinstance(fw, Firewall) else fw
 
+        if "interfaces" in kwargs:
+            kwargs["interfaces"] = [
+                i._serialize() if isinstance(i, ConfigInterface) else i
+                for i in kwargs["interfaces"]
+            ]
+
         params = {
             "type": ltype.id if issubclass(type(ltype), Base) else ltype,
             "region": region.id if issubclass(type(region), Base) else region,

test/integration/linode_client/test_linode_client.py

@@ -5,7 +5,7 @@
 import pytest
 
 from linode_api4 import ApiError, LinodeClient
-from linode_api4.objects import ObjectStorageKeys
+from linode_api4.objects import ConfigInterface, ObjectStorageKeys
 
 
 @pytest.fixture(scope="session", autouse=True)
@@ -231,6 +231,38 @@ def test_create_linode_instance_with_image(setup_client_and_linode):
     assert re.search("linode/debian10", str(linode.image))
 
 
+def test_create_linode_with_interfaces(test_linode_client):
+    client = test_linode_client
+    available_regions = client.regions()
+    chosen_region = available_regions[4]
+    label = get_test_label()
+
+    linode_instance, password = client.linode.instance_create(
+        "g6-nanode-1",
+        chosen_region,
+        label=label,
+        image="linode/debian10",
+        interfaces=[
+            {"purpose": "public"},
+            ConfigInterface(
+                purpose="vlan", label="cool-vlan", ipam_address="10.0.0.4/32"
+            ),
+        ],
+    )
+
+    assert len(linode_instance.configs[0].interfaces) == 2
+    assert linode_instance.configs[0].interfaces[0].purpose == "public"
+    assert linode_instance.configs[0].interfaces[1].purpose == "vlan"
+    assert linode_instance.configs[0].interfaces[1].label == "cool-vlan"
+    assert (
+        linode_instance.configs[0].interfaces[1].ipam_address == "10.0.0.4/32"
+    )
+
+    res = linode_instance.delete()
+
+    assert res
+
+
 # LongviewGroupTests
 def test_get_longview_clients(test_linode_client, test_longview_client):
     client = test_linode_client

test/unit/objects/linode_test.py

@@ -421,6 +421,35 @@ def test_instance_create_with_user_data(self):
                 },
             )
 
+    def test_instance_create_with_interfaces(self):
+        """
+        Tests that user can pass a list of interfaces on Linode create.
+        """
+        interfaces = [
+            {"purpose": "public"},
+            ConfigInterface(
+                purpose="vlan", label="cool-vlan", ipam_address="10.0.0.4/32"
+            ),
+        ]
+        with self.mock_post("linode/instances/123") as m:
+            self.client.linode.instance_create(
+                "us-southeast",
+                "g6-nanode-1",
+                interfaces=interfaces,
+            )
+
+            self.assertEqual(
+                m.call_data["interfaces"],
+                [
+                    {"purpose": "public"},
+                    {
+                        "purpose": "vlan",
+                        "label": "cool-vlan",
+                        "ipam_address": "10.0.0.4/32",
+                    },
+                ],
+            )
+
     def test_build_instance_metadata(self):
         """
         Tests that the metadata field is built correctly.