Add swap file checking in verify_no_swap_on_osdisk

Author: lubaihua33

lisa/tools/swap.py

@@ -1,10 +1,12 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT license.
 import re
+from dataclasses import dataclass
 from typing import List, Optional, Type
 
 from lisa.base_tools import Cat
 from lisa.executable import Tool
+from lisa.tools.df import Df
 from lisa.tools.lsblk import Lsblk
 from lisa.tools.rm import Rm
 from lisa.util import (
@@ -14,6 +16,13 @@
 )
 
 
+@dataclass
+class SwapPartition(object):
+    filename: str = ""
+    type: str = ""
+    partition: str = ""
+
+
 class SwapOn(Tool):
     @property
     def command(self) -> str:
@@ -66,7 +75,7 @@ def is_swap_enabled(self) -> bool:
         lsblk = self.node.tools[Lsblk].run().stdout
         return "SWAP" in lsblk
 
-    def get_swap_partitions(self) -> List[str]:
+    def get_swap_partitions(self) -> List[SwapPartition]:
         # run 'cat /proc/swaps' or 'swapon -s' and parse the output
         # The output is in the following format:
         # <Filename> <Type> <Size> <Used> <Priority>
@@ -82,11 +91,25 @@ def get_swap_partitions(self) -> List[str]:
                 raise LisaException("Failed to get swap information")
 
         output = swap_result.stdout
-        swap_parts: List[str] = []
+        swap_parts: List[SwapPartition] = []
         swap_entries = find_patterns_groups_in_lines(output, [self._SWAPS_PATTERN])[0]
         for swap_entry in swap_entries:
-            if swap_entry["type"] == "partition":
-                swap_parts.append(swap_entry["filename"])
+            filename = swap_entry["filename"]
+            file_type = swap_entry["type"]
+            if file_type == "partition":
+                partition = filename
+            else:
+                # For swap files, get the partition information
+                part = self.node.tools[Df].get_partition_by_path(filename)
+                if not part:
+                    raise LisaException(
+                        f"Failed to get partition information for {filename}"
+                    )
+                partition = part.name
+            swap_parts.append(
+                SwapPartition(filename=filename, type=file_type, partition=partition)
+            )
+
         return swap_parts
 
     def create_swap(
@@ -121,7 +144,7 @@ def is_swap_enabled(self) -> bool:
 
         return False
 
-    def get_swap_partitions(self) -> List[str]:
+    def get_swap_partitions(self) -> List[SwapPartition]:
         # run 'swapinfo -k' and parse the output
         # The output is in the following format:
         # <Device> <1K-blocks> <Used> <Avail> <Capacity>
@@ -130,9 +153,15 @@ def get_swap_partitions(self) -> List[str]:
             raise LisaException("Failed to get swap information")
 
         output = swap_result.stdout
-        swap_parts: List[str] = []
+        swap_parts: List[SwapPartition] = []
         swap_entries = find_patterns_groups_in_lines(output, [self._SWAP_ENTRIES])[0]
         # FreeBSD doesn't have swap files, only partitions
         for swap_entry in swap_entries:
-            swap_parts.append(swap_entry["device"])
+            swap_parts.append(
+                SwapPartition(
+                    filename=swap_entry["device"],
+                    type="partition",
+                    partition=swap_entry["device"],
+                )
+            )
         return swap_parts

microsoft/testsuites/core/azure_image_standard.py

@@ -1645,21 +1645,22 @@ def verify_omi_version(self, node: Node) -> None:
 
     @TestCaseMetadata(
         description="""
-        This test verifies that there is no swap partition on the OS disk.
+        This test verifies that there is no swap partition or swap file on the OS disk
 
         Azure's policy 200.3.3 Linux:
         No swap partition on the OS disk. Swap can be requested for creation on the
         local resource disk by the Linux Agent. It is recommended that a single root
         partition is created for the OS disk.
 
-        There should be no Swap Partition on OS Disk. OS disk has IOPS limit. When
-        memory pressure causes swapping, IOPS limit may be reached easily and cause VM
-        performance to go down disastrously, because aside from memory issues in now
-        also has IO issues.
+        There should be no Swap Partition or swap file on OS Disk. OS disk has IOPS
+        limit. When memory pressure causes swapping, IOPS limit may be reached easily
+        and cause VM performance to go down disastrously, because aside from memory
+        issues it now also has IO issues.
 
         Steps:
-        1. Use 'cat /proc/swaps' or 'swapon -s' to list all swap devices
-            Note: For FreeBSD, use 'swapinfo -k'.
+        1. Use 'cat /proc/swaps' or 'swapon -s' to list all swap devices and swap files
+            If it is a swap file, use 'df <swap_file>' to get the partition name.
+            Note: For FreeBSD, use 'swapinfo -k'. FreeBSD only supports swap partition.
         2. Use 'lsblk <swap_part> -P -o NAME' to get the real block device name for
            each swap partition. If there is no swap partition, pass the case.
         3. Use 'lsblk' to identify the OS disk and get all its partitions and logical
@@ -1685,12 +1686,15 @@ def verify_no_swap_on_osdisk(self, node: Node) -> None:
         lsblk = node.tools[Lsblk]
         os_disk = lsblk.find_disk_by_mountpoint("/")
         for swap_part in swap_parts:
-            block_name = lsblk.get_block_name(swap_part)
+            block_name = lsblk.get_block_name(swap_part.partition)
             if block_name == "":
                 raise LisaException(
-                    f"Failed to get the device name for swap partition '{swap_part}'."
+                    "Failed to get the device name for swap partition/file "
+                    f"'{swap_part.filename}'."
                 )
-            node.log.info(f"Swap partition '{swap_part}' is on device '{block_name}'.")
+            node.log.info(
+                f"Swap partition '{swap_part.filename}' is on device '{block_name}'."
+            )
             for part in os_disk.partitions:
                 # e.g. 'sda1', 'vg-root', 'vg-home'
                 parts = [part] + part.logical_devices
@@ -1700,13 +1704,13 @@ def verify_no_swap_on_osdisk(self, node: Node) -> None:
                         # "Swap partition .* is found on OS disk" is a failure triage
                         # pattern. Please be careful when changing this string.
                         raise LisaException(
-                            f"Swap partition '{swap_part}' is found on OS disk "
-                            f"partition or logical device '{p.name}'. There should be "
-                            "no Swap Partition on OS Disk. OS disk has IOPS limit. "
-                            "When memory pressure causes swapping, IOPS limit may be "
-                            "reached easily and cause VM performance to go down "
-                            "disastrously, as aside from memory issues in now also has"
-                            " IO issues."
+                            f"Swap partition/file '{swap_part.filename}' is found on "
+                            f"OS disk partition or logical device '{p.name}'. There "
+                            "should be no Swap Partition on OS Disk. OS disk has IOPS"
+                            " limit. When memory pressure causes swapping, IOPS limit"
+                            " may be reached easily and cause VM performance to go "
+                            "down disastrously, as aside from memory issues it now "
+                            "also has IO issues."
                         )
 
     @TestCaseMetadata(