askrobots / dbbasic-object-server
Public
Runs live, versioned Python application objects on one VM, with a suite of apps: projects, notes, tasks, files and more.
danq9
signup: the person chooses the password and name on the confirm page
83c7aa6
2 weeks, 5 days ago
History
test_package_attention.py · 16.0 KB · 375 lines
| 1 | """What needs a human ships with the app that knows. |
| 2 | |
| 3 | Every gate on this server ends in a pile somebody has to look at, and the |
| 4 | system has been computing those piles and discarding them for as long as |
| 5 | it has existed -- `system_scan_processor` returns a key literally named |
| 6 | `needing_a_human` that no surface has ever read. The `attention` manifest |
| 7 | section is where a package finally says what its pile MEANS, and these |
| 8 | are the properties that make saying it safe to do repeatedly. |
| 9 | |
| 10 | They are the same properties `nav` holds, for the same reasons: an |
| 11 | operator's decision outlives an upgrade, a plan that says "unchanged" |
| 12 | writes nothing, a second package cannot quietly take over a definition, |
| 13 | and a package still installs when the home-screen app is absent. The one |
| 14 | addition is the blocking check -- a counter aimed at an object that will |
| 15 | not exist reads zero forever, and a queue that reads zero forever is |
| 16 | indistinguishable from a queue that is empty. That silent failure is the |
| 17 | entire reason this section exists, so it refuses to install. |
| 18 | """ |
| 19 | |
| 20 | import json |
| 21 | import pathlib |
| 22 | |
| 23 | import pytest |
| 24 | |
| 25 | import object_packages |
| 26 | import object_records |
| 27 | |
| 28 | REPO_ROOT = pathlib.Path(__file__).resolve().parents[1] |
| 29 | PACKAGES = REPO_ROOT / "packages" |
| 30 | APP_NAV = PACKAGES / "app-nav" |
| 31 | SOURCES_SCHEMA = json.loads((APP_NAV / "schemas" / "attention_sources.json").read_text()) |
| 32 | |
| 33 | MANIFEST = { |
| 34 | "id": "app-demo", |
| 35 | "name": "Demo", |
| 36 | "version": "1.0.0", |
| 37 | "objects": [{"id": "system_demo_attention", |
| 38 | "path": "objects/system/demo_attention.py"}], |
| 39 | "schemas": [{"collection": "attention_sources", "path": "schemas/attention_sources.json"}], |
| 40 | "attention": [{"id": "demo_queue", "object_id": "system_demo_attention", |
| 41 | "label": "Demo queue", "path": "/demo?status=waiting", |
| 42 | "nav_id": "demo", "group": "Work", "severity": "warning"}], |
| 43 | } |
| 44 | |
| 45 | SOURCE = "def COUNT(request):\n return {'count': 2, 'detail': 'both today'}\n" |
| 46 | |
| 47 | |
| 48 | @pytest.fixture |
| 49 | def package(tmp_path): |
| 50 | """A one-provider package that also ships the attention_sources |
| 51 | schema, so the registry exists for it to declare into.""" |
| 52 | root = tmp_path / "packages" |
| 53 | pkg = root / "app-demo" |
| 54 | (pkg / "objects" / "system").mkdir(parents=True) |
| 55 | (pkg / "objects" / "system" / "demo_attention.py").write_text(SOURCE) |
| 56 | (pkg / "schemas").mkdir() |
| 57 | (pkg / "schemas" / "attention_sources.json").write_text(json.dumps(SOURCES_SCHEMA)) |
| 58 | (pkg / "dbbasic-package.json").write_text(json.dumps(MANIFEST)) |
| 59 | objects = tmp_path / "objects" |
| 60 | objects.mkdir() |
| 61 | data = tmp_path / "data" |
| 62 | data.mkdir() |
| 63 | return {"root": root, "dir": pkg, "objects": objects, "data": data} |
| 64 | |
| 65 | |
| 66 | def write_manifest(package, **overrides): |
| 67 | manifest = {**MANIFEST, **overrides} |
| 68 | (package["dir"] / "dbbasic-package.json").write_text(json.dumps(manifest)) |
| 69 | |
| 70 | |
| 71 | def install(package, **kwargs): |
| 72 | return object_packages.install_package( |
| 73 | "app-demo", root=package["root"], base_dir=package["data"], |
| 74 | object_roots=[package["objects"]], **kwargs) |
| 75 | |
| 76 | |
| 77 | def plan(package): |
| 78 | return object_packages.dry_run_package( |
| 79 | "app-demo", root=package["root"], base_dir=package["data"], |
| 80 | object_roots=[package["objects"]]) |
| 81 | |
| 82 | |
| 83 | def sources(package): |
| 84 | try: |
| 85 | rows = object_records.read_collection_records( |
| 86 | "attention_sources", base_dir=package["data"]) |
| 87 | except Exception: |
| 88 | return {} |
| 89 | return {row["id"]: row for row in rows} |
| 90 | |
| 91 | |
| 92 | def set_source(fixture, source_id, **changes): |
| 93 | """An operator editing a row by hand -- `fixture` rather than |
| 94 | `package` because `package` is itself one of the row's columns.""" |
| 95 | object_records.update_collection_record( |
| 96 | "attention_sources", source_id, changes, |
| 97 | base_dir=fixture["data"], actor="operator") |
| 98 | |
| 99 | |
| 100 | # --- declaring ---------------------------------------------------------------- |
| 101 | |
| 102 | def test_installing_a_package_registers_its_queue(package): |
| 103 | result = install(package) |
| 104 | assert [entry["status"] for entry in result["attention"]] == ["written"] |
| 105 | |
| 106 | row = sources(package)["demo_queue"] |
| 107 | assert row["object_id"] == "system_demo_attention" |
| 108 | assert row["label"] == "Demo queue" |
| 109 | assert row["path"] == "/demo?status=waiting" |
| 110 | assert row["nav_id"] == "demo" |
| 111 | assert row["group"] == "Work" |
| 112 | assert row["severity"] == "warning" |
| 113 | assert row["package"] == "app-demo" # provenance, stamped by install |
| 114 | assert row["operator_muted"] == "false" |
| 115 | |
| 116 | |
| 117 | def test_the_plan_says_what_it_would_declare_before_it_does(package): |
| 118 | assert plan(package)["attention"] == [{ |
| 119 | "id": "demo_queue", "object_id": "system_demo_attention", |
| 120 | "label": "Demo queue", "path": "/demo?status=waiting", "nav_id": "demo", |
| 121 | "group": "Work", "severity": "warning", |
| 122 | "exists": False, "action": "create"}] |
| 123 | assert plan(package)["package"]["attention_count"] == 1 |
| 124 | assert sources(package) == {} # a dry run writes nothing |
| 125 | |
| 126 | |
| 127 | def test_a_package_with_no_attention_touches_no_records(package): |
| 128 | write_manifest(package, attention=[]) |
| 129 | result = install(package) |
| 130 | assert result["attention"] == [] |
| 131 | assert sources(package) == {} |
| 132 | |
| 133 | |
| 134 | def test_the_defaults_are_apps_and_normal(package): |
| 135 | write_manifest(package, attention=[{ |
| 136 | "id": "demo_queue", "object_id": "system_demo_attention", |
| 137 | "label": "Demo queue", "path": "/demo"}]) |
| 138 | install(package) |
| 139 | |
| 140 | row = sources(package)["demo_queue"] |
| 141 | assert row["group"] == "Apps" |
| 142 | assert row["severity"] == "normal" |
| 143 | assert row["nav_id"] == "" # a queue may have no door |
| 144 | |
| 145 | |
| 146 | # --- surviving an upgrade ------------------------------------------------------- |
| 147 | |
| 148 | def test_reinstalling_preserves_the_operators_mute(package): |
| 149 | """The package declares what a queue MEANS; the operator decides |
| 150 | whether this deployment wants to be told about it. An upgrade that |
| 151 | silently un-mutes a counter somebody turned off is the same incident |
| 152 | as one that restarts a paused nightly pass.""" |
| 153 | install(package) |
| 154 | set_source(package, "demo_queue", operator_muted="true") |
| 155 | |
| 156 | write_manifest(package, version="1.1.0", |
| 157 | attention=[{**MANIFEST["attention"][0], "label": "Renamed"}]) |
| 158 | install(package, allow_replace=True) |
| 159 | |
| 160 | row = sources(package)["demo_queue"] |
| 161 | assert row["operator_muted"] == "true" # untouched |
| 162 | assert row["label"] == "Renamed" # but the package's word is restated |
| 163 | |
| 164 | |
| 165 | def test_reinstalling_updates_a_changed_declaration(package): |
| 166 | install(package) |
| 167 | write_manifest(package, version="1.1.0", attention=[{ |
| 168 | **MANIFEST["attention"][0], "label": "Renamed", "path": "/elsewhere", |
| 169 | "nav_id": "", "group": "System", "severity": "urgent"}]) |
| 170 | result = install(package, allow_replace=True) |
| 171 | |
| 172 | assert result["attention"][0]["action"] == "update" |
| 173 | assert result["attention"][0]["status"] == "updated" |
| 174 | row = sources(package)["demo_queue"] |
| 175 | assert (row["label"], row["path"], row["nav_id"], row["group"], row["severity"]) == ( |
| 176 | "Renamed", "/elsewhere", "", "System", "urgent") |
| 177 | |
| 178 | |
| 179 | def test_an_unchanged_entry_reports_unchanged(package): |
| 180 | install(package) |
| 181 | result = install(package, allow_replace=True) |
| 182 | assert result["attention"][0]["status"] == "unchanged" |
| 183 | assert result["attention"][0]["action"] == "unchanged" |
| 184 | |
| 185 | |
| 186 | def test_a_plan_that_says_unchanged_writes_nothing_at_all(package): |
| 187 | """Every package-owned field is compared, severity and nav_id |
| 188 | included: a dry run that under-reports is worse than no dry run.""" |
| 189 | install(package) |
| 190 | before = sources(package)["demo_queue"] |
| 191 | install(package, allow_replace=True) |
| 192 | assert sources(package)["demo_queue"] == before # byte-for-byte, created_at included |
| 193 | |
| 194 | write_manifest(package, attention=[{**MANIFEST["attention"][0], |
| 195 | "severity": "urgent"}]) |
| 196 | assert plan(package)["attention"][0]["action"] == "update" |
| 197 | install(package, allow_replace=True) |
| 198 | assert sources(package)["demo_queue"]["severity"] == "urgent" |
| 199 | |
| 200 | |
| 201 | # --- refusing what could not work ------------------------------------------------ |
| 202 | |
| 203 | def test_two_packages_cannot_own_one_definition(package): |
| 204 | """Two packages writing one row is two answers to what needs a human, |
| 205 | where whichever installed last silently wins.""" |
| 206 | install(package) |
| 207 | set_source(package, "demo_queue", package="app-other") |
| 208 | with pytest.raises(object_packages.PackageInstallError) as exc: |
| 209 | install(package, allow_replace=True) |
| 210 | assert "app-other" in str(exc.value) |
| 211 | |
| 212 | |
| 213 | def test_a_counter_pointing_at_nothing_blocks_the_install(package): |
| 214 | """A provider that will not exist reads zero forever, and a queue that |
| 215 | reads zero forever is indistinguishable from an empty one. That silent |
| 216 | failure is the reason this whole section exists.""" |
| 217 | write_manifest(package, attention=[{**MANIFEST["attention"][0], |
| 218 | "object_id": "system_not_shipped"}]) |
| 219 | with pytest.raises(object_packages.PackageInstallError) as exc: |
| 220 | install(package) |
| 221 | assert "system_not_shipped" in str(exc.value) |
| 222 | assert sources(package) == {} |
| 223 | |
| 224 | |
| 225 | def test_a_counter_may_point_at_an_object_already_on_the_server(package): |
| 226 | """A package is allowed to count somebody else's queue, as long as the |
| 227 | provider is genuinely resolvable when the plan is made.""" |
| 228 | (package["objects"] / "system_elsewhere.py").write_text(SOURCE) |
| 229 | write_manifest(package, attention=[{**MANIFEST["attention"][0], |
| 230 | "object_id": "system_elsewhere"}]) |
| 231 | result = install(package) |
| 232 | assert result["attention"][0]["status"] == "written" |
| 233 | |
| 234 | |
| 235 | def test_two_queues_may_point_at_one_list(package): |
| 236 | """Deliberately NOT a collision: an orders page is legitimately both |
| 237 | 'to pick' and 'to invoice', and refusing that would be a false |
| 238 | blocker.""" |
| 239 | write_manifest(package, attention=[ |
| 240 | MANIFEST["attention"][0], |
| 241 | {**MANIFEST["attention"][0], "id": "second_queue", "label": "Also"}, |
| 242 | ]) |
| 243 | result = install(package) |
| 244 | assert [entry["status"] for entry in result["attention"]] == ["written", "written"] |
| 245 | |
| 246 | |
| 247 | @pytest.mark.parametrize("bad, reason", [ |
| 248 | ({"id": "two words", "object_id": "system_demo_attention", "label": "X", |
| 249 | "path": "/x"}, "attention id"), |
| 250 | ({"id": "demo_queue", "object_id": "Not An Id", "label": "X", "path": "/x"}, |
| 251 | "attention object_id"), |
| 252 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X", |
| 253 | "path": "x"}, "start with"), |
| 254 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X", |
| 255 | "path": "/two words"}, "whitespace"), |
| 256 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X", |
| 257 | "path": "/x\nmore"}, "whitespace"), |
| 258 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X", |
| 259 | "path": "/x", "severity": "screaming"}, "normal|warning|urgent"), |
| 260 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X", |
| 261 | "path": "/x", "nav_id": "two words"}, "attention nav_id"), |
| 262 | ({"id": "demo_queue", "object_id": "system_demo_attention", "path": "/x"}, |
| 263 | "requires 'label'"), |
| 264 | ({"id": "demo_queue", "object_id": "system_demo_attention", "label": "X"}, |
| 265 | "requires 'path'"), |
| 266 | ({"id": "demo_queue", "label": "X", "path": "/x"}, "requires 'object_id'"), |
| 267 | ]) |
| 268 | def test_a_declaration_that_could_not_work_is_refused_at_install(package, bad, reason): |
| 269 | write_manifest(package, attention=[bad]) |
| 270 | with pytest.raises(object_packages.InvalidPackageManifestError) as exc: |
| 271 | install(package) |
| 272 | assert reason in str(exc.value) |
| 273 | assert sources(package) == {} |
| 274 | |
| 275 | |
| 276 | def test_two_attention_entries_cannot_share_an_id(package): |
| 277 | write_manifest(package, attention=[MANIFEST["attention"][0], |
| 278 | {**MANIFEST["attention"][0], "path": "/other"}]) |
| 279 | with pytest.raises(object_packages.InvalidPackageManifestError): |
| 280 | install(package) |
| 281 | |
| 282 | |
| 283 | # --- when the home-screen app is not installed ------------------------------------- |
| 284 | |
| 285 | def test_a_missing_registry_skips_gracefully_instead_of_failing(package): |
| 286 | """A package must never fail to install because the home screen is |
| 287 | absent. It says so in the result rather than pretending it wrote.""" |
| 288 | write_manifest(package, schemas=[]) |
| 289 | result = install(package) |
| 290 | |
| 291 | assert [entry["status"] for entry in result["attention"]] == ["skipped"] |
| 292 | assert "attention_sources" in result["attention"][0]["reason"] |
| 293 | assert not (package["data"] / "collections" / "attention_sources").exists() |
| 294 | |
| 295 | |
| 296 | def test_a_missing_registry_still_plans_the_entry(package): |
| 297 | write_manifest(package, schemas=[]) |
| 298 | assert plan(package)["attention"][0]["action"] == "create" |
| 299 | assert plan(package)["safe_to_install"] is True |
| 300 | |
| 301 | |
| 302 | # --- the real packages -------------------------------------------------------------- |
| 303 | |
| 304 | def _manifests(): |
| 305 | return {path.parent.name: json.loads(path.read_text()) |
| 306 | for path in sorted(PACKAGES.glob("*/dbbasic-package.json"))} |
| 307 | |
| 308 | |
| 309 | def test_shipped_attention_sources_do_not_collide_on_an_id(): |
| 310 | seen: dict[str, str] = {} |
| 311 | for package_id, manifest in _manifests().items(): |
| 312 | for entry in manifest.get("attention") or []: |
| 313 | assert entry["id"] not in seen, ( |
| 314 | f"{entry['id']} declared by both {seen.get(entry['id'])} " |
| 315 | f"and {package_id}") |
| 316 | seen[entry["id"]] = package_id |
| 317 | assert len(seen) >= 9, "the box's known queues should all be declared" |
| 318 | |
| 319 | |
| 320 | def test_every_shipped_declaration_names_a_provider_its_package_ships(): |
| 321 | """A counter aimed at an object nobody installs would block its own |
| 322 | package's install; this catches it at review time instead.""" |
| 323 | for package_id, manifest in _manifests().items(): |
| 324 | shipped = {entry["id"] for entry in manifest.get("objects", [])} |
| 325 | for entry in manifest.get("attention") or []: |
| 326 | assert entry["object_id"] in shipped, ( |
| 327 | f"{package_id} counts {entry['object_id']} but does not ship it") |
| 328 | assert entry["object_id"].endswith("_attention"), entry["object_id"] |
| 329 | |
| 330 | |
| 331 | def test_every_shipped_provider_exposes_count_and_nothing_else(): |
| 332 | """COUNT is the contract with the daemon's rollup pass. A provider |
| 333 | that answered on GET or POST instead would read as a permanent zero, |
| 334 | which is exactly the silent failure this layer exists to end.""" |
| 335 | for package_id, manifest in _manifests().items(): |
| 336 | paths = {entry["id"]: entry["path"] for entry in manifest.get("objects", [])} |
| 337 | for entry in manifest.get("attention") or []: |
| 338 | source = (PACKAGES / package_id / paths[entry["object_id"]]).read_text() |
| 339 | assert "def COUNT(request):" in source, package_id |
| 340 | assert "def POST(request):" not in source, package_id |
| 341 | |
| 342 | |
| 343 | def test_every_shipped_declaration_normalizes_and_uses_the_house_groups(): |
| 344 | groups = {"Work", "Publishing", "Money", "Commerce", "Warehouse", "System"} |
| 345 | nav_ids = {entry["id"] |
| 346 | for manifest in _manifests().values() |
| 347 | for entry in manifest.get("nav") or []} |
| 348 | for package_id in _manifests(): |
| 349 | package = object_packages.get_package(package_id, root=PACKAGES) |
| 350 | for entry in package["attention"]: |
| 351 | assert entry["group"] in groups, f"{package_id}: {entry['group']}" |
| 352 | assert entry["path"].startswith("/") |
| 353 | if entry["nav_id"]: |
| 354 | assert entry["nav_id"] in nav_ids, ( |
| 355 | f"{package_id}: {entry['id']} decorates a door nobody declares") |
| 356 | |
| 357 | |
| 358 | def test_only_a_broken_machine_is_urgent(): |
| 359 | """Severity is a scale nobody calibrates if everything claims the top |
| 360 | of it. `urgent` is reserved for the server reporting that it stopped |
| 361 | doing its own work, not for work that is merely late.""" |
| 362 | urgent = {entry["id"] |
| 363 | for manifest in _manifests().values() |
| 364 | for entry in manifest.get("attention") or [] |
| 365 | if entry.get("severity") == "urgent"} |
| 366 | assert urgent == {"scheduler_failures"} |
| 367 | |
| 368 | |
| 369 | def test_app_nav_owns_the_two_collections_and_declares_no_queue(): |
| 370 | """The home screen holds the registry and the rollup; it has no |
| 371 | domain of its own, so it has nothing that needs a human.""" |
| 372 | manifest = _manifests()["app-nav"] |
| 373 | collections = {entry["collection"] for entry in manifest["schemas"]} |
| 374 | assert {"attention_sources", "attention_counts"} <= collections |
| 375 | assert not manifest.get("attention") |