import base64
import fcntl
import json
import os
import pty
import select
import signal
import sqlite3
import struct
import subprocess
import sys
import tempfile
import termios
import time
from pathlib import Path
binary, scenario = sys.argv[1:]
with tempfile.TemporaryDirectory(prefix="qqq-tui-test-") as folder:
env = dict(os.environ, HOME=folder, TERM="xterm-256color")
env.pop("NO_COLOR", None)
color = scenario not in ("no_color", "dumb")
if scenario == "no_color":
env["NO_COLOR"] = "1"
scenario = "blank"
elif scenario == "dumb":
env["TERM"] = "dumb"
scenario = "blank"
for key in ("EDITOR", "QQQ_SESSION", "HERDR_ENV", "HERDR_PANE_ID", "CODEX_THREAD_ID", "CODEX_SESSION_ID"):
env.pop(key, None)
def cli(*args):
result = subprocess.run([binary, "--json", *args], cwd=folder, env=env, capture_output=True, timeout=5)
assert result.returncode == 0, result.stderr.decode()
return json.loads(result.stdout)
cli("init")
args = ["add"]
if scenario in ("edit", "escape_edit", "edit_shift"):
cli("add", "Original\n\nDetails")
cli("next", "--local", "--session", "worker")
args = ["edit", "-1"]
image = Path(folder) / "test image.png"
image.write_bytes(base64.b64decode("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+aGD8AAAAASUVORK5CYII="))
if scenario == "edit_image":
cli("add", "Before ", "--image", str(image))
args = ["edit", "-1"]
if scenario == "edit_pasteboard":
cli("add", "Prefix \n```pasteboard\n" + "x" * 1001 + "\n```")
args = ["edit", "-1"]
if scenario == "continuous_flags":
cli("add", "Parent")
args.extend(["--parent", "1", "--image", str(image)])
if scenario in ("save", "cancel", "escape_discard", "escape_keep"):
flagged = Path(folder) / "flag image.png"
flagged.write_bytes(image.read_bytes())
args.extend(["--image", str(flagged)])
master, slave = pty.openpty()
os.set_blocking(master, False)
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack("HHHH", 12, 60, 0, 0))
before = termios.tcgetattr(slave)
os.setsid()
fcntl.ioctl(slave, termios.TIOCSCTTY, 0)
signal.signal(signal.SIGHUP, signal.SIG_IGN)
child = subprocess.Popen([binary, "--json", *args], cwd=folder, env=env,
stdin=slave, stderr=slave, stdout=subprocess.PIPE)
screen = bytearray()
def read_until(needle, timeout=5):
deadline = time.monotonic() + timeout
while needle not in screen:
if time.monotonic() > deadline:
raise AssertionError(f"Missing {needle!r}: {screen[-2000:]!r}")
if select.select([master], [], [], 0.05)[0]:
try:
screen.extend(os.read(master, 65536))
except OSError:
raise AssertionError(f"Editor exited early: {screen!r}")
if child.poll() is not None and needle not in screen:
raise AssertionError(f"Editor exited early: {screen!r}")
def send(data, alias_escape=False):
if alias_escape and data == b"\x1b" and os.environ.get("QQQ_TEST_ESCAPE_KEY"):
data = os.environ["QQQ_TEST_ESCAPE_KEY"].encode()
remaining = memoryview(data)
deadline = time.monotonic() + 5
while remaining:
assert time.monotonic() < deadline, "Terminal input timed out"
readable, writable, _ = select.select([master], [master], [], 0.05)
if readable:
screen.extend(os.read(master, 65536))
if writable:
try:
remaining = remaining[os.write(master, remaining):]
except BlockingIOError:
pass
def paste(text):
send(b"\x1b[200~" + text.encode() + b"\x1b[201~")
try:
read_until(b"Ctrl-S")
assert b"Ctrl-W word" not in screen, "Ctrl-W appeared in editor hint"
assert b"Whole buffer =" not in screen, "Removed editor hint reappeared"
if color:
assert b"\x1b[48;5;236m" in screen, "Editor grey background missing"
assert b"\x1b[38;5;252m" in screen, "Editor readable foreground missing"
else:
assert b"\x1b[48;" not in screen, "Plain editor set background color"
assert b"\x1b[38;" not in screen, "Plain editor set foreground color"
if scenario == "blank":
send(b"\x13")
read_until(b"Task description cannot be empty")
send(b"Recovered")
elif scenario in ("edit", "escape_edit", "edit_shift"):
if scenario == "escape_edit":
send(b"\x1b")
read_until(b"Discard draft? (y/N)")
assert child.poll() is None
assert cli("show", "1")["task"]["description"] == "Original\n\nDetails"
screen.clear()
send(b"\x1b", alias_escape=True)
read_until(b"Ctrl-S")
cli("add", "Created while editing")
if scenario == "edit_shift":
screen.clear()
send(b"\x1b[1;2A\x1b[1;2B\x05")
read_until(b"Ctrl-S")
assert b"Task #2" not in screen and b"New Task" not in screen
paste(" amended")
elif scenario == "edit_image":
read_until(b"[Image #1: test image.png]")
paste("'" + str(image) + "'")
read_until(b"[Image #2: test image.png]")
elif scenario == "edit_pasteboard":
read_until(b"[Pasted Content 1001 chars]")
assert b"\x1b[38;5;222m" in screen, "Paste accent missing on reload"
send(b" suffix")
elif scenario == "escape_alias_text":
send(b"qQ\x1b[81;2u\x1b[81;5u\x1b[81;3u") paste("Q")
elif scenario == "escape_empty":
pass
elif scenario == "escape_deleted":
send(b"Draft" + b"\x7f" * 5)
elif scenario == "escape_whitespace":
send(b" \r")
elif scenario == "ctrl_w":
send(b"alpha beta\x17")
elif scenario == "alt_words":
send(b"alpha beta\x1b[1;3DX\x1b[1;3CY")
elif scenario == "continuous":
send(b"First\x13")
read_until(b"Saved #1. New task")
assert child.poll() is None
assert cli("show", "1")["task"]["description"] == "First"
assert not select.select([child.stdout], [], [], 0)[0]
screen.clear()
send(b"\x13")
read_until(b"Task description cannot be empty")
assert len(cli("list")) == 1
screen.clear()
send(b"Second\x13")
read_until(b"Saved #2. New task")
assert cli("show", "2")["task"]["description"] == "Second"
send(b"\x1b")
elif scenario == "continuous_flags":
with sqlite3.connect(Path(folder) / ".qqq/qqq.db") as db:
db.execute("DELETE FROM tasks WHERE id=1")
send(b"First\x13")
read_until(b"Task 1 not found")
assert child.poll() is None
assert cli("list") == []
with sqlite3.connect(Path(folder) / ".qqq/qqq.db") as db:
db.execute("INSERT INTO tasks(id,description) VALUES (1,'Parent')")
screen.clear()
send(b"\x13")
read_until(b"Saved #2. New task")
assert child.poll() is None
first = cli("show", "2")
assert first["task"]["description"] == "First"
assert first["task"]["parent_id"] == 1
assert [item["name"] for item in first["images"]] == ["test image.png"]
screen.clear()
send(b"Second\x13")
read_until(b"Saved #3. New task")
second = cli("show", "3")
assert second["task"]["parent_id"] == 1
assert second["images"] == []
send(b"\x03")
elif scenario == "continuous_discard":
send(b"First\x13")
read_until(b"Saved #1. New task")
screen.clear()
send(b"Unsaved\x1b")
read_until(b"Discard draft? (y/N)")
assert cli("show", "1")["task"]["description"] == "First"
send(b"y")
elif scenario in ("escape_image", "escape_narrow"):
paste("'" + str(image) + "'")
read_until(b"[Image #1:")
if color:
assert b"\x1b[38;5;81m" in screen, "Image placeholder accent missing"
else:
send(b"Title\r\r\x1b[200~" + ("\u754c" * 1001).encode() + b"\x1b[201~")
read_until(b"1001 chars")
if color:
assert b"\x1b[38;5;222m" in screen, "Paste accent missing"
send(b"\r")
paste("'" + str(image) + "'")
read_until(b"[Image #1:")
cancelled = scenario in ("cancel", "escape_discard", "escape_image", "escape_whitespace", "escape_narrow", "escape_empty", "escape_deleted")
if scenario in ("escape_discard", "escape_image", "escape_whitespace", "escape_narrow"):
send(b"\x1b")
read_until(b"Discard draft? (y/N)")
assert child.poll() is None
assert cli("list") == []
if scenario == "escape_narrow":
screen.clear()
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack("HHHH", 4, 12, 0, 0))
child.send_signal(signal.SIGWINCH)
read_until(b"Discard? y/N")
send(b"Y" if scenario == "escape_discard" else b"y")
elif scenario == "escape_keep":
for choice in (b"n", b"\r", b"\x1b"):
screen.clear()
send(b"\x1b")
read_until(b"Discard draft? (y/N)")
assert child.poll() is None
assert cli("list") == []
paste("ignored while confirming")
send(b"z\x13")
screen.clear()
send(choice, alias_escape=True)
read_until(b"Ctrl-S")
send(b"\x13")
elif scenario in ("escape_empty", "escape_deleted"):
send(b"\x1b")
elif scenario in ("continuous", "continuous_flags", "continuous_discard"):
pass
else:
send(b"\x03" if scenario == "cancel" else b"\x13")
if not cancelled and args[0] == "add" and scenario not in ("continuous", "continuous_flags", "continuous_discard"):
read_until(b"Saved #1. New task")
assert child.poll() is None
send(b"\x1b")
deadline = time.monotonic() + 5
pending_stdout = bytearray()
while child.poll() is None:
assert time.monotonic() < deadline, f"Save/cancel timed out: {screen[-2000:]!r}"
readable, _, _ = select.select([master, child.stdout], [], [], 0.05)
for stream in readable:
if stream == master:
screen.extend(os.read(master, 65536))
else:
pending_stdout.extend(os.read(child.stdout.fileno(), 65536))
stdout, _ = child.communicate(timeout=5)
stdout = bytes(pending_stdout) + stdout
read_until(b"\x1b[?2004l")
after = termios.tcgetattr(slave)
assert before[3] == after[3], "Terminal flags not restored"
assert b"\x1b[?1049l" in screen, "Alternate screen not restored"
if color:
assert screen.rfind(b"\x1b[0m") < screen.rfind(b"\x1b[?1049l"), "Colors not reset before leaving alternate screen"
assert b"\x1b[0m" in screen, "Colors not reset on exit"
else:
assert b"\x1b[48;" not in screen and b"\x1b[38;" not in screen
if cancelled:
assert child.returncode == 1
assert stdout == b""
assert cli("list") == []
if scenario in ("escape_empty", "escape_deleted"):
assert b"Discard" not in screen
else:
assert child.returncode == 0, screen[-2000:]
task = json.loads(stdout)
if scenario == "continuous":
assert [item["id"] for item in task] == [1, 2]
assert [item["description"] for item in task] == ["First", "Second"]
elif scenario == "continuous_flags":
assert [item["id"] for item in task] == [2, 3]
assert [item["description"] for item in task] == ["First", "Second"]
assert [item["parent_id"] for item in task] == [1, 1]
elif scenario == "continuous_discard":
assert [item["description"] for item in task] == ["First"]
assert [item["id"] for item in cli("list")] == [1]
elif args[0] == "add":
assert len(task) == 1
task = task[0]
if scenario in ("save", "escape_keep"):
assert "title" not in task
assert task["description"] == "Title\n\n```pasteboard\n" + "\u754c" * 1001 + "\n```\n"
attachments = cli("show", "1")["images"]
assert [item["name"] for item in attachments] == ["test image.png", "flag image.png"]
exported = Path(folder) / "export.png"
cli("show", "1", "--export-image", "1", "--output", str(exported))
assert exported.read_bytes() == image.read_bytes()
flagged.unlink()
flagged_export = Path(folder) / "flag export.png"
cli("show", "1", "--export-image", "2", "--output", str(flagged_export))
assert flagged_export.read_bytes() == image.read_bytes()
elif scenario == "escape_alias_text":
assert task["description"] == "qQQQ"
elif scenario == "blank":
assert task["description"] == "Recovered"
elif scenario == "ctrl_w":
assert task["description"] == "alpha "
elif scenario == "alt_words":
assert task["description"] == "alpha XbetaY"
elif scenario == "edit_image":
assert task["description"] == (
"Before "
""
)
assert [item["id"] for item in cli("show", "1")["images"]] == [1, 2]
elif scenario == "edit_pasteboard":
assert task["description"] == "Prefix \n```pasteboard\n" + "x" * 1001 + "\n```\n suffix"
elif scenario not in ("continuous", "continuous_flags", "continuous_discard"):
assert task["id"] == 1
assert task["description"] == "Original\n\nDetails amended"
assert task["harness_session"] == "worker"
assert task["status"] == "in_progress"
assert cli("show", "2")["task"]["description"] == "Created while editing"
finally:
if child.poll() is None:
child.kill()
os.close(master)
os.close(slave)
child.wait(timeout=2)