feat(oracle): add function to auto configure secondary vnic

Author: a-dubs

pycloudlib/oci/instance.py

@@ -2,7 +2,9 @@
 # This file is part of pycloudlib. See LICENSE file for license information.
 """OCI instance."""
 
+import json
 from time import sleep
+import time
 from typing import Dict, List, Optional
 
 import oci
@@ -327,3 +329,46 @@ def remove_network_interface(self, ip_address: str):
                     )
                 return
         raise PycloudlibError(f"Network interface with ip_address={ip_address} did not detach")
+
+    def configure_secondary_vnic(self) -> str:
+        if not self.secondary_vnic_private_ip:
+            raise ValueError("Cannot configure secondary VNIC without a secondary VNIC attached")
+        secondary_vnic_imds_data: Optional[Dict[str, str]] = None
+        # it can take a bit for the 
+        for _ in range(60):
+            # Fetch JSON data from the Oracle Cloud metadata service
+            imds_req = self.execute("curl -s http://169.254.169.254/opc/v1/vnics").stdout
+            vnics_data = json.loads(imds_req)
+            if len(vnics_data) > 1:
+                self._log.debug("Successfully fetched secondary VNIC data from IMDS")
+                secondary_vnic_imds_data = vnics_data[1]
+                break
+            self._log.debug("No secondary VNIC data found from IMDS, retrying...")
+            time.sleep(1)
+
+        if not secondary_vnic_imds_data:
+            raise PycloudlibError(
+                "Failed to fetch secondary VNIC data from IMDS. Cannot configure secondary VNIC"
+            )
+                      
+        # Extract MAC address and private IP from the second VNIC 
+        mac_addr = secondary_vnic_imds_data["macAddr"]
+        private_ip = secondary_vnic_imds_data["privateIp"]
+        subnet_mask = secondary_vnic_imds_data["subnetCidrBlock"].split("/")[1]
+        # Find the network interface corresponding to the MAC address
+        interface = self.execute(
+            f"ip link show | grep -B1 {mac_addr} | head -n1 | awk '{{print $2}}' | sed 's/://' "
+        ).stdout.strip()
+        # Check if the interface was found
+        if not interface:
+            raise ValueError(f"No interface found for MAC address {mac_addr}")
+        # Add the IP address to the interface
+        self.execute(
+            f"sudo ip addr add {private_ip}/{subnet_mask} dev {interface}"
+        )
+        # Verify that the IP address was added
+        r = self.execute(f"ip addr show dev {interface}")
+        if private_ip not in r.stdout:
+            raise ValueError(f"IP {private_ip} was not successfully assigned to interface {interface}")
+        self._log.info("Successfully assigned IP %s to interface %s", private_ip, interface)
+        return private_ip

tests/unit_tests/oci/test_instance.py

@@ -487,3 +487,77 @@ def test_oci_instance_ip_parametrized(
             ip = oci_instance.ip
             # the following will only run if no error is raised
             assert ip == expected_ip
+
+
+class TestConfigureSecondaryVnic:
+    def test_configure_secondary_vnic_success(self, oci_instance:OciInstance):
+        with mock.patch.object(
+            OciInstance, "secondary_vnic_private_ip", new_callable=mock.PropertyMock
+        ) as mock_secondary_ip:
+            mock_secondary_ip.return_value = "10.0.0.5"
+            # Provide a side_effect matching the four execute() calls 
+            oci_instance.execute = mock.Mock(side_effect=[
+                mock.Mock(stdout='[{"macAddr": "00:16:3e:aa:bb:cc","privateIp":"10.0.0.4",'
+                                 '"subnetCidrBlock":"10.0.0.0/24"},'
+                                 '{"macAddr":"00:16:3e:ee:ff:gg","privateIp":"10.0.0.5",'
+                                 '"subnetCidrBlock":"10.0.1.0/24"}]'),
+                mock.Mock(stdout="eth1"),
+                mock.Mock(stdout=""),
+                mock.Mock(stdout="10.0.0.5"),
+            ])
+            ip = oci_instance.configure_secondary_vnic()
+            assert ip == "10.0.0.5"
+
+    def test_configure_secondary_vnic_no_secondary(self, oci_instance:OciInstance):
+        with mock.patch.object(
+            OciInstance, "secondary_vnic_private_ip", new_callable=mock.PropertyMock
+        ) as mock_secondary_ip:
+            mock_secondary_ip.return_value = None
+            with pytest.raises(ValueError, match="Cannot configure secondary VNIC"):
+                oci_instance.configure_secondary_vnic()
+
+    # patch out time.sleep 
+    @mock.patch("time.sleep", mock.MagicMock()) 
+    def test_configure_secondary_vnic_unavailable_imds(self, oci_instance:OciInstance):
+        with mock.patch.object(
+            OciInstance, "secondary_vnic_private_ip", new_callable=mock.PropertyMock
+        ) as mock_secondary_ip:
+            mock_secondary_ip.return_value = "10.0.0.5"
+            # Return empty IMDS data each time
+            oci_instance.execute = mock.Mock(side_effect=[mock.Mock(stdout="[]")] * 60)
+            with pytest.raises(PycloudlibError, match="Failed to fetch secondary VNIC data"):
+                oci_instance.configure_secondary_vnic()
+
+    def test_configure_secondary_vnic_no_interface_found(self, oci_instance:OciInstance):
+        with mock.patch.object(
+            OciInstance, "secondary_vnic_private_ip", new_callable=mock.PropertyMock
+        ) as mock_secondary_ip:
+            mock_secondary_ip.return_value = "10.0.0.5"
+            # IMDS returns one entry
+            oci_instance.execute = mock.Mock(side_effect=[
+                mock.Mock(stdout='[{"macAddr": "00:16:3e:aa:bb:cc","privateIp":"10.0.0.4",'
+                                 '"subnetCidrBlock":"10.0.0.0/24"},'
+                                 '{"macAddr":"00:16:3e:ee:ff:gg","privateIp":"10.0.0.5",'
+                                 '"subnetCidrBlock":"10.0.1.0/24"}]'),
+                mock.Mock(stdout=""),  # No interface found
+            ])
+            with pytest.raises(ValueError, match="No interface found for MAC address"):
+                oci_instance.configure_secondary_vnic()
+
+    def test_configure_secondary_vnic_ip_not_assigned(self, oci_instance:OciInstance):
+        with mock.patch.object(
+            OciInstance, "secondary_vnic_private_ip", new_callable=mock.PropertyMock
+        ) as mock_secondary_ip:
+            mock_secondary_ip.return_value = "10.0.0.5"
+            # Returns the single IMDS entry, then interface, then IP add, then empty IP check
+            oci_instance.execute = mock.Mock(side_effect=[
+                mock.Mock(stdout='[{"macAddr": "00:16:3e:aa:bb:cc","privateIp":"10.0.0.4",'
+                                 '"subnetCidrBlock":"10.0.0.0/24"},'
+                                 '{"macAddr":"00:16:3e:ee:ff:gg","privateIp":"10.0.0.5",'
+                                 '"subnetCidrBlock":"10.0.1.0/24"}]'),
+                mock.Mock(stdout="eth1"),
+                mock.Mock(stdout=""),
+                mock.Mock(stdout=""),  # Nothing found
+            ])
+            with pytest.raises(ValueError, match="was not successfully assigned"):
+                oci_instance.configure_secondary_vnic()