如何在Robot Framework的report.html文件中自定义并添加版本等详情？

一、快速添加被测应用版本信息（无需修改模板） #

最简单的方式是利用Robot Framework的**元数据（Metadata）**功能，直接将版本信息嵌入报告的默认区域：

• 命令行方式：运行测试时通过--metadata参数传入，示例：

  robot --metadata "被测应用版本: v2.3.1" --metadata "测试框架版本: v6.1.1" your_test_suite.robot
  

• 套件文件方式：在测试套件的*** Settings ***区块中添加Metadata关键字，示例：

  *** Settings ***
  Metadata    被测应用版本    v2.3.1
  Metadata    测试环境版本    prod-v1.0
  

  运行后，这些信息会自动显示在报告顶部的「Metadata」区域，无需额外修改报告文件。

二、自定义报告模板添加版本类详情（进阶） #

如果需要更个性化的展示（比如单独的版本板块、自定义样式），可以修改报告模板：

1. 获取默认模板：找到Robot Framework安装目录下的report.html模板（通常在robot/reporting/templates路径下，或通过pip show robotframework查看安装位置），复制一份到本地作为自定义模板。
2. 修改模板内容：打开自定义模板，在合适位置（比如报告头部、侧边栏）插入版本信息的HTML代码。可以利用模板内置变量获取数据：
   • ${robot_version}：当前Robot Framework版本
   • ${metadata}：所有自定义元数据的字典，可通过${metadata.get('键名', '默认值')}获取指定值
     示例添加的HTML片段：

   <div class="panel panel-default" style="margin: 15px;">
       <div class="panel-heading">
           <h3 class="panel-title">版本详情</h3>
       </div>
       <div class="panel-body">
           <ul>
               <li>被测应用版本: ${metadata.get('被测应用版本', '未指定')}</li>
               <li>测试框架版本: ${robot_version}</li>
               <li>测试环境版本: ${metadata.get('测试环境版本', '未指定')}</li>
           </ul>
       </div>
   </div>
   

3. 使用自定义模板运行测试：执行测试时通过--report参数指定自定义模板路径，示例：

   robot --report ./custom_report.html your_test_suite.robot
   

三、补充：动态添加版本信息（监听器方式） #

如果需要从外部文件/接口动态获取版本号，可以编写Python监听器，在测试结束时将版本信息注入报告。示例监听器核心代码：

class VersionListener:
    ROBOT_LISTENER_API_VERSION = 3
    def end_suite(self, suite, result):
        suite.metadata["被测应用版本"] = self.get_app_version()  # 自定义方法获取版本
    def get_app_version(self):
        # 从配置文件/接口获取版本的逻辑
        return "v2.3.1"

运行时指定监听器：

robot --listener ./version_listener.py your_test_suite.robot

内容的提问来源于stack exchange，提问作者Gunjan Chhabra