jfxs/robot-framework

镜像概述和主要用途

jfxs/robot-framework是一个轻量级多架构Docker镜像，专为运行Robot Framework测试设计。基于Alpine Linux构建，镜像大小仅40MB，支持amd64和arm64架构，采用非root用户运行，确保安全性。镜像通过软件物料清单（SBOM）自动检测更新，使用Cosign签名并附加Syft生成的SBOM证明，可从Docker Hub和Quay.io获取。

核心功能和特性

• 轻量级设计：基于Alpine Linux，镜像大小仅40MB
• 多架构支持：兼容amd64和arm64平台
• 安全特性：非root用户运行，镜像签名验证，SBOM证明
• 自动更新：通过SBOM变更检测实现自动更新
• 丰富组件集成：
  • Robot Framework
  • Robot Framework SeleniumLibrary
  • Robot Framework Requests
  • Robotidy（代码格式化）
  • Robocop（静态代码分析）
  • Task（任务管理工具）
  • 任务屏蔽（mask）：隐藏测试报告中的敏感数据
  • 任务徽章（badge）：生成SVG格式的测试结果徽章

使用场景和适用范围

• 自动化执行Robot Framework测试用例
• 对Robot Framework测试代码进行静态分析
• 生成可视化测试结果徽章（用于CI/CD状态展示）
• 处理测试报告中的敏感信息
• 在CI/CD流水线中集成Robot Framework测试环节
• 跨架构环境（amd64/arm64）的测试执行

详细使用方法和配置说明

运行Robot Framework测试

基本测试执行

在当前目录运行测试用例：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework robot --outputdir /tests /tests/tests/RF

安装额外库后执行测试

添加自定义库（如robotframework-faker）并运行测试：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework /bin/sh -c "pip install --user robotframework-faker && robot --outputdir /tests /tests/tests/RF"

Task工具使用指南

镜像内置Task工具及Robot Framework专用模板（robot.yml），提供以下实用任务：

badge：生成测试结果徽章

根据测试结果生成SVG格式徽章（all_tests.svg），徽章背景色规则：

• 全部通过：绿色
• 至少一个失败：红色
• 部分跳过且其余通过：橙色

使用方法：task robot:badge FILE|F=<输出XML文件路径> [DIR|D=<徽章目录>] [IMG|I=<镜像:标签>] [PULL|P=<n|N>]

参数说明：
  FILE | F  测试结果XML文件路径（必填）
  DIR  | D  徽章生成目录（可选，默认当前目录）
  IMG  | I  使用的Robot Framework镜像（可选，默认{{.IMAGE_ROBOT}}）
  PULL | P  是否拉取镜像（可选，默认yes）

依赖要求：
  - pybadges库或Docker环境

示例：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework /bin/sh -c "task --taskfile /robot.yml badge FILE=/tests/reports/output.xml"

cop：静态代码分析

使用Robocop对Robot Framework代码进行静态分析：

使用方法：task robot:cop DIR|D=<测试目录> [ARG|A="命令行参数"] [IMG|I=<镜像:标签>] [PULL|P=<n|N>]

参数说明：
  DIR  | D  测试目录或文件（必填）
  ARG  | A  命令行参数（可选）
  IMG  | I  使用的Robot Framework镜像（可选，默认{{.IMAGE_ROBOT}}）
  PULL | P  是否拉取镜像（可选，默认yes）

依赖要求：
  - robocop或Docker环境

示例：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework /bin/sh -c "task --taskfile /robot.yml cop DIR=/tests/tests/RF"

mask：敏感数据屏蔽

屏蔽文件中的敏感数据（尤其适用于Robot Framework测试报告）：

使用方法：task robot:mask FILE|F=<文件路径> DATA|D=敏感数据1,敏感数据2

参数说明：
  FILE | F  目标文件路径（必填）
  DATA | D  需屏蔽的敏感数据，用逗号分隔（必填）

示例：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework /bin/sh -c "task --taskfile /robot.yml mask FILE=/tests/reports/output.xml DATA=password1,password2"

tidy：代码格式化

使用Robotidy格式化Robot Framework测试文件：

使用方法：task robot:tidy DIR|D=<测试目录> [ARG|A="命令行参数"] [IMG|I=<镜像:标签>] [PULL|P=<n|N>]

参数说明：
  DIR  | D  测试目录或文件（必填）
  ARG  | A  命令行参数（可选）
  IMG  | I  使用的Robot Framework镜像（可选，默认{{.IMAGE_ROBOT}}）
  PULL | P  是否拉取镜像（可选，默认yes）

依赖要求：
  - robotidy或Docker环境

示例：

docker run -t --rm -v $(pwd):/tests jfxs/robot-framework /bin/sh -c "task --taskfile /robot.yml tidy DIR=/tests/tests/RF ARG=\"--check\""

内置组件版本

Docker latest标签对应版本为7.3.2-023, 7.3, 7，包含以下组件：

详细信息可查看Docker Hub概述页面。

版本控制

Docker镜像标签格式由Robot Framework版本和构建增量号组成，用于区分相同Robot Framework版本的不同构建：

<robot_version>-<increment>

示例：6.0.2-001

镜像签名与证明

Cosign公钥

-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEa3yV6+yd/l4zh/tfT6Tx+zn0dhy3
BhFqSad1norLeKSCN2MILv4fZ9GA6ODOlJOw+7vzUvzZVr9IXnxEdjoWJw==
-----END PUBLIC KEY-----

公钥在线地址：<[***]>

验证镜像

验证镜像签名：

cosign verify --key cosign.pub $IMAGE_URI

验证并获取SBOM证明：

cosign verify-attestation --key cosign.pub --type spdxjson $IMAGE_URI | jq '.payload | @base64d | fromjson | .predicate'