安装及使用
安装 CukeTest Agent
安装 CukeTest Agent 非常简单,无需特别注意。
在 Windows 上安装
在Windows中只需运行 .msi
安装包,按提示点击“下一步”即可完成安装。安装界面如下:
在 Linux 上安装
在Linux中,可以通过 .deb
或 .rpm
安装包来安装 CukeTest Agent。使用以下命令:
sudo dpkg -i CukeTest_Agent.deb
或
sudo rpm -i CukeTest_Agent.rpm
启动配置
配置文件 agent_config.json
位于CukeTest Agent的安装目录,示例如下:
{
"agentUniqueId": "cukeAgent",
"localPort": "1349",
"logLevel": "info",
"agentHome": "C:/CukeTest AgentHome",
"resultCallbackUrl": "http://example.com/api/callback"
}
配置文件包含以下主要设置:
agentUniqueId
:Agent 的唯一标识符。localPort
:CukeTest Agent 本地服务监听的端口号。logLevel
:日志记录级别,可设置为 "info"、"warn"、"error" 等,用于控制日志输出的详细程度。agentHome
:存放 CukeTest 运行自动化测试数据的根目录,Windows中默认路径为C:/CukeTest_AgentHome
,Linux默认路径为/var/lib/cuketest-agent
。resultCallbackUrl
:数据回传结果的接收接口地址。配置了这个接口后,CukeTest Agent会在测试运行结束后将结果数据发送至该接口。
Agent Home 目录结构
CukeTest Agent 使用 agentHome
配置项来存放自动化测试运行的数据。在 agentHome
中会新建一个 jobs
目录,用于存储测试任务的输出文件,如报告文件等。每个运行任务对应一个文件夹,例如,如果任务 ID 为 33
,对应的文件夹路径将是 %agentHome%/jobs/33
。
启动与使用
安装完成后,CukeTest Agent 会自动在后台启动服务,无需手动启动。要确认 CukeTest Agent 已启动,可以使用 Win
+ R
快捷键打开运行提示符,输入 “services.msc” 并回车。在打开的“服务”窗口中找到正在运行的 CukeTest Agent 服务,如下所示:
在Linux中,可以通过下面的命令来查看CukeTest Agent的运行状态:
systemctl status cuketest-agent
配置防火墙
为了确保 CukeTest Agent 正常工作,可能需要配置操作系统的防火墙以允许其通信。CukeTest Agent 默认使用 1349 端口进行通信。
Windows 防火墙设置:
- 打开“控制面板” > 选择“系统和安全” > 点击“Windows 防火墙”。
- 在左侧面板中,点击“允许应用或功能通过 Windows 防火墙”。
- 点击“更改设置”按钮,然后点击“允许其他应用”。
- 在弹出的窗口中,点击“浏览”按钮,导航到 CukeTest Agent 的安装目录,默认为
C:\Program Files\LeanPro\CukeTest Agent
,选择cuke_agent.exe
。 - 选择该文件并点击“添加”。
- 确保“公用”和“专用”两个复选框都被选中,然后点击“确定”保存设置。
Linux 防火墙设置:
在Linux系统中,根据您使用的具体发行版和防火墙管理工具(如 iptables
或 firewalld
),设置方法可能有所不同。以下是使用iptables
的基本步骤:
sudo iptables -A INPUT -p tcp --dport 1349 -j ACCEPT
sudo iptables -A OUTPUT -p tcp --sport 1349 -j ACCEPT
以上命令将允许通过 1349 端口的 TCP 流量。确保在配置后保存iptables规则。
完成防火墙配置后,CukeTest Agent 应能够正常工作并监听 1349 端口。接下来,您可以在浏览器中输入以下地址来访问 CukeTest Agent 的用户界面:http://localhost:1349
适用于桌面应用测试的启动方式
在某些情况下,以服务形式启动 CukeTest Agent 可能导致自动化测试无法正常运行。因为服务形式启动的应用通常以系统权限或与用户桌面环境隔离的方式运行,这会限制自动化程序对桌面应用的访问和控制。
为确保自动化测试能顺利执行,请按照以下步骤重新启动 CukeTest Agent:
1. 停止 CukeTest Agent 服务
首先,需要停止 CukeTest Agent 服务,以释放 1349 端口供后续重启使用。
Windows:通过服务列表停止 CukeTest Agent 服务。步骤如下:
- 按
Win + R
打开“运行”对话框。 - 输入
services.msc
并按Enter
。 - 在服务列表中找到
CukeTest Agent
,右键点击并选择“停止”。
- 按
Linux:使用以下命令停止服务:
sudo systemctl stop cuketest-agent
2. 以管理员权限启动
在管理员权限下打开命令行终端,使用 cd
命令导航到 CukeTest Agent 的安装目录并运行启动脚本:
Windows:
- 右键点击“开始”菜单,选择“命令提示符(管理员)”或“Windows PowerShell(管理员)”。
- 输入以下命令并按
Enter
:cd "C:\Program Files\LeanPro\CukeTest Agent" & start.bat
Linux:
- 打开终端。
- 输入以下命令并按
Enter
:cd /usr/share/cuketest-agent/app && sudo ./start.sh
这种方式可以确保 CukeTest Agent 在用户当前桌面会话中启动,使桌面自动化能够正常运行。
3. 远程运行桌面自动化项目
一旦 CukeTest Agent 成功启动,就可以通过浏览器访问 http://localhost:1349/
或使用 API 调用来远程运行桌面自动化项目。
无头模式运行
在 Linux 版本的 CukeTest 中提供了 --headless
选项来使用无头模式运行测试。这种模式支持在服务形式启动的 CukeTest Agent 中运行界面自动化测试。
要使用无头模式运行测试,可以在命令行中添加 --headless
参数。例如:
cuketest run --format html --headless
无头模式允许在没有图形用户界面的环境中运行自动化测试,适用于 CI/CD 管道中的自动化测试任务。