[CI/Build] Package runtime data explicitly (#7956)

Signed-off-by: Doug Smith <dosmith@redhat.com>

.github/workflows/build_wheel.yml

@@ -56,6 +56,35 @@ jobs:
         run: |
           bash scripts/build_wheel.sh --python python
 
+      - name: Validate runtime package data from source archive
+        run: |
+          set -euo pipefail
+          archive_dir="$(mktemp -d)"
+          install_dir="$(mktemp -d)"
+          vcs_wheels=(dist/*.whl)
+          if [[ ${#vcs_wheels[@]} -ne 1 || ! -f "${vcs_wheels[0]}" ]]; then
+            echo "Expected exactly one VCS-built wheel" >&2
+            exit 1
+          fi
+          git archive HEAD | tar -x -C "${archive_dir}"
+          (
+            cd "${archive_dir}"
+            VLLM_OMNI_TARGET_DEVICE=cuda \
+              VLLM_OMNI_VERSION_OVERRIDE=0.0.0 \
+              python -m build --wheel --outdir archive-dist
+          )
+          wheels=("${archive_dir}"/archive-dist/*.whl)
+          if [[ ${#wheels[@]} -ne 1 || ! -f "${wheels[0]}" ]]; then
+            echo "Expected exactly one archive-built wheel" >&2
+            exit 1
+          fi
+          python -m pip install --no-deps --target "${install_dir}" "${wheels[0]}"
+          python tools/check_wheel_package_data.py \
+            --source-root "${archive_dir}" \
+            --wheel "${wheels[0]}" \
+            --vcs-wheel "${vcs_wheels[0]}" \
+            --installed-root "${install_dir}"
+
       - name: Upload Wheel Artifact
         uses: actions/upload-artifact@v7
         with:

pyproject.toml

@@ -161,12 +161,25 @@ vllm-omni = "vllm_omni.entrypoints.cli.main:main"
 vllm_omni_register_models = "vllm_omni.engine.arg_utils:register_omni_models_to_vllm"
 
 
+[tool.setuptools]
+include-package-data = false
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["vllm_omni*"]
 
 [tool.setuptools.package-data]
-"vllm_omni" = ["_version.py", "py.typed", "transformers_utils/chat_templates/*.jinja"]
+"vllm_omni" = [
+    "_version.py",
+    "py.typed",
+    "deploy/*.md",
+    "deploy/*.yaml",
+    "diffusion/distributed/csrc/*.cu",
+    "diffusion/distributed/csrc/*.hpp",
+    "model_executor/models/covo_audio/speaker_prompt/*.npy",
+    "model_executor/models/step_audio2/assets/*.wav",
+    "transformers_utils/chat_templates/*.jinja",
+]
 
 [tool.setuptools_scm]
 # no extra settings needed, presence enables setuptools-scm

tools/check_wheel_package_data.py

@@ -0,0 +1,118 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+"""Verify runtime package data in a built vLLM-Omni wheel.
+
+The source tree may contain package data through setuptools-scm's Git file
+finder even when a VCS-less source archive cannot rediscover it. This check
+compares each runtime-owned source directory with both the wheel payload and,
+optionally, an installed copy of that wheel.
+"""
+
+import argparse
+import sys
+import zipfile
+from pathlib import Path
+
+PACKAGE_NAME = "vllm_omni"
+RUNTIME_DATA_DIRS = (
+    Path("deploy"),
+    Path("diffusion/distributed/csrc"),
+    Path("model_executor/models/covo_audio/speaker_prompt"),
+    Path("model_executor/models/step_audio2/assets"),
+    Path("transformers_utils/chat_templates"),
+)
+
+
+def runtime_data_files(source_root: Path) -> list[Path]:
+    package_root = source_root / PACKAGE_NAME
+    files: list[Path] = []
+    for relative_dir in RUNTIME_DATA_DIRS:
+        data_dir = package_root / relative_dir
+        if not data_dir.is_dir():
+            raise FileNotFoundError(f"runtime data directory not found: {data_dir}")
+        files.extend(
+            path.relative_to(source_root) for path in data_dir.rglob("*") if path.is_file() and path.suffix != ".py"
+        )
+    return sorted(files)
+
+
+def missing_wheel_files(wheel: Path, expected: list[Path]) -> list[Path]:
+    with zipfile.ZipFile(wheel) as archive:
+        members = set(archive.namelist())
+    return [path for path in expected if path.as_posix() not in members]
+
+
+def wheel_package_files(wheel: Path) -> set[Path]:
+    package_prefix = f"{PACKAGE_NAME}/"
+    with zipfile.ZipFile(wheel) as archive:
+        return {
+            Path(member)
+            for member in archive.namelist()
+            if member.startswith(package_prefix) and not member.endswith("/")
+        }
+
+
+def missing_installed_files(installed_root: Path, expected: list[Path]) -> list[Path]:
+    missing = []
+    for path in expected:
+        installed_path = installed_root / path
+        if not installed_path.is_file():
+            missing.append(path)
+            continue
+        installed_path.read_bytes()
+    return missing
+
+
+def report_missing(label: str, missing: list[Path]) -> bool:
+    if not missing:
+        return False
+    print(f"{label} is missing {len(missing)} runtime package-data file(s):", file=sys.stderr)
+    for path in missing:
+        print(f"  {path.as_posix()}", file=sys.stderr)
+    return True
+
+
+def report_wheel_difference(vcs_wheel: Path, archive_wheel: Path) -> bool:
+    vcs_files = wheel_package_files(vcs_wheel)
+    archive_files = wheel_package_files(archive_wheel)
+    only_in_vcs = sorted(vcs_files - archive_files)
+    only_in_archive = sorted(archive_files - vcs_files)
+    if not only_in_vcs and not only_in_archive:
+        return False
+
+    print("VCS-built and archive-built wheel package contents differ:", file=sys.stderr)
+    for label, paths in (("only in VCS-built wheel", only_in_vcs), ("only in archive-built wheel", only_in_archive)):
+        if paths:
+            print(f"  {label} ({len(paths)}):", file=sys.stderr)
+            for path in paths:
+                print(f"    {path.as_posix()}", file=sys.stderr)
+    return True
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("--source-root", type=Path, required=True)
+    parser.add_argument("--wheel", type=Path, required=True)
+    parser.add_argument("--vcs-wheel", type=Path)
+    parser.add_argument("--installed-root", type=Path)
+    args = parser.parse_args()
+
+    expected = runtime_data_files(args.source_root.resolve())
+    failed = report_missing("wheel", missing_wheel_files(args.wheel, expected))
+    if args.vcs_wheel is not None:
+        failed |= report_wheel_difference(args.vcs_wheel.resolve(), args.wheel.resolve())
+    if args.installed_root is not None:
+        failed |= report_missing(
+            "installed wheel",
+            missing_installed_files(args.installed_root.resolve(), expected),
+        )
+
+    if failed:
+        return 1
+    print(f"validated {len(expected)} runtime package-data files in {args.wheel}")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())