refactor(test): Utility to get CPU template name

We do the same thing in multiple places.

Signed-off-by: Takahiro Itazuri <[email protected]>

Author: zulinx86

tests/conftest.py

@@ -38,6 +38,7 @@
 from framework.properties import global_props
 from framework.utils_cpu_templates import (
     custom_cpu_templates_params,
+    get_cpu_template_name,
     static_cpu_templates_params,
 )
 from host_tools.metrics import get_metrics_logger
@@ -361,12 +362,9 @@ def custom_cpu_template(request, record_property):
 )
 def cpu_template_any(request, record_property):
     """This fixture combines no template, static and custom CPU templates"""
-    cpu_template_name = request.param
-    if request.param is None:
-        cpu_template_name = "None"
-    elif "name" in request.param:
-        cpu_template_name = request.param["name"]
-    record_property("cpu_template", cpu_template_name)
+    record_property(
+        "cpu_template", get_cpu_template_name(request.param, with_type=True)
+    )
     return request.param
 
 

tests/framework/microvm.py

@@ -37,6 +37,7 @@
 from framework.jailer import JailerContext
 from framework.microvm_helpers import MicrovmHelpers
 from framework.properties import global_props
+from framework.utils_cpu_templates import get_cpu_template_name
 from framework.utils_drive import VhostUserBlkBackend, VhostUserBlkBackendType
 from framework.utils_uffd import spawn_pf_handler, uffd_handler
 from host_tools.fcmetrics import FCMetricsMonitor
@@ -248,7 +249,7 @@ def __init__(
         self.disks_vhost_user = {}
         self.vcpus_count = None
         self.mem_size_bytes = None
-        self.cpu_template_name = None
+        self.cpu_template_name = "None"
         # The given custom CPU template will be set in basic_config() but could
         # be overwritten via set_cpu_template().
         self.custom_cpu_template = custom_cpu_template
@@ -797,16 +798,15 @@ def basic_config(
 
     def set_cpu_template(self, cpu_template):
         """Set guest CPU template."""
+        self.cpu_template_name = get_cpu_template_name(cpu_template)
         if cpu_template is None:
             return
         # static CPU template
         if isinstance(cpu_template, str):
             self.api.machine_config.patch(cpu_template=cpu_template)
-            self.cpu_template_name = cpu_template
         # custom CPU template
         elif isinstance(cpu_template, dict):
             self.api.cpu_config.put(**cpu_template["template"])
-            self.cpu_template_name = cpu_template["name"]
 
     def add_drive(
         self,

tests/framework/utils_cpu_templates.py

@@ -80,3 +80,12 @@ def static_cpu_templates_params():
     """Return Static CPU templates as pytest parameters"""
     for name in sorted(get_supported_cpu_templates()):
         yield pytest.param(name, id="static_" + name)
+
+
+def get_cpu_template_name(cpu_template, with_type=False):
+    """Return the CPU template name."""
+    if isinstance(cpu_template, str):
+        return ("static_" if with_type else "") + cpu_template
+    if isinstance(cpu_template, dict):
+        return ("custom_" if with_type else "") + cpu_template["name"]
+    return "None"

tests/integration_tests/functional/test_cpu_features_aarch64.py

@@ -39,17 +39,17 @@ def test_guest_cpu_features(uvm_any):
     match global_props.cpu_model, vm.cpu_template_name:
         case CpuModel.ARM_NEOVERSE_N1, "V1N1":
             expected_cpu_features = G2_FEATS
-        case CpuModel.ARM_NEOVERSE_N1, None:
+        case CpuModel.ARM_NEOVERSE_N1, "None":
             expected_cpu_features = G2_FEATS
 
         # [cm]7g with guest kernel 5.10 and later
         case CpuModel.ARM_NEOVERSE_V1, "V1N1":
             expected_cpu_features = G2_FEATS
         case CpuModel.ARM_NEOVERSE_V1, "AARCH64_WITH_SVE_AND_PAC":
             expected_cpu_features = G3_FEATS | G3_SVE_AND_PAC
-        case CpuModel.ARM_NEOVERSE_V1, None:
+        case CpuModel.ARM_NEOVERSE_V1, "None":
             expected_cpu_features = G3_FEATS
-        case CpuModel.ARM_NEOVERSE_V2, None:
+        case CpuModel.ARM_NEOVERSE_V2, "None":
             expected_cpu_features = G4_FEATS
         case CpuModel.ARM_NEOVERSE_V2, "AARCH64_WITH_SVE_AND_PAC":
             expected_cpu_features = G4_FEATS | G4_SVE_AND_PAC

tests/integration_tests/functional/test_cpu_features_x86_64.py

@@ -21,7 +21,7 @@
 from framework import utils
 from framework.defs import SUPPORTED_HOST_KERNELS
 from framework.properties import global_props
-from framework.utils_cpu_templates import SUPPORTED_CPU_TEMPLATES
+from framework.utils_cpu_templates import get_cpu_template_name
 
 PLATFORM = platform.machine()
 UNSUPPORTED_HOST_KERNEL = (
@@ -77,16 +77,6 @@ def _check_extended_cache_features(vm):
     assert cache_size > 0
 
 
-def get_cpu_template_dir(cpu_template):
-    """
-    Utility function to return a valid string which will be used as
-    name of the directory where snapshot artifacts are stored during
-    snapshot test and loaded from during restore test.
-
-    """
-    return cpu_template if cpu_template else "none"
-
-
 def skip_test_based_on_artifacts(snapshot_artifacts_dir):
     """
     It is possible that some X template is not supported on
@@ -431,7 +421,7 @@ def test_cpu_wrmsr_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_templ
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_wrmsr"])
         / guest_kernel.name
-        / (msr_cpu_template if msr_cpu_template else "none")
+        / get_cpu_template_name(msr_cpu_template, with_type=True)
     )
     clean_and_mkdir(snapshot_artifacts_dir)
 
@@ -499,7 +489,7 @@ def test_cpu_wrmsr_restore(microvm_factory, msr_cpu_template, guest_kernel):
     """
 
     shared_names = SNAPSHOT_RESTORE_SHARED_NAMES
-    cpu_template_dir = msr_cpu_template if msr_cpu_template else "none"
+    cpu_template_dir = get_cpu_template_name(msr_cpu_template, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_wrmsr"])
         / guest_kernel.name
@@ -567,7 +557,7 @@ def test_cpu_cpuid_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_templ
     vm.start()
 
     # Dump CPUID to a file that will be published to S3 for the 2nd part of the test
-    cpu_template_dir = get_cpu_template_dir(msr_cpu_template)
+    cpu_template_dir = get_cpu_template_name(msr_cpu_template, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_cpuid"])
         / guest_kernel.name
@@ -619,7 +609,7 @@ def test_cpu_cpuid_restore(microvm_factory, guest_kernel, msr_cpu_template):
     """
 
     shared_names = SNAPSHOT_RESTORE_SHARED_NAMES
-    cpu_template_dir = get_cpu_template_dir(msr_cpu_template)
+    cpu_template_dir = get_cpu_template_name(msr_cpu_template, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_cpuid"])
         / guest_kernel.name

tests/integration_tests/functional/test_snapshot_phase1.py

@@ -16,6 +16,7 @@
     generate_mmds_get_request,
     generate_mmds_session_token,
 )
+from framework.utils_cpu_templates import get_cpu_template_name
 
 if platform.machine() != "x86_64":
     pytestmark = pytest.mark.skip("only x86_64 architecture supported")
@@ -36,20 +37,18 @@ def test_snapshot_phase1(
     vm.add_net_iface()
 
     static_cpu_template = None
-    cpu_template_name = "None"
     if isinstance(cpu_template_any, str):
         static_cpu_template = cpu_template_any
-        cpu_template_name = f"static_{cpu_template_any}"
     elif isinstance(cpu_template_any, dict):
         vm.api.cpu_config.put(**cpu_template_any["template"])
-        cpu_template_name = f"custom_{cpu_template_any['name']}"
     vm.basic_config(
         vcpu_count=2,
         mem_size_mib=512,
         cpu_template=static_cpu_template,
     )
 
     guest_kernel_version = re.search("vmlinux-(.*)", vm.kernel_file.name)
+    cpu_template_name = get_cpu_template_name(cpu_template_any, with_type=True)
     snapshot_artifacts_dir = (
         results_dir
         / f"{guest_kernel_version.group(1)}_{cpu_template_name}_guest_snapshot"

tests/integration_tests/security/test_vulnerabilities.py

@@ -87,7 +87,7 @@ def expected_vulnerabilities(self, cpu_template_name):
         """
         if (
             global_props.cpu_codename in ["INTEL_ICELAKE", "INTEL_SAPPHIRE_RAPIDS"]
-            and cpu_template_name is None
+            and cpu_template_name == "None"
         ):
             return {
                 '{"NAME": "REPTAR", "CVE": "CVE-2023-23583", "VULNERABLE": true, "INFOS": "Your microcode is too old to mitigate the vulnerability"}'