unis-oa/backend/scripts/check_notify_hub_api.py

351 lines
18 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

#!/usr/bin/env python3
"""Hub 企业微信推送的**接口侧**验收:连开发库、连进程内的 API 实例、连一台假 Hub。
cd backend && PYTHONPATH=. python3 scripts/check_notify_hub_api.py
纯逻辑那一口的口径在 ``scripts/check_notify_hub.py``(不连库)。这一份只钉那些
"非得过一遍路由、序列化与权限不可"的事:
1. ``GET /notify/meta`` 把 Hub 那一路的底细(站点、应用编码、还缺什么、两种形态)
如实交给界面——配渠道的人第一屏就该知道自己领没领到密钥;
2. 保存渠道时的参数校验(消息形态、标题额度)与"种类一换,上一档的 url/secret
不留在库里";
3. **测试发送真的按点按钮的人自己发**,且带一条 ``/todo`` 深链——点开那一跳
是这条链路上最容易配错的一段,测试得一起验掉;
4. 投递记录里看得见 Hub 的幂等键与那条永久链接;「回查送达」打的是
``GET {推送路径}/{msg_key}``;
5. **已经投出去过的那一条人工重发要换幂等键世代**(同键只会命中 Hub 的缓存,
人不重复收到,但界面会骗人说发了);
6. 邮件记录没有 Hub 明细可回查,得当场说清楚,不是 500;
7. 看投递记录与改渠道一样要 ``system:notify``。
假 Hub 从环境变量接管:``OA_HUB_BASE_URL`` 指到本机的桩、``OA_HUB_INTEGRATION_KEY``
给一把测试密钥(环境变量优先于库里的值,所以不碰开发库那把真密钥)。
脚本只建自己那个带时间戳编码的渠道,跑完连同投递记录与操作日志一起删掉;
它不跑 startup 事件,所以本进程不起调度线程抢自己的行。
"""
from __future__ import annotations
import datetime as dt
import os
import pathlib
import sys
HERE = pathlib.Path(__file__).resolve().parent
sys.path.insert(0, str(HERE))
sys.path.insert(0, str(HERE.parent))
from check_notify_hub import FakeHub # noqa: E402
FAILS: list[str] = []
NOTES: list[str] = []
def eq(name: str, got, want) -> None:
if got != want:
FAILS.append(f"{name}:期望 {want!r},实得 {got!r}")
def ok(name: str, condition, detail=None) -> None:
if not condition:
FAILS.append(f"{name}:{detail if detail is not None else '条件不成立'}")
def note(text: str) -> None:
NOTES.append(text)
def main() -> int:
hub = FakeHub()
env_keys = ("OA_HUB_BASE_URL", "OA_HUB_INTEGRATION_KEY")
saved = {key: os.environ.get(key) for key in env_keys}
os.environ["OA_HUB_BASE_URL"] = hub.base_url
os.environ["OA_HUB_INTEGRATION_KEY"] = "api-probe-key"
from app import hubconfig, models
from app.db import SessionLocal
from app.deps import CurrentUser
from app.security import create_access_token
from sqlalchemy import select
hubconfig.reload()
code = f"hubapi{dt.datetime.now().strftime('%H%M%S')}"
created: list[str] = []
# 挑一个管理员:改渠道与看投递记录都要 system:notify
db = SessionLocal()
try:
admin = db.execute(
select(models.User)
.where(models.User.role == models.ROLE_ADMIN)
.where(models.User.status.in_(sorted(models.UserStatus.LOGIN_ALLOWED)))
.order_by(models.User.id)
.limit(1)
).scalars().first()
member = db.execute(
select(models.User)
.where(models.User.role != models.ROLE_ADMIN)
.where(models.User.status.in_(sorted(models.UserStatus.LOGIN_ALLOWED)))
.order_by(models.User.id)
.limit(1)
).scalars().first()
finally:
db.close()
if admin is None:
print("库里没有一个可用的管理员账号,这一份验不了")
return 1
admin_token, _ = create_access_token(str(admin.id))
member_token, _ = create_access_token(str(member.id)) if member else ("", 0)
from fastapi.testclient import TestClient
from app.main import app
client = TestClient(app) # 不进 with:不跑 startup,本进程不起调度线程
def api(method: str, path: str, body=None, token: str = ""):
headers = {"Authorization": f"Bearer {token or admin_token}"}
response = client.request(method, f"/api/v1{path}", json=body, headers=headers)
try:
payload = response.json()
except ValueError:
payload = {}
return response.status_code, payload
try:
# 1) meta:Hub 那一路的底细
status, body = api("GET", "/notify/meta")
eq("meta 200", status, 200)
data = body.get("data") or {}
eq("渠道类型里有 hub_wecom",
[k for k in data.get("kinds", []) if k["value"] == "hub_wecom"],
[{"value": "hub_wecom", "label": "企业微信(经统一身份 Hub 推送)"}])
eq("两种消息形态都摊开给界面", len(data.get("hubMsgtypes") or []), 2)
info = data.get("hub") or {}
eq("站点地址取的是当前生效那一个(假 Hub)", info.get("baseUrl"), hub.base_url)
eq("密钥状态只说有没有", info.get("keySet"), True)
eq("配齐了 ready 就是真", info.get("ready"), True)
eq("推送路径如实回显", info.get("pushPath"), "/api/v1/auth/notify/wecom/messages")
# 收件人标识:界面要能自己摊开这一格,所以后端把清单、常用组合与默认一起给出去
receivers = data.get("hubReceivers") or []
eq("摊开的是 Hub 认的那两种标识", [item["value"] for item in receivers],
["user_id", "account"])
ok("每一种都说得清本地取哪一列", all(item.get("column") for item in receivers), receivers)
eq("几种常用顺序组合都给了", len(data.get("hubReceiverPresets") or []), 4)
eq("默认那一档是主键优先退回账号", data.get("hubReceiverDefault"), ["user_id", "account"])
# 2) 保存:形态与标题额度的校验
base = {"code": code, "name": "接口探针:Hub 企业微信", "kind": "hub_wecom",
"enabled": True, "events": ["task"],
"config": {"msgtype": "textcard", "with_link": True, "title_limit": 64}}
status, body = api("POST", "/notify/channels", base)
eq("建渠道 200", status, 200)
created.append(code)
view = body.get("data") or {}
eq("新渠道体检没有毛病", view.get("problems"), [])
eq("回显里带着形态与额度",
(view.get("config") or {}).get("msgtype"), "textcard")
eq("没配过收件人标识就是默认顺序", view.get("receiverPref"), ["user_id", "account"])
ok("列表里说得出按哪一列认人", "Hub 用户 ID" in str(view.get("receiverLabel") or ""), view)
status, body = api("POST", "/notify/channels",
dict(base, code=code + "-recv", config={"receiver": ["openid"]}))
eq("没这一列的收件人标识被挡下", status, 400)
ok("挡下的话说是哪几种能填", "user_id" in str(body.get("message") or ""), body)
bad = dict(base, code=code + "-bad", config={"msgtype": "news", "title_limit": 64})
status, body = api("POST", "/notify/channels", bad)
eq("不认的消息形态被挡下", status, 400)
ok("挡下的话说是哪两种能填", "textcard" in str(body.get("message") or ""), body)
status, body = api("POST", "/notify/channels",
dict(base, code=code + "-lim", config={"title_limit": 999}))
eq("标题额度超范围被挡下", status, 400)
# 改种类时别把上一档的 url/secret 拖进来
status, body = api("PUT", f"/notify/channels/{code}",
dict(base, config={"msgtype": "markdown", "with_link": True,
"title_limit": 80, "url": "https://x/y",
"secret": "不该留下"}))
eq("改渠道 200", status, 200)
left = (body.get("data") or {}).get("config") or {}
eq("换成 markdown 了", left.get("msgtype"), "markdown")
eq("上一档的 url 不留在库里", "url" in left, False)
# 形态回成卡片,测试发送才验得到点开那一跳
api("PUT", f"/notify/channels/{code}", base)
# 收件人标识是渠道上可配的一项:存的写法、视图口径、换档后的清理都要跟着它
status, body = api("PUT", f"/notify/channels/{code}",
dict(base, config={**base["config"], "receiver": ["account", "user_id"]}))
eq("改收件人标识 200", status, 200)
after = body.get("data") or {}
eq("库里存的就是这个顺序", (after.get("config") or {}).get("receiver"),
["account", "user_id"])
eq("视图说的是账号优先", after.get("receiverPref"), ["account", "user_id"])
eq("顺序也翻成人话", after.get("receiverLabel"), "登录账号 → Hub 用户 ID")
status, body = api("PUT", f"/notify/channels/{code}",
dict(base, config={**base["config"], "receiver": " Account "}))
eq("交一个串也收", status, 200)
eq("洗成规范化后的列表",
((body.get("data") or {}).get("config") or {}).get("receiver"), ["account"])
status, body = api("PUT", f"/notify/channels/{code}",
dict(base, kind="webhook",
config={"url": "https://x/y", "receiver": ["account"]}))
eq("换到机器人那一档 200", status, 200)
eq("换档之后不留没人读的 receiver",
"receiver" in ((body.get("data") or {}).get("config") or {}), False)
# 换回 Hub 一档、定成"只认登录账号":测试发送要真的按账号发出去
api("PUT", f"/notify/channels/{code}",
dict(base, config={**base["config"], "receiver": ["account"]}))
# 3) 测试发送:真发给点按钮的人自己,并带一条深链
hub.script = [(200, {"code": "200", "message": "success", "data": {
"msg_key": "x", "status": "sent", "grant": "g" * 24,
"link": "https://hub.example.com/auth/go/" + "g" * 24,
"attempt": 1, "sent_at": "2026-11-04T06:00:00Z",
"recipients": [{"receiver": "1", "status": "sent"}]}})]
status, body = api("POST", f"/notify/channels/{code}/test")
if status != 200 and "对不上号" in str(body.get("message") or ""):
note("这个管理员账号既没有 Hub 用户 ID 也没有登录账号,测试发送那一步跳不过去")
eq("测试发送 200", status, 200)
sent = hub.last
eq("打的是假 Hub 的推送路径", sent["path"], "/api/v1/auth/notify/wecom/messages")
eq("用的是统一身份那把密钥", sent["key"], "api-probe-key")
eq("消息形态照渠道", sent["body"]["msgtype"], "textcard")
eq("测试消息带 /todo 深链", sent["body"]["target_path"], "/todo")
eq("按渠道配的那一列认人", sent["body"]["receivers"], [{"account": str(admin.account)}])
ok("收件人是点按钮的那个人", bool(sent["body"]["receivers"]), sent["body"])
eq("幂等键带得上这个渠道与这条记录",
str(sent["body"]["msg_key"]).startswith(f"oa-{code}-"), True)
delivery_view = (body.get("data") or {}).get("delivery") or {}
eq("记录当场就是成功", delivery_view.get("status"), "success")
delivery_id = str(delivery_view.get("id") or "")
# 一串数字分不清是 Hub 主键还是账号:记录要自带"这是按哪一列取的"
eq("记录说得出这串是哪一列取的", delivery_view.get("targetField"), "account")
eq("还带一个界面上能直接念的名字", delivery_view.get("targetFieldLabel"), "登录账号")
# 4) 投递记录看得见 Hub 那份明细
status, body = api("GET", f"/notify/deliveries?channel={code}")
eq("投递记录 200", status, 200)
items = (body.get("data") or {}).get("items") or []
eq("只有刚发的那一条", len(items), 1)
hub_detail = (items[0].get("response") or {}).get("hub") or {}
eq("幂等键记在记录里", hub_detail.get("msgKey"), sent["body"]["msg_key"])
eq("Hub 那条永久链接也记着", str(hub_detail.get("link") or "").startswith("https://"), True)
eq("打码这件事只管机器人地址", items[0].get("target"), str(list(sent["body"]["receivers"][0].values())[0]))
# 5) 回查送达:GET 同一路径 + /{msg_key}
hub.script = [(200, {"code": "200", "data": {
"msg_key": hub_detail.get("msgKey"), "status": "sent",
"attempt": 1, "sent_at": "2026-11-04T06:00:00Z",
"recipients": [{"receiver": str(items[0].get("target")), "status": "sent"}]}})]
status, body = api("POST", f"/notify/deliveries/{delivery_id}/recheck")
eq("回查 200", status, 200)
eq("回查走 GET 且带上幂等键", hub.last["method"], "GET")
eq("回查的路径", hub.last["path"],
f"/api/v1/auth/notify/wecom/messages/{hub_detail.get('msgKey')}")
ok("回查记了时间", bool(((body.get("data") or {}).get("response") or {})
.get("hub", {}).get("recheckedAt")), body)
# 6) 已投出过的人工重发要换世代,且真的按新键再发一次
hub.script = [(200, {"code": "200", "data": {
"msg_key": "x", "status": "sent", "attempt": 2,
"recipients": [{"receiver": str(items[0].get("target")), "status": "sent"}]}})]
status, body = api("POST", f"/notify/deliveries/{delivery_id}/resend")
eq("重新排队 200", status, 200)
status, body = api("POST", f"/notify/deliveries/{delivery_id}/send-now")
eq("立刻再发一次 200", status, 200)
again = str(hub.last["body"]["msg_key"])
eq("补发换了世代号", again, f"{hub_detail.get('msgKey')}-r1")
# 7) 不是 Hub 渠道的记录没有明细可回查
db = SessionLocal()
try:
plain = models.NotifyDelivery(channel=code, kind=models.NotifyChannel.KIND_EMAIL,
type="task", identity=admin.account, person=str(admin.id),
person_name=admin.display_name, target="someone@example.com",
title="探针:一条邮件记录", body="")
db.add(plain)
db.commit()
plain_id = str(plain.id)
finally:
db.close()
created.append(f"delivery:{plain_id}")
status, body = api("POST", f"/notify/deliveries/{plain_id}/recheck")
eq("邮件记录回查给的是 400 不是 500", status, 400)
ok("话说的是没有明细可回查", "回查" in str(body.get("message") or ""), body)
# 7b) 收件人标识的覆盖情况:换标识之前先在渠道列表里看见"能发到几个人"
status, body = api("GET", "/notify/channels")
eq("渠道列表 200", status, 200)
cov = (body.get("data") or {}).get("hubCoverage") or {}
ok("有 Hub 渠道就回一份覆盖情况", bool(cov), cov)
eq("两种标识各算一个数", sorted((cov.get("fields") or {}).keys()), ["account", "user_id"])
ok("在职账号总数不是零(库里有人)", int(cov.get("active") or 0) > 0, cov)
eq("怎么配都发不到 = 总数 - 至少有一种标识",
int(cov.get("none") or 0), int(cov.get("active") or 0) - int(cov.get("any") or 0))
# 8) 权限:看投递记录也要 system:notify
if member_token:
status, _body = api("GET", "/notify/deliveries", token=member_token)
eq("没有 system:notify 看不到投递记录", status, 403)
status, _body = api("GET", "/notify/channels", token=member_token)
eq("渠道列表本身只要登录", status, 200)
else:
note("库里找不到一个非管理员账号,权限那一步没验")
for line in FAILS:
print(f"[FAIL] {line}")
for line in NOTES:
print(f"[NOTE] {line}")
if FAILS:
print(f"共 {len(FAILS)} 条不对")
return 1
print("通过:meta 说清底细、保存校验形态与额度、上一档的 url/secret 不留库、"
"收件人标识可配且串/列表都洗成一种写法、换档不留孤儿参数、"
"测试发送按渠道配的那一列认人、记录自带这串是哪一列取的、"
"测试发送真发给本人且带 /todo 深链、记录里看得见幂等键与永久链接、"
"回查打 GET {推送路径}/{msg_key}、已投出的补发换幂等键世代、"
"非 Hub 记录回查给 400、投递记录按 system:notify 收口")
return 0
finally:
# 清场:渠道、它名下的投递记录、以及这个码写过的操作日志
db = SessionLocal()
try:
ids = [str(row.id) for row in db.execute(
select(models.NotifyDelivery).where(models.NotifyDelivery.channel == code)
).scalars().all()]
for extra in created:
if extra.startswith("delivery:"):
ids.append(extra.split(":", 1)[1])
for row in db.execute(
select(models.NotifyDelivery).where(models.NotifyDelivery.id.in_(ids))
).scalars().all():
db.delete(row)
for row in db.execute(
select(models.OperationLog).where(models.OperationLog.target.like(f"{code}%"))
).scalars().all():
db.delete(row)
channel = db.execute(
select(models.NotifyChannel).where(models.NotifyChannel.code.in_([code]))
).scalar_one_or_none()
if channel is not None:
db.delete(channel)
db.commit()
left = db.execute(select(models.NotifyChannel).where(
models.NotifyChannel.code.like("hubapi%"))).scalars().all()
if left:
print(f"[NOTE] 清场没清干净,还剩 {len(left)} 个探针渠道")
finally:
db.close()
for key, value in saved.items():
if value is None:
os.environ.pop(key, None)
else:
os.environ[key] = value
hubconfig.reload()
hub.close()
if __name__ == "__main__":
raise SystemExit(main())