Files
openspec-schema/tests/test_task_tracker_archive.py
T

122 lines
5.4 KiB
Python

"""Check the binding's storage contract with the real CLI; no tracker calls."""
import json
import shutil
import subprocess
import tempfile
import unittest
from pathlib import Path
OPENSPEC = shutil.which("openspec")
SCHEMA_DIR = Path(__file__).resolve().parents[1] / "openspec/schemas/use-case-driven"
@unittest.skipUnless(OPENSPEC, "OpenSpec CLI is not installed")
class TaskTrackerArchiveTests(unittest.TestCase):
def setUp(self) -> None:
self.temp_dir = tempfile.TemporaryDirectory()
self.project = Path(self.temp_dir.name).resolve()
self.root = self.project / "openspec"
shutil.copytree(SCHEMA_DIR, self.root / "schemas/use-case-driven",
ignore=shutil.ignore_patterns("__pycache__"))
(self.root / "config.yaml").write_text("schema: use-case-driven\n")
(self.root / "specs").mkdir()
def tearDown(self) -> None:
self.temp_dir.cleanup()
def create_change(self, change_id: str) -> tuple[Path, bytes]:
change = self.root / "changes" / change_id
change.mkdir(parents=True)
(change / ".openspec.yaml").write_text(
"schema: use-case-driven\ncreated: '2026-10-14'\nskip_specs: true\n"
)
(change / "proposal.md").write_text(
"## Why\nImprove tooling.\n\n## What Changes\nUpdate instructions.\n"
"\n## Capabilities\nNo behavior changes.\n\n## Impact\nDocumentation.\n"
)
(change / "tasks.md").write_text("## 1. Documentation\n- [x] 1.1 Update\n")
binding = {
"version": 1, "change_id": change_id,
"project_key": "EXAMPLE", "application_label": "order-service",
"task_id": "opaque-id/123", "task_url": "https://tracker.example/task/123",
"sync": {"pending": "close", "last_error": "MCP unavailable"},
"worklog": [{"id": "session-1", "date": "2026-10-14", "minutes": 25,
"description": "Proposal", "status": "recorded"}],
}
# JSON is valid YAML; the test needs only the standard library.
content = json.dumps(binding, ensure_ascii=False, indent=2).encode()
(change / "task-tracker.yaml").write_bytes(content)
return change, content
def archive(self, change_id: str) -> tuple[subprocess.CompletedProcess, dict]:
result = subprocess.run(
[OPENSPEC, "archive", change_id, "--yes", "--json"],
cwd=self.project, capture_output=True, text=True, timeout=30,
)
self.assertTrue(result.stdout, result.stderr)
return result, json.loads(result.stdout)
def test_archive_moves_binding_and_pending_sync_then_retry_preserves_it(self) -> None:
change_id = "improve-order-validation"
change, content = self.create_change(change_id)
result, output = self.archive(change_id)
self.assertEqual(result.returncode, 0, result.stderr + result.stdout)
archived = Path(output["archive"]["path"])
self.assertFalse(change.exists())
self.assertEqual((archived / "task-tracker.yaml").read_bytes(), content)
# A fresh session can find the original ID without interpreting the archive name.
matches = [path for path in (self.root / "changes/archive").glob("*/task-tracker.yaml")
if json.loads(path.read_text())["change_id"] == change_id]
self.assertEqual(matches, [archived / "task-tracker.yaml"])
retry, _ = self.archive(change_id)
self.assertNotEqual(retry.returncode, 0)
self.assertEqual(matches[0].read_bytes(), content)
def test_archive_preserves_change_id_that_already_starts_with_date(self) -> None:
change_id = "2026-10-01-improve-validation"
_, content = self.create_change(change_id)
result, output = self.archive(change_id)
self.assertEqual(result.returncode, 0, result.stderr + result.stdout)
archived = Path(output["archive"]["path"])
self.assertEqual((archived / "task-tracker.yaml").read_bytes(), content)
self.assertEqual(json.loads(content)["change_id"], change_id)
def test_failed_validation_retains_active_binding_and_pending_sync(self) -> None:
change, content = self.create_change("invalid-change")
specs = change / "specs"
specs.mkdir()
(specs / "spec.md").write_text("## ADDED Requirements\nInvalid root spec.\n")
result, output = self.archive(change.name)
self.assertNotEqual(result.returncode, 0)
self.assertIsNone(output["archive"])
self.assertEqual((change / "task-tracker.yaml").read_bytes(), content)
self.assertEqual(list((self.root / "changes").glob("archive/*/task-tracker.yaml")), [])
def test_archive_collision_retains_both_bindings(self) -> None:
change, content = self.create_change("2026-10-01-existing-name")
archived = self.root / "changes/archive" / change.name
archived.mkdir(parents=True)
previous_binding = b'{"change_id": "earlier", "task_id": "other-task"}'
(archived / "task-tracker.yaml").write_bytes(previous_binding)
result, output = self.archive(change.name)
self.assertNotEqual(result.returncode, 0)
self.assertIsNone(output["archive"])
self.assertEqual((change / "task-tracker.yaml").read_bytes(), content)
self.assertEqual((archived / "task-tracker.yaml").read_bytes(), previous_binding)
if __name__ == "__main__":
unittest.main()