unis_hrms/tests/test_self_parity.py

223 lines
12 KiB
Python
Raw Permalink 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.

"""Web 工作台 ⇄ H5 自助端 的一致性守卫(纯静态,不连数据库)。
「普通用户在两端看到同一套模块」这件事靠三层保证:
1. ``web/src/self/manifest.ts`` —— 前端唯一的模块清单(名称/权限/顺序/图标/双端路径);
2. ``app/core/permissions.py`` 的 ``MOBILE_MENU_TREE`` 与 ``SELF_WEB_MENU_TREE``
—— 后端按权限下发给两个外壳的导航树;
3. ``app/core/permissions.py`` 的 ``SELF_LINKS`` —— 通知与待办落库的跳转路径。
三者一旦漂移(改了 H5 忘了 Web、后端 link 写成历史单数路径),本文件的断言就会红。
"""
from __future__ import annotations
import pathlib
import re
ROOT = pathlib.Path(__file__).resolve().parents[1]
WEB = ROOT / "web" / "src"
from app.core.permissions import SELF_LINKS, MOBILE_MENU_TREE, SELF_WEB_MENU_TREE # noqa: E402
MANIFEST = (WEB / "self" / "manifest.ts").read_text(encoding="utf-8")
APP = (WEB / "App.tsx").read_text(encoding="utf-8")
ROUTE_PERMS = (WEB / "api" / "routePerms.ts").read_text(encoding="utf-8")
MODE = (WEB / "lib" / "mode.ts").read_text(encoding="utf-8")
ICONS = (WEB / "components" / "icons.tsx").read_text(encoding="utf-8")
SELF_KEYS = {"home", "leave", "payslips", "benefits", "approvals", "tasks", "profile"}
TEXT = re.compile(r"(\w+): '([^']*)'")
def manifest_modules() -> dict[str, dict]:
"""解析 manifest.ts 里的 SELF_MODULES,返回 {key: {字段: 值}}。"""
body = MANIFEST.split("SELF_MODULES: Record<SelfModuleKey, SelfModule> = {", 1)[1]
body = body.split("\n}\n", 1)[0]
out: dict[str, dict] = {}
for name, block in re.findall(r"\n (\w+): \{(.*?)\n \},", body, re.S):
item = dict(TEXT.findall(block))
assert item.get("key") == name, f"{name}: key 与对象名不一致"
for flag in ("sort",):
item[flag] = int(re.search(flag + r": (\d+)", block).group(1))
for flag in ("inWebMenu", "inMobileTab"):
item[flag] = re.search(flag + r": (true|false)", block).group(1) == "true"
out[name] = item
return out
MODS = manifest_modules()
def test_manifest_lists_every_self_service_module():
assert set(MODS) == SELF_KEYS, "自助模块清单与 manifest 不符"
for key, m in MODS.items():
for field in ("name", "title", "desc", "perm", "webPath", "mobilePath",
"antdIcon", "mobileIcon", "emoji", "color"):
assert m.get(field), f"{key} 缺少 {field}"
def test_manifest_matches_backend_h5_menu_tree():
"""底部 5 个 tab:名称 / 权限 / 路径 / 顺序必须与后端下发的一致。"""
tabs = sorted((m for m in MODS.values() if m["inMobileTab"]), key=lambda x: x["sort"])
assert [m["name"] for m in tabs] == [n["name"] for n in MOBILE_MENU_TREE]
assert [m["mobilePath"] for m in tabs] == [n["path"] for n in MOBILE_MENU_TREE]
assert [m["perm"] for m in tabs] == [n["perm"] for n in MOBILE_MENU_TREE]
assert [n["sort"] for n in MOBILE_MENU_TREE] == sorted(n["sort"] for n in MOBILE_MENU_TREE)
def test_manifest_matches_backend_web_menu_tree():
"""Web 侧栏 5 项:除路径外,与 H5 tab 完全同名同序同权限。"""
nav = sorted((m for m in MODS.values() if m["inWebMenu"]), key=lambda x: x["sort"])
assert [m["name"] for m in nav] == [n["name"] for n in SELF_WEB_MENU_TREE]
assert [m["webPath"] for m in nav] == [n["path"] for n in SELF_WEB_MENU_TREE]
assert [m["perm"] for m in nav] == [n["perm"] for n in SELF_WEB_MENU_TREE]
assert [n["sort"] for n in SELF_WEB_MENU_TREE] == sorted(n["sort"] for n in SELF_WEB_MENU_TREE)
def test_two_shells_use_the_same_navigation_placement():
"""两端可见模块必须一模一样:多的少了都是「Web 和 H5 不一致」的回归。"""
assert {m["key"] for m in MODS.values() if m["inWebMenu"]} == \
{m["key"] for m in MODS.values() if m["inMobileTab"]}
# 审批与待办刻意不进导航,两端都从首页宫格进入
off = {k for k, m in MODS.items() if not m["inWebMenu"]}
assert off == {"approvals", "tasks"}, off
def test_every_self_route_exists_in_both_shells():
"""manifest 里的每个路径都必须在 App.tsx 注册了路由,否则点了就是 404。"""
for key, m in MODS.items():
assert re.search(r'<Route path="self/' + re.escape(m["webPath"].split("/")[-1]) + r'"', APP) \
or m["webPath"] == "/dashboard", f"{key}: Web 路由缺失 {m['webPath']}"
seg = m["mobilePath"].replace("/m", "").lstrip("/")
pattern = '<Route index' if not seg else '<Route path="' + re.escape(seg) + '"'
assert pattern in APP, f"{key}: H5 路由缺失 {m['mobilePath']}"
assert 'path="/m"' in APP
def test_web_route_perms_match_manifest_permissions():
"""Web 侧栏准入按权限:routePerms.ts 里登记的权限必须等于 manifest 的 perm。"""
for key, m in MODS.items():
if m["webPath"] == "/dashboard":
continue
row = re.search(re.escape("'" + m["webPath"] + "'") + r": \[([^\]]*)\]", ROUTE_PERMS)
assert row, f"{key}: routePerms.ts 未登记 {m['webPath']}"
assert m["perm"] in row.group(1), f"{key}: {m['webPath']} 权限 {row.group(1)} 与 {m['perm']} 不符"
def test_icons_are_registered_for_both_shells():
for key, m in MODS.items():
assert m["antdIcon"] in ICONS, f"{key}: 图标 {m['antdIcon']} 未注册"
block = ICONS.split("MOBILE_ICONS: Record<string, IconComp> = {", 1)[1].split("}", 1)[0]
registered = set(re.findall(r"(\w+):\s", block))
for key, m in MODS.items():
assert m["mobileIcon"] in registered, f"{key}: H5 图标 {m['mobileIcon']} 未注册"
def test_notification_links_follow_the_canonical_paths():
"""落库 link 只能是 manifest 里的 H5 路径,前端再改写为当前外壳的路径。"""
mobile = {m["mobilePath"] for m in MODS.values()}
for key, link in SELF_LINKS.items():
assert key in MODS, f"SELF_LINKS 多出未知模块 {key}"
assert link == MODS[key]["mobilePath"], f"{key}: link={link} 应为 {MODS[key]['mobilePath']}"
assert link in mobile
def test_business_code_never_hardcodes_mobile_paths():
"""通知 / 待办的 link 一律走 SELF_LINKS,避免又写出 /m/payslip 这种历史单数路径。"""
offenders = []
for py in (ROOT / "app").rglob("*.py"):
if py.name == "permissions.py":
continue
for lineno, line in enumerate(py.read_text(encoding="utf-8").splitlines(), 1):
if '"/m/' in line or "'/m/" in line:
offenders.append(f"{py.relative_to(ROOT)}:{lineno}")
assert not offenders, "请改用 SELF_LINKS:" + ", ".join(offenders)
def test_h5_pages_share_the_web_data_layer():
"""两端读同一批 hooks / queryKey:H5 页面不得再自己拼 query 与状态字典。"""
pages = sorted((WEB / "pages" / "mobile").glob("M*.tsx"))
extra = {"MLogin.tsx"}
checked = [p for p in pages if p.name not in extra]
assert len(checked) >= 7, "H5 页面数量异常"
for p in checked:
src = p.read_text(encoding="utf-8")
assert "from '../../api/http'" not in src, f"{p.name} 仍在直连 api/http"
assert re.search(r"useQuery\(|useMutation\(", src) is None, f"{p.name} 仍自建查询"
for p in sorted((WEB / "pages" / "self").glob("*.tsx")):
if p.name == "_shared.tsx":
continue
assert "from '../../api/self'" in p.read_text(encoding="utf-8"), f"{p.name} 未使用公共数据层"
def test_both_shells_use_the_shared_formatters():
"""金额/百分比只能走 lib/selfLabels 的格式化函数,避免两端数值字面不一致。"""
offenders: list[str] = []
for sub in ("self", "mobile"):
for tsx in (WEB / "pages" / sub).glob("*.tsx"):
if tsx.name == "_shared.tsx":
continue
for lineno, line in enumerate(tsx.read_text(encoding="utf-8").splitlines(), 1):
# 0.07 * 100 直出百分比会露出浮点尾数(7.000000000000001%)
if re.search(r"\* 100\)?}\s*%", line) or "\u00a5{Number" in line:
offenders.append(f"{tsx.relative_to(ROOT)}:{lineno}")
assert not offenders, "请改用 selfLabels 的 pct()/rmb():" + ", ".join(offenders)
# 用到比例与金额的页面必须真的引用了公共层
for name in ("self/Benefits.tsx", "mobile/MBenefits.tsx"):
src = (WEB / "pages" / name).read_text(encoding="utf-8")
assert "pct" in src and "rmb" in src, f"{name} 未使用公共格式化函数"
def test_status_dictionaries_are_complete_for_both_shells():
"""状态中文只有一份来源:自助端不得漏字典、也不得再内联三元判断。"""
labels = (WEB / "lib" / "selfLabels.ts").read_text(encoding="utf-8")
defs = (WEB / "api" / "defs.ts").read_text(encoding="utf-8")
# 合同状态取自后台同一份 CONTRACT_STATUS_OPTIONS,renewed 这类取值不会再露英文
block = labels.split("export const CONTRACT_STATUS_TEXT", 1)[1].split("export const", 1)[0]
assert "CONTRACT_STATUS_OPTIONS.map" in block, "合同状态字典应派生自 api/defs"
opts = defs.split("export const CONTRACT_STATUS_OPTIONS", 1)[1].split("]", 1)[0]
colors = labels.split("export const CONTRACT_STATUS_COLOR", 1)[1].split("}", 1)[0]
for value in re.findall(r"value: '(\w+)'", opts):
assert f"{value}: '" in colors, f"合同状态 {value} 缺少配色"
# 两端页面不得再把 .status / .unit 各自翻译成中文:必须走 lib/selfLabels 字典
offenders: list[str] = []
for sub in ("self", "mobile"):
for tsx in (WEB / "pages" / sub).glob("*.tsx"):
for lineno, line in enumerate(tsx.read_text(encoding="utf-8").splitlines(), 1):
if re.search(r"(?<!\?)\.(status|unit)\s*===\s*'[\w-]+'\s*\?\s*'[^']*[一-鿿]", line):
offenders.append(f"{tsx.relative_to(ROOT)}:{lineno}")
assert not offenders, "请改用 lib/selfLabels 的状态字典:" + ", ".join(offenders)
def test_desktop_lands_on_web_shell_by_default():
"""问题 1 的回归守卫:桌面浏览器必须落 Web 工作台,账号不决定外壳。"""
assert "localStorage" in MODE, "外壳偏好必须持久化,否则员工每次登录都被拽回 H5"
entry = MODE.split("export const entryPath", 1)[1].split("\n", 2)[:2]
assert "currentMode() === 'h5'" in entry[0]
assert "'/m'" in entry[0] and "'/dashboard'" in entry[0]
# 偏好优先于设备:只有显式选了 H5 或本身是手机浏览器才走 H5
assert "pref === 'auto' ? detectMode() : pref" in MODE
assert "isMobileBrowser()" in MODE
# 登录与过期跳转都必须经过外壳改写,不能把 ?redirect=/m 原样吞下
assert "sanitizeRedirect(" in (WEB / "pages" / "Login.tsx").read_text(encoding="utf-8")
auth = (WEB / "store" / "auth.ts").read_text(encoding="utf-8")
assert "pathname.startsWith('/m')" not in auth, "token 过期不能再按 /m 前缀决定去向"
def test_both_home_grids_come_from_the_manifest():
"""两端首页宫格都由 manifest 生成:新增模块时只需改一处,两端同时出现。"""
for name in ("SelfHome.tsx", "mobile/MHome.tsx"):
src = (WEB / "pages" / name).read_text(encoding="utf-8")
assert "permittedModules(" in src, f"{name} 首页宫格未取 manifest"
assert "setModePref(" in src, f"{name} 缺少显式切换外壳的入口"
# 两端都能一键切到对方,且切完记住偏好
for name in ("SelfHome.tsx", "mobile/MHome.tsx", "mobile/MProfile.tsx"):
assert "oppositePath(" in (WEB / "pages" / name).read_text(encoding="utf-8"), name
def test_no_web_self_frame_phone_mockup_left():
"""Web 端不再用手机框套 H5 页面 —— 这是两端功能不一致的历史根源。"""
assert not (WEB / "components" / "WebSelfFrame.tsx").exists()
assert "web-self-frame" not in (WEB / "styles" / "global.css").read_text(encoding="utf-8")
assert "WebSelfFrame" not in re.sub(r"/\*.*?\*/", "", APP, flags=re.S), "Web 端不得再引用手机框"