test_packaging.py

"""Packaging regression tests (Phase 10.5 / wheel-install net).

Editable installs hide ``package_data`` mistakes because
``Path(__file__).parent`` resolves quickstart templates from the source
checkout regardless of what setuptools actually copied. These tests
exercise the *importlib.resources* path — which mirrors what a real
``pip install forgelm-X.Y.Z-py3-none-any.whl`` exposes — and assert that
the YAML/JSONL/Markdown assets advertised by :mod:`forgelm.quickstart`
are reachable as package resources.

A missing assertion here means the wheel will silently ship without a
template asset; the corresponding nightly job (``wheel-install-smoke``)
catches the same class of regression end-to-end.
"""

from __future__ import annotations

import importlib.resources as ir
from pathlib import Path

import pytest

import forgelm.templates
from forgelm.quickstart import TEMPLATES


def test_templates_dir_is_a_real_python_package() -> None:
    """``forgelm.templates`` must be an importable subpackage.

    Without an ``__init__.py``, ``importlib.resources`` would fall back to
    namespace-package semantics that do not surface bundled data files
    after a wheel install.
    """

    init_file = getattr(forgelm.templates, "__file__", None)
    assert init_file is not None, (
        "forgelm.templates has no __file__ attribute — it became a namespace "
        "package. Wheels would not bundle the templates' data files. "
        "Restore forgelm/templates/__init__.py."
    )
    init_path = Path(init_file)
    assert init_path.is_file(), (
        f"forgelm.templates.__init__.py missing at {init_path}; templates would not be importable from a wheel install."
    )
    assert init_path.name == "__init__.py"


def test_each_template_directory_is_discoverable_via_importlib_resources() -> None:
    """Every registered template's bundled assets must resolve via importlib.resources."""

    root = ir.files("forgelm.templates")
    for name, template in TEMPLATES.items():
        config_resource = root / name / "config.yaml"
        assert config_resource.is_file(), (
            f"Template '{name}' missing config.yaml as a package resource — package_data globs likely fail to ship it."
        )
        if template.bundled_dataset:
            dataset_resource = root / name / "data.jsonl"
            assert dataset_resource.is_file(), (
                f"Template '{name}' advertises bundled_dataset=True but data.jsonl is not packaged as a resource."
            )


def test_top_level_licenses_md_is_packaged() -> None:
    """The top-level LICENSES.md inside forgelm/templates/ must ship in the wheel."""

    licenses_resource = ir.files("forgelm.templates") / "LICENSES.md"
    assert licenses_resource.is_file(), (
        "forgelm/templates/LICENSES.md is not packaged — top-level *.md "
        "glob in [tool.setuptools.package-data] may be missing."
    )


def test_domain_expert_readme_is_packaged() -> None:
    """The domain-expert README explains the BYOD flow and must travel with the wheel."""

    readme_resource = ir.files("forgelm.templates") / "domain-expert" / "README.md"
    assert readme_resource.is_file(), (
        "forgelm/templates/domain-expert/README.md is not packaged — subdirectory */*.md glob may be missing."
    )


def test_pyproject_package_data_globs_cover_every_extension() -> None:
    """Guard against accidental removal of the package_data globs.

    We assert (a) the ``forgelm.templates`` key exists and (b) the four
    glob patterns we rely on are all present. Any future edit that drops
    one of these patterns will trip this test before it ships a broken
    wheel.
    """

    try:
        import tomllib  # type: ignore[import-not-found]
    except ModuleNotFoundError:  # pragma: no cover — Python <3.11 fallback
        try:
            import tomli as tomllib  # type: ignore[import-not-found, no-redef]
        except ModuleNotFoundError:
            pytest.skip("Neither tomllib (3.11+) nor tomli is available; package_data glob assertion skipped.")

    pyproject_path = Path(__file__).resolve().parent.parent / "pyproject.toml"
    assert pyproject_path.is_file(), f"pyproject.toml not found at {pyproject_path}"

    with pyproject_path.open("rb") as fh:
        pyproject = tomllib.load(fh)

    package_data = pyproject.get("tool", {}).get("setuptools", {}).get("package-data", {})
    assert "forgelm.templates" in package_data, (
        "[tool.setuptools.package-data] is missing the 'forgelm.templates' key; "
        "wheel installs would not bundle quickstart assets."
    )

    globs = package_data["forgelm.templates"]
    required_patterns = {"*.md", "*/*.yaml", "*/*.jsonl", "*/*.md"}
    missing = required_patterns - set(globs)
    assert not missing, (
        f"package_data['forgelm.templates'] is missing required glob(s): {sorted(missing)}. Present: {sorted(globs)}."
    )