ykxmz/_tests/test_verify_admin_format.py

# -*- coding: utf-8 -*-
"""打 admin.py 的格式化面。

ADMIN_CSS / ADMIN_JS 是 Python 字符串，里面用了 %-格式化。
只要有一个漏写的单个 %，render_admin() 就会抛
    ValueError: unsupported format character
而 relay 的上层兜底会把它变成 500 —— 管理页直接打不开。

反向的错也要查：如果某个**不参与格式化**的字符串里写了 %%
（为了转义而转义），页面上就会显示出字面的 "%%"。

这个测试直接调用 render_admin()，并逐字符扫描产物。
"""
from __future__ import annotations

import re
import sys
from pathlib import Path

ROOT = Path(__file__).resolve().parent.parent
sys.path.insert(0, str(ROOT / "relay"))

passed = 0
failed = 0


def check(name: str, ok: bool, detail: str = "") -> bool:
    global passed, failed
    if ok:
        passed += 1
        print("  [PASS] " + name)
    else:
        failed += 1
        print("  [FAIL] " + name + (("  —— " + str(detail)) if detail else ""))
    return ok


def main() -> int:
    import admin

    print("═══ 1. 扫描**源文件**里 ADMIN_CSS / ADMIN_JS 字面量的 % ═══")
    print("    注意：不能扫导入后的 admin.ADMIN_CSS ——")
    print("    它在定义处写了 `\"\"\" % {}`（第 231 行），导入时就已被格式化，")
    print("    %% 已经变成 %。扫那个值会把合法的单个 % 误判成漏写转义。")
    print("    必须回到源文件、只看三引号字面量本身。")
    src = (ROOT / "relay" / "admin.py").read_text(encoding="utf-8")
    for name in ("ADMIN_CSS", "ADMIN_JS"):
        m = re.search(rf"^{name} = \"\"\"", src, re.M)
        if not m:
            check(f"源文件里能找到 {name} 字面量", False)
            continue
        start = m.end()
        end = src.find('"""', start)
        literal = src[start:end]
        # 紧跟三引号之后是不是有 % 运算
        tail = src[end + 3:end + 12].strip()
        formatted = tail.startswith("%")
        print(f"    {name}: 字面量 {len(literal)} 字符，"
              f"定义后{'有' if formatted else '没有'} % 格式化"
              f"（紧跟 {tail[:6]!r}）")

        singles = []
        i = 0
        while i < len(literal):
            if literal[i] == "%":
                if i + 1 < len(literal) and literal[i + 1] == "%":
                    i += 2
                    continue
                singles.append((i, literal[max(0, i - 25):i + 25]))
                i += 1
            else:
                i += 1

        if formatted:
            # 会被格式化，单个 % 就是漏写，必须报告
            check(f"{name} 会被 %-格式化，字面量里不能有单个 %",
                  not singles, f"找到 {len(singles)} 处: "
                               + "; ".join(repr(c) for _p, c in singles[:3]))
        else:
            # 不参与格式化，单个 % 是正常的（而且 %(x)s 也不会被替换）
            check(f"{name} 不参与格式化，单个 % 无害", True)
            if singles:
                print(f"      （{name} 里有 {len(singles)} 个单个 %，"
                      f"因为不格式化所以无害）")

    print()
    print("═══ 1b. 反向检查：格式化后的值里不该再出现 %% ═══")
    check("导入后 ADMIN_CSS 里没有残留 %%",
          "%%" not in admin.ADMIN_CSS,
          "说明 %{} 格式化确实生效了")
    check("导入后 ADMIN_CSS 里保留了正常的 %",
          "100%" in admin.ADMIN_CSS)

    print()
    print("═══ 2. 真调 render_admin()，看能不能渲染出来 ═══")
    snap = {
        "ok": True, "version": "1.8.2", "uptimeSeconds": 3725,
        "devices": [], "sessions": 0, "totalRequests": 12,
        "memoryKB": 22656, "allowNew": True, "codeCount": 0,
    }
    try:
        html = admin.render_admin(snap, "https://relay.xxmxxs.top",
                                  "/zhongzhuanzhan", 0,
                                  lambda: [])
        check("空设备列表能渲染", isinstance(html, str) and len(html) > 500,
              f"len={len(html) if isinstance(html, str) else type(html)}")
    except Exception as exc:                               # noqa: BLE001
        check("空设备列表能渲染", False, f"{type(exc).__name__}: {exc}")
        return 1

    print()
    print("═══ 3. 产物里有没有残留的字面 %% ═══")
    if "%%" in html:
        idx = html.find("%%")
        ctx = html[max(0, idx - 80):idx + 80]
        check("渲染产物里没有字面 %%", False, f"出现在: {ctx!r}")
    else:
        check("渲染产物里没有字面 %%", True)

    print()
    print("═══ 4. 有设备 + 有会话时的渲染（覆盖表格分支）═══")
    snap2 = dict(snap)
    snap2["devices"] = [
        {"deviceId": "dev-aaa-111", "code": "246810", "name": "家里的电脑",
         "lanIps": ["192.168.1.5"], "port": 8765, "version": "1.8.2",
         "online": True, "idleSeconds": 3, "sessions": 1,
         "queuedToClient": 0, "queuedToAgent": 2,
         "bytesIn": 123456, "bytesOut": 654321},
        {"deviceId": "dev-bbb-222", "code": "135790", "name": "教室电脑",
         "lanIps": [], "port": 0, "version": "1.8.1",
         "online": False, "idleSeconds": 99999, "sessions": 0,
         "queuedToClient": 0, "queuedToAgent": 0,
         "bytesIn": 0, "bytesOut": 0},
    ]
    snap2["codeCount"] = 2
    try:
        html2 = admin.render_admin(snap2, "https://relay.xxmxxs.top",
                                   "/zhongzhuanzhan", 2,
                                   lambda: [{"name": "ykxmz-server-1.8.2.zip",
                                             "size": 214900}])
        check("有设备时能渲染", len(html2) > 1000, len(html2))
        check("有设备时没有字面 %%", "%%" not in html2)
        check("设备名出现在页面上", "家里的电脑" in html2)
        check("配对码出现在页面上", "246810" in html2)
    except Exception as exc:                               # noqa: BLE001
        check("有设备时能渲染", False, f"{type(exc).__name__}: {exc}")
        return 1

    print()
    print("═══ 5. 新增开关的控件和 JS 是否真的在页面里 ═══")
    for token, label in (
        ("allowNew", "allowNew 字段"),
        ("允许新设备接入", "开关文案"),
        ("data-recode", "改码按钮属性"),
    ):
        check(f"页面包含 {label}", token in html2, token)

    # 开关的 JS 里 % 有没有处理干净
    js = admin.ADMIN_JS
    if "fetch(" in js or "XMLHttpRequest" in js:
        check("JS 里有网络请求代码（不是空壳）", True)
    else:
        check("JS 里有网络请求代码（不是空壳）", False, "没找到 fetch/XHR")

    print()
    print("═══ 6. 极端输入：设备名里带 % 会不会把格式化搞崩 ═══")
    snap3 = dict(snap)
    snap3["devices"] = [
        {"deviceId": "dev-%s-%d", "code": "111111", "name": "百分号 %s %d %% 测试",
         "lanIps": [], "port": 0, "version": "1.8.2",
         "online": True, "idleSeconds": 1, "sessions": 0,
         "queuedToClient": 0, "queuedToAgent": 0,
         "bytesIn": 0, "bytesOut": 0},
    ]
    snap3["codeCount"] = 1
    try:
        html3 = admin.render_admin(snap3, "https://x", "/zhongzhuanzhan", 1,
                                   lambda: [])
        ok = "百分号" in html3
        check("设备名里的 % 不会让渲染崩溃", True)
        check("设备名里的 % 被当作普通字符保留", ok)
        if "%s" in html3 or "%d" in html3:
            idx = html3.find("%s") if "%s" in html3 else html3.find("%d")
            ctx = html3[max(0, idx - 60):idx + 60]
            check("页面里没有把设备名里的 %s 当成格式符吃掉", True)
            print(f"    · 上下文: {ctx!r}")
    except Exception as exc:                               # noqa: BLE001
        check("设备名里的 % 不会让渲染崩溃", False,
              f"{type(exc).__name__}: {exc}")

    print()
    print("═══ 7. 转义检查：设备名/deviceId 里的 HTML 是否被转义 ═══")
    snap4 = dict(snap)
    snap4["devices"] = [
        {"deviceId": "<img src=x onerror=alert(1)>",
         "code": "222222", "name": "<script>alert(2)</script>",
         "lanIps": [], "port": 0, "version": "1.8.2",
         "online": True, "idleSeconds": 1, "sessions": 0,
         "queuedToClient": 0, "queuedToAgent": 0,
         "bytesIn": 0, "bytesOut": 0},
    ]
    snap4["codeCount"] = 1
    html4 = admin.render_admin(snap4, "https://x", "/zhongzhuanzhan", 1,
                               lambda: [])
    check("设备名里的 <script> 被转义（无原始标签）",
          "<script>alert(2)</script>" not in html4,
          "发现原始 <script> -> 存储型 XSS")
    check("deviceId 里的 <img onerror 被转义",
          "<img src=x onerror=alert(1)>" not in html4,
          "发现原始 <img> -> 存储型 XSS")
    check("deviceId 在 data 属性里也被转义（引号）",
          'data-device="<img' not in html4)

    print()
    print("=" * 62)
    print(f"  通过 {passed} 项，失败 {failed} 项")
    print("=" * 62)
    return 1 if failed else 0


if __name__ == "__main__":
    sys.exit(main())