Check NVMe devices: handle NVMe-FC and NVMe-pci

TBD

Jira-ref: RHEL-46807

Author: pirat89

repos/system_upgrade/common/actors/checknvme/actor.py

@@ -0,0 +1,30 @@
+from leapp.actors import Actor
+from leapp.libraries.actor import checknvme
+from leapp.models import NVMEInfo
+from leapp.reporting import Report
+from leapp.tags import ChecksPhaseTag, IPUWorkflowTag
+
+
+class CheckLuks(Actor):
+    """
+    Check if NVMe devices are used and possibly register additional actions.
+
+    To be able to boot correctly the storage with NVMe devices, the initramfs
+    needs to contain nvmf dracut module with additional possibly required data.
+    Register all required actions that should happen to handle correctly systems
+    with NVMe devices.
+
+    Currently covered:
+        * NVMe (PCIe)
+        * NVMe-FC
+    """
+    # FIXME(pstodulk): update the description once the actor is fully
+    # implemented
+
+    name = 'check_nvme'
+    consumes = (NVMEInfo,)
+    produces = (Report, TargetUserSpaceUpgradeTasks, UpgradeInitramfsTasks)
+    tags = (ChecksPhaseTag, IPUWorkflowTag)
+
+    def process(self):
+        checknvme.process()

repos/system_upgrade/common/actors/checknvme/libraries/checknvme.py

@@ -0,0 +1,112 @@
+from leapp import reporting
+from leapp.libraries.stdlib import api
+from leapp.models import (
+    CopyFile,
+    DracutModule,
+    NVMEInfo,
+    TargetUserSpaceUpgradeTasks,
+    UpgradeInitramfsTasks
+)
+from leapp.reporting import create_report
+
+FMT_LIST_SEPARATOR = '\n    - '
+BROKEN_TRANSPORT_TYPES = ['tcp', 'rdma']
+SAFE_TRANSPORT_TYPES = ['pcie', 'fc']
+RQ_RPMS_CONTAINER = [
+    'iproute',
+    'jq',
+    'nvme-cli',
+    'sed',
+]
+RQ_CONFIG_FILES = [
+    '/etc/nvme/hostid',
+    '/etc/nvme/hostnqn',
+]
+"""
+These config files seems to be required, but potentially they could be missing
+on the source system. Tracking them explicitely.
+"""
+
+
+def _format_list(data, sep=FMT_LIST_SEPARATOR, callback_sort=sorted, limit=0):
+    # NOTE(pstodulk): Teaser O:-> https://issues.redhat.com/browse/RHEL-126447
+    if callback_sort is None:
+        callback_sort = lambda x: x
+    res = ['{}{}'.format(sep, item) for item in callback_sort(data)]
+    if limit:
+        return ''.join(res[:limit])
+    return ''.join(res)
+
+
+def _register_upgrade_tasks():
+    """
+    Register tasks that should happen during IPU to handle NVMe devices
+    successfully.
+    """
+    api.produce(TargetUserSpaceUpgradeTasks(
+        copy_files=[CopyFile(src='/etc/nvme/')],
+        install_rpms=RQ_RPMS_CONTAINER)
+    )
+
+    api.produce(UpgradeInitramfsTasks(
+        # TODO(pstodulk): the module should take all files as it needs them.
+        # Drop the comment when verified, uncomment the line below otherwise
+        # include_files=RQ_CONFIG_FILES,
+        include_dracut_modules=[DracutModule(name='nvmf')])
+    )
+
+
+def report_missing_configs(nvmeinfo, nvmeof_devices):
+    # TODO(pstodulk)
+    pass
+
+
+def check_nvme(nvmeinfo):
+    """
+    Check the system can be configured with discovered NVMe configuration.
+
+    In case the discovered configuration is considered
+
+    Return True if upgrade can continue, False otherwise.
+    """
+    upgrade_can_continue = True
+    unhandled_devices = []
+    safe_devices = []
+    nvmeof_devices = []
+    for device in nvmeinfo.devices:
+        if device.transport in BROKEN_TRANSPORT_TYPES:
+            unhandled_devices.append(device)
+        elif device.transport in SAFE_TRANSPORT_TYPES:
+            safe_devices.append(device)
+        else:
+            # TODO(pstodulk): hm? loop, apple-..., etc. types
+        if device.transport != 'pcie':
+            nvmeof_devices.append(device)
+
+
+    if unhandled_devices:
+        # TODO(pstodulk): what we will do here? It's not clear whether to stop
+        # the upgrade or not, as it could be about devices used for a data
+        # storage - unrelated to the system partitions / filesystems.
+        # maybe just report potential risk?
+
+    if nvmeof_devices and not (nvmeinfo.hostid and nvmeinfo.hostnqn):
+        # NOTE(pstodulk): hostid and hostnqn are mandatory for NVMe-oF devices.
+        # That means practically FC, RDMA, TCP. Let's inform user the upgrade
+        # is blocked and they must cofigure the system properly to be able to
+        # upgrade
+        upgrade_can_continue = False
+        report_missing_configs(nvmeinfo, nvmeof_devices)
+
+    return upgrade_can_continue
+
+
+def process():
+    nvmeinfo = next(api.consume(NVMEInfo), None)
+    if not nvmeinfo or not nvmeinfo.devices:
+        # Nothing to do
+        return
+
+    if check_nvme(nvmeinfo):
+        _register_upgrade_tasks()
+

repos/system_upgrade/common/actors/checknvme/tests/test_checknvme.py

@@ -0,0 +1,16 @@
+"""
+Unit tests for checknvme actor
+
+Skip isort as it's kind of broken when mixing grid import and one line imports
+
+isort:skip_file
+"""
+
+# from leapp.models import (
+# )
+# from leapp.reporting import Report
+# from leapp.utils.report import is_inhibitor
+
+def test_missing():
+    # FIXME(pstodulk): add the missint tests. Created just an empty boilerplate
+    pass