机器人框架：访问同一个库的多个资源文件

Question

所有 RobotFramework 用户您好

问题

我们有许多不同抽象级别的关键字，并且正在寻找一种简单的方法来导入它们，同时在 IDE 中保持对自动完成等的支持。

继承可能如下所示：

   /---------------------> basic_keywords.robot <---\
  /                             ^                    \
 /                              |                    |
 |  advanced_keywords_1.robot --/            advanced_keywords_2.robot
 |            ^
 |            |
more_advanced_keywords_1.robot

方案一：导入all_keywords.robot中的所有关键字

all_keywords.robot:

*** Settings ***
Library     SomeLibrary.py
Resource    basic_keywords.robot
Resource    advanced_keywords_1.robot
Resource    more_advanced_keywords_1.robot
Resource    advanced_keywords_2.robot

more_advanced_keywords_1.robot:

# No Import of basic_keywords.robot here!!!
*** Keywords ***
My More Advanced Keyword
    Advanced Keyword   # from advanced_keywords.robot
    Basic Keyword      # from basic_keywords.robot

在测试套件中导入：

*** Settings ***
Resource   all_keywords.robot

好处：

• 这在执行时起作用。
• 使用任何测试套件中的同一行，我们可以访问所有关键字。
• 我们不需要在每个高级关键字文件中导入必要的关键字，这会导致双重导入。

缺点：

• 不支持自动补全等，因为advanced_keywords.robot 不知道basic_keywords.robot。
• 在测试套件中导入许多（通常不使用）关键字，降低性能 (?)

提案2：参考basic_keywords...在advanced_keywords

@Todor 提议

advanced_keywords.robot:

*** Settings ***
Resource    basic_keywords.robot
*** Keywords ***
Advanced Keyword
    Basic Keyword      # from basic_keywords.robot

more_advanced_keywords_1.robot:

Resource    advanced_keywords.robot
# basic_keywords is imported here by advanced_keywords.robot
*** Keywords ***
My More Advanced Keyword
    Advanced Keyword   # from advanced_keywords.robot
    Basic Keyword      # from basic_keywords.robot

双重导入由 Robot Framework 处理。

在测试套件中导入：

*** Settings ***
Resource   more_advanced_keywords_1.robot
Resource   advanced_keywords_2.robot

好处：

• 这在执行时起作用
• 支持自动完成等，因为 IDE 知道 Advaned Keyword 的定义位置
• 更好地控制哪些关键字可用，更快

缺点：

• 您必须明确决定/导入您在测试套件中使用的advanced_keywords。

ROBOT_LIBRARY_SCOPE = 'GLOBAL' 中的SomeLibrary.py 可以防止库的双重实例化，请参阅Robot Framework makes two instances from the class instead of one 和Robot Framework User Guide

其他建议？

这两种建议各有利弊。有什么建议吗？你会建议什么结构？

Answer 1

解析在什么级别不起作用？

从常识（以及个人使用 PyCharm 的经验）来看，在仅导入 basic.robot 的套件中，来自 more_advanced_keywords_1.robot 的关键字将是可解析的——它们是通过 basic 间接导入的，因此在当前上下文中。

编辑more_advanced_keywords_1 时，我认为没有IDE 可以解析advanced_keywords_1 或basic 中的关键字。原因是当前文件无法单独访问它们。

在一个使用上下文（套件 A）中，消费者可能已经导入了这个文件（more_advanced_keywords_1）和另一个文件（advanced_keywords_1），并且可以访问后者的关键字；但在另一种情况下（套件 B），消费者可能只导入了 more_advanced_keywords_1。
那么如果more_advanced_keywords_1 引用来自advanced_keywords_1 的关键字，B 会发生什么？它会在运行时失败，因为此时未定义（可访问）关键字。
这与编辑 more_advanced_keywords_1 时 IDE 无法解析 advanced_keywords_1 或 basic 中定义的关键字的原因相同 - 它在当前上下文中无法访问它们。

你有两个选择：

• 咬紧牙关，不要让IDE在更深的关键字文件中解析；它仍然可以在套件中使用，所以这是可以忍受的。
• 使用双重导入 - basic 导入 advanced_keywords_1 和 advanced_keywords_1 导入 basic；这听起来可能很可怕或错误，但 Robot Framework（实际上是 py）可以很好地管理它。即使是循环导入也不会引起问题（a 导入 b，b 导入 a）。

过去我有一个和你一样的结构 - 一个主关键字文件，它本身导入了 20 多个二级资源文件，其中一些导入了三级资源文件。我使用了双重导入并且没有遇到问题（唯一的要求 - 没有关键字名称冲突）。
从那时起，我转向更分解的结构 - 没有主文件，套件只导入他们需要的资源。原因 - 更轻和更快的初始加载，主要是 - 我厌倦了在当前命名空间中不断提供 1000 多个关键字 - 例如出现在自动建议中:)

Answer 2

这是与 PyCharm IDE 相关的问题，我用 RED Robot Editor 做了一个正确处理继承资源的示例：

project structure:
  res/basic.robot contains basic kw
  res/advanced.robot imports basic.robot -> all kws from basic are avaliable and validated
  res/even_more_adv.robot imports advanced.robot -> all kw from advanced + all kw from basic
  main_testsuite.robot imports res/even_more_adv.robot -> all kw from even_more + advanced + basic resources are visible

我很确定 RIDE 也会处理这种情况，尽管我没有安装它。