vh
f99faabb80
A custom index.html is returned verbatim, so booth.html's asks panel never rendered there — a valid ask (emmie-anchor/anchor.ask.json) was listed by the CLI and shown nowhere, with nothing to say so. - panel extracted to _asks.html; new GET /b/<name>/asks standalone page - verbatim pages get an amber '? N open asks' chip beside the back chip - POST /answer honours back=asks so answering returns to that page - single-question asks now keep an optional 'title' (was silently dropped) - README + routes table; 8 regression tests; v0.1.12
384 lines
15 KiB
Python
384 lines
15 KiB
Python
"""Asks: session poses a multiple-choice question; operator answers in the
|
|
browser; the answer lands as a sidecar the session reads."""
|
|
import json
|
|
import pathlib
|
|
|
|
import pytest
|
|
from fastapi.testclient import TestClient
|
|
|
|
from booth.app import build_gallery, create_app, list_booths
|
|
from booth.asks import (
|
|
ANSWER_SUFFIX,
|
|
ASK_SUFFIX,
|
|
AskError,
|
|
list_asks,
|
|
load_ask,
|
|
normalize_ask,
|
|
read_answer,
|
|
write_answer,
|
|
write_ask,
|
|
)
|
|
|
|
|
|
def _ask(booth, stem="winner", **kw):
|
|
doc = {"prompt": "Which render wins?", "options": ["A — baseline", "B — async"]}
|
|
doc.update(kw)
|
|
booth.mkdir(parents=True, exist_ok=True)
|
|
(booth / f"{stem}{ASK_SUFFIX}").write_text(json.dumps(doc))
|
|
return booth
|
|
|
|
|
|
@pytest.fixture
|
|
def client(tmp_path):
|
|
app = create_app(tmp_path, ttl_hours=24, start_sweeper=False)
|
|
return TestClient(app), tmp_path
|
|
|
|
|
|
# ---- normalisation ----------------------------------------------------------
|
|
|
|
|
|
def test_normalize_string_options():
|
|
a = normalize_ask({"prompt": " Pick ", "options": ["x", "y"]}, "s")
|
|
assert a["prompt"] == "Pick"
|
|
assert a["options"] == [{"id": "x", "label": "x", "detail": ""}, {"id": "y", "label": "y", "detail": ""}]
|
|
assert a["notes"] is True and a["notes_label"] == "notes"
|
|
|
|
|
|
def test_normalize_object_options_and_flags():
|
|
a = normalize_ask(
|
|
{"prompt": "p", "options": [{"id": "a", "label": "A", "detail": "d"}, {"label": "B"}],
|
|
"notes": False, "notes_label": "why"},
|
|
"s",
|
|
)
|
|
assert a["options"][0] == {"id": "a", "label": "A", "detail": "d"}
|
|
assert a["options"][1] == {"id": "B", "label": "B", "detail": ""}
|
|
assert a["notes"] is False and a["notes_label"] == "why"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"doc",
|
|
[
|
|
{"options": ["a", "b"]},
|
|
{"prompt": "", "options": ["a", "b"]},
|
|
{"prompt": "p", "options": ["only"]},
|
|
{"prompt": "p", "options": "a,b"},
|
|
{"prompt": "p", "options": ["a", "a"]},
|
|
{"prompt": "p", "options": [{"id": "a"}, "b"]},
|
|
{"prompt": "p", "options": ["a", "b"], "notes": "yes"},
|
|
[],
|
|
],
|
|
)
|
|
def test_normalize_rejects(doc):
|
|
with pytest.raises(AskError):
|
|
normalize_ask(doc, "s")
|
|
|
|
|
|
# ---- files ------------------------------------------------------------------
|
|
|
|
|
|
def test_load_ask_reports_bad_json(tmp_path):
|
|
(tmp_path / f"x{ASK_SUFFIX}").write_text("{not json")
|
|
with pytest.raises(AskError):
|
|
load_ask(tmp_path, "x")
|
|
with pytest.raises(AskError):
|
|
load_ask(tmp_path, "missing")
|
|
|
|
|
|
def test_list_asks_folds_answer_and_surfaces_errors(tmp_path):
|
|
_ask(tmp_path, "one")
|
|
_ask(tmp_path, "two")
|
|
(tmp_path / f"broken{ASK_SUFFIX}").write_text("[]")
|
|
(tmp_path / ".hidden.ask.json").write_text("{}") # dotfiles never listed
|
|
write_answer(tmp_path, "two", "B — async", "less banding", who="10.0.0.1")
|
|
|
|
asks = list_asks(tmp_path)
|
|
by = {a["stem"]: a for a in asks}
|
|
assert set(by) == {"one", "two", "broken"}
|
|
assert by["one"]["answer"] is None and by["one"]["error"] is None
|
|
assert by["two"]["answer"]["choice"] == "B — async"
|
|
assert by["two"]["answer"]["choice_index"] == 1
|
|
assert by["two"]["answer"]["notes"] == "less banding"
|
|
assert by["two"]["answer"]["answered_by"] == "10.0.0.1"
|
|
assert by["broken"]["error"] and by["broken"]["options"] == []
|
|
|
|
|
|
def test_write_answer_validates_choice_and_is_atomic(tmp_path):
|
|
_ask(tmp_path)
|
|
with pytest.raises(AskError):
|
|
write_answer(tmp_path, "winner", "C — nope")
|
|
with pytest.raises(AskError):
|
|
write_answer(tmp_path, "nosuch", "A — baseline")
|
|
ans = write_answer(tmp_path, "winner", "A — baseline", " ok \r\n")
|
|
assert ans["notes"] == "ok"
|
|
assert ans["answered_at"]
|
|
assert read_answer(tmp_path, "winner") == ans
|
|
assert not (tmp_path / f"winner{ANSWER_SUFFIX}.tmp").exists()
|
|
# re-answer overwrites — the sidecar is the CURRENT answer, not a log
|
|
write_answer(tmp_path, "winner", "B — async")
|
|
assert read_answer(tmp_path, "winner")["choice_index"] == 1
|
|
|
|
|
|
def test_write_answer_drops_notes_when_ask_disables_them(tmp_path):
|
|
_ask(tmp_path, notes=False)
|
|
assert write_answer(tmp_path, "winner", "A — baseline", "ignored")["notes"] == ""
|
|
|
|
|
|
def test_write_ask_roundtrip_and_stem_guard(tmp_path):
|
|
p = write_ask(tmp_path / "b", "pick", "Pick one", ["x", {"id": "y", "label": "Y"}], notes=False)
|
|
assert p.name == f"pick{ASK_SUFFIX}"
|
|
a = load_ask(tmp_path / "b", "pick")
|
|
assert [o["id"] for o in a["options"]] == ["x", "y"] and a["notes"] is False
|
|
for bad in ("../x", ".hidden", "a/b", ""):
|
|
with pytest.raises(AskError):
|
|
write_ask(tmp_path / "b", bad, "p", ["a", "b"])
|
|
with pytest.raises(AskError):
|
|
write_ask(tmp_path / "b", "ok", "p", ["solo"])
|
|
|
|
|
|
# ---- gallery + index integration -------------------------------------------
|
|
|
|
|
|
def test_gallery_hides_ask_and_answer_files(tmp_path):
|
|
b = _ask(tmp_path / "b")
|
|
(b / "a.png").write_bytes(b"x")
|
|
write_answer(b, "winner", "A — baseline")
|
|
names = {it["name"] for it in build_gallery(b)}
|
|
assert names == {"a.png"}
|
|
|
|
|
|
def test_list_booths_counts_open_asks(tmp_path):
|
|
b = _ask(tmp_path / "b", "one")
|
|
_ask(b, "two")
|
|
write_answer(b, "two", "A — baseline")
|
|
(tmp_path / "plain").mkdir()
|
|
by = {x["name"]: x for x in list_booths(tmp_path, 3600)}
|
|
assert by["b"]["asks_open"] == 1 and by["b"]["asks_total"] == 2
|
|
assert by["plain"]["asks_open"] == 0 and by["plain"]["asks_total"] == 0
|
|
assert by["b"]["count"] == 0 # ask/answer files are not "items"
|
|
|
|
|
|
# ---- routes -----------------------------------------------------------------
|
|
|
|
|
|
def test_booth_page_renders_open_ask_as_form(client):
|
|
c, data = client
|
|
_ask(data / "b")
|
|
html = c.get("/b/b/").text
|
|
assert "Which render wins?" in html
|
|
assert 'type="radio"' in html and 'name="choice"' in html
|
|
assert 'value="B — async"' in html
|
|
assert 'action="/b/b/answer"' in html
|
|
assert "<textarea" in html
|
|
assert "1 open ask" in html
|
|
|
|
|
|
def test_answer_route_writes_sidecar_and_page_shows_it(client):
|
|
c, data = client
|
|
_ask(data / "b")
|
|
r = c.post("/b/b/answer", data={"ask": "winner", "choice": "B — async", "notes": "less banding"},
|
|
follow_redirects=False)
|
|
assert r.status_code == 303 and r.headers["location"] == "/b/b/#ask-winner"
|
|
ans = json.loads((data / "b" / f"winner{ANSWER_SUFFIX}").read_text())
|
|
assert ans["choice"] == "B — async" and ans["notes"] == "less banding"
|
|
assert ans["answered_by"] # TestClient's client addr
|
|
html = c.get("/b/b/").text
|
|
assert "answered" in html and "less banding" in html
|
|
assert "1 open ask" not in html
|
|
# the sidecar is fetchable over HTTP for remote sessions
|
|
assert c.get("/b/b/winner.answer.json").json()["choice"] == "B — async"
|
|
|
|
|
|
def test_answer_route_rejects_bad_choice_and_unknown_ask(client):
|
|
c, data = client
|
|
_ask(data / "b")
|
|
assert c.post("/b/b/answer", data={"ask": "winner", "choice": "Z"}).status_code == 400
|
|
assert c.post("/b/b/answer", data={"ask": "nosuch", "choice": "A — baseline"}).status_code == 404
|
|
assert c.post("/b/b/answer", data={"ask": "../x", "choice": "A — baseline"}).status_code == 404
|
|
assert not (data / "b" / f"winner{ANSWER_SUFFIX}").exists()
|
|
|
|
|
|
def test_answer_json_404s_until_answered(client):
|
|
c, data = client
|
|
_ask(data / "b")
|
|
assert c.get("/b/b/winner.answer.json").status_code == 404
|
|
|
|
|
|
def test_notes_field_hidden_when_disabled(client):
|
|
c, data = client
|
|
_ask(data / "b", notes=False)
|
|
assert "<textarea" not in c.get("/b/b/").text
|
|
|
|
|
|
def test_index_card_shows_open_ask_badge(client):
|
|
c, data = client
|
|
_ask(data / "b")
|
|
html = c.get("/").text
|
|
assert "1 ask" in html
|
|
|
|
|
|
# ---- multi-question asks ----------------------------------------------------
|
|
|
|
|
|
MULTI = {
|
|
"title": "R18 batch review",
|
|
"questions": [
|
|
{"key": "r1", "prompt": "Render 1?", "options": ["keep", "drop"], "notes": True},
|
|
{"key": "r2", "prompt": "Render 2?", "options": [{"id": "k", "label": "keep"}, {"id": "d", "label": "drop"}]},
|
|
],
|
|
"notes": True,
|
|
}
|
|
|
|
|
|
def _multi(booth, stem="batch", **kw):
|
|
doc = json.loads(json.dumps(MULTI)); doc.update(kw)
|
|
booth.mkdir(parents=True, exist_ok=True)
|
|
(booth / f"{stem}{ASK_SUFFIX}").write_text(json.dumps(doc))
|
|
return booth
|
|
|
|
|
|
def test_normalize_multi():
|
|
a = normalize_ask(MULTI, "batch")
|
|
assert a["multi"] is True and a["title"] == "R18 batch review"
|
|
assert [q["key"] for q in a["questions"]] == ["r1", "r2"]
|
|
assert a["questions"][0]["notes"] is True and a["questions"][1]["notes"] is False
|
|
assert a["questions"][1]["options"][0] == {"id": "k", "label": "keep", "detail": ""}
|
|
# single stays single, and exposes ONE question with key None
|
|
s = normalize_ask({"prompt": "p", "options": ["a", "b"]}, "s")
|
|
assert s["multi"] is False and s["questions"][0]["key"] is None
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"doc",
|
|
[
|
|
{"questions": []},
|
|
{"questions": [{"prompt": "p", "options": ["a", "b"]}]}, # no key
|
|
{"questions": [{"key": "bad key", "prompt": "p", "options": ["a", "b"]}]},
|
|
{"questions": [{"key": "x", "prompt": "p", "options": ["a", "b"]},
|
|
{"key": "x", "prompt": "q", "options": ["a", "b"]}]}, # dup key
|
|
{"questions": [{"key": "x", "prompt": "p", "options": ["only"]}]},
|
|
{"prompt": "p", "options": ["a", "b"], "questions": [{"key": "x", "prompt": "p", "options": ["a", "b"]}]},
|
|
],
|
|
)
|
|
def test_normalize_multi_rejects(doc):
|
|
with pytest.raises(AskError):
|
|
normalize_ask(doc, "s")
|
|
|
|
|
|
def test_write_answer_multi_requires_every_question(tmp_path):
|
|
_multi(tmp_path)
|
|
with pytest.raises(AskError):
|
|
write_answer(tmp_path, "batch", {"r1": "keep"}) # r2 missing
|
|
with pytest.raises(AskError):
|
|
write_answer(tmp_path, "batch", {"r1": "keep", "r2": "nope"})
|
|
with pytest.raises(AskError):
|
|
write_answer(tmp_path, "batch", "keep") # wrong shape
|
|
ans = write_answer(tmp_path, "batch", {"r1": "drop", "r2": "k"}, "overall fine",
|
|
qnotes={"r1": "banding", "r2": "ignored: notes off"})
|
|
assert list(ans["answers"]) == ["r1", "r2"]
|
|
assert ans["answers"]["r1"] == {"prompt": "Render 1?", "choice": "drop", "choice_index": 1,
|
|
"label": "drop", "notes": "banding"}
|
|
assert ans["answers"]["r2"]["choice"] == "k" and ans["answers"]["r2"]["notes"] == ""
|
|
assert ans["notes"] == "overall fine" and ans["title"] == "R18 batch review"
|
|
assert read_answer(tmp_path, "batch") == ans
|
|
|
|
|
|
def test_multi_page_and_route(client):
|
|
c, data = client
|
|
_multi(data / "b")
|
|
html = c.get("/b/b/").text
|
|
assert "R18 batch review" in html and "2 questions" in html
|
|
assert 'name="choice.r1"' in html and 'name="choice.r2"' in html
|
|
assert 'name="notes.r1"' in html and 'name="notes.r2"' not in html
|
|
assert 'name="notes"' in html
|
|
# incomplete submission → 400, nothing written
|
|
assert c.post("/b/b/answer", data={"ask": "batch", "choice.r1": "keep"}).status_code == 400
|
|
assert not (data / "b" / f"batch{ANSWER_SUFFIX}").exists()
|
|
r = c.post("/b/b/answer", data={"ask": "batch", "choice.r1": "keep", "notes.r1": "crisp",
|
|
"choice.r2": "d", "notes": "ship r1"}, follow_redirects=False)
|
|
assert r.status_code == 303
|
|
ans = c.get("/b/b/batch.answer.json").json()
|
|
assert ans["answers"]["r1"]["choice"] == "keep" and ans["answers"]["r1"]["notes"] == "crisp"
|
|
assert ans["answers"]["r2"]["choice"] == "d" and ans["notes"] == "ship r1"
|
|
html = c.get("/b/b/").text
|
|
assert "answered" in html and "crisp" in html and "ship r1" in html
|
|
|
|
|
|
def test_write_ask_accepts_full_doc(tmp_path):
|
|
write_ask(tmp_path / "b", "batch", doc=MULTI)
|
|
assert load_ask(tmp_path / "b", "batch")["multi"] is True
|
|
with pytest.raises(AskError):
|
|
write_ask(tmp_path / "b", "bad", doc={"questions": []})
|
|
|
|
|
|
# ---- verbatim-index booths ---------------------------------------------------
|
|
#
|
|
# A booth's own index.html is served VERBATIM, so the inline asks panel can never
|
|
# render on it. Found 2026-09-09 on `emmie-anchor`: a valid ask, listed by the
|
|
# CLI, invisible on the page with nothing to say so. The fix is a chip injected
|
|
# into the verbatim page plus a standalone /asks page that carries the forms.
|
|
|
|
|
|
def test_verbatim_booth_gets_an_asks_chip(client):
|
|
c, data = client
|
|
b = _ask(data / "b")
|
|
(b / "index.html").write_text("<!doctype html><title>report</title><body>hi</body>")
|
|
html = c.get("/b/b/").text
|
|
assert "hi" in html # the report is still served verbatim
|
|
assert "booth-nav-asks" in html # ...with a chip pointing at the asks
|
|
assert "1 open ask" in html
|
|
assert "/b/b/asks" in html
|
|
|
|
|
|
def test_verbatim_chip_disappears_once_answered(client):
|
|
c, data = client
|
|
b = _ask(data / "b")
|
|
(b / "index.html").write_text("<!doctype html><body>hi</body>")
|
|
write_answer(b, "winner", "A — baseline")
|
|
assert "booth-nav-asks" not in c.get("/b/b/").text
|
|
|
|
|
|
def test_verbatim_booth_without_asks_is_untouched(client):
|
|
c, data = client
|
|
(data / "b").mkdir()
|
|
(data / "b" / "index.html").write_text("<!doctype html><body>hi</body>")
|
|
assert "booth-nav-asks" not in c.get("/b/b/").text
|
|
|
|
|
|
def test_asks_page_renders_forms_and_answers_back_to_itself(client):
|
|
c, data = client
|
|
b = _ask(data / "b")
|
|
(b / "index.html").write_text("<!doctype html><body>hi</body>")
|
|
page = c.get("/b/b/asks").text
|
|
assert "Which render wins?" in page and 'type="radio"' in page
|
|
assert 'name="back" value="asks"' in page
|
|
r = c.post("/b/b/answer", data={"ask": "winner", "choice": "B — async", "back": "asks"},
|
|
follow_redirects=False)
|
|
assert r.headers["location"] == "/b/b/asks#ask-winner"
|
|
assert read_answer(b, "winner")["choice"] == "B — async"
|
|
assert "answered" in c.get("/b/b/asks").text
|
|
|
|
|
|
def test_asks_page_on_a_booth_with_none(client):
|
|
c, data = client
|
|
(data / "b").mkdir()
|
|
assert "no asks" in c.get("/b/b/asks").text
|
|
|
|
|
|
def test_asks_page_404s_for_unknown_booth(client):
|
|
c, _ = client
|
|
assert c.get("/b/nope/asks").status_code == 404
|
|
|
|
|
|
def test_single_ask_keeps_its_title(tmp_path):
|
|
a = normalize_ask({"title": "emmie — pick the anchor", "prompt": "Which?",
|
|
"options": ["a", "b"]}, "s")
|
|
assert a["multi"] is False and a["title"] == "emmie — pick the anchor"
|
|
with pytest.raises(AskError):
|
|
normalize_ask({"title": 7, "prompt": "p", "options": ["a", "b"]}, "s")
|
|
|
|
|
|
def test_asks_page_shows_a_single_ask_title(client):
|
|
c, data = client
|
|
_ask(data / "b", title="emmie — pick the anchor")
|
|
assert "emmie — pick the anchor" in c.get("/b/b/asks").text
|