Robot框架辅助工具

Robot框架辅助工具在Sublime Text 3中进行Robot框架测试数据的IDE特性和编辑。

从3.0.0版本开始，插件不再与Sublime Text 2兼容。3.0.0之前的版本将为Sublime Text 2用户提供服务。可以从st2-maintenance分支README找到Sublime Text 2用户的文档

该项目目前正在寻找维护者。

安装

安装最简单的方法是使用软件包控制并搜索：Robot框架辅助工具。

替代安装方法

将插件作为zip文件下载。打开Sublime Text，点击| 首选项 | 浏览包 |打开包目录。然后创建一个名为Robot框架辅助工具的目录，并将插件解压到该目录。

配置

在开始使用Robot框架辅助工具之前，您必须至少在用户包 Robot.sublime-settings文件中配置设置。要打开文件，请转到：首选项 | 包设置 | Robot框架辅助工具 | 设置 - 用户 | 默认设置可以在 首选项 | 包设置 | Robot框架辅助工具 | 设置 - 默认 |找到

用户需要定义的唯一必填设置是robot_framework_workspace和path_to_python。其余参数在尝试插件时可以安全地保留其默认值。

robot_framework_workspace

在Robot框架辅助工具提供关键字和变量完成功能之前，它需要从测试套件和资源文件创建数据库。该参数定义了执行扫描robot数据的主文件夹。

必须指向一个文件夹，不允许指向文件。当执行 Robot Framework: 创建数据库 命令时，将基于此设置扫描 Robot Framework 测试数据。

在 Windows 操作系统中，写入实际的反斜杠需要写两个反斜杠。

robot_framework_keyword_argument_format

此设置定义了在关键字补全时关键字参数的格式。当设置为 false 时，每个参数单独一行格式化。如果设置为 true，则关键字和参数将在单行中返回。

robot_framework_extension

文件扩展名定义了 Robot Framework 辅助插件将在 robot_framework_workspace 选项中定义的文件夹中搜索哪些类型的文件。

此设置影响插件命令和功能，但此插件中的主题定义不受此选项的影响。

如果 Robot Framework 数据中包含库或变量文件导入，则这些导入将自动解析并包含在扫描中。

path_to_python

为了使关键字和变量的数据库创建功能正常工作，必须定义 Python 二进制文件的路径。它必须是安装 Robot Framework 的同一个 Python 二进制文件。

在类似 Linux 的环境中，这可能类似于：/usr/bin/python，在 Windows 中可能类似于：C:\Python27\python.exe

robot_framework_module_search_path

模块搜索路径定义了一个列表，其中包含了 Robot Framework 库的搜索路径。例如，如果您已经通过库名称导入了一个库，那么模块搜索路径必须包含库可能所在的文件夹。

Robot Framework 辅助插件使用 Robot Framework API 解析测试数据和库。为了定位库，所有非系统范围的更改都必须添加到 Robot Framework 辅助插件的模块搜索路径中。

更多关于 Robot Framework 中如何搜索库的详细信息，请参阅 Robot Framework 用户指南

robot_framework_automatic_database_table

robot_framework_automatic_database_table 设置控制内部数据库更新。如果设置为 true，则在保存 Robot Framework 测试数据文件后创建内部数据库表。如果设置为 false，则仅当运行 创建数据库、创建数据库表 或 更新活动选项卡内部数据库 命令时才更新内部数据库表。

此设置仅控制 Robot Framework 测试数据。如果库或变量文件被更新，则必须运行 创建数据库 或 创建数据库表 命令来更新内部数据库。

robot_framework_library_in_xml

当解析时无法访问库（例如，通过远程库接口导入库，或者库不是用 Python 编写的，例如 SwingLibrary），则可以使用此设置以 libdoc XML 格式导入库。

从此路径找到的库将全局可用，就像内置库。例如，即使库未为此特定资源或测试套件导入，关键字补全仍将工作。

robot_framework_builtin_variables

Robot Framework 默认提供一些预定义的和内置的变量。这些变量的名称在不同的 Robot Framework 版本之间可能发生变化。使用此设置定义一个 Robot Framework 内置变量的列表。查看变量列表的最简单方法是运行以下测试用例的 Robot Framework：

注意：在 Robot Framework 2.9.2 或更高版本中，以下命令没有列出空变量，如 ${EMPTY}。

robot_framework_database_path

默认情况下，内部数据库在插件安装目录中的数据库文件夹中创建。有时更改默认数据库位置可能很有用。

如果机器人框架工作空间在Sublime工作空间文件中定义，并且用户想要在不同的项目之间切换，则定义robot_framework_database_path设置很有用，使其也针对特定项目。当内部数据库针对特定项目时，用户更改项目时不需要重新创建数据库。

robot_framework_database_path必须是文件夹的路径。如果设置不是文件夹路径，则数据库将在插件安装目录中创建。

robot_framework_log_commands

设置控制是否启用或禁用“Robot Framework: 命令日志”命令。如果robot_framework_log_commands设置为Python True，则log_commands API调用启用。如果设置为Python False，则禁用log_commands API调用。

如果启用log_commands API调用，则所有从键盘快捷键和菜单中运行的命令都会记录到控制台。

要启用日志记录，将robot_framework_log_commands设置为值true。然后从命令面板运行Robot Framework: Command Logging命令。

robot_framework_keyword_prefixes

在“跳转到关键字”命令中将被忽略的前缀。

编写测试案例时，Gherkin关键字具有类似于given、when和then的前缀。这样的前缀是测试用例特定的，在查找关键字时必须忽略它们。

典型Gherkin故事的配置：“robot_framework_keyword_prefixes” : [Given，When，Then，And，But]

语法定义

默认情况下，此插件将与扩展名为.robot的文件一起使用，插件将使用四个空格作为单元格分隔符。用户可以更改设置，但应查阅Sublime非官方文档，了解用户设置在哪里保存。

更改文件扩展名

文件扩展名在Robot.tmLanguage文件中定义。要更改文件扩展名，请导航到用户包文件夹，并将Robot.tmLanguage文件复制到用户设置文件夹。

在用户设置中的Robot.tmLanguage文件中，找到包含以下内容的行：

<key>fileTypes</key>
    <array>
        <string>robot</string>
    </array>

<string>元素包含文件类型定义。

更改单元格分隔符

单元格分隔符在Robot.tmPreferences文件中定义。要更改单元格分隔符，请导航到用户包文件夹，并打开Robot.tmPreferences文件。

找到包含<string><![CDATA[ ]]></string> XML标签的行。在方括号中有四个空格，这四个空格定义了插件使用的单元格分隔符。单元格分隔符通常用于循环片段以正确对齐和显示片段。

快捷键

• 按住Alt + Enter或用鼠标点击顶部关键字，将转到关键字来源。关键字来源可以位于Robot Framework测试数据或Python库中。对用其他编程语言编写的库不适用。
• 按住Alt + Enter或用鼠标点击资源或库导入，将打开导入的资源或库文件。
• 按住Ctrl + Alt + Enter或用鼠标点击将显示关键字文档。
• 按住Ctrl + /或Ctrl + Shift + /将在注释中切换。
• 按住Ctrl + Alt + a将运行Robot Framework: 创建数据库命令
• 按住Ctrl + Alt + s将运行Robot Framework: 创建数据库表命令
• 按下 Ctrl + Alt + i 将运行 Robot Framework: 更新活动选项卡内部数据库 命令。
• 按下 Ctrl + Alt + r 将在快捷菜单中显示可用的库、资源或变量导入项。快捷菜单仅在光标位于设置表，并且行包含 库、资源 或 变量 设置时显示。

Ctrl + Alt + a/s/i 命令的用法在 内部数据库 for 关键词和变量 维基页面中解释。

代码片段

代码片段 是 Sublime Text 的一个功能，用于提供常用文本模板。在此插件中，代码片段提供了对 Robot Framework 数据中常用设置的快速访问。要访问代码片段，请写入所需的字符组合。如果代码片段没有显示，请按 Tab 键查看代码片段完成列表。可以通过以下快捷键访问代码片段：* 写入 :f 以访问 Robot Framework 循环。目前有以下代码片段可供选择：普通循环、迭代循环、范围循环 和 zip 循环 类型。* 写入 *k 以访问 *** 关键词 *** 表代码片段。* 写入 *s 以访问 *** 设置 *** 表和它的设置。目前有以下代码片段可用：默认标签、文档说明、库、资源、*** 设置 ***、测试设置、测试销毁、测试模板 和 测试超时。* 写入 *t 以访问 *** 测试用例 *** 表代码片段。* 写入 : 以访问 关键词 和 测试用例 设置。目前有以下代码片段：[Arguments]、[Documentation]、[Return]、[Setup]、[Tags]、[Template]、[Teardown] 和 [Timeout]。* 写入 *v 以访问 *** 变量 *** 代码片段。

不同的循环代码片段使用了代码片段的 字段 功能。完成循环代码片段后，可以按 tab 键访问不同的循环字段。

请注意，插件不能阻止用户将代码片段放置在测试数据中无效的位置。请参阅 Robot Framework 的 用户指南，以了解不同可用代码片段的正确用法。

转到关键词

或者，使用 Sublime Text 的 转到符号 来转到关键词或变量的源代码。

请注意，转到符号 只适用于同一文件中的关键词和变量。无法使用 转到符号 来跳转到其他资源文件或库中的关键词或变量。

创建数据库

完成插件配置后，插件需要扫描测试数据，以创建位于包目录中的内部数据库。数据库将包含每个测试用例、资源和库的表。 once the tables have been created，插件将为每个测试用例、资源和库创建索引。索引将包含测试用例或资源在测试数据中导入的所有关键词和变量。索引允许插件仅为您打开的测试或资源文件提供已导入的关键词或变量的补全。

插件将在用户在Sublime中切换不同标签页时，自动更新数据库索引的指针。

关于如何更新内部数据库的详细信息，可以在关键字和变量内部数据库的维基页面上找到。

数据库创建错误调查

在创建数据库时，插件会将日志文件写入软件包安装目录：`database/scan_index.log`文件。如果数据库创建时出现错误，请检查日志并纠正可能的错误。

项目特定设置

配置Robot Framework Assistant时，也可以使用项目特定设置。

打开项目设置，并将`robot_framework_assistant`字典添加到设置文件中

"robot_framework_assistant":
    {

    }

例如，如果配置项目特定的工作空间和数据库路径，`robot_framework_assistant`字典应该如下所示

"robot_framework_assistant":
    {
        "robot_framework_workspace": "/path/to/folder/containing/robot/data",
        "robot_framework_database_path": "/path/to/project/database"
    }