TheRock/build_tools/github_actions/test_executable_scripts/test_tensilelite.py

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

"""
Test runner for TensileLite and rocisa Python tests using pre-built artifacts.

Runs against installed artifacts from the hipBLASLt test component:
  share/hipblaslt/tensilelite/Tensile/     — Tensile Python package
  share/hipblaslt/tensilelite/rocisa/       — rocisa Python package + _rocisa.abi3.so
  share/hipblaslt/tensilelite/rocisa_tests/ — rocisa pytest modules

Test order (fail fast):
- rocisa (build dependency of TensileLite)
- TensileLite unit tests
- TensileLite common GEMM tests (gfx1250 in AMDGPU_FAMILIES)

CI: All GPU archs (unit tests), GPU emulation (gfx1250 common tests)

Usage: python test_tensilelite.py
"""

import logging
import os
import subprocess
import sys
from pathlib import Path

logging.basicConfig(level=logging.INFO, format="%(message)s")

# GPU families where unit tests are skipped. These families run under emulation
# where hip-python is unavailable and no arch-specific unit tests exist.
# TODO: move this skip logic into the pytest conftest so the wrapper stays thin.
UNIT_TEST_SKIP_FAMILIES = {"gfx1250"}

# Per-test timeout (seconds); slow tests are killed, rest continue.
FFM_PER_TEST_TIMEOUT = int(os.getenv("FFM_PER_TEST_TIMEOUT", "300"))

# TENSILE_NUM_PYTEST_WORKERS: number of pytest-xdist processes running tests in parallel.
NUM_PYTEST_WORKERS = os.getenv("TENSILE_NUM_PYTEST_WORKERS", "16")

SCRIPT_DIR = Path(__file__).resolve().parent
THEROCK_DIR = SCRIPT_DIR.parent.parent.parent
THEROCK_BIN_DIR = os.getenv("THEROCK_BIN_DIR", str(THEROCK_DIR / "build" / "bin"))

rocm_path = Path(THEROCK_BIN_DIR).resolve().parent
tensilelite_root = rocm_path / "share" / "hipblaslt" / "tensilelite"

if not tensilelite_root.is_dir():
    raise FileNotFoundError(
        f"TensileLite test artifacts not found at {tensilelite_root}. "
        "Ensure the build used -DHIPBLASLT_INSTALL_TENSILELITE_TEST_ARTIFACTS=ON."
    )

env = os.environ.copy()
existing_pythonpath = env.get("PYTHONPATH")
env["PYTHONPATH"] = (
    f"{tensilelite_root}{os.pathsep}{existing_pythonpath}"
    if existing_pythonpath
    else str(tensilelite_root)
)
env["ROCM_PATH"] = str(rocm_path)

# _rocisa links libamdhip64.so, tensilelite-client links libomp.so.
lib_path = rocm_path / "lib"
llvm_lib_path = rocm_path / "lib" / "llvm" / "lib"
existing_ld_path = env.get("LD_LIBRARY_PATH", "")
env["LD_LIBRARY_PATH"] = os.pathsep.join(
    filter(None, [str(lib_path), str(llvm_lib_path), existing_ld_path])
)

# GPU unit tests use amdclang++ to assemble kernels.
existing_path = env.get("PATH", "")
env["PATH"] = os.pathsep.join(
    filter(
        None,
        [
            str(rocm_path / "bin"),
            str(rocm_path / "lib" / "llvm" / "bin"),
            existing_path,
        ],
    )
)

# Smoke test: verify install layout and stable ABI.
logging.info("=== Verifying artifact install layout ===")
rocisa_dir = tensilelite_root / "rocisa"
logging.info(
    f"rocisa directory contents: {[f.name for f in rocisa_dir.iterdir() if not f.name.startswith('__')]}"
)
abi3_files = list(rocisa_dir.glob("*.abi3.*"))
if abi3_files:
    logging.info(f"Stable ABI confirmed: {[f.name for f in abi3_files]}")
else:
    logging.warning("No .abi3 extension found — stable ABI may not be enabled")
subprocess.check_call(
    [
        sys.executable,
        "-c",
        "import Tensile, rocisa, rocisa.instruction; "
        "print('Tensile:', Tensile.ROOT_PATH); print('rocisa:', rocisa.__file__)",
    ],
    cwd=str(THEROCK_DIR),
    env=env,
)

# Determine arch before running tests — gfx1250 uses subprocess.run for rocisa
# so common GEMM tests run regardless of rocisa outcome. Other archs keep
# check_call (fail-fast: rocisa failure → abort before unit tests).
amdgpu_family = os.getenv("AMDGPU_FAMILIES", "")
common_tests = tensilelite_root / "Tensile" / "Tests" / "common"
run_common_tests = common_tests.is_dir() and "gfx1250" in amdgpu_family

logging.info("=== Running rocisa tests ===")
if run_common_tests:
    rocisa_result = subprocess.run(
        [
            sys.executable,
            "-m",
            "pytest",
            "-v",
            str(tensilelite_root / "rocisa_tests"),
        ],
        cwd=str(THEROCK_DIR),
        env=env,
    )
    if rocisa_result.returncode != 0:
        logging.warning(
            f"rocisa tests failed (exit {rocisa_result.returncode}), continuing to common tests"
        )
else:
    subprocess.check_call(
        [
            sys.executable,
            "-m",
            "pytest",
            "-v",
            str(tensilelite_root / "rocisa_tests"),
        ],
        cwd=str(THEROCK_DIR),
        env=env,
    )

# TensileLite Python unit tests (includes GPU subtile tests).
# TODO(TheRock#3288): gfx950-dcgpu is excluded from PR CI (ci.yml) due to runner
# capacity — GPU subtile tests only exercise on nightly/scheduled builds.
skip_unit = UNIT_TEST_SKIP_FAMILIES & set(amdgpu_family.split(","))
if not skip_unit:
    logging.info("=== Running TensileLite unit tests ===")
    # Snapshot characterization tests own their .ambr baselines under tox, which
    # selects a superset of cases. Running just Tensile/Tests/unit via pytest can
    # leave some snapshots orphaned (unused); syrupy fails the session on those by
    # default, so warn instead of failing on snapshots we don't exercise here.
    subprocess.check_call(
        [
            sys.executable,
            "-m",
            "pytest",
            "-v",
            "--snapshot-warn-unused",
            str(tensilelite_root / "Tensile" / "Tests" / "unit"),
        ],
        cwd=str(THEROCK_DIR),
        env=env,
    )
else:
    logging.info("=== Skipping unit tests (emulation mode) ===")

# TensileLite common (GEMM) tests — gfx1250 only, requires GPU or emulator.
# Scope to Tensile/Tests/common (not Tensile/Tests) to avoid rocisa singleton
# poisoning: unit test modules call validateToolchain()/makeIsaInfoMap() at
# import time, caching all-false ISA caps that break subsequent common tests.
client_path = rocm_path / "libexec" / "hipblaslt" / "tensilelite" / "tensilelite-client"

if run_common_tests:
    test_profile = os.getenv("TEST_PROFILE", "default")
    logging.info(
        f"=== Running TensileLite common gfx1250 tests (TEST_PROFILE={test_profile}) ==="
    )
    cxx = rocm_path / "bin" / "amdclang++"
    junit_xml_dir = os.getenv("JUNIT_XML_DIR", "")
    common_cmd = [
        sys.executable,
        "-m",
        "pytest",
        "-v",
        "--durations=0",
        f"--timeout={FFM_PER_TEST_TIMEOUT}",
        "-n",
        NUM_PYTEST_WORKERS,
        str(common_tests),
        "-m",
        "gfx1250",
    ]
    if junit_xml_dir:
        common_cmd.append(f"--junit-xml={junit_xml_dir}/tensilelite.xml")
    if client_path.is_file():
        common_cmd += [f"--prebuilt-client={client_path}"]
        common_cmd += ["--global-parameters=LibraryFormat='msgpack'"]
    if cxx.is_file():
        common_cmd += [f"--tensile-options=--cxx-compiler,{cxx},--gpu-targets,gfx1250"]
    # HSA_MODEL_NUM_THREADS: number of threads inside the FFM emulator per process.
    env["HSA_MODEL_NUM_THREADS"] = os.getenv("HSA_MODEL_NUM_THREADS", "8")
    common_result = subprocess.run(common_cmd, cwd=str(THEROCK_DIR), env=env)
    # Exit with common test result — this is the primary outcome.
    # rocisa failure is logged above but does not override the common test exit code.
    sys.exit(common_result.returncode)