Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions scripts/devstream/entries.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import json
import os
from pathlib import Path
from typing import Literal, TypedDict
from typing import Literal, TypedDict, get_args

DATA = Path(__file__).resolve().parents[2] / "data"
DEFAULT_PATH = str(DATA / "entries.json")

STATUSES = ("live", "warned", "flagged", "hidden", "archived", "superseded")
Status = Literal["live", "warned", "flagged", "hidden", "archived", "superseded"]
STATUSES: tuple[str, ...] = get_args(Status)


class Entry(TypedDict):
Expand All @@ -16,7 +18,7 @@ class Entry(TypedDict):
submitted_by: str
submitted_at: str
issue: int
status: Literal["live", "warned", "flagged", "hidden", "archived", "superseded"]
status: Status
warned_at: str | None
superseded_by: str | None
added_by_seed: bool
Expand Down Expand Up @@ -44,9 +46,13 @@ def load(path: str = DEFAULT_PATH) -> list[Entry]:

def save(entries: list[Entry], path: str = DEFAULT_PATH) -> None:
doc = {"version": 1, "entries": sorted(entries, key=sort_key)}
Path(path).write_text(
json.dumps(doc, indent=2, ensure_ascii=False) + "\n", encoding="utf-8"
)
# Written beside the target and renamed over it, so a crash mid-write never leaves half a file.
tmp = Path(f"{path}.tmp")
try:
tmp.write_text(json.dumps(doc, indent=2, ensure_ascii=False) + "\n", encoding="utf-8")
os.replace(tmp, path)
finally:
tmp.unlink(missing_ok=True)


def find(entries: list[Entry], repo: str) -> Entry | None:
Expand Down
56 changes: 49 additions & 7 deletions scripts/tests/test_entries.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import json
import os
import tempfile
import zlib
import unittest
from pathlib import Path

from unittest import mock

from scripts.devstream import entries as E
from scripts.validate_data import validate
from scripts.validate_data import main, validate


def make(repo="foo/bar", **kw):
Expand Down Expand Up @@ -55,14 +58,33 @@ def test_validate_rejects_unsorted(self):

def test_validate_field_checks(self):
self.assertEqual(validate([]), [])
self.assertTrue(validate([make(status="bogus")]))
self.assertTrue(validate([make("bad repo")]))
self.assertTrue(validate([make("alice/tool\n")]))
self.assertTrue(validate([make(submitted_at="2026-11-05")]))
self.assertTrue(validate([make(issue=True)]))
self.assertEqual(validate([make(status="bogus")]), ["entry 0 (foo/bar): unknown status 'bogus'"])
self.assertEqual(validate([make("bad repo")]), ["entry 0 (bad repo): bad repo format"])
self.assertEqual(validate([make("alice/tool\n")]), ["entry 0 (alice/tool\n): bad repo format"])
self.assertEqual(validate([make(submitted_at="2026-11-05")]),
["entry 0 (foo/bar): submitted_at must be ISO-8601 UTC (…Z)"])
self.assertEqual(validate([make(issue=True)]), ["entry 0 (foo/bar): issue must be int"])
self.assertEqual(validate([make(extra=1)]), ["entry 0 (foo/bar): unknown field extra"])
e = make()
del e["description"]
self.assertTrue(validate([e]))
self.assertEqual(validate([e]), ["entry 0 (foo/bar): missing description"])

def test_every_status_is_valid_and_matches_the_schema(self):
for s in E.STATUSES:
self.assertEqual(validate([make(status=s)]), [], s)
schema = json.loads((Path(E.DATA) / "schema.json").read_text(encoding="utf-8"))
self.assertEqual(tuple(schema["$defs"]["entry"]["properties"]["status"]["enum"]), E.STATUSES)

def test_save_leaves_the_old_file_when_the_write_fails(self):
with tempfile.TemporaryDirectory() as d:
p = str(Path(d) / "e.json")
E.save([make("a/x")], p)
before = Path(p).read_text(encoding="utf-8")
with mock.patch("scripts.devstream.entries.os.replace", side_effect=OSError("disk full")):
with self.assertRaises(OSError):
E.save([make("b/y")], p)
self.assertEqual(Path(p).read_text(encoding="utf-8"), before)
self.assertEqual(os.listdir(d), ["e.json"])

def test_validate_requires_a_positive_repo_id(self):
e = make()
Expand All @@ -82,6 +104,26 @@ def test_validate_rejects_description_the_filter_would_change(self):
errors = validate([make(description=bad)])
self.assertTrue(any("description" in e for e in errors), bad)

def test_cli_exit_codes_and_messages(self):
with tempfile.TemporaryDirectory() as d:
p = str(Path(d) / "e.json")
cases = [
({"version": 1, "entries": [make()]}, 0, ""),
({"version": True, "entries": [make()]}, 1, "expected {version: 1, entries: [...]}"),
({"version": 1.0, "entries": [make()]}, 1, "expected {version: 1, entries: [...]}"),
({"version": 1, "entries": {}}, 1, "expected {version: 1, entries: [...]}"),
({"version": 1}, 1, "'entries'"),
({"version": 1, "entries": [make(status="bogus")]}, 1, "entry 0 (foo/bar): unknown status 'bogus'"),
]
for doc, code, msg in cases:
Path(p).write_text(json.dumps(doc), encoding="utf-8")
with mock.patch("sys.stderr") as err:
self.assertEqual(main(["validate_data", p]), code, doc)
self.assertIn(msg, "".join(c.args[0] for c in err.write.call_args_list))
Path(p).write_text("{not json", encoding="utf-8")
with mock.patch("sys.stderr"):
self.assertEqual(main(["validate_data", p]), 1)

def test_shipped_data_passes(self):
doc = json.loads((Path(E.DEFAULT_PATH)).read_text(encoding="utf-8"))
self.assertEqual(validate(doc["entries"]), [])
Expand Down
3 changes: 2 additions & 1 deletion scripts/validate_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ def main(argv: list[str]) -> int:
with open(path, encoding="utf-8") as f:
doc = json.load(f)
entries = doc["entries"]
if doc.get("version") != 1 or not isinstance(entries, list):
# type(), not ==: True == 1 and 1.0 == 1 in Python.
if type(doc.get("version")) is not int or doc["version"] != 1 or not isinstance(entries, list):
raise ValueError("expected {version: 1, entries: [...]}")
except (OSError, ValueError, KeyError, TypeError) as exc:
print(f"{path}: {exc}", file=sys.stderr)
Expand Down
Loading