TheRock/rocm-libraries/test/therock/test_hipdnn_install.py

#!/usr/bin/env python3
# Copyright (c) Advanced Micro Devices, Inc.
# SPDX-License-Identifier: MIT

"""
hipDNN installation consumption test.

This test verifies that hipDNN packages built by TheRock can be properly
consumed by external projects using CMake's find_package. It tests the
CMake packaging/installation correctness, not hipDNN functionality.
"""

import argparse
import logging
import os
import platform
import shlex
import subprocess
import tempfile
from pathlib import Path

OUTPUT_ARTIFACTS_DIR = os.getenv("OUTPUT_ARTIFACTS_DIR")
SCRIPT_DIR = Path(__file__).resolve().parent
THEROCK_DIR = Path(
    os.environ.get("THEROCK_DIR") or SCRIPT_DIR.parent.parent.parent
).resolve()
TEST_PROJECT_DIR = SCRIPT_DIR / "hipdnn_install_tests"

logging.basicConfig(level=logging.INFO)


def run_tests(build_dir: Path):
    """Configure, build, and test all hipDNN packages."""
    # Locally, can set OUTPUT_ARTIFACTS_DIR=build/dist/rocm for testing
    artifacts_path = Path(OUTPUT_ARTIFACTS_DIR).resolve()
    is_windows = platform.system() == "Windows"

    # Compiler extension differs by platform
    compiler_ext = ".exe" if is_windows else ""

    # Set up environment variables for CMake/HIP
    environ_vars = os.environ.copy()
    environ_vars["HIP_PLATFORM"] = "amd"

    if is_windows:
        # Set library path for runtime (needed when running the test executables)
        rocm_lib = str(artifacts_path)

        # Windows uses PATH for DLL lookup
        path_sep = ";"
        if "PATH" in environ_vars:
            environ_vars["PATH"] = f"{rocm_lib}{path_sep}{environ_vars['PATH']}"
        else:
            environ_vars["PATH"] = rocm_lib
    else:
        rocm_lib = str(artifacts_path / "lib")

        # Linux uses LD_LIBRARY_PATH
        path_sep = ":"
        if "LD_LIBRARY_PATH" in environ_vars:
            environ_vars["LD_LIBRARY_PATH"] = (
                f"{rocm_lib}{path_sep}{environ_vars['LD_LIBRARY_PATH']}"
            )
        else:
            environ_vars["LD_LIBRARY_PATH"] = rocm_lib

    # We configure and build test projects externally (not during TheRock build)
    # to emulate how a consumer would build against the installed hipDNN artifacts.
    # This catches packaging issues that only manifest during external consumption.
    configure_cmd = [
        "cmake",
        "-B",
        str(build_dir),
        "-S",
        str(TEST_PROJECT_DIR),
        "-GNinja",
        f"-DCMAKE_PREFIX_PATH={artifacts_path}",
        f"-DCMAKE_CXX_COMPILER={artifacts_path}/lib/llvm/bin/clang++{compiler_ext}",
        f"-DCMAKE_C_COMPILER={artifacts_path}/lib/llvm/bin/clang{compiler_ext}",
        "--log-level=WARNING",
    ]

    # Windows needs a resource compiler specified
    if is_windows:
        configure_cmd.append("-DCMAKE_RC_COMPILER=rc.exe")
    logging.info(f"++ Configure: {shlex.join(configure_cmd)}")
    subprocess.run(configure_cmd, check=True, cwd=THEROCK_DIR, env=environ_vars)

    build_cmd = ["cmake", "--build", str(build_dir)]
    logging.info(f"++ Build: {shlex.join(build_cmd)}")
    subprocess.run(build_cmd, check=True, cwd=THEROCK_DIR, env=environ_vars)

    test_cmd = [
        "ctest",
        "--test-dir",
        str(build_dir),
        "--output-on-failure",
        "--parallel",
        "8",
        "--timeout",
        "120",
    ]
    logging.info(f"++ Test: {shlex.join(test_cmd)}")
    subprocess.run(test_cmd, check=True, cwd=THEROCK_DIR, env=environ_vars)


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="Test hipDNN package installation and consumption"
    )
    parser.add_argument(
        "--build-dir",
        type=Path,
        help="Build directory path (will be created if doesn't exist). "
        "If not specified, uses temporary directory that is auto-deleted.",
    )
    args = parser.parse_args()

    if not OUTPUT_ARTIFACTS_DIR:
        raise RuntimeError("OUTPUT_ARTIFACTS_DIR environment variable not set")

    logging.info(f"Using OUTPUT_ARTIFACTS_DIR: {OUTPUT_ARTIFACTS_DIR}")

    if args.build_dir:
        build_dir = args.build_dir.resolve()
        build_dir.mkdir(parents=True, exist_ok=True)
        logging.info(f"Using persistent build directory: {build_dir}")
        run_tests(build_dir)
        logging.info(f"Build artifacts retained in: {build_dir}")
    else:
        logging.info("Using temporary build directory (auto-cleanup)")
        with tempfile.TemporaryDirectory() as temp_dir:
            run_tests(Path(temp_dir))

    logging.info("All hipDNN install tests passed!")