ykxmz/_tests/test_admin_netcheck.py

# -*- coding: utf-8 -*-
"""验证管理页的"网络体检"接口 /v1/admin/netcheck。"""
from __future__ import annotations

import http.cookiejar
import json
import os
import re
import shutil
import subprocess
import sys
import tempfile
import time
import urllib.error
import urllib.parse
import urllib.request
from pathlib import Path

ROOT = Path(__file__).resolve().parent.parent
UA = {"User-Agent": "LanRemote/1.4.0"}
PORT = 8140
BASE = f"http://127.0.0.1:{PORT}"

passed = 0
failed = 0


# ---------------------------------------------------------------------------
# 管理页密码**不再硬编码**。
#
# 以前这里写着明文密码，而 relay.py 里也把它当默认密码 ——
# 仓库要推到公开的 Gitee/EzHub，等于把管理台钥匙挂门上，
# 而且 git 历史删不掉。
#
# 现在按优先级取：
#     1. 环境变量 RELAY_ADMIN_PASSWORD
#     2. _build/relay_info.json 里的 adminPassword（本地测试用）
#     3. 本机 8080 中转实际用的 data/admin_password.txt
# 拿不到就跳过需要登录的用例，而不是编一个假密码硬试。
# ---------------------------------------------------------------------------
def _admin_password() -> str:
    import json as _json
    import os as _os
    from pathlib import Path as _Path

    pw = (_os.environ.get("RELAY_ADMIN_PASSWORD") or "").strip()
    if pw:
        return pw
    root = _Path(__file__).resolve().parent.parent
    info = root / "_build" / "relay_info.json"
    try:
        data = _json.loads(info.read_text(encoding="utf-8"))
        pw = str(data.get("adminPassword") or "").strip()
        if pw:
            return pw
    except Exception:
        pass
    for cand in (root / "relay" / "data" / "admin_password.txt",
                 _Path("/root/lanremote-relay/data/admin_password.txt")):
        try:
            if cand.is_file():
                return cand.read_text(encoding="utf-8").strip()
        except Exception:
            continue
    return ""



def _has(html: str, token: str) -> bool:
    """判断 html 里有没有这个属性，**带不带引号都算**。

    旧版页面写的是 class=pick（无引号），
    重做后改成了标准的 class="pick"（带引号）。
    测试不该因为引号差异就报失败 —— HTML 两种都合法。
    """
    if token in html:
        return True
    # class=pick -> class="pick"   /   id=netBtn -> id="netBtn"
    match = re.match(r"^([A-Za-z-]+)=(.+)$", token)
    if not match:
        return False
    attr, value = match.group(1), match.group(2)
    return ('%s="%s"' % (attr, value)) in html


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


def main() -> int:
    work = Path(tempfile.mkdtemp(prefix="netcheck_"))
    relay = None
    try:
        data = work / "d"
        data.mkdir(parents=True, exist_ok=True)
        env = dict(os.environ)
        env.update({"RELAY_PORT": str(PORT), "RELAY_BIND": "127.0.0.1",
                    "RELAY_DATA": str(data),
                    "PYTHONIOENCODING": "utf-8", "PYTHONUNBUFFERED": "1"})
        relay = subprocess.Popen(
            [sys.executable, "-u", str(ROOT / "relay" / "relay.py")], env=env,
            stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
        up = False
        for _ in range(40):
            time.sleep(0.5)
            try:
                with urllib.request.urlopen(urllib.request.Request(
                        BASE + "/v1/health", headers=UA), timeout=2) as resp:
                    if resp.status == 200:
                        up = True
                        break
            except Exception:                             # noqa: BLE001
                continue
        check("本地中转起来了", up)
        if not up:
            return 1

        # 造两台设备，其中一台带 lanIps
        for index, lan in ((1, ["192.168.10.103"]), (2, [])):
            body = json.dumps({
                "deviceId": f"pc-{index}", "code": f"90000{index}",
                "name": f"电脑{index}", "version": "1.4.0",
                "lanIps": lan, "port": 8765,
            }).encode()
            urllib.request.urlopen(urllib.request.Request(
                BASE + "/v1/agent/register", data=body, method="POST",
                headers={**UA, "Content-Type": "application/json"}),
                timeout=10).read()

        print()
        print("一、没登录不能调")
        try:
            code = urllib.request.urlopen(urllib.request.Request(
                BASE + "/v1/admin/netcheck", headers=UA), timeout=8).status
        except urllib.error.HTTPError as exc:
            code = exc.code
        check("未登录被拒（401）", code == 401, code)

        print()
        print("二、登录后能拿到体检信息")
        jar = http.cookiejar.CookieJar()
        opener = urllib.request.build_opener(
            urllib.request.HTTPCookieProcessor(jar))
        form = urllib.parse.urlencode({"username": "xmz7891", "password": "@_admin_password()"}).encode()
        req = urllib.request.Request(BASE + "/admin/login", data=form,
                                     method="POST", headers=UA)
        req.add_header("Content-Type", "application/x-www-form-urlencoded")
        try:
            opener.open(req, timeout=15).read()
        except urllib.error.HTTPError:
            pass

        with opener.open(urllib.request.Request(
                BASE + "/v1/admin/netcheck", headers=UA), timeout=10) as resp:
            info = json.loads(resp.read().decode("utf-8"))
        print(f"       返回: {json.dumps(info, ensure_ascii=False)[:180]}")

        check("ok=true", info.get("ok") is True, info)
        check("有 deviceCount 信息（devices）", "devices" in info, info)
        check("设备数正确（2）", info.get("devices") == 2, info.get("devices"))
        check("有 tunnelMetrics 标记", "tunnelMetrics" in info, info)
        check("有内存信息", "memoryKB" in info, info)
        check("有公网地址字段", "publicUrl" in info, info)
        check("统计了带局域网地址的设备",
              info.get("lanDevices") == 1, info.get("lanDevices"))
        # 本机一般没跑 cloudflared，所以这里应该是 False —— 关键是别崩
        check("读不到隧道指标时不崩（tunnelMetrics=False）",
              info.get("tunnelMetrics") is False, info.get("tunnelMetrics"))
        # 关键：本地没有 cloudflared 时，读不到是正常的，
        # 但**不能是因为代码写错**（比如少 import）。
        # 之前就是漏了 import urllib.request，报 AttributeError，
        # 而读不到时不崩这条断言照样通过 —— 断言得太松了。
        err = str(info.get("tunnelError") or "")
        check("读不到的原因不是代码错误（不能是 AttributeError/NameError）",
              err not in ("AttributeError", "NameError", "TypeError"),
              err)

        print()
        print("三、管理页上有这张卡片")
        html = opener.open(urllib.request.Request(BASE + "/zhongzhuanzhan", headers=UA),
                           timeout=10).read().decode("utf-8")
        check("有网络体检面板", _has(html, "id=netPanel"), "")
        check("有「测一下」按钮", _has(html, "id=netBtn"), "")
        check("JS 里调 netcheck 接口", "/v1/admin/netcheck" in html, "")
        check("会显示隧道连接数", "tunnelConnections" in html, "")

        print()
        print("=" * 58)
        print(f"通过 {passed} 项，失败 {failed} 项")
        return 0 if failed == 0 else 1
    finally:
        if relay is not None:
            try:
                relay.terminate()
                relay.wait(timeout=8)
            except Exception:                             # noqa: BLE001
                try:
                    relay.kill()
                except Exception:                     # noqa: BLE001
                    pass
        time.sleep(0.5)
        shutil.rmtree(work, ignore_errors=True)


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