rflogs CLI

rflogs 是一个命令行界面工具，用于将RF Logs服务与Robot Framework测试结果进行上传和管理。它提供了一个简单的方式来将RF Logs集成到您的CI/CD管道或本地开发工作流程中。

安装

使用pipx（推荐）或pip安装rflogs

pipx install rflogs

或者

pip install rflogs

用法

身份验证

rflogs 使用API密钥进行身份验证。将您的RF Logs API密钥设置为环境变量

export RFLOGS_API_KEY=your_api_key_here

您可以将此行添加到您的shell配置文件（例如.bashrc，.zshrc）以使其永久生效。

标记运行

您可以将标记与您的测试运行关联起来以对其进行分类和筛选。标记可以在上传结果时使用--tag或-t选项指定。

标记格式

• 键值标记： key:value
• 简单标记： tag

约束

• 标记键

  • 必须以字母（a-z，A-Z）开头。
  • 长度： 1到50个字符。
  • 允许的字符： 字母，数字，下划线（_），连字符（-），点（.）。
  • 不区分大小写： Env 和 env 被视为相同的键。

• 标记值

  • 长度： 1到100个字符。
  • 允许的字符： 字母，数字，空格，下划线（_），连字符（-），点（.），斜杠（/）。
  • 区分大小写。

示例

# Valid Tags
rflogs upload -t env:production -t browser:chrome -t regression

# Invalid Tag Key (starts with a number)
rflogs upload -t 1env:production  # Will produce an error

# Invalid Tag Value (contains invalid character '@')
rflogs upload -t env:prod@ction  # Will produce an error

上传测试结果

在运行您的Robot Framework测试后上传测试结果

rflogs upload [OUTPUTDIR]

• OUTPUTDIR：可选。指定测试输出文件的存储位置。默认为当前目录。
• 该命令不执行递归搜索。

该命令将

1. 在指定的目录中查找相关的测试结果文件（log.html、report.html、output.xml 和截图）
2. 使用 tar.gz 压缩 output.xml
3. 将所有文件上传到 RF 日志服务器
4. 提供查看已上传结果的链接

示例输出

$ rflogs upload ./results
Uploading results
  output.xml    1.20 MB - compressed to 800.00 KB ✓
  log.html    256.00 KB ✓
  report.html 128.00 KB ✓
  screenshot1.png 45.00 KB ✓
  screenshot2.png 52.00 KB ✓

Run ID: 1234abcd
Files:  5
Size:   1.28 MB

Overview: https://rflogs.io/runs/1234abcd
Log:      https://rflogs.io/runs/1234abcd/log.html
Report:   https://rflogs.io/runs/1234abcd/report.html

列出上传

查看您的最近上传

rflogs list

示例输出

$ rflogs list
Available runs:
  1234abcd
  5678efgh
  90ijklmn

To view details of a specific run, use: rflogs info <run_id>

查看上传详情

获取特定结果的详细信息

rflogs info <run_id>

示例输出

$ rflogs info 1234abcd
Run ID: 1234abcd
Files: 5
  - log.html (ID: 1)
  - report.html (ID: 2)
  - output.xml (ID: 3)
  - screenshot1.png (ID: 4)
  - screenshot2.png (ID: 5)

下载测试结果

将测试结果下载到您的本地计算机

rflogs download <run_id>

此命令将下载与指定测试结果关联的所有文件到您的当前目录。

示例输出

$ rflogs download 1234abcd
Downloaded log.html
Downloaded report.html
Downloaded output.xml
Downloaded screenshot1.png
Downloaded screenshot2.png

删除测试运行

要删除特定运行

rflogs delete <run_id>

此命令将立即从服务器删除指定的运行及其相关文件。

与 CI/CD 系统集成

GitHub Actions

要将 rflogs 与 GitHub Actions 集成，请在您的工作流程中添加以下步骤

- name: Upload Robot Framework results
  env:
    RFLOGS_API_KEY: ${{ secrets.RFLOGS_API_KEY }}
  run: |
    pipx install rflogs
    rflogs upload ./results

请确保在您的 GitHub 仓库设置中将 RFLOGS_API_KEY 秘密设置。

其他 CI/CD 系统

对于其他 CI/CD 系统

1. 在您的 CI 环境中安装 RF 日志 CLI 工具
2. 设置 RFLOGS_API_KEY 环境变量
3. 使用适当的输出目录运行 rflogs upload