test: Cover all CPU templates in snapshot/restore wrmsr/cpuid tests

Previously only a limited set of static CPU templates were supported.
Now it covers all the cases (no CPU template, all the static CPU
templates and all the custom CPU templates). It will help support newer
CPU templates (e.g. a CPU template for Intel Sapphire Rapids).

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

Author: zulinx86

tests/integration_tests/functional/test_cpu_features_x86_64.py

@@ -77,7 +77,7 @@ def _check_extended_cache_features(vm):
     assert cache_size > 0
 
 
-def get_cpu_template_name_str(cpu_template):
+def get_cpu_template_name_str(cpu_template, with_type=False):
     """
     Utility function to return a valid string which will be used as
     name of the directory where snapshot artifacts are stored during
@@ -87,9 +87,13 @@ def get_cpu_template_name_str(cpu_template):
     if isinstance(cpu_template, str):
         # static CPU template
         name = cpu_template.lower()
+        if with_type:
+            name = "static_" + name
     elif isinstance(cpu_template, dict):
         # custom CPU template
         name = cpu_template["name"].lower()
+        if with_type:
+            name = "custom_" + name
     return name
 
 
@@ -363,7 +367,7 @@ def dump_msr_state_to_file(dump_fname, ssh_conn, shared_names):
 )
 @pytest.mark.timeout(900)
 @pytest.mark.nonci
-def test_cpu_wrmsr_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_template):
+def test_cpu_wrmsr_snapshot(microvm_factory, guest_kernel, rootfs, cpu_template_any):
     """
     This is the first part of the test verifying
     that MSRs retain their values after restoring from a snapshot.
@@ -389,10 +393,10 @@ def test_cpu_wrmsr_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_templ
     vm.basic_config(
         vcpu_count=vcpus,
         mem_size_mib=guest_mem_mib,
-        cpu_template=msr_cpu_template,
         track_dirty_pages=True,
         boot_args="msr.allow_writes=on",
     )
+    vm.set_cpu_template(cpu_template_any)
     vm.start()
 
     # Make MSR modifications
@@ -413,7 +417,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_str(cpu_template_any, with_type=True)
     )
     clean_and_mkdir(snapshot_artifacts_dir)
 
@@ -465,7 +469,7 @@ def check_msrs_are_equal(before_recs, after_recs):
 )
 @pytest.mark.timeout(900)
 @pytest.mark.nonci
-def test_cpu_wrmsr_restore(microvm_factory, msr_cpu_template, guest_kernel):
+def test_cpu_wrmsr_restore(microvm_factory, cpu_template_any, guest_kernel):
     """
     This is the second part of the test verifying
     that MSRs retain their values after restoring from a snapshot.
@@ -481,7 +485,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_str(cpu_template_any, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_wrmsr"])
         / guest_kernel.name
@@ -520,7 +524,7 @@ def dump_cpuid_to_file(dump_fname, ssh_conn):
 )
 @pytest.mark.timeout(900)
 @pytest.mark.nonci
-def test_cpu_cpuid_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_template):
+def test_cpu_cpuid_snapshot(microvm_factory, guest_kernel, rootfs, cpu_template_any):
     """
     This is the first part of the test verifying
     that CPUID remains the same after restoring from a snapshot.
@@ -543,13 +547,13 @@ def test_cpu_cpuid_snapshot(microvm_factory, guest_kernel, rootfs, msr_cpu_templ
     vm.basic_config(
         vcpu_count=1,
         mem_size_mib=1024,
-        cpu_template=msr_cpu_template,
         track_dirty_pages=True,
     )
+    vm.set_cpu_template(cpu_template_any)
     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_name_str(msr_cpu_template)
+    cpu_template_dir = get_cpu_template_name_str(cpu_template_any, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_cpuid"])
         / guest_kernel.name
@@ -587,7 +591,7 @@ def check_cpuid_is_equal(before_cpuid_fname, after_cpuid_fname):
 )
 @pytest.mark.timeout(900)
 @pytest.mark.nonci
-def test_cpu_cpuid_restore(microvm_factory, guest_kernel, msr_cpu_template):
+def test_cpu_cpuid_restore(microvm_factory, guest_kernel, cpu_template_any):
     """
     This is the second part of the test verifying
     that CPUID remains the same after restoring from a snapshot.
@@ -601,7 +605,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_name_str(msr_cpu_template)
+    cpu_template_dir = get_cpu_template_name_str(cpu_template_any, with_type=True)
     snapshot_artifacts_dir = (
         Path(shared_names["snapshot_artifacts_root_dir_cpuid"])
         / guest_kernel.name