Add power endpoints and survive the emulator being off

POST /api/power/{on,off,reset,pause,resume}, and every route now tolerates there
being no emulator: /api/status reports powered:false, /frame.png returns 503,
keypresses return 409 with "press On first". Previously create_app required a live
client and the whole page would 500.

The client is fetched through the supervisor per request rather than captured once,
because a power cycle replaces it and the captured one goes stale.

After any power action the pump is rebound, so Off actually goes dark instead of
freezing on the last frame.

Off is refused with 409 for an adopted emulator: we did not start that process.
Reset is allowed either way, since system_reset ends nothing.

Verified over HTTP with a real supervisor and real QEMU:
  start     powered=False  qemu=0  frame=503
  key       409 as expected
  On        powered=True   qemu=1  frame=2920 bytes
  Reset     qemu=1 (process survived)
  Off       powered=False  qemu=0  frame=503
  On again  powered=True   qemu=1  frame=2920 bytes
The web server stayed up throughout, which is the requested behaviour.
This commit is contained in:
mckero committed 2026-08-28 06:00:50 +01:00
1 parent 71d72c2393
commit 699561794a
2 files changed
+208 -3

No files matched your search

+143
View File
@@ -268,5 +268,148 @@ class TestStreamUsesPump(unittest.TestCase):
self.assertEqual(app.test_client().get("/frame.png").status_code, 503)
class FakeSupervisor:
"""Minimal supervisor double: records calls, tracks powered state."""
def __init__(self, client=None, owns=True):
self._client = client
self._owns = owns
self.calls = []
def is_running(self):
return self._client is not None
def owns_process(self):
return self._owns
def client(self):
return self._client
def power_on(self):
self.calls.append("power_on")
if self._client is None:
self._client = StubClient()
return True
def power_off(self):
self.calls.append("power_off")
self._client = None
return True
def reset(self):
self.calls.append("reset")
if self._client is not None:
self._client.command("system_reset")
return True
def pause(self):
self.calls.append("pause")
if self._client is None:
return False
self._client.command("stop")
return True
def resume(self):
self.calls.append("resume")
if self._client is None:
return False
self._client.command("cont")
return True
def make_supervised(owns=True):
client = StubClient()
sup = FakeSupervisor(client, owns=owns)
app = webui.create_app(client, frame_addr=0x1000, status_addr=0x2000,
supervisor=sup)
app.config.update(TESTING=True)
return client, sup, app.test_client()
class TestPowerEndpoints(unittest.TestCase):
def test_reset_issues_system_reset(self):
client, sup, http = make_supervised()
resp = http.post("/api/power/reset")
self.assertEqual(resp.status_code, 200)
self.assertIn("reset", sup.calls)
self.assertIn("system_reset", [n for n, _ in client.sent])
def test_pause_and_resume(self):
client, sup, http = make_supervised()
self.assertEqual(http.post("/api/power/pause").status_code, 200)
self.assertEqual(http.post("/api/power/resume").status_code, 200)
names = [n for n, _ in client.sent]
self.assertIn("stop", names)
self.assertIn("cont", names)
def test_off_then_on(self):
_, sup, http = make_supervised()
self.assertEqual(http.post("/api/power/off").status_code, 200)
self.assertFalse(http.get("/api/status").get_json()["powered"])
self.assertEqual(http.post("/api/power/on").status_code, 200)
self.assertTrue(http.get("/api/status").get_json()["powered"])
self.assertEqual(sup.calls, ["power_off", "power_on"])
def test_unknown_action_is_rejected(self):
_, sup, http = make_supervised()
resp = http.post("/api/power/explode")
self.assertEqual(resp.status_code, 400)
self.assertEqual(sup.calls, [])
def test_off_is_refused_for_an_adopted_emulator(self):
"""We did not start that process, so killing it is not ours to do."""
_, sup, http = make_supervised(owns=False)
resp = http.post("/api/power/off")
self.assertEqual(resp.status_code, 409)
self.assertEqual(sup.calls, [])
def test_reset_is_allowed_for_an_adopted_emulator(self):
"""system_reset does not kill anything, so it is fine either way."""
_, sup, http = make_supervised(owns=False)
self.assertEqual(http.post("/api/power/reset").status_code, 200)
self.assertIn("reset", sup.calls)
def test_power_without_a_supervisor_is_409_not_500(self):
_, http = make_app()
resp = http.post("/api/power/on")
self.assertEqual(resp.status_code, 409)
class TestStatusReportsPower(unittest.TestCase):
def test_status_includes_powered(self):
_, http = make_app()
self.assertIn("powered", http.get("/api/status").get_json())
def test_status_when_powered_off_does_not_error(self):
"""The page must load with the emulator off, not 500."""
app = webui.create_app(None, frame_addr=0x1000, status_addr=0x2000)
app.config.update(TESTING=True)
http = app.test_client()
self.assertEqual(http.get("/").status_code, 200)
resp = http.get("/api/status")
self.assertEqual(resp.status_code, 200)
self.assertFalse(resp.get_json()["powered"])
def test_status_reports_unreachable_when_qmp_raises(self):
class Broken:
def command(self, name, **args):
raise RuntimeError("socket gone")
app = webui.create_app(Broken(), frame_addr=0x1000, status_addr=0x2000)
app.config.update(TESTING=True)
body = app.test_client().get("/api/status").get_json()
self.assertFalse(body["powered"])
self.assertIn("unreachable", body["status"])
class TestKeyWhenPoweredOff(unittest.TestCase):
def test_key_is_refused_with_no_emulator(self):
"""Pressing a key on a dark screen is a 409, not a crash."""
app = webui.create_app(None, frame_addr=0x1000, status_addr=0x2000)
app.config.update(TESTING=True)
resp = app.test_client().post("/api/key", json={"key": "MENU"})
self.assertEqual(resp.status_code, 409)
if __name__ == "__main__":
unittest.main()
+65 -3
View File
@@ -71,7 +71,11 @@ KEY_BINDINGS = {
}
def create_app(client, frame_addr: int, status_addr: int, scale: int = 4):
POWER_ACTIONS = ("on", "off", "reset", "pause", "resume")
def create_app(client, frame_addr: int, status_addr: int, scale: int = 4,
supervisor=None):
app = Flask(__name__)
# One background grabber for every client. client may be None: the emulator
@@ -79,9 +83,23 @@ def create_app(client, frame_addr: int, status_addr: int, scale: int = 4):
pump = FramePump(client, frame_addr, status_addr, fps=TARGET_FPS, scale=scale)
pump.start()
app.config["PUMP"] = pump
app.config["SUPERVISOR"] = supervisor
def active_client():
"""The live QMP client, or None when the emulator is off.
The supervisor is authoritative once present: it replaces the client on
every power cycle, so the one captured at create_app time goes stale.
"""
if supervisor is not None:
return supervisor.client()
return client
def set_press(value: str):
client.command("qom-set", path=KEYPAD_PATH, property="press", value=value)
target = active_client()
if target is None:
raise LookupError("emulator is off")
target.command("qom-set", path=KEYPAD_PATH, property="press", value=value)
@app.get("/")
def index():
@@ -89,7 +107,45 @@ def create_app(client, frame_addr: int, status_addr: int, scale: int = 4):
@app.get("/api/status")
def api_status():
return jsonify(client.command("query-status"))
target = active_client()
if target is None:
return jsonify(powered=False, status="off")
try:
info = target.command("query-status")
except Exception as exc:
# The emulator can die under us; that is a state to report, not a 500.
return jsonify(powered=False, status="unreachable", error=str(exc))
return jsonify(powered=True, **info)
@app.post("/api/power/<action>")
def api_power(action):
action = (action or "").strip().lower()
if action not in POWER_ACTIONS:
return jsonify(error=f"unknown action {action!r}",
valid=list(POWER_ACTIONS)), 400
if supervisor is None:
return jsonify(
error="power control needs a supervisor; this server was "
"started without one"), 409
# Refuse to kill a process we did not start. Reset is fine either way,
# since system_reset does not end anything.
if action == "off" and not supervisor.owns_process():
return jsonify(
error="this server attached to an emulator it did not start, "
"so it will not stop it. Restart without --attach to "
"manage the process here."), 409
{"on": supervisor.power_on,
"off": supervisor.power_off,
"reset": supervisor.reset,
"pause": supervisor.pause,
"resume": supervisor.resume}[action]()
# Point the pump at whatever client is live now. rebind(None) blanks the
# screen, so power off actually goes dark instead of freezing on the last
# frame.
pump.rebind(supervisor.client())
return jsonify(ok=True, action=action, powered=supervisor.is_running())
@app.post("/api/key")
def api_key():
@@ -117,6 +173,7 @@ def create_app(client, frame_addr: int, status_addr: int, scale: int = 4):
return jsonify(error="hold_ms must not be negative"), 400
hold_ms = min(hold_ms, MAX_HOLD_MS)
try:
if action == "down":
set_press(key)
elif action == "up":
@@ -127,12 +184,17 @@ def create_app(client, frame_addr: int, status_addr: int, scale: int = 4):
set_press(key)
time.sleep(hold_ms / 1000)
set_press("")
except LookupError:
return jsonify(error="emulator is off; press On first"), 409
return jsonify(ok=True, key=key, action=action, hold_ms=hold_ms)
@app.post("/api/release-all")
def api_release_all():
"""Safety valve: an empty press clears every key in the model."""
try:
set_press("")
except LookupError:
return jsonify(error="emulator is off"), 409
return jsonify(ok=True)
def wait_for_frame(timeout: float = 2.0):