Implement ironic inspect hook setting port local_link, physical_network

Author: stevekeay

python/ironic-understack/ironic_understack/inspected_port.py

@@ -0,0 +1,56 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class InspectedPort:
+    """Represents a parsed entry from Ironic inspection (inventory) data."""
+
+    mac_address: str
+    name: str
+    switch_system_name: str
+    switch_port_id: str
+    switch_chassis_id: str
+
+    @property
+    def local_link_connection(self) -> dict:
+        return {
+            "port_id": self.switch_port_id,
+            "switch_id": self.switch_chassis_id,
+            "switch_info": self.switch_system_name,
+        }
+
+    @property
+    def parsed_name(self) -> dict[str, str]:
+        parts = self.switch_system_name.split(".", maxsplit=1)
+        if len(parts) != 2:
+            raise ValueError(
+                "Failed to parse switch hostname - expecting name.dc in %s", self
+            )
+        switch_name, data_center_name = parts
+
+        parts = switch_name.rsplit("-", maxsplit=1)
+        if len(parts) != 2:
+            raise ValueError(
+                f"Unknown switch name format: {switch_name} - this hook requires "
+                f"that switch names follow the convention <cabinet-name>-<suffix>"
+            )
+
+        rack_name, switch_suffix = parts
+
+        return {
+            "rack_name": rack_name,
+            "switch_suffix": switch_suffix,
+            "data_center_name": data_center_name,
+        }
+
+    @property
+    def rack_name(self) -> str:
+        return self.parsed_name["rack_name"]
+
+    @property
+    def switch_suffix(self) -> str:
+        return self.parsed_name["switch_suffix"]
+
+    @property
+    def data_center_name(self) -> str:
+        return self.parsed_name["data_center_name"]

python/ironic-understack/ironic_understack/tests/test_update_baremetal_port.py

@@ -0,0 +1,108 @@
+import logging
+
+import ironic.objects
+from oslo_utils import uuidutils
+
+import ironic_understack
+from ironic_understack.update_baremetal_port import UpdateBaremetalPortsHook
+
+# load some metaprgramming normally taken care of during Ironic initialization:
+ironic.objects.register_all()
+
+_INVENTORY = {}
+_PLUGIN_DATA = {
+    "all_interfaces": {
+        "ex1": {
+            "name": "ex1",
+            "mac_address": "11:11:11:11:11:11",
+        },
+        "ex2": {
+            "name": "ex2",
+            "mac_address": "22:22:22:22:22:22",
+        },
+        "ex3": {
+            "name": "ex3",
+            "mac_address": "33:33:33:33:33:33",
+        },
+        "ex4": {
+            "name": "ex4",
+            "mac_address": "44:44:44:44:44:44",
+        },
+    },
+    "parsed_lldp": {
+        "ex1": {
+            "switch_chassis_id": "88:5a:92:ec:54:59",
+            "switch_port_id": "Ethernet1/18",
+            "switch_system_name": "f20-3-1.iad3",
+        },
+        "ex2": {
+            "switch_chassis_id": "88:5a:92:ec:54:59",
+            "switch_port_id": "Ethernet1/18",
+            "switch_system_name": "f20-3-2.iad3",
+        },
+        "ex3": {
+            "switch_chassis_id": "88:5a:92:ec:54:59",
+            "switch_port_id": "Ethernet1/18",
+            "switch_system_name": "f20-3-1f.iad3",
+        },
+        "ex4": {
+            "switch_chassis_id": "88:5a:92:ec:54:59",
+            "switch_port_id": "Ethernet1/18",
+            "switch_system_name": "f20-3-2f.iad3",
+        },
+    },
+}
+
+MAPPING = {
+    "1": "network",
+    "2": "network",
+    "1f": "storage",
+    "2f": "storage",
+    "-1d": "bmc",
+}
+
+
+def test_with_valid_data(mocker, caplog):
+    caplog.set_level(logging.DEBUG)
+
+    node_uuid = uuidutils.generate_uuid()
+    mock_traits = mocker.Mock()
+    mock_context = mocker.Mock()
+    mock_node = mocker.Mock(id=1234, traits=mock_traits)
+    mock_task = mocker.Mock(node=mock_node, context=mock_context)
+    mock_port = mocker.Mock(
+        uuid=uuidutils.generate_uuid(),
+        node_id=node_uuid,
+        address="11:11:11:11:11:11",
+        local_link_connection={},
+        physical_network="original_value",
+    )
+
+    mocker.patch(
+        "ironic_understack.update_baremetal_port.ironic_ports_for_node",
+        return_value=[mock_port],
+    )
+    mocker.patch(
+        "ironic_understack.update_baremetal_port.CONF.ironic_understack.switch_name_vlan_group_mapping",
+        MAPPING,
+    )
+    mocker.patch("ironic_understack.update_baremetal_port.objects.TraitList.create")
+
+    mock_traits.get_trait_names.return_value = ["CUSTOM_BMC_SWITCH", "bar"]
+
+    UpdateBaremetalPortsHook().__call__(mock_task, _INVENTORY, _PLUGIN_DATA)
+
+    assert mock_port.local_link_connection == {
+        "port_id": "Ethernet1/18",
+        "switch_id": "88:5a:92:ec:54:59",
+        "switch_info": "f20-3-1.iad3",
+    }
+    assert mock_port.physical_network == "f20-3-network"
+    mock_port.save.assert_called()
+
+    mock_traits.get_trait_names.assert_called_once()
+    mock_traits.destroy.assert_called_once_with("CUSTOM_BMC_SWITCH")
+    ironic_understack.update_baremetal_port.objects.TraitList.create.assert_called_once_with(
+        mock_context, 1234, ["CUSTOM_NETWORK_SWITCH", "CUSTOM_STORAGE_SWITCH"]
+    )
+    mock_node.save.assert_called_once()

python/ironic-understack/ironic_understack/tests/test_vlan_group_name_convention.py

@@ -0,0 +1,143 @@
+import pytest
+
+from ironic_understack.inspected_port import InspectedPort
+from ironic_understack.vlan_group_name_convention import TopologyError
+from ironic_understack.vlan_group_name_convention import vlan_group_names
+
+mapping = {
+    "1": "network",
+    "2": "network",
+    "3": "network",
+    "4": "network",
+    "1f": "storage",
+    "2f": "storage",
+    "3f": "storage-appliance",
+    "4f": "storage-appliance",
+    "1d": "bmc",
+}
+
+
+def port(switch: str):
+    return InspectedPort(
+        mac_address="",
+        name="",
+        switch_system_name=switch,
+        switch_chassis_id="",
+        switch_port_id="",
+    )
+
+
+def test_vlan_group_name_single_cab():
+    assert vlan_group_names(
+        [
+            port("a1-1-1.abc1"),
+            port("a1-1-2.abc1"),
+            port("a1-1-1f.abc1"),
+            port("a1-1-2f.abc1"),
+        ],
+        mapping,
+    ) == {
+        "a1-1-1.abc1": "a1-1-network",
+        "a1-1-2.abc1": "a1-1-network",
+        "a1-1-1f.abc1": "a1-1-storage",
+        "a1-1-2f.abc1": "a1-1-storage",
+    }
+
+
+def test_vlan_group_name_pair_cab():
+    assert vlan_group_names(
+        [
+            port("a1-1-1.abc1"),
+            port("a1-2-1.abc1"),
+            port("a1-1-1f.abc1"),
+            port("a1-2-1f.abc1"),
+        ],
+        mapping,
+    ) == {
+        "a1-1-1.abc1": "a1-1/a1-2-network",
+        "a1-2-1.abc1": "a1-1/a1-2-network",
+        "a1-1-1f.abc1": "a1-1/a1-2-storage",
+        "a1-2-1f.abc1": "a1-1/a1-2-storage",
+    }
+
+
+def test_vlan_group_name_with_domain():
+    assert vlan_group_names(
+        [
+            port("a1-1-1.abc1.domain"),
+            port("a1-1-2.abc1.domain"),
+            port("a1-1-1f.abc1.domain"),
+            port("a1-1-2f.abc1.domain"),
+        ],
+        mapping,
+    ) == {
+        "a1-1-1.abc1.domain": "a1-1-network",
+        "a1-1-2.abc1.domain": "a1-1-network",
+        "a1-1-1f.abc1.domain": "a1-1-storage",
+        "a1-1-2f.abc1.domain": "a1-1-storage",
+    }
+
+
+def test_vlan_group_name_invalid_format():
+    with pytest.raises(ValueError, match="Unknown switch name format"):
+        vlan_group_names([port("invalid.abc1")], mapping)
+
+    with pytest.raises(ValueError, match="Unknown switch name format"):
+        vlan_group_names([port(".abc1")], mapping)
+
+
+def test_vlan_group_name_unknown_suffix():
+    with pytest.raises(TopologyError, match="suffix a1-1-99.abc1 is not present"):
+        vlan_group_names([port("a1-1-99.abc1")], mapping)
+
+    with pytest.raises(TopologyError, match="suffix a1-1-5f.abc1 is not present"):
+        vlan_group_names([port("a1-1-5f.abc1")], mapping)
+
+    with pytest.raises(TopologyError, match="suffix a1-1-xyz.abc1 is not present"):
+        vlan_group_names([port("a1-1-xyz.abc1")], mapping)
+
+
+def test_vlan_group_name_many_dc():
+    with pytest.raises(TopologyError, match="multiple"):
+        vlan_group_names(
+            [
+                port("a1-1-1.abc1.domain"),
+                port("a1-1-1.xyz2.domain"),
+            ],
+            mapping,
+        )
+
+
+def test_vlan_group_name_too_many_racks():
+    with pytest.raises(TopologyError, match="more than two racks"):
+        vlan_group_names(
+            [
+                port("a1-1-1.abc1.domain"),
+                port("a1-2-1.abc1.domain"),
+                port("a1-3-1.abc1.domain"),
+            ],
+            mapping,
+        )
+
+
+def test_vlan_group_name_too_many_switches():
+    with pytest.raises(TopologyError, match="exactly two network switches"):
+        vlan_group_names(
+            [
+                port("a1-1-1.abc1.domain"),
+                port("a1-1-2.abc1.domain"),
+                port("a1-1-3.abc1.domain"),
+            ],
+            mapping,
+        )
+
+
+def test_vlan_group_name_not_enough_switches():
+    with pytest.raises(TopologyError, match="exactly two network switches"):
+        vlan_group_names(
+            [
+                port("a1-1-1.abc1.domain"),
+                port("a1-1-1.abc1.domain"),
+            ],
+            mapping,
+        )