From c4c6608cd3f3f4f6a66dae9215f61405d9d43a01 Mon Sep 17 00:00:00 2001
From: Kameron Carr <kameroncarr@microsoft.com>
Date: Wed, 27 Dec 2023 09:58:52 -0800
Subject: [PATCH] Add verify_supports_nvme

This test case checks whether the NVMe drivers are present such that the image can boot with DiskControllerType NVMe.
---
 microsoft/testsuites/core/storage.py | 68 +++++++++++++++++++++++++++-
 1 file changed, 67 insertions(+), 1 deletion(-)

diff --git a/microsoft/testsuites/core/storage.py b/microsoft/testsuites/core/storage.py
index b97b563354..34d2f28710 100644
--- a/microsoft/testsuites/core/storage.py
+++ b/microsoft/testsuites/core/storage.py
@@ -33,16 +33,31 @@
 from lisa.node import Node
 from lisa.operating_system import BSD, Posix, Windows
 from lisa.schema import DiskControllerType, DiskType
+from lisa.search_space import SetSpace
 from lisa.sut_orchestrator import AZURE
+from lisa.sut_orchestrator.azure.common import AzureNodeSchema, VhdSchema
 from lisa.sut_orchestrator.azure.features import AzureDiskOptionSettings, AzureFileShare
+from lisa.sut_orchestrator.azure.platform_ import AzurePlatform
 from lisa.sut_orchestrator.azure.tools import Waagent
-from lisa.tools import Blkid, Cat, Dmesg, Echo, Lsblk, Mount, NFSClient, Swap, Sysctl
+from lisa.tools import (
+    Blkid,
+    Cat,
+    Dmesg,
+    Echo,
+    Lsblk,
+    Lsinitrd,
+    Mount,
+    NFSClient,
+    Swap,
+    Sysctl,
+)
 from lisa.tools.blkid import PartitionInfo
 from lisa.tools.journalctl import Journalctl
 from lisa.tools.kernel_config import KernelConfig
 from lisa.util import (
     BadEnvironmentStateException,
     LisaException,
+    SkippedException,
     generate_random_chars,
     get_matched_str,
 )
@@ -277,6 +292,57 @@ def verify_scsi_disk_controller_type(self, node: RemoteNode) -> None:
     def verify_nvme_disk_controller_type(self, node: RemoteNode) -> None:
         self._verify_disk_controller_type(node, DiskControllerType.NVME)
 
+    @TestCaseMetadata(
+        description="""
+        This test verifies the nvme drivers are either built in or present in initramfs.
+        This test can be used to verify an image before it is tagged as NVMe capable.
+        """,
+        priority=1,
+        requirement=simple_requirement(
+            supported_platform_type=[AZURE],
+        ),
+    )
+    def verify_supports_nvme(self, node: RemoteNode, environment: Environment) -> None:
+        has_nvme_core = node.tools[KernelConfig].is_built_in("CONFIG_NVME_CORE") or (
+            node.tools[KernelConfig].is_built_as_module("CONFIG_NVME_CORE")
+            and node.tools[Lsinitrd].has_module("nvme-core.ko")
+        )
+        has_nvme = node.tools[KernelConfig].is_built_in("CONFIG_BLK_DEV_NVME") or (
+            node.tools[KernelConfig].is_built_as_module("CONFIG_BLK_DEV_NVME")
+            and node.tools[Lsinitrd].has_module("nvme.ko")
+        )
+
+        # Pass condition
+        if has_nvme_core and has_nvme:
+            return
+
+        assert isinstance(environment.platform, AzurePlatform)
+        node_runbook: AzureNodeSchema = node.capability.get_extended_runbook(
+            AzureNodeSchema, AZURE
+        )
+        image = node_runbook.image
+        # Failure conditions
+        if image and not isinstance(image, VhdSchema):
+            image.load_from_platform(environment.platform)
+            if isinstance(image.disk_controller_type, DiskControllerType):
+                assert DiskControllerType.NVME != image.disk_controller_type, (
+                    "Image is tagged as NVMe capable, but NVMe drivers are missing."
+                    f"nvme-core: {has_nvme_core}, nvme: {has_nvme}"
+                )
+            elif isinstance(image.disk_controller_type, SetSpace):
+                assert (
+                    DiskControllerType.NVME not in image.disk_controller_type.items
+                ), (
+                    "Image is tagged as NVMe capable, but NVMe drivers are missing."
+                    f"nvme-core: {has_nvme_core}, nvme: {has_nvme}"
+                )
+
+        # Skip if image is not tagged as NVMe capable
+        raise SkippedException(
+            "NVME drivers are not present. "
+            f"nvme-core: {has_nvme_core}, nvme: {has_nvme}"
+        )
+
     @TestCaseMetadata(
         description="""
         This test will verify that identifier of root partition matches