`b1be33a`

tests: move sway_json helper tests to tests/unit/export/ so the export coverage gate sees them

Authored by mfwolffe <wolffemf@dukes.jmu.edu> 2 weeks ago

SHA: b1be33aad5a06ff95c1219d79202ccc33b8c5f65
Parents: be573f9
Tree: 7e3e7af

2 changed files

Status	File	+	-
M	`tests/unit/cli/test_export_sway_json.py`	16	164
C	`tests/unit/export/test_sway_json.py`	0	0

tests/unit/cli/test_export_sway_json.pymodified

--"""Sprint 26 X1 — `dlm export --emit-sway-json` test coverage.
++"""Sprint 26 X1 — CLI-flag wiring for `dlm export --emit-sway-json`.
--
++
--Two scopes here, both unit-level:
++The helper-module unit tests (``write_sway_json`` round-trip + every
--
++error path) live at ``tests/unit/export/test_sway_json.py`` so the
--1. The helper module (``dlm.export.sway_json.write_sway_json``)
++``Coverage gate — src/dlm/export = 100%`` job (which runs only
--   round-trips a synthetic ``.dlm`` document into a ``sway.yaml`` on
++``tests/unit/export``) sees them. This file owns the CLI-surface
--   disk. Stubs the dlm-sway dependency via ``sys.modules`` injection
++half: the flag is registered, shows up in ``--help``, and carries
--   so the test runs without the real ``[sway]`` extra installed.
++the sprint-specified text.
--
--2. The CLI flag (``--emit-sway-json``) is wired into ``dlm export``
--   with the right help text, and the typed
--   :class:`SwayJsonExportError` surfaces a clear message when
--   dlm-sway isn't installed.
--
--End-to-end against the real ``dlm-sway`` package (running ``sway run``
--on the emitted yaml) lives in the sway repo as
--``tests/integration/test_dlm_sway_json_export.py`` once both PRs are
--mergeable — see the sprint file's coordination notes.
  """
  from __future__ import annotations
--import sys
++import re
--import types
--from pathlib import Path
--
--import pytest
--
--from dlm.export.sway_json import SwayJsonExportError, write_sway_json
--
--
--def _install_fake_dlm_sway(monkeypatch: pytest.MonkeyPatch) -> None:
--    """Inject minimal `dlm_sway.integrations.dlm.{autogen,resolver}`
--    modules so write_sway_json runs without the real extra installed.
--
--    The fakes return shapes the real autogen produces so the helper
--    can write a syntactically-valid YAML.
--    """
--    dlm_sway = types.ModuleType("dlm_sway")
--    integrations = types.ModuleType("dlm_sway.integrations")
--    integrations_dlm = types.ModuleType("dlm_sway.integrations.dlm")
--    autogen = types.ModuleType("dlm_sway.integrations.dlm.autogen")
--    resolver = types.ModuleType("dlm_sway.integrations.dlm.resolver")
--
--    class _FakeHandle:
--        dlm_id = "01TEST"
--
--    def _resolve_dlm(_path: Path) -> _FakeHandle:
--        return _FakeHandle()
--
--    def _build_spec_dict(_handle: _FakeHandle, *, dlm_source: str) -> dict[str, object]:
--        return {
--            "version": 1,
--            "models": {
--                "base": {"kind": "hf", "base": "smollm2-135m"},
--                "ft": {"kind": "hf", "base": "smollm2-135m"},
--            },
--            "defaults": {"seed": 0},
--            "suite": [
--                {"name": "dk", "kind": "delta_kl", "prompts": ["x"]},
--            ],
--            "dlm_source": dlm_source,
--        }
--
--    resolver.resolve_dlm = _resolve_dlm  # type: ignore[attr-defined]
--    autogen.build_spec_dict = _build_spec_dict  # type: ignore[attr-defined]
--
--    monkeypatch.setitem(sys.modules, "dlm_sway", dlm_sway)
--    monkeypatch.setitem(sys.modules, "dlm_sway.integrations", integrations)
--    monkeypatch.setitem(sys.modules, "dlm_sway.integrations.dlm", integrations_dlm)
--    monkeypatch.setitem(sys.modules, "dlm_sway.integrations.dlm.autogen", autogen)
--    monkeypatch.setitem(sys.modules, "dlm_sway.integrations.dlm.resolver", resolver)
--
--
--class TestWriteSwayJson:
--    def test_writes_yaml_in_export_dir(
--        self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
--    ) -> None:
--        """Helper writes ``<export_dir>/sway.yaml`` and returns the path."""
--        _install_fake_dlm_sway(monkeypatch)
--        dlm_path = tmp_path / "doc.dlm"
--        dlm_path.write_text("---\ndlm_id: 01TEST\n---\nbody\n", encoding="utf-8")
--        export_dir = tmp_path / "export"
--        export_dir.mkdir()
--
--        out = write_sway_json(dlm_path, export_dir)
--        assert out == export_dir / "sway.yaml"
++from typer.testing import CliRunner
--        assert out.exists()
--        # Structural check on the emitted YAML — the test's fake
--        # ``build_spec_dict`` returned a delta_kl probe.
--        content = out.read_text(encoding="utf-8")
--        assert "version: 1" in content
--        assert "delta_kl" in content
--        assert "dlm_source:" in content
--    def test_creates_export_dir_if_missing(
++from dlm.cli.app import app
--        self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
--    ) -> None:
--        """Caller may pass a non-existent export_dir — helper mkdirs."""
--        _install_fake_dlm_sway(monkeypatch)
--        dlm_path = tmp_path / "doc.dlm"
--        dlm_path.write_text("---\ndlm_id: 01\n---\n", encoding="utf-8")
--        export_dir = tmp_path / "fresh" / "nested" / "export"
--        # NOT mkdir'd — helper should create.
--
--        out = write_sway_json(dlm_path, export_dir)
--        assert out.exists()
--        assert export_dir.is_dir()
--
--    def test_dlm_sway_missing_raises_typed_error(
--        self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
--    ) -> None:
--        """ImportError on dlm_sway → SwayJsonExportError with install hint."""
--        # Wipe any cached dlm_sway modules so the import lookup re-fires.
--        for mod in list(sys.modules):
--            if mod == "dlm_sway" or mod.startswith("dlm_sway."):
--                monkeypatch.delitem(sys.modules, mod, raising=False)
--
--        # Block the import so the lazy import inside write_sway_json fails.
--        import builtins
--
--        real_import = builtins.__import__
--
--        def fake_import(name: str, *args: object, **kwargs: object) -> object:
--            if name.startswith("dlm_sway"):
--                raise ImportError("dlm-sway not installed (test stub)")
--            return real_import(name, *args, **kwargs)
--
--        monkeypatch.setattr(builtins, "__import__", fake_import)
--
--        dlm_path = tmp_path / "doc.dlm"
--        dlm_path.write_text("---\ndlm_id: 01\n---\n", encoding="utf-8")
--
--        with pytest.raises(SwayJsonExportError, match="pip install 'dlm\\[sway\\]'"):
--            write_sway_json(dlm_path, tmp_path / "export")
--
--    def test_autogen_failure_wrapped_in_typed_error(
--        self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
--    ) -> None:
--        """A sway-side parse error during build_spec_dict wraps to
--        SwayJsonExportError so the dlm CLI sees a familiar exception
--        family."""
--        # Install a dlm_sway whose build_spec_dict explodes.
--        _install_fake_dlm_sway(monkeypatch)
--        from dlm_sway.integrations.dlm import (
--            autogen as fake_autogen,  # type: ignore[import-not-found]
--        )
--
--        def _raise(*_a: object, **_kw: object) -> dict[str, object]:
--            raise RuntimeError("intentional autogen blowup for test")
--
--        monkeypatch.setattr(fake_autogen, "build_spec_dict", _raise)
--
--        dlm_path = tmp_path / "doc.dlm"
--        dlm_path.write_text("---\ndlm_id: 01\n---\n", encoding="utf-8")
--        with pytest.raises(SwayJsonExportError, match="intentional autogen blowup"):
--            write_sway_json(dlm_path, tmp_path / "export")
  class TestExportCliFlagWiring:
--    """The ``--emit-sway-json`` flag is registered on the CLI with the
--    sprint-specified help text. Smoke-level — flag presence + help."""
--
      def test_flag_present_in_export_help(self) -> None:
--        from typer.testing import CliRunner
++        """``--emit-sway-json`` flag appears in ``dlm export --help``."""
--
--        from dlm.cli.app import app
--
          # Force a wide terminal so typer/Rich don't wrap the long
          # ``--emit-sway-json`` flag across lines (CI's runner has a
          # narrow default that breaks substring asserts).
          runner = CliRunner(env={"COLUMNS": "200", "TERM": "dumb"})
          result = runner.invoke(app, ["export", "--help"])
          assert result.exit_code == 0, result.output
--        # Strip any ANSI escapes so a substring match is robust to
--        # color codes inserted at arbitrary positions.
--        import re
++        # Strip ANSI escapes + collapse whitespace so substring asserts
++        # are robust to color codes and any wrap that COLUMNS=200 still
++        # leaves in place.
          plain = re.sub(r"\x1b\[[0-9;]*m", "", result.output)
--        # Collapse whitespace so wrap-induced line breaks within the
--        # flag name still match — belt + braces with the COLUMNS env.
          plain = re.sub(r"\s+", " ", plain)
++
          assert "--emit-sway-json" in plain, plain
          assert "sway.yaml" in plain, plain

tests/unit/cli/test_export_sway_json.py → tests/unit/export/test_sway_json.pycopied (65% similarity)

--"""Sprint 26 X1 — `dlm export --emit-sway-json` test coverage.
++"""Sprint 26 X1 — `dlm.export.sway_json` helper-module unit tests.
--Two scopes here, both unit-level:
++Exists at this path (rather than under ``tests/unit/cli/``) because
++CI's ``Coverage gate — src/dlm/export = 100%`` runs ``pytest tests/unit/export``
++exclusively. Without these tests in this dir, ``sway_json.py``'s
++coverage shows 0% under the gate even though the CLI-side tests
++exercise everything.
--1. The helper module (``dlm.export.sway_json.write_sway_json``)
++The CLI-flag-wiring test (``--emit-sway-json`` shows up in
--   round-trips a synthetic ``.dlm`` document into a ``sway.yaml`` on
++``dlm export --help``) lives at ``tests/unit/cli/test_export_sway_json.py``
--   disk. Stubs the dlm-sway dependency via ``sys.modules`` injection
++because it touches the CLI surface, not just the helper.
--   so the test runs without the real ``[sway]`` extra installed.
--
--2. The CLI flag (``--emit-sway-json``) is wired into ``dlm export``
--   with the right help text, and the typed
--   :class:`SwayJsonExportError` surfaces a clear message when
--   dlm-sway isn't installed.
--
--End-to-end against the real ``dlm-sway`` package (running ``sway run``
--on the emitted yaml) lives in the sway repo as
--``tests/integration/test_dlm_sway_json_export.py`` once both PRs are
--mergeable — see the sprint file's coordination notes.
  """
  from __future__ import annotations
  def _install_fake_dlm_sway(monkeypatch: pytest.MonkeyPatch) -> None:
      """Inject minimal `dlm_sway.integrations.dlm.{autogen,resolver}`
--    modules so write_sway_json runs without the real extra installed.
++    modules so write_sway_json runs without the real ``[sway]`` extra
--
++    installed. Mirrors the fakes in ``tests/unit/cli/test_export_sway_json.py``
--    The fakes return shapes the real autogen produces so the helper
++    so the helper-module surface is exercised independently of the
--    can write a syntactically-valid YAML.
++    CLI flag wiring test.
      """
      dlm_sway = types.ModuleType("dlm_sway")
      integrations = types.ModuleType("dlm_sway.integrations")
      monkeypatch.setitem(sys.modules, "dlm_sway.integrations.dlm.resolver", resolver)
--class TestWriteSwayJson:
++class TestWriteSwayJsonHelper:
      def test_writes_yaml_in_export_dir(
          self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
      ) -> None:
          assert out == export_dir / "sway.yaml"
          assert out.exists()
--        # Structural check on the emitted YAML — the test's fake
--        # ``build_spec_dict`` returned a delta_kl probe.
          content = out.read_text(encoding="utf-8")
          assert "version: 1" in content
          assert "delta_kl" in content
      def test_creates_export_dir_if_missing(
          self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
      ) -> None:
--        """Caller may pass a non-existent export_dir — helper mkdirs."""
++        """Caller may pass a non-existent export_dir — helper mkdirs it."""
          _install_fake_dlm_sway(monkeypatch)
          dlm_path = tmp_path / "doc.dlm"
          dlm_path.write_text("---\ndlm_id: 01\n---\n", encoding="utf-8")
          export_dir = tmp_path / "fresh" / "nested" / "export"
--        # NOT mkdir'd — helper should create.
          out = write_sway_json(dlm_path, export_dir)
          assert out.exists()
          self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
      ) -> None:
          """ImportError on dlm_sway → SwayJsonExportError with install hint."""
--        # Wipe any cached dlm_sway modules so the import lookup re-fires.
          for mod in list(sys.modules):
              if mod == "dlm_sway" or mod.startswith("dlm_sway."):
                  monkeypatch.delitem(sys.modules, mod, raising=False)
--        # Block the import so the lazy import inside write_sway_json fails.
          import builtins
          real_import = builtins.__import__
      def test_autogen_failure_wrapped_in_typed_error(
          self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
      ) -> None:
--        """A sway-side parse error during build_spec_dict wraps to
++        """A sway-side error during build_spec_dict wraps to
          SwayJsonExportError so the dlm CLI sees a familiar exception
          family."""
--        # Install a dlm_sway whose build_spec_dict explodes.
          _install_fake_dlm_sway(monkeypatch)
          from dlm_sway.integrations.dlm import (
              autogen as fake_autogen,  # type: ignore[import-not-found]
          dlm_path.write_text("---\ndlm_id: 01\n---\n", encoding="utf-8")
          with pytest.raises(SwayJsonExportError, match="intentional autogen blowup"):
              write_sway_json(dlm_path, tmp_path / "export")
--
--
--class TestExportCliFlagWiring:
--    """The ``--emit-sway-json`` flag is registered on the CLI with the
--    sprint-specified help text. Smoke-level — flag presence + help."""
--
--    def test_flag_present_in_export_help(self) -> None:
--        from typer.testing import CliRunner
--
--        from dlm.cli.app import app
--
--        # Force a wide terminal so typer/Rich don't wrap the long
--        # ``--emit-sway-json`` flag across lines (CI's runner has a
--        # narrow default that breaks substring asserts).
--        runner = CliRunner(env={"COLUMNS": "200", "TERM": "dumb"})
--        result = runner.invoke(app, ["export", "--help"])
--        assert result.exit_code == 0, result.output
--        # Strip any ANSI escapes so a substring match is robust to
--        # color codes inserted at arbitrary positions.
--        import re
--
--        plain = re.sub(r"\x1b\[[0-9;]*m", "", result.output)
--        # Collapse whitespace so wrap-induced line breaks within the
--        # flag name still match — belt + braces with the COLUMNS env.
--        plain = re.sub(r"\s+", " ", plain)
--        assert "--emit-sway-json" in plain, plain
--        assert "sway.yaml" in plain, plain