易测 - Y-Test Runner

🚀 一个强大的 VSCode 扩展，让 UI 自动化测试变得更简单！

✨ 什么是易测？

易测是一个专为前端开发者设计的 UI 自动化测试助手，通过 VSCode 扩展的形式集成 y-test CLI 工具，让你可以在熟悉的编辑器中完成从需求文档到自动化测试脚本的全流程：

📄 从飞书文档自动生成测试用例 - 支持直接从飞书文档提取需求并生成结构化测试用例
🎯 可视化测试管理 - 无需记忆复杂命令，通过图形界面完成项目初始化、用例生成、调试和执行
🤖 AI 辅助测试编写 - 利用知识库和 AI 能力，快速生成自动化测试代码
📊 完整的测试工作流 - 覆盖测试用例设计、脚本生成、执行调试、报告查看的全链路

🎯 核心功能

📄 飞书文档集成 ⭐NEW

从需求文档到测试用例，一键完成！

将产品需求文档直接转化为结构化测试用例，大幅提升测试设计效率。

功能亮点：

📑 支持多种飞书文档类型 - 飞书文档（docx）、飞书知识库（wiki）、飞书表格（sheets）、旧版文档（docs）
🔄 自动文档处理 - 将飞书文档自动转换为 PDF 并上传至 CDN，无需手动下载
🤖 AI 智能解析 - 利用 AI 分析需求文档，自动提取测试场景、业务逻辑和验证点
📝 结构化用例生成 - 生成包含前置条件、测试步骤、预期结果的完整测试用例树
💾 本地文件保存 - 自动保存为 JSON 格式，可直接用于生成自动化脚本
⚡ 实时进度反馈 - 显示文档下载、AI 分析、用例生成的每个步骤进度

使用流程：

产品经理在飞书中撰写需求文档
测试人员复制飞书文档链接（如：https://xxx.feishu.cn/docx/xxxxx）
在插件的"飞书 Case 生成"面板粘贴链接，输入 KeonesId
点击"生成 Case"，AI 自动分析文档并生成结构化测试用例
预览生成的测试用例树结构，确认用例覆盖度
点击"保存文件"，自动保存到本地 y-test/cases/ 目录

适用场景：

新需求的测试用例设计
需求变更时快速更新测试用例
批量生成回归测试用例
团队测试用例规范化

🚀 项目初始化

快速搭建自动化测试环境

一键创建标准化的测试项目结构，配置测试环境参数。

功能特性：

📦 一键初始化 - 自动创建 y-test 测试项目的完整目录结构
⚙️ 可视化配置 - 通过表单配置测试环境（开发域名、测试域名、认证 Token）
🔄 配置同步 - 自动创建项目配置文件并同步到服务器
💾 持久化保存 - 配置信息自动保存，下次打开无需重新设置
📂 标准目录结构 - 自动创建 y-test/cases/、y-test/e2e/、config.json 等标准目录和文件
✅ 环境验证 - 自动检查依赖和环境配置是否正确

生成的目录结构：

your-project/
├── midscene_run/          # 测试运行数据
│   └── report/            # 测试报告
│       └── index.html
├── y-test/                # y-test 测试目录
│   ├── config.json        # 项目配置文件
│   ├── cases/             # 测试用例定义（JSON格式）
│   └── e2e/               # 生成的测试文件
├── playwright.config.ts   # Playwright 配置
└── package.json

📝 测试脚本生成

从 JSON 用例到可执行脚本

将结构化的 JSON 测试用例转换为可执行的 Playwright 自动化测试脚本。

功能特性：

📁 可视化文件浏览 - 树形结构浏览和选择测试用例文件（JSON 格式）
🤖 一键生成脚本 - 将 JSON 用例自动转换为 Playwright 测试脚本（.spec.ts）
📊 实时进度显示 - 查看生成进度和详细日志，了解每个步骤的执行情况
✅ 自动打开文件 - 生成完成后自动打开生成的测试文件，方便查看和编辑
🔍 文件搜索筛选 - 支持快速搜索和筛选测试用例文件
📦 批量生成 - 支持同时选择多个 JSON 文件批量生成

适用于：

从飞书文档生成的测试用例
手动编写的 JSON 测试用例
批量生成多个测试场景

🔍 智能代码生成

在编辑器中直接生成测试代码

基于 AI 的智能代码生成能力，帮助你快速编写单个测试用例的自动化代码。

功能特性：

💡 智能悬停提示 - 悬停在测试用例描述上，自动显示生成代码的入口
⚡ 自然语言输入 - 使用自然语言描述测试步骤，AI 自动转换为代码
🧠 知识库辅助 - 可选择使用知识库辅助生成，提升代码质量和准确性
📝 实时代码预览 - 在专用面板中实时预览生成的测试代码
🎯 多格式支持 - 适配多种测试文件格式（.spec.js、.test.ts、.spec.tsx 等）
📋 一键复制 - 快速复制生成的代码到项目中使用

使用方式：

在测试文件中，悬停在 test() 或 it() 的描述文本上
点击弹出的"🚀 生成单条自动化测试代码"链接
在代码生成面板中输入测试步骤的自然语言描述
选择是否使用知识库辅助（推荐）
点击"生成"按钮，AI 自动生成对应的 Playwright 代码
预览并复制代码到项目中使用

示例：

输入：「登录系统，点击用户菜单，验证显示用户名」
输出：完整的 Playwright 测试代码，包含登录、点击、断言等操作

支持的文件识别：

.spec.js / .spec.ts / .spec.tsx
.test.js / .test.ts / .test.tsx
test/、tests/、e2e/、__tests__/ 目录下的文件

🐛 交互式调试

可视化调试测试脚本

启动 Playwright UI 模式，可视化调试测试脚本的执行过程。

功能特性：

🎮 UI 调试模式 - 启动 Playwright 的 UI 模式，提供友好的调试界面
🔄 实时执行查看 - 实时查看测试执行过程，每个步骤都可视化展示
🖼️ 元素定位检查 - 可视化查看页面元素定位，验证选择器是否正确
⏯️ 执行控制 - 支持暂停、单步执行、继续运行、重新运行
⏹️ 随时停止 - 可以随时停止和重启调试会话
🔍 状态监控 - 自动检测调试服务启动状态和错误信息
📋 日志输出 - 在输出面板实时显示调试日志

适用场景：

调试测试脚本的执行逻辑
验证页面元素选择器是否正确
排查测试失败原因
优化测试用例执行流程
学习和理解测试代码的执行过程

⚡ 测试执行

一键运行自动化测试

执行自动化测试并生成测试报告，支持全量执行或选择性执行。

功能特性：

🏃 灵活执行 - 支持执行全部测试或指定的测试文件
📊 实时日志 - 实时显示测试执行日志和进度，了解每个用例的执行情况
⏹️ 中途停止 - 支持中途停止执行，避免长时间等待
📈 自动打开报告 - 测试完成后自动生成并打开 HTML 报告
🔄 失败重试 - 支持重新运行失败的测试用例
💾 历史记录 - 保存测试执行历史，方便对比和追踪

执行选项：

执行所有测试文件
执行指定的单个测试文件
执行失败的测试用例（重试）

📊 测试报告查看

清晰呈现测试结果

自动扫描和管理测试报告，提供便捷的报告查看功能。

功能特性：

📈 自动扫描 - 自动扫描并列出所有测试报告
🌐 一键打开 - 一键在浏览器中打开 HTML 格式的测试报告
🔄 手动刷新 - 支持手动刷新报告列表，获取最新报告
📂 目录展示 - 显示报告的生成时间和目录结构
📸 多媒体支持 - 报告包含测试截图和执行录像（如果配置）
📋 历史报告 - 保留历史报告，方便对比不同版本的测试结果

报告内容：

测试用例执行统计（通过/失败/跳过）
每个用例的执行时间
失败用例的错误信息和堆栈
测试执行的截图和视频
详细的测试步骤日志

💡 使用指南

🎯 智能悬停功能

在已生成的测试文件（如 y-test/e2e/*.spec.ts）中：

将鼠标悬停在 test() 或 it() 函数的测试用例描述上
查看弹出的悬停提示窗口，显示测试用例完整信息
点击 🚀 生成单条自动化测试代码 链接
在打开的代码生成面板中：
- 输入自然语言描述的测试步骤
- 选择是否使用知识库辅助生成（推荐开启）
- 点击"生成"按钮查看生成的测试代码
- 复制代码到项目中使用

提示：智能悬停支持多种测试文件格式：

.spec.js / .spec.ts / .spec.tsx
.test.js / .test.ts / .test.tsx
test/、tests/、e2e/、__tests__/ 目录下的文件

⌨️ 命令面板快捷操作

按 Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac) 打开命令面板，输入"易测"或"YTest"查看所有可用命令：

YTest: 生成单条自动化测试代码 - 快速生成单个测试用例代码
YTest: 打开单条用例代码生成面板 - 打开专用代码生成界面
YTest: 重置插件状态 - 清除所有配置和状态，重新开始
YTest: 刷新 YTest 环境 - 更新 y-test 工具链和依赖
YTest: 检查插件更新 - 检查是否有新版本可用

🔧 状态管理与持久化

易测会自动保存以下信息（存储在 VSCode 工作区状态中）：

🏠 选择的根目录路径 - 避免每次打开都重新选择
⚙️ 项目初始化配置 - 保存域名、Token等设置
📝 最近使用的文件 - 快速访问常用测试文件

需要清除所有保存的状态？使用命令面板中的 "YTest: 重置插件状态" 命令即可恢复初始状态。

📂 完整工作流示例

从需求文档到自动化测试的完整流程：

项目初始化（首次使用）
- 打开 VSCode 侧边栏的"易测"面板
- 选择项目根目录
- 点击"初始化项目"，填写配置信息（域名、Token）
- 等待初始化完成
生成测试用例（从飞书文档）
- 复制飞书需求文档链接
- 在"飞书 Case 生成"面板粘贴链接
- 输入 KeonesId
- 点击"生成 Case"，等待 AI 分析
- 预览生成的测试用例树
- 点击"保存文件"
生成测试脚本
- 在文件浏览器中选择刚保存的 JSON 文件
- 点击"生成测试"按钮
- 等待脚本生成完成
- 查看自动打开的 .spec.ts 文件
调试测试脚本
- 点击"开始调试"按钮
- 在 Playwright UI 中查看测试执行过程
- 验证元素定位和测试逻辑
- 如有问题，修改代码后重新调试
执行测试
- 点击"执行测试"按钮
- 实时查看测试执行日志
- 等待测试完成
查看报告
- 测试完成后自动打开 HTML 报告
- 或在"报告列表"中选择历史报告查看

🎨 界面介绍

主侧边栏面板

🌳 目录选择器 - 树形结构浏览和选择项目根目录
📁 文件浏览器 - 显示 y-test/cases/ 下的测试用例 JSON 文件
🛠️ 操作工具栏 - 提供以下功能按钮：
- 🚀 初始化项目 - 首次配置 y-test 项目
- 📝 生成测试 - 从 JSON 生成测试代码
- 🐛 开始调试 - 启动 Playwright UI 模式
- ⚡ 执行测试 - 运行测试并生成报告
- ⏹️ 停止任务 - 终止当前运行的任务
📄 飞书 Case 生成 - 输入飞书文档链接，生成测试用例
📊 报告列表 - 显示 midscene_run/report/ 下的所有报告文件
📋 实时日志 - 显示命令执行状态和输出

单条代码生成面板

💻 代码编辑器 - 实时预览生成的测试代码，支持语法高亮
📝 输入区域 - 输入自然语言测试步骤描述
⚙️ 配置选项 - 选择是否使用知识库辅助
🔄 生成按钮 - 触发代码生成流程
📋 复制按钮 - 一键复制生成的代码

输出面板

在 VSCode 底部的"输出"面板中，选择 "易测 YTest Runner" 频道可以查看：

✅ 命令执行的详细日志
⚠️ 错误和警告信息
📊 测试进度和结果
🔍 调试信息（用于问题排查）

🆘 常见问题

Q: 提示 "ytest 命令未找到"？

确保已全局安装 y-test CLI：npm install -g @ke/y-test
验证安装：在终端运行 ytest --version
如果安装后仍提示未找到，尝试重启 VSCode
检查系统 PATH 环境变量是否包含 npm 全局包路径
检查 node 版本是否为 18 或以上

Q: 飞书文档生成失败？

确认飞书文档链接格式正确（完整的 URL）
检查文档是否有访问权限（需要登录飞书账号）
确认文档内容不为空
查看输出面板的详细错误信息
支持的文档类型：docx、wiki、sheets、docs

Q: 初始化项目时出错？

确保选择的目录是前端项目的根目录（包含 package.json）
检查目录是否有写入权限
确认已安装 Git 并配置了用户信息（git config user.email）
查看输出面板的详细错误信息

Q: 生成的测试代码在哪里？

从 JSON 生成的测试文件位于：y-test/e2e/ 目录
单条代码生成的代码显示在代码生成面板中，需手动复制到项目
生成成功后，插件会自动打开生成的文件

Q: 调试模式启动失败？

确保项目已正确初始化（存在 y-test/ 目录）
检查是否缺少依赖：运行 npm install 和 npx playwright install chromium
查看输出面板的错误信息，通常会提示缺少的模块
确认端口未被占用（调试模式默认使用特定端口）

Q: 如何查看详细的执行日志？

打开 VSCode 底部面板（View → Output 或 Ctrl+Shift+U）
在下拉菜单中选择 "易测 YTest Runner"
所有命令执行、进程输出和错误信息都会实时显示

Q: 插件运行异常或状态错误？

A: 尝试以下方法：

使用命令面板 → "YTest: 重置插件状态" 清除所有缓存
重启 VSCode
检查 y-test CLI 版本是否最新：npm update -g @ke/y-test
查看输出面板的详细错误信息并反馈给开发团队

Q: 测试报告打不开？

确认测试已成功执行完成
检查 midscene_run/report/ 目录是否存在报告文件
点击侧边栏的"刷新报告"按钮重新扫描
确保系统已安装浏览器（Chrome/Edge/Firefox）

Q: 智能悬停功能不生效？

确保文件路径包含 .spec.、.test. 或在 test/、e2e/ 目录下
检查是否打开了 JavaScript/TypeScript 文件
悬停位置需在 test() 或 it() 函数的字符串参数上
确保插件已激活（打开过侧边栏或执行过相关命令）

Q: AI 生成的测试用例质量不理想？

确保需求文档描述清晰、结构完整
在文档中明确标注测试点和验证规则
使用知识库辅助功能（如果支持）
生成后可以手动调整和优化测试用例
将优化后的用例作为参考，提升后续生成质量

📦 安装要求

前置依赖

VSCode: 版本 1.99.0 或更高
Node.js: 建议 18.x 或更高版本
y-test CLI: 全局安装 npm install -g @ke/y-test
Git: 用于项目初始化和配置管理

可选依赖

Playwright: 用于测试执行（首次运行时会自动安装）
浏览器: 用于查看测试报告（Chrome/Edge/Firefox）

🔄 更新日志

v0.0.22 (Latest)

✨ 新增飞书文档集成功能，支持从飞书文档自动生成测试用例
🎨 优化用户界面，提升操作体验
🐛 修复已知问题

历史版本

v0.0.13: 修复智能悬停功能激活问题，添加语言激活事件
v0.0.1: 首个版本发布，包含基础测试管理功能

易测 - 让 UI 自动化测试更简单、更高效！ 🚀