test_describe_envelope.py
file-level
1
files
1
commits
0
hotspots
0
🧊 dead
0
💥 blast risk
| 1 | """Envelope tests for describe command.""" |
| 2 | from __future__ import annotations |
| 3 | |
| 4 | import datetime |
| 5 | import json |
| 6 | import pathlib |
| 7 | from collections.abc import Mapping |
| 8 | |
| 9 | import argparse |
| 10 | import pytest |
| 11 | from tests.cli_test_helper import CliRunner |
| 12 | |
| 13 | from muse.core.ids import hash_commit, hash_snapshot |
| 14 | from muse.core.commits import CommitRecord, write_commit |
| 15 | from muse.core.snapshots import SnapshotRecord, write_snapshot |
| 16 | from muse.core.version_tags import VersionTagRecord, write_version_tag |
| 17 | from muse.core.semver import parse_semver |
| 18 | from muse.core.types import Manifest, content_hash |
| 19 | from muse.core.paths import muse_dir, ref_path |
| 20 | |
| 21 | runner = CliRunner() |
| 22 | |
| 23 | _FIELDS = ("muse_version", "schema", "timestamp", "warnings") |
| 24 | _REPO_ID = content_hash({"name": "envelope-test"}) |
| 25 | |
| 26 | |
| 27 | def _check(d: Mapping[str, object]) -> None: |
| 28 | for f in _FIELDS: |
| 29 | assert f in d, f"missing {f}" |
| 30 | assert "schema_version" not in d |
| 31 | |
| 32 | |
| 33 | def _init_repo(path: pathlib.Path) -> pathlib.Path: |
| 34 | dot_muse = muse_dir(path) |
| 35 | for d in ("commits", "snapshots", "objects", "refs/heads"): |
| 36 | (dot_muse / d).mkdir(parents=True, exist_ok=True) |
| 37 | (dot_muse / "HEAD").write_text("ref: refs/heads/main", encoding="utf-8") |
| 38 | (dot_muse / "repo.json").write_text( |
| 39 | json.dumps({"repo_id": _REPO_ID, "domain": "code"}), encoding="utf-8" |
| 40 | ) |
| 41 | return path |
| 42 | |
| 43 | |
| 44 | def _make_commit(root: pathlib.Path, parent_id: str | None = None, content: bytes = b"data") -> str: |
| 45 | manifest: Manifest = {} |
| 46 | snap_id = hash_snapshot(manifest) |
| 47 | write_snapshot(root, SnapshotRecord(snapshot_id=snap_id, manifest=manifest)) |
| 48 | committed_at = datetime.datetime.now(datetime.timezone.utc) |
| 49 | parent_ids = [parent_id] if parent_id else [] |
| 50 | commit_id = hash_commit( |
| 51 | parent_ids=parent_ids, |
| 52 | snapshot_id=snap_id, |
| 53 | message="msg", |
| 54 | committed_at_iso=committed_at.isoformat(), |
| 55 | ) |
| 56 | write_commit(root, CommitRecord( |
| 57 | commit_id=commit_id, |
| 58 | branch="main", |
| 59 | snapshot_id=snap_id, |
| 60 | message="msg", |
| 61 | committed_at=committed_at, |
| 62 | parent_commit_id=parent_id, |
| 63 | )) |
| 64 | ref_path(root, "main").write_text(commit_id, encoding="utf-8") |
| 65 | return commit_id |
| 66 | |
| 67 | |
| 68 | def _make_vtag(root: pathlib.Path, tag: str, commit_id: str) -> None: |
| 69 | write_version_tag(root, VersionTagRecord( |
| 70 | tag_id=content_hash({"tag": tag, "commit_id": commit_id}), |
| 71 | repo_id=_REPO_ID, |
| 72 | tag=tag, |
| 73 | semver=parse_semver(tag), |
| 74 | commit_id=commit_id, |
| 75 | created_at=datetime.datetime.now(datetime.timezone.utc), |
| 76 | author="", |
| 77 | message="", |
| 78 | )) |
| 79 | |
| 80 | |
| 81 | class TestDescribeEnvelope: |
| 82 | def test_describe_has_envelope_on_tag(self, tmp_path: pathlib.Path) -> None: |
| 83 | _init_repo(tmp_path) |
| 84 | cid = _make_commit(tmp_path, content=b"env-test") |
| 85 | _make_vtag(tmp_path, "v1.0.0", cid) |
| 86 | r = runner.invoke(None, ["describe", "--json"], env={"MUSE_REPO_ROOT": str(tmp_path)}) |
| 87 | assert r.exit_code == 0, r.output |
| 88 | _check(json.loads(r.output)) |
| 89 | |
| 90 | def test_describe_has_envelope_no_tag(self, tmp_path: pathlib.Path) -> None: |
| 91 | _init_repo(tmp_path) |
| 92 | _make_commit(tmp_path, content=b"no-tag") |
| 93 | r = runner.invoke(None, ["describe", "--json"], env={"MUSE_REPO_ROOT": str(tmp_path)}) |
| 94 | assert r.exit_code == 1 |
| 95 | _check(json.loads(r.output)) |
| 96 | |
| 97 | |
| 98 | # --------------------------------------------------------------------------- |
| 99 | # TestRegisterFlags — argparse-level verification |
| 100 | # --------------------------------------------------------------------------- |
| 101 | |
| 102 | |
| 103 | class TestRegisterFlags: |
| 104 | """Verify that register() wires --json / -j correctly.""" |
| 105 | |
| 106 | def _make_parser(self) -> "argparse.ArgumentParser": |
| 107 | import argparse |
| 108 | from muse.cli.commands.describe import register |
| 109 | ap = argparse.ArgumentParser() |
| 110 | subs = ap.add_subparsers() |
| 111 | register(subs) |
| 112 | return ap |
| 113 | |
| 114 | def test_json_flag_long(self) -> None: |
| 115 | ns = self._make_parser().parse_args(["describe", "--json"]) |
| 116 | assert ns.json_out is True |
| 117 | |
| 118 | def test_j_alias(self) -> None: |
| 119 | ns = self._make_parser().parse_args(["describe", "-j"]) |
| 120 | assert ns.json_out is True |
| 121 | |
| 122 | def test_default_is_text(self) -> None: |
| 123 | ns = self._make_parser().parse_args(["describe"]) |
| 124 | assert ns.json_out is False |
| 125 | |
| 126 | def test_dest_is_json_out(self) -> None: |
| 127 | ns = self._make_parser().parse_args(["describe", "-j"]) |
| 128 | assert hasattr(ns, "json_out") |
| 129 | assert not hasattr(ns, "fmt") |