测试数据文档工具(Testdoc)
Testdoc是机器人框架内置的工具生成高水平 根据测试用例文档。 创建的文档是在HTML中 格式和它包括名称、文档和其他元数据 测试套件和测试用例,以及和他们的顶级关键词 参数。
一般使用
简介
python -m robot.testdoc [options] data_sources output_file
选项
- t , ——标题 <标题> 生成的文档的标题。 标题中强调转换为空间。 默认的标题是顶级套件的名称。 - n , ——名字 <名称> 覆盖顶级测试套件的名称。 - d , ——医生 <文件> 覆盖顶层的文档测试套件。 - m , ——元数据 <名称:值> 释放/覆盖顶级测试套件的元数据。 - g , ——settag <标记> 设置给定的标记(s)所有测试用例。 - t , ——测试 <名称> 包括测试的名字。 - s , ——套件 <名称> 包括套件的名字。 -我 , ——包括 <标记> 包括测试的标签。 - e , ——排除 <标记> 排除测试的标签。 - h ,——帮助 在控制台打印此帮助。
所有的选择除了 ——标题 有完全相同的语义相同吗 选择当 执行测试用例 。
生成文档
数据可以作为一个单独的文件,目录,或者是多个文件 目录。 在所有这些情况下,最后一个参数必须的文件 写输出。
Testdoc与所有翻译工作由机器人框架(支持Python, Jython和IronPython)。 它可以作为一个执行安装模块 python - m robot.testdoc 或作为一个脚本 python /机器人/ testdoc.py路径 。
例子:
python -m robot.testdoc my_test.html testdoc.html jython -m robot.testdoc --name smoke_tests --include smoke path/to/my_tests smoke.html ipy path/to/robot/testdoc.py first_suite.txt second_suite.txt output.html
测试数据清理工具(整洁)
- 5.3.1一般使用
- 5.3.2清理测试数据
- 5.3.3改变测试数据格式
整洁是机器人框架内置的清理和变化的工具 机器人框架测试数据文件的格式。
输出写入标准输出流在默认情况下,但是 一个可选的输出文件可以从机器人2.7.5框架。 就地使用文件也可以被修改 ——原地 或 ——递归 选项。
一般使用
剧情简介
python -m robot.tidy [options] inputfile python -m robot.tidy [options] inputfile [outputfile] python -m robot.tidy --inplace [options] inputfile [more input files] python -m robot.tidy --recursive [options] directory
选项
-我 ,——原地 整洁的给定文件),这样原始文件被覆盖 (或删除,如果格式改变)。 当这个选项 使用,它可以给多个输入文件。 例子:
python -m robot.tidy --inplace tests.html python -m robot.tidy --inplace --format txt *.html- r , ——递归 给定目录递归过程。 文件的目录 同样当处理的地方吗 ——原地 选择使用。 - f , - - -格式 html <机器人| txt | | tsv > 输出文件格式。 如果显式给定的输出文件, 默认值为从其扩展。 否则 格式是没有改变。 - p , ——用管道 使用管道字符(|)作为细胞分离器txt格式。 - s , ——spacecount <数> 细胞之间的空间txt格式的数量。 2.7.3新机器人框架。 - l , ——lineseparator <本机windows | | unix > 行分隔符用于输出。 默认值是“本地”。
- 本机 :使用操作系统的本机行分隔符
- 窗户 :使用Windows行分隔符(CRLF)
- unix :使用Unix行分隔符(低频)
新机器人2.7.6框架。
- h ,——帮助 显示帮助。
选择执行
虽然整洁与Python在上面的简介中,只使用它的工作原理 也与Jython和IronPython。 在执行概要整洁 一个安装模块( python - m robot.tidy ),但它也可以运行 一个脚本:
python path/robot/tidy.py [options] arguments
执行一个脚本可以是有用的,如果你所做的 手动安装 或者只有 机器人 与源代码目录 在您的系统。
输出编码
所有输出文件编写使用utf - 8编码。 输出写入到 控制台使用当前控制台编码。
清理测试数据
测试用例文件创建HTML编辑器或手写可以规范化 使用整洁。 整洁总是写标题一致,一致的订单 设置,和一致的细胞和表之间的空白。
例子:
python -m robot.tidy messed_up_tests.html cleaned_tests.html python -m robot.tidy --inplace tests.txt
改变测试数据格式
机器人框架支持测试数据在HTML中,TSV和TXT格式整齐 使改变之间的格式简单。 输入格式总是确定的 基于扩展的输入文件。 可以设置输出格式使用 的 - - -格式 的选项,默认值是得到了扩展 可能的输出文件。
例子:
python -m robot.tidy tests.html tests.txt python -m robot.tidy --format txt --inplace tests.html python -m robot.tidy --format tsv --recursive mytests
外部工具
有很多外部工具,可以用于机器人框架。 这些工具包括测试数据编辑器 骑 ,为各种ide和扩展 文本编辑器插件,持续集成系统和构建工具, 等等。
这些工具是作为独立项目开发独立于机器人 框架本身。 可用工具的列表,请参阅 http://robotframework.org/工具 。
请注意
一些支持工具使用与机器人分布式框架 本身。 现在所有这些工具也可单独购买, 他们从存储库中删除和源分布 在机器人2.8.6框架。
测试数据中所有可用的设置
- 但是设置表
- 6.1.2测试用例表
- 6.1.3关键字表
但是设置表
设置表是用于导入测试库,文件和资源 变量定义元数据的文件和测试套件和测试 用例。 它可以包括在测试用例文件和资源文件。 请注意 在一个资源文件,设置表只能包括设置 导入库、资源和变量。
| 的名字 | 描述 |
|---|---|
| 图书馆 | 用于 导入库 。 |
| 资源 | 用于 考虑到资源文件使用 。 |
| 变量 | 用于 考虑变量文件使用 。 |
| 文档 | 用于指定一个 测试套件 或 资源文件 文档。 |
| 元数据 | 用于设置 免费测试套件的元数据 。 |
| 套件设置 | 用于指定 套件设置 。 |
| 套件拆卸 | 用于指定 套件拆卸 。 |
| 力的标签 | 当用于指定强制值标签 标签的测试用例 。 |
| 默认的标签 | 用于指定标签时的默认值 标签的测试用例 。 |
| 测试设置 | 用于指定一个默认的 测试设置 。 |
| 测试拆卸 | 用于指定一个默认的 测试拆卸 。 |
| 测试模板 | 用于指定一个默认的 模板的关键字 测试用例。 |
| 测试超时 | 用于指定一个默认的 测试用例超时 。 |
请注意
所有设置名称可以包含一个冒号最后, 例子 文档: 。 这可以简化设置读取 尤其是当使用纯文本格式。
测试用例表
设置测试用例表中总是具体的测试 定义它们。 覆盖这些设置 表中定义的默认值设置。
| 的名字 | 描述 |
|---|---|
| (文档) | 用于指定一个 测试用例文档。 |
| (标签) | 用于 标签的测试用例 。 |
| (设置) | 用于指定一个 测试设置 。 |
| (拆卸) | 用于指定一个 测试拆卸 。 |
| (模板) | 用于指定一个 模板的关键字。 |
| (超时) | 用于指定一个 测试用例超时。 |
关键字表
设置关键字表中的特定于用户的关键字 定义它们。
| 的名字 | 描述 |
|---|---|
| (文档) | 用于指定一个 用户的关键字的文档。 |
| (标签) | 用于指定 用户关键词标签 。 |
| (参数) | 用于指定 用户关键字参数 。 |
| (返回) | 用于指定 用户关键字返回值 。 |
| (拆卸) | 用于指定 用户关键字拆卸 。 |
| (超时) | 用于指定一个 用户关键字超时 。 |
所有的命令行选项
这个附录列出了所有可用的命令行选项 当 执行测试用例 当 后处理输出 。 环境变量影响执行和后期处理 列出。
- 6.2.1测试执行的命令行选项
- 6.2.2后处理输出的命令行选项
- 6.2.3环境变量为执行和后期处理
测试执行的命令行选项
- n , ——名字 <名称> 集的名字 顶级的测试套件。 - d , ——医生 <文件> 设置文档 顶级的测试套件。 - m , ——元数据 <名称:值> 套免费的元数据 顶级测试套件。 - g , ——settag <标记> 设置标签(s) 执行测试用例。 - t , ——测试 <名称> 选择测试用例的名字 。 - s , ——套件 <名称> 选择测试套件 的名字。 - r , ——rerunfailed <文件> 选择失败的测试 从较早的 输出文件 可重复。 ——runfailed <文件> 机器人框架2.8.4以来弃用。 使用 ——rerunfailed 代替。 -我 , ——包括 <标记> 选择测试用例 通过标签。 - e , ——排除 <标记> 选择测试用例 通过标签。 - c , ——关键 <标记> 测试有给定的标记 被认为是至关重要的 。 - n , ——被 <标记> 测试有给定的标记 不是至关重要的 。 - v , ——变量 <名称:值> 集 单独的变量 。 - v , ——variablefile <路径:参数> 设置变量使用 变量的文件 。 - d , ——outputdir < dir > 定义在哪里 创建输出文件 。 - o , ——输出 <文件> 集生成的路径 输出文件 。 - l , ——日志 <文件> 集生成的路径 日志文件 。 - r , ——报告 <文件> 集生成的路径 报告文件 。 - x , ——xunit <文件> 集生成的路径 xUnit兼容的结果文件 。 ——xunitskipnoncritical 马克非关键测试 xUnit兼容的结果文件 跳过。 - b , ——debugfile <文件> 一个 调试文件 这是在执行期间写的。 - t , ——timestampoutputs 添加一个时间戳 所有输出文件。 ——splitlog 把日志文件 成小块,开放 浏览器透明。 ——logtitle <标题> 设定一个标题 对生成的测试日志。 ——reporttitle <标题> 设定一个标题 对生成的测试报告。 ——reportbackground <色调> 设置背景颜色 生成的报告。 - l , ——loglevel <上> 设置阈值水平 为日志记录。 (可选) 默认的 可见的日志级别 可以给 分离一个冒号(:)。 ——suitestatlevel <上> 定义了多少 水平显示 在 统计的套件 表中输出。 ——tagstatinclude <标记> 只包含这些标记 在 统计数据的标签 表。 ——tagstatexclude <标记> 不包括这些标签 从 统计数据的标签 表。 ——tagstatcombine <标签:标题> 创建 结合统计数据基于标签 。 ——tagdoc <模式:医生> 增加了 文档指定的标签 。 ——tagstatlink <模式:链接:标题> 增加了 外部链接 到 统计数据的标签 表。 ——removekeywords < | |通过名字:模式|标签:模式| | wuks > 删除关键字数据 从生成的日志文件。 ——flattenkeywords <为| foritem |名称:模式|标签:模式> 趋于平缓的关键词 在生成的日志文件。 ——侦听器 <名称:参数> 设置一个侦听器 测试执行监控。 ——warnonskippedfiles 显示一个警告,当 跳过一个无效的文件 。 ——nostatusrc 设置 返回代码 为零,不管失败 在测试用例。 错误代码返回正常。 ——runemptysuite 如果选择的执行测试 测试套件是空的 。 ——dryrun 在 排练 没有执行模式运行测试 关键字源自测试库。 有用的 验证测试数据的语法。 ——exitonfailure 停止测试执行 如果任何关键的测试失败。 ——exitonerror 停止测试执行 如果任何错误发生在解析测试数据,导入库,等等。 ——skipteardownonexit 跳过拆解 测试执行是过早地停止了。 ——prerunmodifier <名称:参数> 激活 编程式的修改测试数据 。 ——prerebotmodifier <名称:参数> 激活 编程式的修改结果 。 ——随机 < | | |套件测试都没有> 随机排列 测试执行的顺序。 ——控制台 <详细|虚线| |安静没有> 控制台输出类型 。 ——点缀 的快捷方式 ——控制台点缀。——安静 的快捷方式 ——控制台安静。- w , ——consolewidth <宽度> 设置宽度 的控制台输出。 - c , ——consolecolors <汽车| | ansi |关闭> 指定是颜色 在控制台上使用。 - k , ——consolemarkers <汽车| |关闭> 显示 标记在控制台上 当顶层 关键字在一个测试用例结束。 - p , ——pythonpath环境 <路径> 额外添加的位置 模块搜索路径 。 - e , ——逃避 <什么:> 转义字符 有问题的在控制台。 ——一个 , ——argumentfile <路径> 一个文本文件 阅读更多的参数 从。 - h , ——帮助 打印 使用说明 。 ——版本 打印 版本信息 。
6.2.2后处理输出的命令行选项
- r ,——合并 结合行为变化的结果 合并 。 ——rerunmerge 机器人框架2.8.6以来弃用。 使用 ——合并 代替。 - n , ——名字 <名称> 集的名字 顶级的测试套件。 - d , ——医生 <文件> 设置文档 顶级的测试套件。 - m , ——元数据 <名称:值> 套免费的元数据 顶级测试套件。 - g , ——settag <标记> 设置标签(s) 所有处理测试用例。 - t , ——测试 <名称> 选择测试用例的名字 。 - s , ——套件 <名称> 选择测试套件 的名字。 -我 , ——包括 <标记> 选择测试用例 通过标签。 - e , ——排除 <标记> 选择测试用例 通过标签。 - c , ——关键 <标记> 测试有给定的标记 被认为是至关重要的 。 - n , ——被 <标记> 测试有给定的标记 不是至关重要的 。 - d , ——outputdir < dir > 定义在哪里 创建输出文件 。 - o , ——输出 <文件> 集生成的路径 输出文件 。 - l , ——日志 <文件> 集生成的路径 日志文件 。 - r , ——报告 <文件> 集生成的路径 报告文件 。 - x , ——xunit <文件> 集生成的路径 xUnit兼容的结果文件 。 ——xunitskipnoncritical 马克非关键测试 xUnit兼容的结果文件 跳过。 - t , ——timestampoutputs 添加一个时间戳 所有输出文件。 ——splitlog 把日志文件 成小块,开放 浏览器透明。 ——logtitle <标题> 设定一个标题 对生成的测试日志。 ——reporttitle <标题> 设定一个标题 对生成的测试报告。 ——reportbackground <色调> 设置背景颜色 生成的报告。 - l , ——loglevel <上> 设置阈值水平 选择日志消息。 选择默认 可见的日志级别 可以给 分离一个冒号(:)。 ——suitestatlevel <上> 定义了多少 水平显示 在 统计的套件 表中输出。 ——tagstatinclude <标记> 只包含这些标记 在 统计数据的标签 表。 ——tagstatexclude <标记> 不包括这些标签 从 统计数据的标签 表。 ——tagstatcombine <标签:标题> 创建 结合统计数据基于标签 。 ——tagdoc <模式:医生> 增加了 文档指定的标签 。 ——tagstatlink <模式:链接:标题> 增加了 外部链接 到 统计数据的标签 表。 ——removekeywords < | |通过名字:模式|标签:模式| | wuks > 删除关键字数据 从生成的输出。 ——flattenkeywords <为| foritem |名称:模式|标签:模式> 趋于平缓的关键词 在生成的输出。 ——开始时间 <时间> 设置 起始时间 当创建的测试执行 报告。 ——endtime <时间> 设置 结束时间 当创建的测试执行报告。 ——nostatusrc 设置 返回代码 为零,不管失败 在测试用例。 错误代码返回正常。 ——processemptysuite 即使文件包含流程的输出文件 空的测试套件 。 ——prerebotmodifier <名称:参数> 激活 编程式的修改结果 。 - c , ——consolecolors <汽车| | ansi |关闭> 指定是颜色 在控制台上使用。 - p , ——pythonpath环境 <路径> 额外添加的位置 模块搜索路径 。 - e , ——逃避 <什么:> 转义字符 有问题的在控制台。 ——一个 , ——argumentfile <路径> 一个文本文件 阅读更多的参数 从。 - h ,——帮助 打印 使用说明 。 ——版本 打印 版本信息 。
环境变量为执行和后期处理
- ROBOT_OPTIONS 和 REBOT_OPTIONS
- 由空格分隔的列表默认选项 前面的任何明确的选择 在命令行上。
- ROBOT_SYSLOG_FILE
- 路径 syslog 文件,机器人框架内部写道 解析信息测试用例文件和运行 测试。
- ROBOT_SYSLOG_LEVEL
- 日志级别使用时写的 syslog 文件。
- ROBOT_INTERNAL_TRACES
- 当设置为任何非空值时,机器人框架的 都包含在内部的方法 错误回溯 。
测试数据模板
这些模板可以使用 创建测试数据 对机器人 框架。 都有模板 测试用例 和 资源 文件 和资源模板也可以用来创建 测试套件 初始化文件 。
模板中可用 HTML格式 和 TSV格式 ,他们可以 自由定制。 没有模板 纯文本格式 因为 它需要样板太少,模板不会是非常有用的。
- testcase_template.html
- 测试用例文件模板的HTML格式。
- testcase_template.tsv
- 测试用例文件模板TSV格式。
- resource_template.html
- 资源文件模板的HTML格式。
- resource_template.tsv
- 资源文件TSV格式的模板。
- attd_template.html
- 在验收测试驱动创建测试用例的模板 开发(ATDD)风格。 这些测试是由高层 关键字不需要参数和模板 相应的简化。
模板是可以通过这个用户指南,它们包含在 源分布,也可以找到 从项目页面 。