天下苦 postman 久矣!
原文链接:
Bruno CLI – Bruno Docs
Bruno CLI
借助 Bruno CLI,您可以使用简单的命令行命令轻松运行 API 集合。
这样可以更轻松地在不同环境中测试 API、自动化测试过程以及将 API 测试与持续集成和部署工作流集成。
安装
要安装 Bruno CLI,请使用您选择的节点包管理器,例如 NPM:
npm install -g @usebruno/cli
开始使用
导航到 API 集合所在的目录,然后运行以下命令:
bru run
这将运行集合中的所有请求。如果要运行单个请求,请指定其文件名:
bru run request.bru
在文件夹中运行请求
要运行文档夹中的所有请求,请使用:
bru run folder
使用环境配置
如果需要使用特定环境,可以使用 --env 选项传递它:
bru run folder --env Local
传递 Environment 变量
您可以使用 --env-var 选项将环境变量直接传递给您的集合:
bru run folder --env Local --env-var JWT_TOKEN=1234
使用 CSV 文件运行集合
如果需要使用 CSV 文件中的数据运行集合,请使用 --csv-file-path 选项指定文件的路径:
bru run folder --csv-file-path /path/to/csv/file.csv
输出结果
要将 API 测试的结果保存到文件中,请使用 --output 选项:
bru run folder --output results.json
生成报告
Bruno CLI 为生成三种格式的报告提供了内置支持:JSON、JUnit 和 HTML。这些报告有助于分析测试结果并与各种 CI/CD 工具集成。
您可以生成这些报告的任意组合,甚至可以同时运行它们。
JSON 报告
要生成 JSON 格式的报告,请使用 '--reporter-json' 选项:
bru run request.bru --reporter-json results.json
这会将测试结果输出到 results.json 文件中,这对于进一步处理或编程分析非常有用。
JUnit 报告
要生成 JUnit 格式的报告,请使用 --reporter-junit 选项:
bru run request.bru --reporter-junit results.xml
results.xml 文件的格式与 JUnit 兼容,非常适合与依赖 JUnit 报告的 CI/CD 管道集成。
HTML 报告
要生成人类可读的 HTML 报告,请使用 --reporter-html 选项:
bru run request.bru --reporter-html results.html
这将创建一个 results.html 文件,该文件提供测试结果的可视化表示形式,非常适合快速审阅。
同时运行多个报告器
您可以通过指定多个 reporter 选项一次生成多个报告。例如,要同时生成 JSON、JUnit 和 HTML 报告,请运行:
bru run request.bru --reporter-json results.json --reporter-junit results.xml --reporter-html results.html
此命令将创建三个文件:results.json、results.xml 和 results.html,允许您根据需要分析不同格式的结果。
选项
| 选项 | 详细 |
|---|---|
| -h, --help | 显示帮助 |
| --version | 显示版本数字 |
| -r | 指示递归运行 (默认值: false) |
| --cacert [string] | 用于验证对等体的 CA 证书 |
| --env [string] | 指定要运行的环境 |
| --env-var [string] | 覆盖单个环境变量,可能有多种用法 |
| -o, --output [string] | 将文件结果写入的路径 |
| -f, --format [string] | 结果文件的格式;可用格式为 “JSON” (默认) 或 “JUnit” |
| --reporter-json [string] | 生成 JSON 报告的路径 |
| --reporter-junit [string] | 生成 JUnit 报告的路径 |
| --reporter-html [string] | 生成 HTML 报告的路径 |
| --insecure | 允许不安全的服务器连接 |
| --tests-only | 仅运行具有测试的请求 |
| --bail | 在请求、测试或断言失败后停止执行 |
| --csv-file-path | CSV 文件来运行集合 |
演示
支持
如果您遇到任何问题或有任何反馈或建议,请在我们的 GitHub 仓库上提出。