520 lines
22 KiB
Python
520 lines
22 KiB
Python
"""Scheduler run: find cases, hand them to the agent, move successes, clean up (fake IMAP, fake agent)."""
|
|
|
|
import json
|
|
import time
|
|
from email.message import EmailMessage
|
|
|
|
import pytest
|
|
|
|
from cases import CaseStore
|
|
from cases import case_key
|
|
from worker import AgentUnavailable, Worker, _tick
|
|
|
|
|
|
def mail_bytes(mid, link="https://shop.example/unsubscribe/1", to="philipp@wagnersnetz.de", links=None,
|
|
sender="Jens <jens@wagnersnetz.de>"):
|
|
m = EmailMessage()
|
|
m["Message-ID"] = mid
|
|
m["Subject"] = "Fwd: News " + mid
|
|
m["From"] = sender
|
|
urls = links if links is not None else ([link] if link else [])
|
|
m.set_content("Von: news@shop.example\nAn: " + to + "\n\n" + "\n".join(urls))
|
|
return m.as_bytes()
|
|
|
|
|
|
class FakeIMAP:
|
|
"""Two folders; uid commands as far as the worker uses them."""
|
|
|
|
def __init__(self, inbox):
|
|
self.folders = {"INBOX": dict(inbox)}
|
|
self.selected = "INBOX"
|
|
self.deleted = set()
|
|
self.fail_copy = False
|
|
self.logged_out = False
|
|
self.fail_store_once = False
|
|
self.search_status = "OK"
|
|
self.fail_fetch = set()
|
|
self.calls = []
|
|
|
|
def select(self, folder):
|
|
if folder not in self.folders:
|
|
return "NO", [b"no such folder"]
|
|
self.selected = folder
|
|
return "OK", [b"1"]
|
|
|
|
def create(self, folder):
|
|
if folder in self.folders:
|
|
return "NO", [b"exists"]
|
|
self.folders[folder] = {}
|
|
return "OK", [b"created"]
|
|
|
|
def uid(self, command, *args):
|
|
self.calls.append((command, args))
|
|
box = self.folders[self.selected]
|
|
if command == "search":
|
|
if len(args) >= 4 and args[1] == "HEADER":
|
|
wanted = args[3].strip('"')
|
|
hits = [u for u, raw in box.items() if ("Message-ID: " + wanted).encode() in raw]
|
|
return "OK", [b" ".join(hits)]
|
|
if self.search_status != "OK":
|
|
return self.search_status, [b"search failed"]
|
|
return "OK", [b" ".join(box)]
|
|
if command == "fetch":
|
|
if args[0] in self.fail_fetch:
|
|
return "NO", [None]
|
|
return "OK", [(b"1 (BODY[] {n}", box[args[0]]), b")"]
|
|
if command == "copy":
|
|
if self.fail_copy or args[0] not in box:
|
|
return "NO", [b"copy failed"]
|
|
self.folders[args[1]][b"9" + args[0]] = box[args[0]]
|
|
return "OK", [b""]
|
|
if command == "store":
|
|
if self.fail_store_once:
|
|
self.fail_store_once = False
|
|
return "NO", [b"store failed"]
|
|
self.deleted.add((self.selected, args[0]))
|
|
return "OK", [b""]
|
|
raise AssertionError(command)
|
|
|
|
def expunge(self):
|
|
for folder, uid in list(self.deleted):
|
|
self.folders[folder].pop(uid, None)
|
|
self.deleted.clear()
|
|
return "OK", [b""]
|
|
|
|
def logout(self):
|
|
self.logged_out = True
|
|
|
|
|
|
def parse(message):
|
|
import app as unsub
|
|
text = unsub.get_text_from_email(message)
|
|
return unsub.get_subject(message), unsub.find_unsubscribe_links(text), text
|
|
|
|
|
|
class Agent:
|
|
def __init__(self, *results):
|
|
self.results = list(results)
|
|
self.calls = []
|
|
|
|
def __call__(self, url, address):
|
|
self.calls.append((url, address))
|
|
r = self.results.pop(0) if self.results else {"result": "unclear", "reason": "no more results"}
|
|
if isinstance(r, Exception):
|
|
raise r
|
|
return {"evidence": "", "evidence_url": "", "steps": 1, "stage": 2, **r}
|
|
|
|
|
|
OK = {"result": "unsubscribed", "reason": "page confirms", "evidence": "abgemeldet", "evidence_url": "https://shop.example/done"}
|
|
|
|
|
|
@pytest.fixture
|
|
def store(tmp_path):
|
|
return CaseStore(str(tmp_path / "cases.db"))
|
|
|
|
|
|
def worker(store, imap, agent, **kw):
|
|
kw.setdefault("allowed_senders", ("jens@wagnersnetz.de",))
|
|
return Worker(store, lambda: imap, parse, agent, allowed_domains=("wagnersnetz.de",), **kw)
|
|
|
|
|
|
def test_success_is_moved_to_the_done_folder(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
assert agent.calls == [("https://shop.example/unsubscribe/1", "philipp@wagnersnetz.de")]
|
|
assert (summary["new"], summary["handled"], summary["unsubscribed"], summary["moved"], summary["error"]) == (1, 1, 1, 1, "")
|
|
assert imap.folders["INBOX"] == {} and len(imap.folders["Erledigt"]) == 1 and imap.logged_out
|
|
c = store.get("<a@x>")
|
|
assert (c["state"], c["moved"], c["evidence"]) == ("unsubscribed", 1, "abgemeldet")
|
|
assert json.loads(store.meta("last_run"))["moved"] == 1 and store.meta("last_run_at")
|
|
|
|
|
|
def test_failure_stays_in_the_inbox_and_is_not_tried_again(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
agent = Agent({"result": "not_possible", "reason": "captcha"})
|
|
w = worker(store, imap, agent)
|
|
w.run_once()
|
|
w.run_once()
|
|
assert len(agent.calls) == 1 and b"7" in imap.folders["INBOX"]
|
|
assert (store.get("<a@x>")["state"], store.get("<a@x>")["reason"]) == ("not_possible", "captcha")
|
|
|
|
|
|
def test_second_link_is_tried_but_not_a_third_and_not_after_login(store):
|
|
links = ["https://shop.example/unsubscribe/1", "https://shop.example/unsubscribe/2", "https://shop.example/unsubscribe/3"]
|
|
imap = FakeIMAP({b"1": mail_bytes("<two@x>", links=links), b"2": mail_bytes("<login@x>", links=links)})
|
|
agent = Agent({"result": "unclear", "reason": "x"}, OK, {"result": "not_possible", "reason": "login"})
|
|
worker(store, imap, agent).run_once()
|
|
assert [u for u, _ in agent.calls] == [links[0], links[1], links[0]]
|
|
assert store.get("<two@x>")["state"] == "unsubscribed"
|
|
assert (store.get("<login@x>")["state"], store.get("<login@x>")["reason"]) == ("not_possible", "login")
|
|
|
|
|
|
def test_agent_error_does_not_burn_the_attempt(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<b@x>")})
|
|
agent = Agent(AgentUnavailable("agent not reachable"))
|
|
w = worker(store, imap, agent)
|
|
summary = w.run_once()
|
|
assert summary["error"] == "agent not reachable" and summary["handled"] == 0 and len(agent.calls) == 1
|
|
assert [(c["state"], c["attempts"]) for c in store.all()] == [("new", 0), ("new", 0)]
|
|
agent.results = [OK, OK]
|
|
assert w.run_once()["unsubscribed"] == 2
|
|
|
|
|
|
def test_model_unavailable_result_counts_like_an_unavailable_agent(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
summary = worker(store, imap, Agent({"result": "error", "reason": "llm_unavailable"})).run_once()
|
|
assert summary["error"] == "llm_unavailable" and store.get("<a@x>")["attempts"] == 0
|
|
|
|
|
|
ERR = {"result": "error", "reason": "llm_unavailable"}
|
|
|
|
|
|
def test_model_error_defers_the_case_and_the_run_goes_on(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", link="https://shop.example/unsubscribe/a"),
|
|
b"2": mail_bytes("<b@x>", link="https://shop.example/unsubscribe/b")})
|
|
agent = Agent(ERR, OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
first, second = store.get("<a@x>"), store.get("<b@x>")
|
|
assert second["state"] == "unsubscribed"
|
|
assert (first["state"], first["attempts"], first["deferrals"]) == ("new", 0, 1)
|
|
assert summary["error"] == "" and summary["deferred"] == 1 and summary["handled"] == 1
|
|
|
|
|
|
def test_deferred_case_is_tried_after_newer_ones(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", link="https://shop.example/unsubscribe/a")})
|
|
agent = Agent(ERR)
|
|
w = worker(store, imap, agent)
|
|
assert w.run_once()["deferred"] == 1
|
|
imap.folders["INBOX"][b"2"] = mail_bytes("<b@x>", link="https://shop.example/unsubscribe/b")
|
|
agent.calls, agent.results = [], [OK, OK]
|
|
w.run_once()
|
|
assert [u for u, _ in agent.calls] == ["https://shop.example/unsubscribe/b", "https://shop.example/unsubscribe/a"]
|
|
|
|
|
|
def test_case_deferred_max_deferrals_times_ends_unclear(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
agent = Agent(ERR, ERR, ERR, OK)
|
|
w = worker(store, imap, agent, max_deferrals=3)
|
|
summaries = [w.run_once() for _ in range(4)]
|
|
c = store.get("<a@x>")
|
|
assert (c["state"], c["reason"]) == ("unclear", "model unavailable for this case")
|
|
assert len(agent.calls) == 3 and summaries[3]["handled"] == 0
|
|
assert [s["deferred"] for s in summaries[:2]] == [1, 1]
|
|
|
|
|
|
def test_transport_failure_still_stops_the_run_and_leaves_all_cases_untouched(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<b@x>")})
|
|
agent = Agent(AgentUnavailable("agent not reachable"), OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
assert summary["error"] == "agent not reachable" and summary["deferred"] == 0 and len(agent.calls) == 1
|
|
assert [(c["state"], c["attempts"], c["deferrals"]) for c in store.all()] == [("new", 0, 0), ("new", 0, 0)]
|
|
|
|
|
|
def test_without_agent_cases_are_only_recorded(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<nolink@x>", link="")})
|
|
summary = worker(store, imap, None).run_once()
|
|
assert (summary["new"], summary["handled"], summary["without_link"]) == (1, 0, 1)
|
|
assert store.get("<a@x>")["state"] == "new" and store.get("<nolink@x>") is None
|
|
|
|
|
|
def test_paused_run_does_nothing(store):
|
|
store.set_meta("paused", "1")
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
assert summary["error"] == "paused" and agent.calls == [] and store.all() == []
|
|
|
|
|
|
def test_pause_during_a_run_stops_before_the_next_case(store):
|
|
imap = FakeIMAP({str(i).encode(): mail_bytes(f"<{i}@x>") for i in range(1, 4)})
|
|
|
|
class Pausing(Agent):
|
|
def __call__(self, url, address):
|
|
store.set_meta("paused", "1") # "Pause agent" pressed while the first case runs
|
|
return super().__call__(url, address)
|
|
|
|
agent = Pausing(OK, OK, OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
assert len(agent.calls) == 1 and summary["error"] == "paused"
|
|
assert summary["handled"] == 1 and summary["moved"] == 1 # what is finished is still moved
|
|
assert [c["state"] for c in store.all()].count("new") == 2
|
|
|
|
|
|
def test_at_most_max_cases_per_run(store):
|
|
imap = FakeIMAP({str(i).encode(): mail_bytes(f"<{i}@x>") for i in range(1, 5)})
|
|
agent = Agent(OK, OK, OK, OK)
|
|
assert worker(store, imap, agent, max_cases=3).run_once()["handled"] == 3
|
|
assert len(agent.calls) == 3
|
|
|
|
|
|
def test_address_of_a_foreign_domain_is_not_handed_over(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", to="victim@elsewhere.example")})
|
|
agent = Agent(OK)
|
|
worker(store, imap, agent).run_once()
|
|
assert agent.calls == [("https://shop.example/unsubscribe/1", "jens@wagnersnetz.de")] # the forwarder
|
|
|
|
|
|
def test_move_failure_keeps_case(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
imap.fail_copy = True
|
|
w = worker(store, imap, Agent(OK))
|
|
summary = w.run_once()
|
|
assert summary["moved"] == 0 and b"7" in imap.folders["INBOX"]
|
|
assert (store.get("<a@x>")["state"], store.get("<a@x>")["moved"]) == ("unsubscribed", 0)
|
|
imap.fail_copy = False
|
|
assert w.run_once()["moved"] == 1 and imap.folders["INBOX"] == {}
|
|
|
|
|
|
def test_cleanup_deletes_old_successes_from_the_done_folder(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<old@x>"), b"8": mail_bytes("<young@x>")})
|
|
now = [time.time()] # store stamps real time; a fixed start date would make the test date-dependent
|
|
w = worker(store, imap, Agent(OK, OK), clock=lambda: now[0], retention_days=30)
|
|
w.run_once()
|
|
assert len(imap.folders["Erledigt"]) == 2
|
|
young_time = store.get("<young@x>")["updated_at"]
|
|
store._run("UPDATE cases SET updated_at = ? WHERE key = '<old@x>'", (young_time - 31 * 86400,))
|
|
now[0] = young_time + 60
|
|
summary = w.run_once()
|
|
assert summary["cleaned"] == 1
|
|
assert store.get("<old@x>") is None and store.get("<young@x>") is not None
|
|
assert len(imap.folders["Erledigt"]) == 1 and imap.selected == "INBOX"
|
|
|
|
|
|
def test_run_survives_a_broken_mail(store):
|
|
imap = FakeIMAP({b"1": b"\xff\xfe not a mail", b"2": mail_bytes("<b@x>")})
|
|
assert worker(store, imap, Agent(OK)).run_once()["unsubscribed"] == 1
|
|
|
|
|
|
def test_mail_from_unknown_sender_is_ignored(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", sender="Jens <JENS@wagnersnetz.de>"),
|
|
b"2": mail_bytes("<evil@x>", sender="Mallory <mallory@evil.example>")})
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent, allowed_senders=("jens@wagnersnetz.de",)).run_once()
|
|
assert len(agent.calls) == 1 and summary["ignored"] == 1
|
|
assert [c["key"] for c in store.all()] == ["<a@x>"]
|
|
assert store.get("<evil@x>") is None and b"2" in imap.folders["INBOX"]
|
|
|
|
|
|
def test_no_allowed_senders_with_agent_means_nobody(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent, allowed_senders=()).run_once()
|
|
assert agent.calls == [] and store.all() == [] and summary["ignored"] == 1
|
|
|
|
|
|
def test_no_allowed_senders_without_agent_lists_everything(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
summary = worker(store, imap, None, allowed_senders=()).run_once()
|
|
assert store.get("<a@x>")["state"] == "new" and summary["ignored"] == 0
|
|
|
|
|
|
def test_spoofed_display_name_does_not_help(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", sender='"jens@wagnersnetz.de" <mallory@evil.example>')})
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent, allowed_senders=("jens@wagnersnetz.de",)).run_once()
|
|
assert agent.calls == [] and store.all() == [] and summary["ignored"] == 1
|
|
|
|
|
|
def old_case(store, key, address="jens@wagnersnetz.de"):
|
|
store.add(key, "Fwd: old", ["https://shop.example/unsubscribe/1"], address)
|
|
|
|
|
|
def test_old_case_of_a_sender_no_longer_allowed_is_not_handled(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", sender="Mallory <mallory@evil.example>")})
|
|
worker(store, imap, None, allowed_senders=()).run_once()
|
|
assert store.get("<a@x>")["state"] == "new"
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent, allowed_senders=("jens@wagnersnetz.de",)).run_once()
|
|
assert agent.calls == [] and summary["ignored"] == 1 and summary["handled"] == 0
|
|
assert (store.get("<a@x>")["state"], store.get("<a@x>")["attempts"]) == ("new", 0)
|
|
|
|
|
|
def test_case_whose_mail_left_the_inbox_is_not_handled(store):
|
|
old_case(store, "<gone@x>")
|
|
agent = Agent(OK)
|
|
worker(store, FakeIMAP({}), agent).run_once()
|
|
assert agent.calls == []
|
|
|
|
|
|
def test_failed_case_whose_mail_was_moved_to_the_trash_disappears(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
w = worker(store, imap, Agent({"result": "not_possible", "reason": "captcha"}))
|
|
w.run_once()
|
|
assert store.get("<a@x>")["state"] == "not_possible"
|
|
imap.folders["INBOX"].pop(b"7") # "Move to Trash" on the page
|
|
summary = w.run_once()
|
|
assert store.get("<a@x>") is None and summary["gone"] == 1
|
|
|
|
|
|
def test_new_case_whose_mail_is_gone_is_deleted_but_a_running_one_is_left_alone(store):
|
|
old_case(store, "<new@x>")
|
|
old_case(store, "<running@x>")
|
|
store.claim("<running@x>")
|
|
summary = worker(store, FakeIMAP({}), Agent()).run_once()
|
|
assert store.get("<new@x>") is None and store.get("<running@x>")["state"] == "running"
|
|
assert summary["gone"] == 1
|
|
|
|
|
|
def test_unmoved_success_whose_mail_is_gone_counts_as_moved_and_expires(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
imap.fail_copy = True
|
|
now = [time.time()]
|
|
w = worker(store, imap, Agent(OK), clock=lambda: now[0], retention_days=30)
|
|
w.run_once()
|
|
assert (store.get("<a@x>")["state"], store.get("<a@x>")["moved"]) == ("unsubscribed", 0)
|
|
imap.folders["INBOX"].pop(b"7") # moved by hand
|
|
summary = w.run_once()
|
|
assert store.get("<a@x>")["moved"] == 1 and summary["gone"] == 1
|
|
imap.folders["Erledigt"] = {}
|
|
now[0] = store.get("<a@x>")["updated_at"] + 31 * 86400
|
|
assert w.run_once()["cleaned"] == 1 and store.get("<a@x>") is None
|
|
|
|
|
|
@pytest.mark.parametrize("status", ["NO", "BAD"])
|
|
def test_failed_inbox_search_ends_the_run_with_an_error_and_deletes_nothing(store, status):
|
|
old_case(store, "<a@x>")
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
imap.search_status = status
|
|
agent = Agent(OK)
|
|
summary = worker(store, imap, agent).run_once()
|
|
assert summary["error"] == "inbox scan failed" and summary["gone"] == 0 and agent.calls == []
|
|
assert store.get("<a@x>")["state"] == "new" and imap.logged_out
|
|
assert json.loads(store.meta("last_run"))["error"] == "inbox scan failed"
|
|
|
|
|
|
def test_case_added_by_the_page_during_the_scan_is_not_tidied_away(store):
|
|
def parse_while_the_page_scans(message):
|
|
store.add("<arrived@x>", "s", ["https://shop.example/unsubscribe/9"], "") # page scan saw a newer mail
|
|
return parse(message)
|
|
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
w = Worker(store, lambda: imap, parse_while_the_page_scans, None, allowed_domains=("wagnersnetz.de",))
|
|
assert w.run_once()["gone"] == 0 and store.get("<arrived@x>") is not None
|
|
|
|
|
|
def test_unreadable_mail_in_the_inbox_means_nothing_is_tidied(store):
|
|
old_case(store, "<a@x>")
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<b@x>")})
|
|
imap.fail_fetch = {b"1"} # could be the mail of <a@x>: its key is unknown
|
|
summary = worker(store, imap, Agent(OK, OK)).run_once()
|
|
assert store.get("<a@x>") is not None and summary["gone"] == 0
|
|
assert store.get("<b@x>")["state"] == "unsubscribed"
|
|
|
|
|
|
def test_case_of_a_mail_from_a_sender_no_longer_allowed_is_kept(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>", sender="Mallory <mallory@evil.example>")})
|
|
worker(store, imap, None, allowed_senders=()).run_once()
|
|
summary = worker(store, imap, Agent(OK), allowed_senders=("jens@wagnersnetz.de",)).run_once()
|
|
assert store.get("<a@x>")["state"] == "new" and summary["gone"] == 0
|
|
|
|
|
|
def test_skipped_cases_do_not_eat_the_budget(store):
|
|
for i in range(3):
|
|
old_case(store, f"<gone{i}@x>")
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<b@x>")})
|
|
agent = Agent(OK, OK, OK)
|
|
assert worker(store, imap, agent, max_cases=2).run_once()["handled"] == 2
|
|
assert len(agent.calls) == 2 and store.get("<a@x>")["state"] == "unsubscribed"
|
|
|
|
|
|
def test_agent_bug_ends_the_case_unclear_and_the_run_goes_on(store):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>"), b"2": mail_bytes("<b@x>")})
|
|
summary = worker(store, imap, Agent(RuntimeError("boom"), OK)).run_once()
|
|
first, second = store.get("<a@x>"), store.get("<b@x>")
|
|
assert (first["state"], first["reason"], first["attempts"]) == ("unclear", "agent error", 1)
|
|
assert second["state"] == "unsubscribed"
|
|
assert summary["handled"] == 2 and summary["error"] == ""
|
|
|
|
|
|
class RawAgent:
|
|
def __init__(self, result):
|
|
self.result = result
|
|
|
|
def __call__(self, url, address):
|
|
return self.result
|
|
|
|
|
|
@pytest.mark.parametrize("result", [{}, {"result": "bought"}, None, "text"])
|
|
def test_malformed_agent_result_ends_the_case_unclear(store, result):
|
|
imap = FakeIMAP({b"1": mail_bytes("<a@x>")})
|
|
summary = worker(store, imap, RawAgent(result)).run_once()
|
|
c = store.get("<a@x>")
|
|
assert (c["state"], c["reason"], c["attempts"]) == ("unclear", "agent error", 1)
|
|
assert summary["handled"] == 1 and summary["error"] == ""
|
|
|
|
|
|
def test_exception_while_handling_one_mail_does_not_stop_the_run(store):
|
|
raw = ("Message-ID: <broken@x>\nSubject: broken\nFrom: jens@wagnersnetz.de\n\n"
|
|
"Von: news@shop.example\nAn: philipp@wagnersnetz.de\n\nhttps://shop.example/unsubscribe/9\n").encode("utf-8")
|
|
|
|
def parse_failing_on_one(message):
|
|
result = parse(message)
|
|
if result[0] == "broken":
|
|
raise ValueError("cannot handle this mail")
|
|
return result
|
|
|
|
imap = FakeIMAP({b"1": raw, b"2": mail_bytes("<b@x>")})
|
|
w = Worker(store, lambda: imap, parse_failing_on_one, Agent(OK), allowed_domains=("wagnersnetz.de",),
|
|
allowed_senders=("jens@wagnersnetz.de",))
|
|
summary = w.run_once()
|
|
assert store.get("<broken@x>") is None
|
|
assert store.get("<b@x>")["state"] == "unsubscribed" and summary["error"] == ""
|
|
|
|
|
|
@pytest.mark.parametrize("key", ["<a\r\nb@x>", "<a@x>\\", '<a"b@x>', "<n\u00e4h@x>"])
|
|
def test_cleanup_never_sends_a_hostile_message_id(store, key):
|
|
old_case(store, key)
|
|
store.claim(key)
|
|
store.finish(key, "unsubscribed")
|
|
store.mark_moved(key)
|
|
store._run("UPDATE cases SET updated_at = ? WHERE key = ?", (1.0, key))
|
|
imap = FakeIMAP({})
|
|
imap.folders["Erledigt"] = {}
|
|
summary = worker(store, imap, Agent()).run_once()
|
|
assert summary["cleaned"] == 1 and store.get(key) is None
|
|
assert not any(cmd == "search" and key in " ".join(map(str, args)) for cmd, args in imap.calls)
|
|
|
|
|
|
def test_scan_from_a_request_does_not_change_a_runs_counters(store):
|
|
w = worker(store, FakeIMAP({}), Agent())
|
|
result = w.scan(FakeIMAP({b"1": mail_bytes("<a@x>")}))
|
|
assert len(result) == 2 and not hasattr(w, "_created") and not hasattr(w, "_ignored")
|
|
|
|
|
|
def test_failed_delete_flag_keeps_the_case_unmoved(store):
|
|
imap = FakeIMAP({b"7": mail_bytes("<a@x>")})
|
|
imap.fail_store_once = True
|
|
w = worker(store, imap, Agent(OK))
|
|
assert w.run_once()["moved"] == 0
|
|
assert store.get("<a@x>")["moved"] == 0 and b"7" in imap.folders["INBOX"]
|
|
assert w.run_once()["moved"] == 1 and store.get("<a@x>")["moved"] == 1
|
|
|
|
|
|
ALL_KEYS = {"new", "handled", "unsubscribed", "moved", "cleaned", "without_link", "ignored", "error", "deferred", "gone"}
|
|
|
|
|
|
class Boom:
|
|
def __init__(self, store, set_meta_fails=False):
|
|
self.store, self.fail = store, set_meta_fails
|
|
self.clock = lambda: 1.0
|
|
|
|
def run_once(self):
|
|
raise ValueError("secret subject line")
|
|
|
|
|
|
class BrokenStore:
|
|
def set_meta(self, k, v):
|
|
raise OSError("disk")
|
|
|
|
|
|
def test_tick_records_only_the_exception_type(store):
|
|
_tick(Boom(store))
|
|
last = json.loads(store.meta("last_run"))
|
|
assert set(last) == ALL_KEYS and last["error"] == "ValueError"
|
|
assert "secret subject line" not in store.meta("last_run")
|
|
|
|
|
|
def test_tick_survives_a_failing_store():
|
|
_tick(Boom(BrokenStore()))
|