Robotframework - 如何记录测试中存在的关键字

Posted 2023-03-23

【中文标题】Robotframework - 如何记录测试中存在的关键字

【英文标题】：Robotframework - How to document keywords present inside a tests

【发布时间】：2021-06-19 13:54:29

【问题描述】：

我坚持一些机器人测试用例的文档主题。

上下文：我尝试为所有机器人文件（测试用例或关键字库）生成文档。 关于关键字 library => robot.libdoc 按预期完成工作。 关于测试用例 => robots.testdoc 按预期完成工作。

但是对于以下情况我不知道。 例如：

*** Settings ***
Documentation     description of test case: bla bla bla
Test Setup        SETUP_TC_001
Test Teardown     TEARDOWN_TC_001
Ressource         r1
Ressource         r2

*** Test Cases ***
TC_001
   step1
   step2

*** Keywords ***
SET_UP_TC_001
     Action1
     Action2

TEARDOWN_TC_001
    TD_action1
    TD_action2

问题：我们如何为测试用例中定义的关键字生成文档？ 我尝试使用 libdoc，但出现以下错误：

资源文件中不允许设置“测试设置”。 资源文件中不允许设置“Test Teardown”。 “测试用例”部分的资源文件无效。

我对 testdoc 进行了同样的尝试，它描述了测试用例和步骤顺序，但内部关键字。 我错过了什么吗？

溴 拉朱夫

【问题讨论】：

正确的术语是套件文件，而不是“测试用例”。 libdoc 文档是怎么说的？

正如我提到的，在使用 libdoc 记录套件文件期间存在以下错误：资源文件中不允许设置“测试设置”。资源文件中不允许设置“Test Teardown”。带有“测试用例”部分的资源文件无效。我的问题是：如何记录套件文件中定义的关键字？

【参考方案1】：

libdoc 是生成“关键字”资源文档的工具。为了生成测试文档，您应该使用 testdoc 工具。

python -m robot.testdoc ./robot/space-test-plan.robot space-test-plan.html

这应该会生成一个TestCase的HTML报告，如果你有关联的关键字资源文件，你可以使用libdoc工具生成这个文档

python -m robot.testdoc  ./robot/resources.robot resources.html