ci: move create_snapshot_artifact to a test

It's more hassle to keep this as a separate tool than including it in
the tests, and we avoid having to treat it specially.

Also this way we can run it in parallel easily.

Signed-off-by: Pablo Barbáchano <pablob@amazon.com>

Author: pb8o

.buildkite/pipeline_cross.py

@@ -21,13 +21,9 @@
     instances_x86_64 = ["c5n.metal", "m5n.metal", "m6i.metal", "m6a.metal"]
     instances_aarch64 = ["m7g.metal"]
     commands = [
-        # we run 0 tests for the side effect of downloading the artifacts. We
-        # should convert create_snapshot_artifact to a proper test/
-        "./tools/devtool test -- integration_tests/performance/test_benchmarks.py",
-        "./tools/devtool -y sh ./tools/create_snapshot_artifact/main.py",
+        "./tools/devtool -y test --no-build -- -m nonci -n4 integration_tests/functional/test_snapshot_phase1.py",
         "mkdir -pv snapshots/{instance}_{kv}",
-        "sudo chown -Rc $USER: snapshot_artifacts",
-        "mv -v snapshot_artifacts/* snapshots/{instance}_{kv}",
+        "mv -v test_results/test_snapshot_phase1/* snapshots/{instance}_{kv}",
     ]
     pipeline.build_group(
         "📸 create snapshots",
@@ -86,7 +82,7 @@
                 f"buildkite-agent artifact download snapshots/{src_instance}_{src_kv}/* .",
                 f"mv -v snapshots/{src_instance}_{src_kv} snapshot_artifacts",
                 *pipeline.devtool_test(
-                    pytest_opts=f"-m nonci {k_val} integration_tests/functional/test_snapshot_restore_cross_kernel.py",
+                    pytest_opts=f"-m nonci -n4 {k_val} integration_tests/functional/test_snapshot_restore_cross_kernel.py",
                 ),
             ],
             "label": f"🎬 {src_instance} {src_kv} ➡️ {dst_instance} {dst_kv}",

docs/snapshotting/snapshot-support.md

@@ -642,8 +642,8 @@ booting, to avoid this issue.
 
 We have a mechanism in place to experiment with snapshot compatibility across
 supported host kernel versions by generating snapshot artifacts through
-[this tool](../../tools/create_snapshot_artifact) and checking devices'
-functionality using
+[this test](../../tests/integration_tests/functional/test_snapshot_phase1.py)
+and checking devices' functionality using
 [this test](../../tests/integration_tests/functional/test_snapshot_restore_cross_kernel.py).
 The test restores the snapshot and ensures that all the devices set-up (network
 devices, disk, vsock, balloon and MMDS) are operational post-load.

tests/conftest.py

@@ -307,14 +307,20 @@ def custom_cpu_template(request, record_property):
 
 
 @pytest.fixture(
-    params=list(static_cpu_templates_params()) + list(custom_cpu_templates_params())
+    params=[
+        pytest.param(None, id="NO_CPU_TMPL"),
+        *static_cpu_templates_params(),
+        *custom_cpu_templates_params(),
+    ],
 )
 def cpu_template_any(request, record_property):
-    """This fixture combines static and custom CPU templates"""
-    if "name" in request.param:
-        record_property("custom_cpu_template", request.param["name"])
-    else:
-        record_property("static_cpu_template", request.param)
+    """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)
     return request.param
 
 

tests/integration_tests/functional/test_snapshot_phase1.py

@@ -0,0 +1,108 @@
+# Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Creates snapshots for other tests like test_snapshot_restore_cross_kernel.py
+"""
+
+import json
+import platform
+import re
+
+import pytest
+
+from framework.utils import (
+    configure_mmds,
+    generate_mmds_get_request,
+    generate_mmds_session_token,
+)
+
+if platform.machine() != "x86_64":
+    pytestmark = pytest.mark.skip("only x86_64 architecture supported")
+
+# Default IPv4 address to route MMDS requests.
+IPV4_ADDRESS = "169.254.169.254"
+NET_IFACE_FOR_MMDS = "eth3"
+
+
+@pytest.mark.nonci
+def test_snapshot_phase1(
+    microvm_factory, guest_kernel, rootfs_ubuntu_24, cpu_template_any, results_dir
+):
+    """Create a snapshot and save it to disk"""
+
+    vm = microvm_factory.build(guest_kernel, rootfs_ubuntu_24, monitor_memory=False)
+    vm.spawn(log_level="Info")
+    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=1024,
+        cpu_template=static_cpu_template,
+    )
+
+    guest_kernel_version = re.search("vmlinux-(.*)", vm.kernel_file.name)
+    snapshot_artifacts_dir = (
+        results_dir
+        / f"{guest_kernel_version.group(1)}_{cpu_template_name}_guest_snapshot"
+    )
+
+    # Add 4 network devices
+    for i in range(4):
+        vm.add_net_iface()
+    # Add a vsock device
+    vm.api.vsock.put(vsock_id="vsock0", guest_cid=3, uds_path="/v.sock")
+    # Add MMDS
+    configure_mmds(vm, ["eth3"], version="V2")
+    # Add a memory balloon.
+    vm.api.balloon.put(amount_mib=0, deflate_on_oom=True, stats_polling_interval_s=1)
+
+    vm.start()
+
+    # Populate MMDS.
+    data_store = {
+        "latest": {
+            "meta-data": {
+                "ami-id": "ami-12345678",
+                "reservation-id": "r-fea54097",
+                "local-hostname": "ip-10-251-50-12.ec2.internal",
+                "public-hostname": "ec2-203-0-113-25.compute-1.amazonaws.com",
+            }
+        }
+    }
+
+    # MMDS should be empty.
+    assert vm.api.mmds.get().json() == {}
+    # Populate MMDS with data.
+    vm.api.mmds.put(**data_store)
+    # Ensure data is persistent inside the data store.
+    assert vm.api.mmds.get().json() == data_store
+
+    # Iterate and validate connectivity on all ifaces after boot.
+    for i in range(4):
+        exit_code, _, _ = vm.ssh_iface(i).run("sync")
+        assert exit_code == 0
+
+    # Validate MMDS.
+    # Configure interface to route MMDS requests
+    vm.ssh.check_output(f"ip route add {IPV4_ADDRESS} dev {NET_IFACE_FOR_MMDS}")
+
+    # Fetch metadata to ensure MMDS is accessible.
+    token = generate_mmds_session_token(vm.ssh, IPV4_ADDRESS, token_ttl=60)
+    cmd = generate_mmds_get_request(IPV4_ADDRESS, token=token)
+    _, stdout, _ = vm.ssh.run(cmd)
+    assert json.loads(stdout) == data_store
+
+    # Copy snapshot files to be published to S3 for the 2nd part of the test
+    # Create snapshot artifacts directory specific for the kernel version used.
+    snapshot = vm.snapshot_full()
+    snapshot_artifacts_dir.mkdir(parents=True)
+    snapshot.save_to(snapshot_artifacts_dir)

tests/integration_tests/security/test_nv.py

@@ -30,7 +30,7 @@ def uvm_with_cpu_template(
     if isinstance(cpu_template_any, str):
         cpu_template = cpu_template_any
     vm.basic_config(cpu_template=cpu_template)
-    if cpu_template is None:
+    if isinstance(cpu_template_any, dict):
         vm.api.cpu_config.put(**cpu_template_any["template"])
     vm.add_net_iface()
     vm.start()