Set boot_mode in node properties during Redfish introspection

If Redfish OOB inspection returns current boot mode of the
node, add this boot mode into node properties/capabilities.

The idea behind this change is to align with the in-band
inspection behavior [1].

1. https://docs.openstack.org/ironic-inspector/ocata/usage.html#boot-mode

Story: 1668487
Task: 29855
Change-Id: I11de35fa87512d12eb6a259b26e88cd94e4a803d

ironic/drivers/modules/redfish/inspect.py

@@ -17,12 +17,15 @@ from oslo_log import log
 from oslo_utils import importutils
 from oslo_utils import units
 
+from ironic.common import boot_modes
 from ironic.common import exception
 from ironic.common.i18n import _
 from ironic.common import states
+from ironic.common import utils
 from ironic.drivers import base
 from ironic.drivers.modules import inspect_utils
 from ironic.drivers.modules.redfish import utils as redfish_utils
+from ironic.drivers import utils as drivers_utils
 
 LOG = log.getLogger(__name__)
 
@@ -37,6 +40,11 @@ if sushy:
         sushy.PROCESSOR_ARCH_OEM: 'oem'
     }
 
+    BOOT_MODE_MAP = {
+        sushy.BOOT_SOURCE_MODE_UEFI: boot_modes.UEFI,
+        sushy.BOOT_SOURCE_MODE_BIOS: boot_modes.LEGACY_BIOS
+    }
+
 
 class RedfishInspect(base.InspectInterface):
 
@@ -188,6 +196,14 @@ class RedfishInspect(base.InspectInterface):
                         {'node': task.node.uuid})
             inspected_properties['local_gb'] = '0'
 
+        if system.boot.mode:
+            if not drivers_utils.get_node_capability(task.node, 'boot_mode'):
+                capabilities = utils.get_updated_capabilities(
+                    inspected_properties.get('capabilities', ''),
+                    {'boot_mode': BOOT_MODE_MAP[system.boot.mode]})
+
+                inspected_properties['capabilities'] = capabilities
+
         valid_keys = self.ESSENTIAL_PROPERTIES
         missing_keys = valid_keys - set(inspected_properties)
         if missing_keys:

ironic/tests/unit/drivers/modules/redfish/test_inspect.py

@@ -49,6 +49,8 @@ class RedfishInspectTestCase(db_base.DbTestCase):
 
         system_mock.reset()
 
+        system_mock.boot.mode = 'uefi'
+
         system_mock.memory_summary.size_gib = 2
 
         system_mock.processors.summary = '8', 'MIPS'
@@ -85,6 +87,7 @@ class RedfishInspectTestCase(db_base.DbTestCase):
     def test_inspect_hardware_ok(self, mock_create_ports_if_not_exist,
                                  mock_get_system):
         expected_properties = {
+            'capabilities': 'boot_mode:uefi',
             'cpu_arch': 'mips', 'cpus': '8',
             'local_gb': '3', 'memory_mb': '2048'
         }
@@ -102,6 +105,7 @@ class RedfishInspectTestCase(db_base.DbTestCase):
     def test_inspect_hardware_fail_missing_cpu(self, mock_get_system):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.processors.summary = None, None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
@@ -113,10 +117,12 @@ class RedfishInspectTestCase(db_base.DbTestCase):
     def test_inspect_hardware_ignore_missing_cpu(self, mock_get_system):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.processors.summary = None, None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
             expected_properties = {
+                'capabilities': 'boot_mode:uefi',
                 'cpu_arch': 'x86_64', 'cpus': '8',
                 'local_gb': '3', 'memory_mb': '2048'
             }
@@ -128,10 +134,12 @@ class RedfishInspectTestCase(db_base.DbTestCase):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.simple_storage.disks_sizes_bytes = None
         system_mock.storage.volumes_sizes_bytes = None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
             expected_properties = {
+                'capabilities': 'boot_mode:uefi',
                 'cpu_arch': 'mips', 'cpus': '8',
                 'local_gb': '0', 'memory_mb': '2048'
             }
@@ -142,6 +150,7 @@ class RedfishInspectTestCase(db_base.DbTestCase):
     def test_inspect_hardware_fail_missing_memory_mb(self, mock_get_system):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.memory_summary.size_gib = None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
@@ -153,10 +162,12 @@ class RedfishInspectTestCase(db_base.DbTestCase):
     def test_inspect_hardware_ignore_missing_memory_mb(self, mock_get_system):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.memory_summary.size_gib = None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
             expected_properties = {
+                'capabilities': 'boot_mode:uefi',
                 'cpu_arch': 'mips', 'cpus': '8',
                 'local_gb': '3', 'memory_mb': '4096'
             }
@@ -170,8 +181,41 @@ class RedfishInspectTestCase(db_base.DbTestCase):
             self, mock_create_ports_if_not_exist, mock_get_system):
         system_mock = self.init_system_mock(mock_get_system.return_value)
         system_mock.ethernet_interfaces.summary = None
+        system_mock.boot.mode = 'uefi'
 
         with task_manager.acquire(self.context, self.node.uuid,
                                   shared=True) as task:
             task.driver.inspect.inspect_hardware(task)
             self.assertFalse(mock_create_ports_if_not_exist.called)
+
+    @mock.patch.object(redfish_utils, 'get_system', autospec=True)
+    def test_inspect_hardware_preserve_boot_mode(self, mock_get_system):
+        system_mock = self.init_system_mock(mock_get_system.return_value)
+        system_mock.boot.mode = 'uefi'
+
+        with task_manager.acquire(self.context, self.node.uuid,
+                                  shared=True) as task:
+            task.node.properties = {
+                'capabilities': 'boot_mode:bios'
+            }
+            expected_properties = {
+                'capabilities': 'boot_mode:bios',
+                'cpu_arch': 'mips', 'cpus': '8',
+                'local_gb': '3', 'memory_mb': '2048'
+            }
+            task.driver.inspect.inspect_hardware(task)
+            self.assertEqual(expected_properties, task.node.properties)
+
+    @mock.patch.object(redfish_utils, 'get_system', autospec=True)
+    def test_inspect_hardware_ignore_missing_boot_mode(self, mock_get_system):
+        system_mock = self.init_system_mock(mock_get_system.return_value)
+        system_mock.boot.mode = None
+
+        with task_manager.acquire(self.context, self.node.uuid,
+                                  shared=True) as task:
+            expected_properties = {
+                'cpu_arch': 'mips', 'cpus': '8',
+                'local_gb': '3', 'memory_mb': '2048'
+            }
+            task.driver.inspect.inspect_hardware(task)
+            self.assertEqual(expected_properties, task.node.properties)

releasenotes/notes/add-boot-mode-redfish-inspect-48e2b27ef022932a.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Adds currently used boot mode into node ``properties/capabilities`` upon
+    ``redfish`` inspect interface run. The idea behind this change is to align
+    with the in-band ``inspector`` behavior.