Robot Framework Libdoc 扩展,用于生成 imbustestbench库的导入格式。
项目描述
Libdoc2TestBench
Robot Framework Libdoc 扩展,用于生成 imbustestbench企业版导入格式。它可以用于从 Robot Framework 库中生成 Testbench 交互和数据类型。
安装
要安装此软件包,您可以使用以下 pip
命令
pip install robotframework-libdoc2testbench
注意:此扩展需要 Robot Framework 5.0.0 或更高版本,并且不兼容早期版本。
用法
主要有三个用例
- 导入官方 Robot Framework 库
- 导入自定义 Robot Framework 库
- 导入 Robot Framework 资源文件
导入官方 Robot Framework 库
对于最基本的用法,您只需将 Robot Framework 库作为参数传递给 Libdoc2TestBench
命令。 Libdoc2TestBench
将在当前工作目录中创建一个以库名称命名的 zip 文件。此 zip 文件可以导入到 TestBench 中,以便在 TestBench 中使用 Robot Framework 关键字。
Libdoc2TestBench <LIBRARY>
参数<LIBRARY>
对应于你将在机器人框架库文件中使用的机器人框架库名称,用于在*** Settings ***
中导入库。第二个位置参数可用于指定生成的zip文件的名称。
Libdoc2TestBench <LIBRARY> <output.zip>
导入生成的测试平台zip文件
生成的zip文件可以通过在imbus TestBench的项目管理视图中使用导入项目...
命令来导入
之后,你可以在测试元素视图中找到导入的RF库、不同的交互和数据类型
导入的测试元素可以复制到另一个测试平台项目。在复制时,确保测试元素保持在相同的子分类中
导入自定义的robotframework库
Libdoc2Testbench也可以用来导入自定义的Robot Framework库。
自定义库的示例
class mycustomlibrary(object):
def print_hello_world(self):
print("Hello World")
Libdoc2Testbench使用示例
Libdoc2TestBench mycustomlibrary.py
导入 Robot Framework 资源文件
Libdoc2Testbench也可以用来导入Robot Framework资源文件。
资源文件的示例
*** Keywords ***
print hello world
log Hello World
Libdoc2Testbench使用示例
Libdoc2TestBench path/to/keywords.resource
一次性导入多个库和资源文件
Libdoc2Testbench可以用来一次性导入多个库和资源文件。为此,使用了一个特殊的机器人框架部分。
导入列表示例
*** Import List ***
BrowserLibrary
BuiltIn
mycustomlibrary.py
myresource.resource
Libdoc2Testbench使用示例
Libdoc2TestBench importlist.robot
命令行参数
有几个可选参数,其结构与robot.libdoc模块的结构相同。在从RF库生成导入时,这些值应已经正确设置。您可以通过设置下面的相关参数来覆盖docformat和其他元数据。
参数 | 描述 | 允许值 |
---|---|---|
-h , --help |
显示帮助信息并退出 | |
-a , --attachment |
定义是否将用于生成交互的资源文件附加到这些交互上。 | |
-F FORMAT , --docformat FORMAT |
指定源文档格式。可能的值是Robot Framework的文档格式、HTML、纯文本和reStructuredText。默认值可以在库源代码中指定,初始默认值是ROBOT 。 |
ROBOT HTML TEXT REST |
--libraryroot LIBRARYROOT |
定义包含导入的Robot Framework库的子分类名称。默认是RF 。 |
|
--resourceroot RESOURCEROOT |
定义包含导入的Robot Framework资源的子分类名称。默认是Resource 。 |
|
--libversion LIBVERSION |
设置描述中记录的库或资源的版本。 | |
--libname |
设置记录的库或资源的名称。 | |
-r REPOSITORY , --repository REPOSITORY |
设置TestBench导入的存储库ID。默认是iTB_RF 。 |
|
-s SPECFORMAT , --specdocformat SPECFORMAT |
指定用于XML和JSON规范文件的文档格式。RAW 表示保留原始文档格式,HTML 表示将文档转换为HTML。默认值是HTML 。 |
HTML RAW |
--version , --info |
将Libdoc2TestBench、Robot Framework和Python版本写入控制台。 | |
--library_name_extension |
向TestBench中机器人框架库子分类的名称添加扩展名。通常与testbench2robotframework 中的rfLibraryRegex 结合使用。默认是[Robot-Library] 。 |
|
--resource_name_extension |
向TestBench中机器人框架资源子分类的名称添加扩展名。通常与testbench2robotframework 中的rfResourceRegex 结合使用。默认是[Robot-Resource] 。 |
|
--created_datatypes |
可选参数,用于指定是否应在TestBench中创建所有Robot Framework数据类型(ALL )、仅枚举类型(ENUM )或不应创建数据类型,仅使用通用参数(NONE )。默认是ALL 。 |
变更日志
- 1.2
- 添加了RobotFramework版本>= 7的库关键字返回类型
- 添加了具有默认值的数据类型创建选项
- 删除了
--xml
命令行选项 - 删除了
--temp
命令行选项
- 1.1
- 添加了 TestBench 数据类型
- 添加了默认值
- 1.0rc2
- 为以下添加了可选参数:
- xml文件输出(而不是zip文件)
- 自定义临时目录
- 更改xml头部中的存储库ID
- 自定义主键枚举起始值
- info命令用于在控制台打印Libdoc2TestBench/Robot Framework/Python版本信息
- 支持资源文件(附件支持即将推出)
- 修复
- 仅在库中存在数据类型时创建
_Datatype
子分卷 Resource
子分卷现在位于正确的父分卷中- 更新了README.md / 包帮助信息以反映更改
- 仅在库中存在数据类型时创建
- 为以下添加了可选参数:
- 1.0rc1
- 第一个发布候选版
许可证
在Apache-2.0许可证下分发。有关更多信息,请参阅LICENSE。
依赖项
- python >= 3.8
- robotframework >= 5.0.0
项目详情
哈希值 for robotframework_libdoc2testbench-1.2.1-py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | f96d13a827cb89af749daa221474d86cf045728e03c108263bac8dbaf46262fc |
|
MD5 | ff833574c2f030165786454b0c3e1e87 |
|
BLAKE2b-256 | de67c9c4e27e0a8eb01fd9d4bcbc04eb8b01ee4e87d2bc1f50d96c9a3044e76f |