katalonstudio/agent

Katalon TestOps Agent

概述和主要用途

Katalon TestOps Agent是一款与Katalon TestOps平台集成的代理工具，主要用于在持续集成（CI）环境中执行测试任务，实现测试流程的自动化管理。通过配置代理名称、认证凭据、服务器URL及团队ID等参数，Agent可与Katalon TestOps平台通信，接收测试任务并上报执行结果，适用于团队协作场景下的自动化测试流程管理。

核心功能和特性

• 平台集成：支持与Katalon TestOps平台无缝集成，通过配置团队ID实现团队内资源共享
• 灵活配置：可自定义代理名称、认证信息（***、API密钥）、服务器URL，支持代理服务器、日志级别及临时文件保留策略设置
• 跨平台支持：提供Windows、Linux及MacOS平台的启动脚本和服务脚本，适配不同运行环境
• 服务化运行：支持作为系统服务持续运行，满足长时间无人值守的测试任务执行需求
• 配置生成：提供命令行工具快速生成或更新配置文件，简化初始化流程
• 开发调试：兼容IntelliJ IDEA和Visual Studio Code等IDE，支持代码级调试，便于功能扩展与问题排查

使用场景和适用范围

• CI/CD流水线集成：嵌入自动化测试环节，实现代码提交后自动触发测试任务
• 团队测试管理：通过团队ID配置，实现团队内测试资源统一管理与任务分配
• 跨环境测试执行：支持在不同操作系统环境中运行测试任务，验证多平台兼容性
• 无人值守测试：通过服务化运行模式，确保测试代理持续在线，响应平台任务调度

使用方法和配置说明

前提条件

• Node.js 版本 ≥ 10.x
• 在Katalon Agent根目录执行 npm install 命令安装依赖包

配置说明

在Katalon Agent根目录创建 agentconfig 文件并配置以下内容：

ini
agentName=我的代理
email=<登录邮箱>
apikey=<API密钥>
serverUrl=https://analytics.katalon.com/
teamId=<团队ID>

支持的配置选项

必填选项

可选选项

启动Katalon Agent

通过Node CLI启动

1. 导航至Katalon Agent根目录
2. 执行以下命令启动代理：

   bash
   npm start
   # 或
   node cli.js start-agent
   

通过打包可执行文件启动

1. 从Katalon Agent https://github.com/katalon-studio/katalon-agent/releases 下载目标平台安装包
2. 解压安装包，根据平台执行对应启动脚本：
   • Windows：start.bat
   • Linux/MacOS：start.sh

注意：Linux/MacOS环境下需为以下文件添加执行权限（chmod u+x <文件名>）：

• cli-linux-x64
• cli-macos-x64
• start.sh
• service.sh

打包Katalon Agent

1. 检出代码仓库
2. 执行 npm install 确保依赖安装完成
3. 执行 npm run build 构建项目
4. 构建产物生成在 bin 目录中

生成配置文件

通过 config 命令生成或更新 agentconfig 文件，示例：

bash
node cli.js config --server-url https://analytics.katalon.com --username <邮箱> --apikey <API密钥> --teamid <团队ID> --agent-name 我的代理

• 若配置文件已存在，现有配置将被覆盖
• 使用 -h 选项查看命令帮助：node cli.js config -h

将Katalon Agent作为服务运行

1. 从Katalon Agent https://github.com/katalon-studio/katalon-agent/releases 下载目标平台安装包
2. 解压安装包，根据平台执行对应服务脚本：
   • Windows：service.bat
   • Linux/MacOS：service.sh

开发Katalon Agent

使用IntelliJ IDEA调试

1. 检出代码并使用IntelliJ IDEA打开项目目录
2. 依次选择 Run → Edit Configurations... → + → npm
3. 配置参数：
   • package.json：选择项目根目录下的 package.json
   • Command：选择 start
   • Node interpreter：指定Node.js安装路径
   • Package manager：指定npm安装路径
   • Environment：设置 NODE_ENV=debug
4. 保存配置后，选择该配置启动调试

使用Visual Studio Code调试

1. 检出代码并使用Visual Studio Code打开项目目录
2. 打开「运行」视图，创建 launch.json 配置文件
3. 添加以下配置：

   json5
   {
       "version": "0.2.0",
       "configurations": [
           {
               "type": "node",
               "request": "launch",
               "name": "Start Agent",
               "skipFiles": ["<node_internals>/**"],
               "program": "${workspaceFolder}\\cli.js",
               "args": ["start-agent"],
               "env": {"NODE_ENV": "debug"},
               "console": "integratedTerminal"
           }
       ]
   }
   

4. 在「运行」视图中选择 Start Agent 配置并启动调试