Implement ironic post-inspection hook to set port bios_name, pxe_enabled

Author: stevekeay

python/ironic-understack/ironic_understack/ironic_wrapper.py

@@ -0,0 +1,5 @@
+import ironic.objects
+
+
+def ironic_ports_for_node(context, node_id: str) -> list:
+    return ironic.objects.Port.list_by_node_id(context, node_id)

python/ironic-understack/ironic_understack/port_bios_name_hook.py

@@ -0,0 +1,64 @@
+from ironic.drivers.modules.inspector.hooks import base
+from oslo_log import log as logging
+
+from ironic_understack.ironic_wrapper import ironic_ports_for_node
+
+LOG = logging.getLogger(__name__)
+
+
+class PortBiosNameHook(base.InspectionHook):
+    """Set port.extra.bios_name and pxe_enabled fields from redfish data."""
+
+    # "ports" creates baremetal ports for each physical NIC, be sure to run this
+    # first because we will only be updating ports that already exist:
+    dependencies = ["ports"]
+
+    def __call__(self, task, inventory, plugin_data):
+        """Populate the baremetal_port.extra.bios_name attribute."""
+        LOG.debug(f"{__class__} called with {task=!r} {inventory=!r} {plugin_data=!r}")
+
+        inspected_interfaces = inventory.get("interfaces")
+        if not inspected_interfaces:
+            LOG.error("No interfaces in inventory for node %s", task.node.uuid)
+            return
+
+        interface_names = {
+            i["mac_address"].upper(): i["name"] for i in inspected_interfaces
+        }
+
+        pxe_interface = _pxe_interface_name(inspected_interfaces)
+
+        for baremetal_port in ironic_ports_for_node(task.context, task.node.id):
+            mac = baremetal_port.address.upper()
+            required_bios_name = interface_names.get(mac)
+            extra = baremetal_port.extra
+            current_bios_name = extra.get("bios_name")
+
+            if current_bios_name != required_bios_name:
+                LOG.info(
+                    "Port %(mac)s updating bios_name from %(old)s to %(new)s",
+                    {"mac": mac, "old": current_bios_name, "new": required_bios_name},
+                )
+
+                if required_bios_name:
+                    extra["bios_name"] = required_bios_name
+                else:
+                    extra.pop("bios_name", None)
+
+                baremetal_port.extra = extra
+                baremetal_port.save()
+
+            required_pxe = required_bios_name == pxe_interface
+            if baremetal_port.pxe_enabled != required_pxe:
+                LOG.info("Port %s changed pxe_enabled to %s", mac, required_pxe)
+                baremetal_port.pxe_enabled = required_pxe
+                baremetal_port.save()
+
+
+def _pxe_interface_name(inspected_interfaces: list[dict]) -> str:
+    """Use a heuristic to determine our default interface for PXE."""
+    names = sorted(i["name"] for i in inspected_interfaces)
+    for prefix in ["NIC.Integrated", "NIC.Slot"]:
+        for name in names:
+            if name.startswith(prefix):
+                return name

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

@@ -0,0 +1,63 @@
+import logging
+
+from oslo_utils import uuidutils
+
+from ironic_understack.port_bios_name_hook import PortBiosNameHook
+
+_INVENTORY = {
+    "memory": {"physical_mb": 98304},
+    "interfaces": [
+        {"mac_address": "11:11:11:11:11:11", "name": "NIC.Integrated.1-1"},
+        {"mac_address": "22:22:22:22:22:22", "name": "NIC.Integrated.1-2"},
+    ],
+}
+
+
+def test_adding_bios_name(mocker, caplog):
+    caplog.set_level(logging.DEBUG)
+
+    node_uuid = uuidutils.generate_uuid()
+    mock_context = mocker.Mock()
+    mock_node = mocker.Mock(id=1234)
+    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",
+        extra={},
+    )
+
+    mocker.patch(
+        "ironic_understack.port_bios_name_hook.ironic_ports_for_node",
+        return_value=[mock_port],
+    )
+
+    PortBiosNameHook().__call__(mock_task, _INVENTORY, {})
+
+    assert mock_port.extra == {"bios_name": "NIC.Integrated.1-1"}
+    mock_port.save.assert_called()
+
+
+def test_removing_bios_name(mocker, caplog):
+    caplog.set_level(logging.DEBUG)
+
+    node_uuid = uuidutils.generate_uuid()
+    mock_context = mocker.Mock()
+    mock_node = mocker.Mock(id=1234)
+    mock_task = mocker.Mock(node=mock_node, context=mock_context)
+    mock_port = mocker.Mock(
+        uuid=uuidutils.generate_uuid(),
+        node_id=node_uuid,
+        address="33:33:33:33:33:33",
+        extra={"bios_name": "old_name_no_longer_valid"},
+    )
+
+    mocker.patch(
+        "ironic_understack.port_bios_name_hook.ironic_ports_for_node",
+        return_value=[mock_port],
+    )
+
+    PortBiosNameHook().__call__(mock_task, _INVENTORY, {})
+
+    assert "bios_name" not in mock_port.extra
+    mock_port.save.assert_called()