测试用例名称和文档

测试用例的名称直接在测试用例表格中指定: 即表格中输入的用例名称是什么就是什么.一个测试套件中的用例名称必须唯一.

在测试用例中, 可以通过 automatic variable ${TEST_NAME} 来指代当前用例的名称. 这个变量在测试执行的任何阶段都可以访问到, 包括用户关键字, 以及测试准备和测试结束阶段.

配置项 [Documentation] 用来为用例设置一段文档说明. 这个说明会显示在命令行的输出中, 以及后续的测试日志和测试报告中. 文档中可以使用简单的 HTML formatting, 也可以使用 变量, 使文档更加的动态.

如果一个文档被分为多列, 则同一行中每个单元格中的内容最终以空格连接. 如果文档 被分为多行, 则最终的文档 以换行符拼接起来. 如果某行结尾已经有了换行符, 或者使用了 转义的反斜杠, 则不会再添加换行符.

  1. *** Test Cases ***
  2. Simple
  3.     [Documentation]    Simple documentation
  4.     No Operation
  5.  
  6. Formatting
  7.     [Documentation]    *This is bold*, _this is italic_  and here is a link: http://robotframework.org
  8.     No Operation
  9.  
  10. Variables
  11.     [Documentation]    Executed at ${HOST} by ${USER}
  12.     No Operation
  13.  
  14. Splitting
  15.     [Documentation]    This documentation    is split    into multiple columns
  16.     No Operation
  17.  
  18. Many lines
  19.     [Documentation]    Here we have
  20.     ...                an automatic newline
  21.     No Operation

测试用例拥有一个清楚的, 描述性的名称是非常重要的, 这种情况下一般就不再需要文档说明了.如果用例的逻辑比较复杂, 以至于必须使用文档才能说清楚, 这往往意味着该用例中的关键字有待改进, 需要使用更好的名称, 而不是添加额外的文档.最后, 诸如环境或用户信息等这类元数据, 最好使用 测试用例的标签 来指定.