add fedora42 vmtests

Author: himaja-kesari

.github/workflows/tests-vmtests-imagecreator.yml

@@ -119,8 +119,10 @@ jobs:
       run: |
         set -eux
 
-        # Download the test RPM and tools file.
-        ./repo/toolkit/tools/internal/testutils/testrpms/download-test-utils.sh -t 3.0 -s true
+        # Download the test RPM and tools file for azurelinux
+        ./repo/toolkit/tools/internal/testutils/testrpms/download-test-utils.sh -d azurelinux -t 3.0 -s true
+        # Download the test RPM and tools file for fedora
+        ./repo/toolkit/tools/internal/testutils/testrpms/download-test-utils.sh -d fedora -t 42 -s true
 
 
     - name: Run image creator tests
@@ -129,13 +131,20 @@ jobs:
 
         pushd ./repo/test/vmtests
 
-        sudo make test-imagecreator \
+        sudo make test-imagecreator-azurelinux \
           IMAGE_CREATOR_BIN="../../toolkit/out/tools/imagecreator" \
           TOOLS_TAR="../../toolkit/tools/internal/testutils/testrpms/build/tools-azurelinux-3.0.tar.gz" \
           RPM_SOURCES="../../toolkit/tools/internal/testutils/testrpms/downloadedrpms/azurelinux/3.0" \
           IMAGE_CUSTOMIZER_BINARY_PATH="../../toolkit/out/tools/imagecustomizer" \
           SSH_PRIVATE_KEY_FILE=~/.ssh/id_ed25519
 
+        sudo make test-imagecreator-fedora \
+          IMAGE_CREATOR_BIN="../../toolkit/out/tools/imagecreator" \
+          TOOLS_TAR="../../toolkit/tools/internal/testutils/testrpms/build/tools-fedora-42.tar.gz" \
+          RPM_SOURCES="../../toolkit/tools/internal/testutils/testrpms/downloadedrpms/fedora/42" \
+          IMAGE_CUSTOMIZER_BINARY_PATH="../../toolkit/out/tools/imagecustomizer" \
+          SSH_PRIVATE_KEY_FILE=~/.ssh/id_ed25519  
+
     - uses: actions/upload-artifact@v4
       if: ${{ !cancelled() }}
       with:

test/vmtests/Makefile

@@ -99,8 +99,8 @@ test-imagecustomizer:
 		--junitxml=./out/$(DATETIME_AS_VERSION)/report.xml \
 		./vmtests/imagecustomizer/test_min_change.py
 
-.PHONY: test-imagecreator
-test-imagecreator:
+.PHONY: test-imagecreator-azurelinux
+test-imagecreator-azurelinux:
 	${PYTEST} \
 		--image-creator-binary-path="${IMAGE_CREATOR_BIN}" \
 		--rpm-sources="${RPM_SOURCES}" \
@@ -114,6 +114,21 @@ test-imagecreator:
 		--junitxml=./out/$(DATETIME_AS_VERSION)/report.xml \
 		./vmtests/imagecreator/test_imagecreator.py
 
+.PHONY: test-imagecreator-fedora
+test-imagecreator-fedora:
+	${PYTEST} \
+		--image-creator-binary-path="${IMAGE_CREATOR_BIN}" \
+		--rpm-sources="${RPM_SOURCES}" \
+		--tools-tar="${TOOLS_TAR}" \
+		--image-customizer-binary-path="${IMAGE_CUSTOMIZER_BINARY_PATH}" \
+		--ssh-private-key="${SSH_PRIVATE_KEY_FILE}" \
+		$(if $(filter y,$(KEEP_ENVIRONMENT)),--keep-environment) \
+		--log-cli-level=DEBUG \
+		--show-capture=all \
+		--tb=short \
+		--junitxml=./out/$(DATETIME_AS_VERSION)/report.xml \
+		./vmtests/imagecreator/test_imagecreator_fedora.py
+
 .PHONY: test-osmodifier
 test-osmodifier:
 	${PYTEST} \
@@ -133,7 +148,7 @@ test-osmodifier:
 run-imagecustomizer: image-customizer-container test-imagecustomizer
 
 .PHONY: run-imagecreator
-run-imagecreator: ${IMAGE_CREATOR_BIN} test-imagecreator
+run-imagecreator: ${IMAGE_CREATOR_BIN} test-imagecreator-azurelinux test-imagecreator-fedora
 
 .PHONY: run-osmodifier
 run-osmodifier: ${OSMODIFIER_BIN} test-osmodifier

test/vmtests/vmtests/imagecreator/test_imagecreator.py

@@ -5,7 +5,7 @@
 import os
 import platform
 from pathlib import Path
-from typing import List, Tuple
+from typing import Any, Dict, List, Tuple
 
 import libvirt  # type: ignore
 import pytest
@@ -14,7 +14,7 @@
 from ..utils.closeable import Closeable
 from ..utils.host_utils import get_host_distro
 from ..utils.imagecreator import run_image_creator, run_image_customizer_binary
-from ..utils.imagecustomizer import add_ssh_to_config
+from ..utils.imagecustomizer import add_preview_features_to_config, add_ssh_to_config
 from ..utils.libvirt_utils import VmSpec, create_libvirt_domain_xml
 from ..utils.libvirt_vm import LibvirtVm
 from ..utils.ssh_client import SshClient
@@ -25,6 +25,27 @@
     "toolkit/tools/pkg/imagecreatorlib/testdata"
 )
 
+# Common packages that should be present in all distributions
+COMMON_PACKAGES = ["kernel", "systemd", "bash"]
+
+# Distribution-specific configuration
+DISTRO_CONFIGS: Dict[str, Dict[str, Any]] = {
+    "fedora": {
+        "os_release": {
+            "ID": "fedora",
+            "VERSION_ID": "42",
+        },
+        "packages": COMMON_PACKAGES + ["grub2-efi-x64"],
+    },
+    "azurelinux": {
+        "os_release": {
+            "ID": "azurelinux",
+            "VERSION_ID": "3.0",
+        },
+        "packages": COMMON_PACKAGES + ["grub2"],
+    },
+}
+
 
 def run_image_creator_test(
     image_creator_binary_path: Path,
@@ -89,6 +110,10 @@ def run_image_creator_test(
     base_ssh_config_path = IMAGECREATOR_TEST_CONFIGS_DIR.joinpath("ssh-base-config.yaml")
     customizer_config_path_obj = add_ssh_to_config(base_ssh_config_path, username, ssh_public_key, close_list)
 
+    # Add Fedora preview features if needed
+    if distro.lower() == "fedora":
+        customizer_config_path_obj = add_preview_features_to_config(customizer_config_path_obj, "fedora-42", close_list)
+
     run_image_customizer_binary(
         image_customizer_binary_path,
         initial_output_image_path,
@@ -189,32 +214,65 @@ def run_image_creator_test(
         logging.info(f"SSH connection established successfully!")
         # Run the test
         logging.info(f"Running basic checks on the VM")
-        run_basic_checks(ssh_client, test_temp_dir)
+        run_basic_checks(ssh_client, test_temp_dir, distro)
         logging.info(f"Basic checks completed successfully!")
 
 
+def verify_packages(ssh_client: SshClient, packages_to_check: List[str]) -> None:
+    """Verify that specified packages are present in the system.
+
+    Args:
+        ssh_client: SSH client connected to the target system
+        packages_to_check: List of package names to verify
+    """
+    for package in packages_to_check:
+        ssh_client.run(f"rpm -q {package}").check_exit_code()
+
+
+def verify_os_release(os_release_text: str, expected_values: Dict[str, str]) -> None:
+    """Verify os-release content matches expected values.
+
+    Args:
+        os_release_text: Content of os-release file
+        expected_values: Dictionary of key-value pairs to verify
+    """
+    for key, value in expected_values.items():
+        expected = f"{key}={value}"
+        assert expected in os_release_text, f"Expected '{expected}' in os-release, but not found"
+
+
 def run_basic_checks(
     ssh_client: SshClient,
     test_temp_dir: Path,
+    distro: str,
 ) -> None:
+    """Run basic checks for the specified distribution.
 
+    Args:
+        ssh_client: SSH client for running commands
+        test_temp_dir: Temporary directory for test artifacts
+        distro: Distribution name (must be a key in DISTRO_CONFIGS)
+    """
+    if distro not in DISTRO_CONFIGS:
+        raise ValueError(f"Unsupported distribution: {distro}")
+
+    config = DISTRO_CONFIGS[distro]
+
+    # Check kernel cmdline
     ssh_client.run("cat /proc/cmdline").check_exit_code()
 
+    # Get and verify os-release
     os_release_path = test_temp_dir.joinpath("os-release")
     ssh_client.get_file(Path("/etc/os-release"), os_release_path)
 
     with open(os_release_path, "r") as os_release_fd:
         os_release_text = os_release_fd.read()
+        os_release_config = {str(k): str(v) for k, v in config["os_release"].items()}
+        verify_os_release(os_release_text, os_release_config)
 
-        # Since imagecreator creates new images, we expect Azure Linux 3.0
-        assert "ID=azurelinux" in os_release_text
-        assert 'VERSION_ID="3.0"' in os_release_text
-
-    # Check that essential packages are installed
-    ssh_client.run("rpm -q kernel").check_exit_code()
-    ssh_client.run("rpm -q systemd").check_exit_code()
-    ssh_client.run("rpm -q grub2").check_exit_code()
-    ssh_client.run("rpm -q bash").check_exit_code()
+    # Check required packages
+    package_list = [str(pkg) for pkg in config["packages"]]
+    verify_packages(ssh_client, package_list)
 
 
 @pytest.mark.skipif(platform.machine() != "x86_64", reason="arm64 is not supported for this combination")

test/vmtests/vmtests/imagecreator/test_imagecreator_fedora.py

@@ -0,0 +1,50 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+import logging
+import platform
+from pathlib import Path
+from typing import List, Tuple
+
+import libvirt  # type: ignore
+import pytest
+
+from ..utils.closeable import Closeable
+from .test_imagecreator import IMAGECREATOR_TEST_CONFIGS_DIR, run_image_creator_test
+
+
+@pytest.mark.skipif(platform.machine() != "x86_64", reason="arm64 is not supported for this combination")
+def test_create_image_efi_qcow_output_fedora(
+    image_creator_binary_path: Path,
+    rpm_sources: List[Path],
+    tools_tar: Path,
+    ssh_key: Tuple[str, Path],
+    test_temp_dir: Path,
+    test_instance_name: str,
+    logs_dir: Path,
+    libvirt_conn: libvirt.virConnect,
+    close_list: List[Closeable],
+    image_customizer_binary_path: Path,
+) -> None:
+    config_path = IMAGECREATOR_TEST_CONFIGS_DIR.joinpath("fedora.yaml")
+    output_format = "qcow2"
+
+    # debug message
+    logging.debug("Running test_create_image_efi_qcow_output_fedora")
+
+    run_image_creator_test(
+        image_creator_binary_path,
+        rpm_sources,
+        tools_tar,
+        config_path,
+        output_format,
+        ssh_key,
+        test_temp_dir,
+        test_instance_name,
+        logs_dir,
+        libvirt_conn,
+        close_list,
+        image_customizer_binary_path,
+        "fedora",
+        "42",
+    )

test/vmtests/vmtests/utils/imagecustomizer.py

@@ -137,6 +137,40 @@ def add_ssh_to_config(config_path: Path, username: str, ssh_public_key: str, clo
     return path
 
 
+def add_preview_features_to_config(config_path: Path, preview_feature: str, close_list: List[Closeable]) -> Path:
+    """Modify an image customizer config file to add preview features.
+
+    Args:
+        config_path: Path to the base config file
+        preview_feature: Feature flag to add to previewFeatures list
+        close_list: List of resources to be cleaned up
+
+    Returns:
+        Path to the modified config file
+    """
+    config_str = config_path.read_text()
+    config = yaml.safe_load(config_str)
+
+    # Get or create previewFeatures list
+    preview_features = config.get("previewFeatures", [])
+    if not isinstance(preview_features, list):
+        preview_features = []
+
+    # Add the feature if not already present
+    if preview_feature not in preview_features:
+        preview_features.append(preview_feature)
+        config["previewFeatures"] = preview_features
+
+    # Write out new config file to a temporary file
+    fd, modified_config_path = tempfile.mkstemp(prefix=config_path.name + "~", suffix=".tmp", dir=config_path.parent)
+    with fdopen(fd, mode="w") as file:
+        yaml.safe_dump(config, file)
+
+    path = Path(modified_config_path)
+    close_list.append(RemoveFileOnClose(path))
+    return path
+
+
 def dict_get_or_set(dictionary: Dict[Any, Any], value_name: str, default: Any = None) -> Any:
     value = dictionary.get(value_name)
     if value is None:

toolkit/tools/pkg/imagecreatorlib/testdata/fedora.yaml

@@ -49,4 +49,6 @@ os:
     - libxkbcommon
     - shim-x64
     - kernel
+    # Add dnf to support dnf based package installation in imagecustomizer
+    - dnf