taskflow-yaml-run

为基于 guandata taskflow 的 API 自动化测试项目开发的用例快速执行工具。支持 Java 和 Python 两种执行环境。

功能特性

🚀 多执行环境支持

插件根据文件路径自动识别执行环境：

• Python 执行: api_integration_test/ 目录下的 YAML 文件
• Java 执行: src/main/resources/ 目录下的 YAML 文件

📂 支持的执行方式

1. 编辑器标题栏执行

   

   打开 YAML 文件时，点击标题栏的 ▶️ 按钮执行

2. 右键菜单执行

   

   • 单个 YAML 文件执行
   • 整个目录执行（包含所有 YAML 文件）

   

🔍 ApiTask 代码的预览和跳转

在 YAML 文件中悬停在 clazz 字段上，可以：

• 预览对应的 Python / Java 类代码
• 点击链接直接跳转到 Python / Java 文件

执行逻辑

Python 执行 (优先级高)

• 路径要求: 文件必须在 api_integration_test/ 目录下
• 执行命令: poetry run api_test --files={相对路径}
• 工作目录: 项目根目录

Java 执行

• 路径要求: 文件必须在 src/main/resources/ 目录下
• 执行流程:
  1. 动态获取 Maven classpath
  2. 生成 argfile (.run/auto_gen_yaml_run.argfile)
  3. 执行 java @argfile com.guandata.test.TestExecutor -f {相对路径}
  4. 自动打开测试报告 (report/result_report.html)

环境要求

Python 项目

• 安装 Poetry
• 配置 api_test 命令

Java 项目

• Maven 项目结构
• com.guandata.test.TestExecutor 类
• 编译后的 target/classes 目录

开发调试

调试插件

1. 启动调试环境

   F5 或 Ctrl+F5
   

2. 设置断点

   • 在 src/extension.js 中点击行号左侧设置断点
   • 或按 F9 在当前行设置断点

3. 查看调试信息

   • Debug Console: View > Debug Console - 查看 console.log 输出
   • Output Panel: View > Output 选择 "Extension Host" - 查看插件日志
   • Developer Tools: 在测试窗口中 Help > Toggle Developer Tools

4. 重新加载插件

   • 在测试窗口中按 Ctrl+R (macOS: Cmd+R)
   • 或使用命令面板: Developer: Reload Window

测试流程

1. 按 F5 启动调试环境
2. 在新窗口中打开包含测试文件的项目
3. 在 api_integration_test/ 或 src/main/resources/ 目录下创建或打开 YAML 文件
4. 通过右键菜单或编辑器按钮测试执行功能

项目结构

taskflow-yaml-run/
├── src/
│   ├── extension.js          # 主要逻辑
│   └── assets/              # 图标资源
├── package.json             # 插件配置
└── README.md               # 说明文档

Enjoy!