hao-ai-lab-FastVideo/fastvideo/tests/entrypoints/test_openai_serving_engine.py

# SPDX-License-Identifier: Apache-2.0
"""CPU-light contracts for the shared OpenAI serving engine and adapter."""

from __future__ import annotations

import asyncio
from pathlib import Path
import threading
import time
from types import SimpleNamespace

import pytest
from fastapi import FastAPI
from fastapi.testclient import TestClient

from fastvideo.api.parser import parse_config
from fastvideo.api.schema import GenerationRequest
from fastvideo.entrypoints.openai.protocol import VideoGenerationRequest
from fastvideo.entrypoints.openai.request_adapter import (
    RequestAdaptationError,
    build_generation_request,
    prepare_reference_media,
    validate_served_model_name,
)
from fastvideo.entrypoints.openai.serving_engine import OpenAIServingEngine
from fastvideo.entrypoints.openai.stores import VIDEO_STORE


class _BlockingGenerator:

    def __init__(self) -> None:
        self.started = threading.Event()
        self.release = threading.Event()
        self.shutdown_called = False

    def generate(self, request):
        self.started.set()
        self.release.wait(timeout=5)
        return request

    def shutdown(self) -> None:
        self.shutdown_called = True


class _FileGenerator:

    def __init__(self) -> None:
        self.last_output: Path | None = None

    def generate(self, request):
        output = Path(request.output.output_path)
        self.last_output = output
        output.parent.mkdir(parents=True, exist_ok=True)
        output.write_bytes(b"\x00\x00\x00\x18ftypmp42fastvideo-test")
        return SimpleNamespace(
            video_path=str(output),
            generation_time=0.01,
            peak_memory_mb=12.5,
            logging_info=None,
        )

    def shutdown(self) -> None:
        return None


def _served_config(model_path: str, **components):
    """Stand-in for the served resolved config; ``components`` overrides ``pipeline.components`` fields."""
    values = {
        "lora_path": None,
        "lora_nickname": "default",
        "lora_strength": 1.0,
        "override_pipeline_cls_name": None,
    }
    values.update(components)
    return SimpleNamespace(model_path=model_path, pipeline=SimpleNamespace(components=SimpleNamespace(**values)))


def test_engine_cancellation_keeps_pipeline_locked() -> None:
    asyncio.run(_assert_engine_cancellation_keeps_pipeline_locked())


async def _assert_engine_cancellation_keeps_pipeline_locked() -> None:
    generator = _BlockingGenerator()
    engine = OpenAIServingEngine(generator)  # type: ignore[arg-type]

    first = asyncio.create_task(engine.generate("first"))  # type: ignore[arg-type]
    await asyncio.to_thread(generator.started.wait, 2)
    first.cancel()
    await asyncio.sleep(0)
    first.cancel()

    second_started = threading.Event()

    def second_call():
        second_started.set()
        return "second"

    second = asyncio.create_task(engine.run_serialized(second_call))
    await asyncio.sleep(0.05)
    assert not second_started.is_set()

    generator.release.set()
    with pytest.raises(asyncio.CancelledError):
        await first
    assert await second == "second"

    await engine.shutdown()
    assert generator.shutdown_called


def test_protocol_rejects_unknown_and_client_output_fields() -> None:
    with pytest.raises(Exception, match="prompt_path"):
        VideoGenerationRequest(prompt="a fox", prompt_path="/srv/prompts.txt")
    with pytest.raises(Exception, match="output_path"):
        VideoGenerationRequest(prompt="a fox", output_path="/srv/keep.mp4")


def test_validate_served_model_name_accepts_omitted_or_matching_name() -> None:
    resolved_config = _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers")
    validate_served_model_name(None, resolved_config, "wan")
    validate_served_model_name("wan", resolved_config, "wan")


def test_validate_served_model_name_rejects_mismatch() -> None:
    with pytest.raises(RequestAdaptationError, match="this server provides wan"):
        validate_served_model_name("other-model", _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"), "wan")


def test_validate_served_model_name_uses_lora_nickname() -> None:
    resolved_config = _served_config(
        "Wan-AI/Wan2.1-T2V-1.3B-Diffusers",
        lora_path="/models/startup.safetensors",
        lora_nickname="fast",
    )
    validate_served_model_name("fast", resolved_config, "wan")
    with pytest.raises(RequestAdaptationError, match="this server provides fast"):
        validate_served_model_name("wan", resolved_config, "wan")


def test_request_adapter_restricts_extra_params(tmp_path: Path) -> None:
    request = VideoGenerationRequest(prompt="a fox", extra_params={"prompt_path": "/srv/prompts.txt"})
    with pytest.raises(RequestAdaptationError, match="Unsupported extra_params fields: prompt_path"):
        build_generation_request(
            "video_gen_test",
            request,
            _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"),
            served_model_name="wan",
            output_dir=str(tmp_path),
        )


def test_request_adapter_owns_output_path(tmp_path: Path) -> None:
    request = VideoGenerationRequest(prompt="a fox", size="64x64", num_frames=1)
    default_request = parse_config(GenerationRequest, {"output": {"output_path": "/srv/untrusted-default.mp4"}})
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"),
        served_model_name="wan",
        output_dir=str(tmp_path),
        default_request=default_request,
    )
    assert adapted.output.output_path == str(tmp_path / "videos" / "video_gen_test.mp4")


def test_missing_reference_fails_during_admission(tmp_path: Path) -> None:
    request = VideoGenerationRequest(prompt="a fox", input_reference=str(tmp_path / "missing.png"))
    with pytest.raises(RequestAdaptationError, match="does not exist"):
        asyncio.run(prepare_reference_media("request", request, str(tmp_path)))


def test_request_adapter_resolves_vllm_nested_params(tmp_path: Path) -> None:
    request = VideoGenerationRequest(
        prompt="a fox",
        video_params={"width": 832, "height": 480, "fps": 30},
        seconds="2",
        seed=7,
    )
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"),
        served_model_name="wan",
        output_dir=str(tmp_path),
    )

    assert adapted.sampling.width == 832
    assert adapted.sampling.height == 480
    assert adapted.sampling.fps == 30
    assert adapted.sampling.num_frames == 60
    assert adapted.sampling.seed == 7
    assert adapted.output.output_path.endswith("video_gen_test.mp4")


def test_request_adapter_accepts_matching_startup_lora(tmp_path: Path) -> None:
    adapter = str(tmp_path / "adapter.safetensors")
    resolved_config = _served_config(
        "Wan-AI/Wan2.1-T2V-1.3B-Diffusers",
        lora_path=adapter,
        lora_nickname="fast",
        lora_strength=0.75,
    )
    request = VideoGenerationRequest(
        prompt="a fox",
        model="fast",
        lora={"name": "fast", "path": adapter, "scale": 0.75},
    )

    build_generation_request(
        "video_gen_test",
        request,
        resolved_config,
        served_model_name="wan",
        output_dir=str(tmp_path),
    )


def test_request_adapter_rejects_runtime_lora_swap(tmp_path: Path) -> None:
    resolved_config = _served_config(
        "Wan-AI/Wan2.1-T2V-1.3B-Diffusers",
        lora_path="/models/startup.safetensors",
        lora_nickname="fast",
    )
    request = VideoGenerationRequest(prompt="a fox", lora={"path": "/models/other.safetensors"})

    with pytest.raises(RequestAdaptationError, match="does not match the startup adapter"):
        build_generation_request(
            "video_gen_test",
            request,
            resolved_config,
            served_model_name="wan",
            output_dir=str(tmp_path),
        )


def test_fasth3_request_uses_the_general_adapter(tmp_path: Path) -> None:
    request = VideoGenerationRequest(
        prompt="a fox",
        task="t2va",
        aspect_ratio="16:9",
        num_frames=124,
        num_inference_steps=5,
        guidance_scale=1.0,
    )
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("FastVideo/FastVideo-Minimax-FastH3-Preview-v0.2"),
        served_model_name="fasth3",
        output_dir=str(tmp_path),
    )

    assert adapted.sampling.width == 1344
    assert adapted.sampling.height == 768
    assert adapted.sampling.num_frames == 124


@pytest.mark.parametrize(
    ("overrides", "message"),
    [
        ({"aspect_ratio": "16:9", "num_frames": 22}, "generates 5-15 seconds"),
        ({"size": "100x100", "num_frames": 124}, "positive multiples of 32"),
        ({"aspect_ratio": "1:9", "num_frames": 124}, "supports aspect ratios"),
        ({"aspect_ratio": "16:9", "num_frames": 120}, "causal-VAE grid"),
    ],
)
def test_fasth3_invalid_geometry_fails_at_admission(tmp_path: Path, overrides, message) -> None:
    request = VideoGenerationRequest(prompt="a fox", **overrides)
    with pytest.raises(RequestAdaptationError, match=message):
        build_generation_request(
            "video_gen_test",
            request,
            _served_config("FastVideo/FastVideo-Minimax-FastH3-Preview-v0.2"),
            served_model_name="fasth3",
            output_dir=str(tmp_path),
        )


@pytest.mark.parametrize(("seconds", "expected_frames"), [("5", 124), ("15", 362)])
def test_fasth3_seconds_align_to_causal_vae_grid(tmp_path: Path, seconds: str, expected_frames: int) -> None:
    request = VideoGenerationRequest(prompt="a fox", aspect_ratio="16:9", seconds=seconds)
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("FastVideo/FastVideo-Minimax-FastH3-Preview-v0.2"),
        served_model_name="fasth3",
        output_dir=str(tmp_path),
    )
    assert adapted.sampling.num_frames == expected_frames


def test_fasth3_ref2va_limits_references_at_admission(tmp_path: Path) -> None:
    request = VideoGenerationRequest(
        prompt="a fox",
        task="ref2va",
        aspect_ratio="16:9",
        num_frames=124,
        image_reference=[{"image_url": f"/tmp/reference-{index}.png"} for index in range(10)],
    )
    with pytest.raises(RequestAdaptationError, match="at most 9 image references"):
        build_generation_request(
            "video_gen_test",
            request,
            _served_config(
                "MiniMaxAI/MiniMax-H3",
                override_pipeline_cls_name="MiniMaxH3Ref2VAModularPipeline",
            ),
            served_model_name="minimax-h3",
            output_dir=str(tmp_path),
        )


def test_aspect_ratio_overrides_operator_dimensions(tmp_path: Path) -> None:
    default_request = parse_config(
        GenerationRequest,
        {"sampling": {
            "width": 1344,
            "height": 768,
            "num_frames": 124,
        }},
    )
    request = VideoGenerationRequest(prompt="a fox", aspect_ratio="9:16")
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("FastVideo/FastVideo-Minimax-FastH3-Preview-v0.2"),
        served_model_name="fasth3",
        output_dir=str(tmp_path),
        default_request=default_request,
    )
    assert adapted.sampling.width == 768
    assert adapted.sampling.height == 1344


def test_explicit_null_uses_seconds_and_operator_fps(tmp_path: Path) -> None:
    default_request = parse_config(
        GenerationRequest,
        {"sampling": {
            "fps": 30,
            "num_frames": 99,
        }},
    )
    request = VideoGenerationRequest(prompt="a fox", seconds=2, fps=None, num_frames=None)
    adapted = build_generation_request(
        "video_gen_test",
        request,
        _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"),
        served_model_name="wan",
        output_dir=str(tmp_path),
        default_request=default_request,
    )
    assert adapted.sampling.fps == 30
    assert adapted.sampling.num_frames == 60


def test_unsupported_vllm_postprocessing_fails_at_admission(tmp_path: Path) -> None:
    request = VideoGenerationRequest(prompt="a fox", enable_frame_interpolation=True)

    with pytest.raises(RequestAdaptationError, match="frame_interpolation"):
        build_generation_request(
            "video_gen_test",
            request,
            _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers"),
            served_model_name="wan",
            output_dir=str(tmp_path),
        )


def test_video_routes_cover_async_sync_list_content_and_delete(tmp_path: Path) -> None:
    from fastvideo.entrypoints.openai import state
    from fastvideo.entrypoints.openai.video_api import router

    generator = _FileGenerator()
    engine = OpenAIServingEngine(generator)  # type: ignore[arg-type]
    resolved_config = _served_config("Wan-AI/Wan2.1-T2V-1.3B-Diffusers")
    state.set_state(
        generator,  # type: ignore[arg-type]
        engine,
        resolved_config,  # type: ignore[arg-type]
        str(tmp_path),
        served_model_name="wan-test",
    )
    asyncio.run(VIDEO_STORE.clear())
    app = FastAPI()
    app.include_router(router)

    try:
        with TestClient(app) as client:
            created = client.post(
                "/v1/videos",
                json={
                    "model": "wan-test",
                    "prompt": "a fox",
                    "size": "64x64",
                    "num_frames": 1,
                },
            )
            assert created.status_code == 200
            video_id = created.json()["id"]

            for _ in range(50):
                detail = client.get(f"/v1/videos/{video_id}")
                if detail.json()["status"] == "completed":
                    break
                time.sleep(0.01)
            assert detail.status_code == 200
            assert detail.json()["status"] == "completed"

            listing = client.get("/v1/videos", params={"limit": 1})
            assert listing.status_code == 200
            assert listing.json()["data"][0]["id"] == video_id

            content = client.get(f"/v1/videos/{video_id}/content")
            assert content.status_code == 200
            assert content.content[4:8] == b"ftyp"

            deleted = client.delete(f"/v1/videos/{video_id}")
            assert deleted.status_code == 200
            assert deleted.json() == {
                "id": video_id,
                "deleted": True,
                "object": "video.deleted",
            }

            sync = client.post(
                "/v1/videos/sync",
                json={
                    "prompt": "a fox",
                    "size": "64x64",
                    "num_frames": 1,
                },
            )
            assert sync.status_code == 200
            assert sync.headers["x-model"] == "wan-test"
            assert sync.content[4:8] == b"ftyp"
            assert generator.last_output is not None
            assert not generator.last_output.exists()
    finally:
        asyncio.run(VIDEO_STORE.clear())
        state.clear_state()