Repository Public
1"""Live tests against a real SP Mail test server (never production).23Skipped unless SPMAIL_TEST_BASE_URL is set. They are driven by tests/integration/sdk-python.test.ts of the repository,4which starts the server, creates api-...@stg.spboucher.ai test mailboxes and keys, passes them in the environment5and purges everything afterwards.6"""7from __future__ import annotations89import http.server10import os11import sys12import threading13import time14import unittest15from pathlib import Path1617sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "src"))1819import spmail # noqa: E40220from spmail import SPMail # noqa: E4022122E = os.environ23BASE = E.get("SPMAIL_TEST_BASE_URL", "")242526def until(fn, what, timeout=40.0):27 t0 = time.monotonic()28 while time.monotonic() - t0 < timeout:29 v = fn()30 if v:31 return v32 time.sleep(0.4)33 raise AssertionError(f"timed out waiting for: {what}")343536@unittest.skipUnless(BASE, "SPMAIL_TEST_BASE_URL not set")37class Live(unittest.TestCase):38 @classmethod39 def setUpClass(cls):40 assert "mail.spboucher.ai" not in BASE, "never run the live tests against production"41 cls.A, cls.B, cls.EXT = E["SPMAIL_TEST_ADDR_A"], E["SPMAIL_TEST_ADDR_B"], E["SPMAIL_TEST_ADDR_EXT"]42 for addr in (cls.A, cls.B, cls.EXT):43 assert addr.startswith("api-") and addr.endswith("@stg.spboucher.ai"), addr44 cls.a = SPMail(E["SPMAIL_TEST_KEY_A"], BASE)45 cls.b = SPMail(E["SPMAIL_TEST_KEY_B"], BASE)4647 def test_01_me_health_addresses_folders(self):48 me = self.a.me()49 self.assertEqual(me["type"], "key")50 self.assertEqual([(x["address"], x["read"]) for x in me["addresses"]], [(self.A, "full")])51 h = self.a.health()52 self.assertEqual((h["ok"], h["database"], h["mail_server"]), (True, "ok", "reachable"))53 self.assertEqual([x["address"] for x in self.a.addresses.list()], [self.A])54 self.assertEqual(self.a.addresses.get(self.A)["address"], self.A)55 self.assertTrue(any(f["role"] == "inbox" for f in self.a.folders.list()))56 self.assertTrue(self.a.folders.create(address=self.A, name="Factures Python")["id"].startswith("fld_"))5758 def test_02_real_errors(self):59 with self.assertRaises(spmail.AuthenticationError) as cm:60 SPMail("spm_aaaaaaaaaa_" + "A" * 43, BASE).me()61 self.assertEqual(cm.exception.code, "invalid_api_key")62 self.assertTrue(cm.exception.request_id.startswith("req_"))63 ro = SPMail(E["SPMAIL_TEST_KEY_READONLY"], BASE)64 with self.assertRaises(spmail.PermissionDeniedError) as cm:65 ro.messages.send(from_=self.A, to=[self.B], subject="x", text="x")66 self.assertEqual(cm.exception.code, "insufficient_scope")67 self.assertIn("mail.send", str(cm.exception.details))68 with self.assertRaises(spmail.NotFoundError):69 self.a.messages.get("msg_unknown")70 with self.assertRaises(spmail.BadRequestError) as cm:71 self.a.messages.send(from_=self.A, to=[self.B], subject="x", text="x", headers={"From": "evil@example.org"})72 self.assertEqual(cm.exception.code, "header_not_allowed")73 with self.assertRaises(spmail.PermissionDeniedError) as cm:74 self.a.messages.send(from_=self.B, to=[self.A], subject="x", text="x")75 self.assertEqual(cm.exception.code, "from_not_allowed")7677 def test_03_upload_send_wait_read_attachments(self):78 f = self.a.files.upload("col1,col2\n1,2\n".encode(), filename="données.csv", content_type="text/csv")79 self.assertTrue(f["id"].startswith("file_"))80 batch = self.a.messages.send_batch([81 {"from": self.A, "to": [self.B], "subject": "SDK Py un", "text": "Premier message", "attachments": [{"file_id": f["id"]}]},82 {"from": self.A, "to": [{"email": self.B, "name": "Boîte B"}], "subject": "SDK Py deux", "html": "<p>Deux<script>alert(1)</script></p>"},83 {"from": self.B, "to": [self.A], "subject": "refusé", "text": "x"},84 ])85 self.assertEqual([r["ok"] for r in batch["results"]], [True, True, False])86 done = self.a.wait_for_delivery(batch["results"][0]["message"]["id"], timeout=40)87 self.assertEqual(done["status"], "delivered")88 self.assertEqual([(r["address"], r["status"]) for r in done["recipients"]], [(self.B, "delivered")])89 self.a.messages.wait_for_delivery(batch["results"][1]["message"]["id"], timeout=40)9091 inbox = until(lambda: (lambda d: d if len(d) >= 2 else None)(self.b.messages.list(folder="inbox", limit=50)["data"]), "two messages received")92 self.assertEqual(sorted(m["subject"] for m in inbox), ["SDK Py deux", "SDK Py un"])93 walked = [m["id"] for m in self.b.messages.iterate(folder="inbox", limit=1)]94 self.assertEqual(sorted(walked), sorted(m["id"] for m in inbox))95 found = self.b.messages.list(subject="SDK Py un", unread=True, has_attachment=True, from_=self.A)["data"]96 self.assertEqual(len(found), 1)97 first = found[0]98 type(self).first = first99 full = self.b.messages.get(first["id"])100 self.assertEqual(full["text"].strip(), "Premier message")101 atts = self.b.messages.attachments.list(first["id"])102 self.assertEqual([(x["name"], x["size"]) for x in atts], [("données.csv", 14)])103 dl = self.b.messages.attachments.download(first["id"], atts[0]["id"])104 self.assertEqual((dl.data, dl.filename, dl.size), (b"col1,col2\n1,2\n", "données.csv", 14))105 self.assertEqual([m["id"] for m in self.b.threads.get(first["thread_id"])["messages"]], [first["id"]])106 self.assertTrue(any(t["id"] == first["thread_id"] for t in self.b.threads.iterate(folder="inbox")))107 state = self.b.messages.changes()108 self.assertTrue(state["state"].startswith("st_"))109 self.assertEqual(self.b.messages.changes(since=state["state"])["created"], [])110 outs = [o["id"] for o in self.a.messages.outbound.iterate(limit=1)]111 self.assertTrue(len(outs) >= 2 and len(set(outs)) == len(outs))112113 def test_04_modify_move_reply(self):114 first = type(self).first115 self.assertFalse(self.b.messages.mark_read(first["id"])["unread"])116 up = self.b.messages.update(first["id"], starred=True, add_labels=["sdk-py"])117 self.assertEqual((up["starred"], up["labels"]), (True, ["sdk-py"]))118 self.assertEqual([f["role"] for f in self.b.messages.archive(first["id"])["folders"]], ["archive"])119 self.b.messages.move(first["id"], "inbox")120 reply = self.b.messages.reply(first["id"], text="Bien reçu (SDK Python)")121 self.assertEqual([r["address"] for r in reply["recipients"]], [self.A])122 self.assertEqual(self.b.wait_for_delivery(reply["id"], timeout=40)["status"], "delivered")123 got = until(lambda: self.a.messages.list(folder="inbox", subject="Re: SDK Py un")["data"], "reply received")[0]124 self.assertEqual(self.a.messages.get(got["id"])["text"].strip(), "Bien reçu (SDK Python)")125 self.assertEqual(self.a.messages.delete(got["id"]), {"ok": True, "permanent": False})126 self.assertEqual(self.a.messages.delete(got["id"], permanent=True), {"ok": True, "permanent": True})127 with self.assertRaises(spmail.NotFoundError):128 self.a.messages.get(got["id"])129130 def test_05_drafts_schedule_idempotency(self):131 d = self.a.drafts.create(from_=self.A, to=[self.B], subject="Brouillon Py", text="v1")132 self.assertEqual(d["status"], "draft")133 self.assertTrue(any(m["id"] == d["id"] for m in self.a.drafts.iterate()))134 d2 = self.a.drafts.update(d["id"], text="v2")135 self.assertNotEqual(d2["id"], d["id"])136 self.assertEqual(self.a.drafts.get(d2["id"])["text"].strip(), "v2")137 self.assertEqual(self.a.drafts.delete(d2["id"]), {"ok": True})138139 later = self.a.messages.send(from_=self.A, to=[self.B], subject="Plus tard", text="x",140 send_at=time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime(time.time() + 3600)))141 self.assertEqual(later["status"], "scheduled")142 self.assertTrue(any(o["id"] == later["id"] for o in self.a.messages.scheduled.list()["data"]))143 with self.assertRaises(spmail.TimeoutError) as cm:144 self.a.wait_for_delivery(later["id"], timeout=1.0, interval=0.3)145 self.assertEqual(cm.exception.details["last"]["status"], "scheduled")146 self.assertEqual(self.a.messages.scheduled.cancel(later["id"])["status"], "cancelled")147 with self.assertRaises(spmail.ConflictError) as cm:148 self.a.messages.scheduled.cancel(later["id"])149 self.assertEqual(cm.exception.code, "not_cancellable")150151 body = {"from": self.A, "to": [self.B], "subject": "Idempotent Py", "text": "une seule fois"}152 one = self.a.messages.send(body, idempotency_key="sdk-py-idem-1")153 two = self.a.messages.send(body, idempotency_key="sdk-py-idem-1")154 self.assertEqual(one["id"], two["id"])155 with self.assertRaises(spmail.ConflictError) as cm:156 self.a.messages.send({**body, "text": "autre"}, idempotency_key="sdk-py-idem-1")157 self.assertEqual(cm.exception.code, "idempotency_conflict")158 self.a.wait_for_delivery(one["id"], timeout=40)159 got = until(lambda: self.b.messages.list(subject="Idempotent Py")["data"], "idempotent message received")160 self.assertEqual(len(got), 1)161162 def test_06_external_recipient_needs_approval(self):163 careful = SPMail(E["SPMAIL_TEST_KEY_APPROVAL"], BASE)164 r = careful.messages.send(from_=self.A, to=[self.EXT], subject="Externe Py", text="en attente")165 self.assertEqual(r["status"], "pending_approval")166 self.assertTrue(r["approval_id"])167 with self.assertRaises(spmail.TimeoutError) as cm:168 careful.wait_for_delivery(r["id"], timeout=1.0, interval=0.3)169 self.assertEqual(cm.exception.details["last"]["status"], "pending_approval")170171 def test_07_webhooks_signed_test_event(self):172 hits = []173174 class Handler(http.server.BaseHTTPRequestHandler):175 def do_POST(self): # noqa: N802176 body = self.rfile.read(int(self.headers.get("content-length", "0")))177 hits.append((dict((k.lower(), v) for k, v in self.headers.items()), body))178 self.send_response(200)179 self.end_headers()180181 def log_message(self, *args):182 pass183184 srv = http.server.ThreadingHTTPServer(("127.0.0.1", int(E["SPMAIL_TEST_WEBHOOK_PORT"])), Handler)185 threading.Thread(target=srv.serve_forever, daemon=True).start()186 try:187 hook = self.a.webhooks.create(name="sdk-py", url=f"http://127.0.0.1:{srv.server_port}/hook", events=["message.sent", "message.received"])188 self.assertTrue(hook["secret"].startswith("whsec_"))189 self.assertNotIn("secret", self.a.webhooks.get(hook["id"]))190 self.assertTrue(any(w["id"] == hook["id"] for w in self.a.webhooks.list()))191 self.assertEqual(self.a.webhooks.test(hook["id"])["http_status"], 200)192 headers, body = until(lambda: hits and hits[0], "webhook.test received")193 sig = headers["spmail-signature"]194 self.assertTrue(self.a.webhooks.verify_signature(body, sig, hook["secret"]))195 self.assertFalse(spmail.verify_webhook_signature(body, sig, "whsec_wrong"))196 ev = spmail.construct_event(body, sig, hook["secret"])197 self.assertEqual((ev["type"], ev["id"]), ("webhook.test", headers["spmail-event-id"]))198 deliveries = self.a.webhooks.deliveries.list(hook["id"])["data"]199 self.assertEqual(deliveries[0]["status"], "delivered")200 self.assertEqual(self.a.webhooks.replay(deliveries[0]["id"])["event_id"], deliveries[0]["event_id"])201 until(lambda: len(hits) >= 2, "replay received")202 rotated = self.a.webhooks.update(hook["id"], rotate_secret=True, active=False)203 self.assertTrue(rotated["secret"] != hook["secret"] and rotated["active"] is False)204 events = self.a.events.list(type="message.sent", limit=5)["data"]205 self.assertTrue(events and all(e["type"] == "message.sent" for e in events))206 self.assertEqual(self.a.webhooks.delete(hook["id"]), {"ok": True})207 finally:208 srv.shutdown()209 srv.server_close()210211 def test_08_templates(self):212 tpl = E["SPMAIL_TEST_TEMPLATE_ID"]213 self.assertEqual([t["id"] for t in self.a.templates.list()], [tpl])214 self.assertIn("{{code}}", self.a.templates.get(tpl)["html"])215 r = self.a.templates.render(tpl, {"first_name": "Max", "code": "123456"})216 self.assertEqual((r["subject"], r["missing"]), ("Votre code, Max", []))217 self.assertEqual(sorted(self.a.templates.render(tpl)["missing"]), ["code", "first_name"])218 with self.assertRaises(spmail.BadRequestError) as cm:219 self.a.messages.send(from_=self.A, to=[self.B], template_id=tpl, variables={"first_name": "Max"})220 self.assertEqual(cm.exception.code, "missing_variables")221 sent = self.a.messages.send(from_=self.A, to=[self.B], template_id=tpl, variables={"first_name": "Max", "code": "424242"})222 self.assertEqual(self.a.wait_for_delivery(sent["id"], timeout=40)["status"], "delivered")223 got = until(lambda: self.b.messages.list(subject="Votre code, Max")["data"], "template message received")[0]224 self.assertIn("424242", self.b.messages.get(got["id"])["text"])225226227if __name__ == "__main__":228 unittest.main()229