/webapp-testing

name: webapp-testing
description: 使用 Playwright 与本地 Web 应用程序交互及进行测试的工具包。支持验证前端功能、调试 UI 行为、捕获浏览器截图以及查看浏览器日志。
license: 完整条款见 LICENSE.txt

Web 应用程序测试

要测试本地 Web 应用程序，请编写原生的 Python Playwright 脚本。

**可用的辅助脚本**:

• `scripts/with_server.py` - 管理服务器生命周期（支持多服务器）

**务必先运行带有 `--help` 参数的脚本**以查看用法。除非您在尝试运行脚本后发现绝对需要自定义解决方案，否则不要阅读源码。这些脚本可能非常庞大，从而污染您的上下文窗口。它们旨在作为黑盒脚本直接调用，而不是摄入到您的上下文窗口中。

决策树：选择您的方法

用户任务 → 是静态 HTML 吗？
    ├─ 是 → 直接读取 HTML 文件以识别选择器 (selectors)
    │         ├─ 成功 → 使用选择器编写 Playwright 脚本
    │         └─ 失败/不完整 → 视为动态（见下文）
    │
    └─ 否 (动态 Web 应用) → 服务器是否已在运行？
        ├─ 否 → 运行：python scripts/with_server.py --help
        │        然后使用辅助工具 + 编写简化的 Playwright 脚本
        │
        └─ 是 → 侦察并行动：
            1. 导航并等待 networkidle
            2. 截图或检查 DOM
            3. 从渲染状态中识别选择器 (selectors)
            4. 使用发现的选择器执行操作

示例：使用 with_server.py

要启动服务器，请先运行 `--help`，然后使用该辅助工具：

**单个服务器：**

python scripts/with_server.py --server "npm run dev" --port 5173 -- python your_automation.py

**多个服务器（例如，后端 + 前端）：**

python scripts/with_server.py \
  --server "cd backend && python server.py" --port 3000 \
  --server "cd frontend && npm run dev" --port 5173 \
  -- python your_automation.py

要创建自动化脚本，仅需包含 Playwright 逻辑（服务器由程序自动管理）：

from playwright.sync_api import sync_playwright

with sync_playwright() as p:
    browser = p.chromium.launch(headless=True) # 始终以无头模式启动 chromium
    page = browser.new_page()
    page.goto('http://localhost:5173') # 服务器已在运行并就绪
    page.wait_for_load_state('networkidle') # 关键：等待 JS 执行
    # ... 您的自动化逻辑
    browser.close()

侦察并行动模式

1. **检查渲染后的 DOM**：

   page.screenshot(path='/tmp/inspect.png', full_page=True)
   content = page.content()
   page.locator('button').all()

2. **从检查结果中识别选择器 (selectors)**

3. **使用发现的选择器执行操作**

常见陷阱

❌ **不要**在动态应用等待 `networkidle` 之前检查 DOM ✅ **务必**在检查前等待 `page.wait_for_load_state('networkidle')`

最佳实践

• **将捆绑脚本视为黑盒** - 要完成一项任务，请考虑 `scripts/` 中可用的脚本之一是否有所帮助。这些脚本可以可靠地处理常见的复杂工作流，而不会弄乱上下文窗口。使用 `--help` 查看用法，然后直接调用。
• 对同步脚本使用 `sync_playwright()`
• 完成后务必关闭浏览器
• 使用描述性的选择器：`text=`、`role=`、CSS 选择器或 ID
• 添加适当的等待：`page.wait_for_selector()` 或 `page.wait_for_timeout()`

参考文件

• **examples/** - 显示常见模式的示例：
• `element_discovery.py` - 发现页面上的按钮、链接和输入框
• `static_html_automation.py` - 对本地 HTML 使用 file:// URL
• `console_logging.py` - 在自动化过程中捕获控制台日志 (console logs)