用户自定义实用工具

目前有两类 utility:AXSUtility(AXSUtility) 和 UserUtility(UserUtility)。 它们都是 Python 模块,具体结构将在下文详细说明。要使用这些 utility, 必须将其保存到 utilities 目录中(如 Options ‣ Settings ‣ Directories 菜单所示)或其子目录中。 这两类 utility 的示例位于 ecu.test 安装目录 Templates/DefaultData/Utilities/ExampleUtilities。 还可以通过 Utility wizard(Utility 向导) 生成 utility 的基本结构。

AXSUtility

AXSUtility 可以作为 test step 插入。为此,该 utility 会映射到其自身,也就是说, AXSUtility 同时提供接口和实现。

其优点在于,用户只需编写接口并实现 run() 方法。接口用于描述输入参数和返回值, 随后即可在 run() 方法中通过读写访问这些参数。其余部分(如对话框、序列化、 报告等)均由 ecu.test 自动生成。

提供的示例

在 Utilities 选项卡的示例中,提供了 AXSUtility “SimpleCalculationExample” 作为演示。 如果该示例尚不可用,可按章节 Workspace creation(Workspace 创建) 中所述, 将其复制到所选 Workspace 中。

../_images/AXSUtility_1.png

在 operation 中,可以在加、减、乘、除之间进行选择。执行时,所选运算将应用于两个操作数 a 和 b。

右键单击 “SimpleCalculationExample” 并选择 Edit,即可查看其实现。 此外,也可以通过 Utility Wizard(Utility 向导) 打开该编辑器。

生成 AXSUtility

Utility Wizard(Utility 向导) 中的第二个条目:

接口定义

现在必须在方法 GetInterface(cls) 中定义 AXSUtility 的接口。参数和返回值都以约束的形式描述。

目前仅支持标量值,也就是数字或文本等简单数据类型。

  • NumericType

    带可选物理单位的数值。构造函数需要四个参数:

    def __init__(self, name, min, max, step)

    第一个参数定义名称。其余可选参数分别定义下限、上限和步长,后续输入值必须满足这些限制。 如果传入 None,则不应用该限制。

    随后可通过以下方法指定单位:

    def SetUnitFromStr(self, unitName)

    使用 ecu.test 中显示的单位文本表示。

    如果将该 utility 添加到 test case 中,可通过以下方法指定初始显示值:

    def SetDefaultValue(self, defaultValue)

    如果未显式指定该值,则使用最小值或 0。

  • TextType

    文本值。构造函数仅需要名称参数。

    def __init__(self, name)

    可通过以下方式指定可选值范围:

    def AddTextEntry(self, entry)

    在对话框中,可选项会以下拉框的形式显示。

    如果将该 utility 添加到 test case 中,可通过以下方法指定初始显示值:

    def SetDefaultValue(self, defaultValue)

    如果未显式指定该值,则使用第一个文本值或空字符串。

接口可通过以下方法添加参数约束:

def AddArgument(self, argument)

并通过以下方法添加返回值约束:

def AddReturn(self, returnValue).

实现

在方法

def OnRun(self, userExcInst, testEngine)

中,用户可通过对象 userExcInst 读取输入参数,并写入返回参数。 userExcInst 是 UserExecInst 类的实例,当前支持通过以下方法处理值:

  • def GetArgumentValue(self, name)

  • def GetRawArgumentValue(self, name)

    按名称获取参数。第一个方法返回值对象实例,第二个方法返回实际值,即数值或文本。

  • def SetReturnValue(self, name, value)

  • def SetRawReturnValue(self, name, raw value)

    设置指定名称的返回值或原始返回值。第一个方法要求传入封装在值对象中的参数, 第二个方法要求传入实际值,即数值或文本。未传入或未映射的参数结果为 None。

此外,还可选择重写以下方法:

def OnPreProcess(self, testEngine)

或

def OnPreProcessEx(self, userExcInst, testEngine)

以及

def OnPostProcess(self, testEngine)

和

def GetReportInfos(self)

可以被覆盖。在 OnPreProcessEx 中,输入参数的访问方式与 OnRun 中相同。 但只有被赋予常量值的参数(即不引用 test case 变量)才能被访问。对于 test case 中每次非隐藏的 utility 调用, 都会以相应参数调用一次 OnPreProcessEx 方法,不考虑 loop、if-then-else 等结构。

信息

特别是在 test case 中多次使用同一个 AXSUtility 时,GetReportInfos 返回的 dict 必须保存在 list(或 deque)中。原因在于,例如某个 AXSUtility 被使用两次时, 在调用 GetReportInfos 之前,OnRun 方法已经执行了两次。 如果直接将 ReportInfos 保存在单个 dict 中,那么在第二次调用 OnRun 时会被覆盖。 因此,随后两次调用 GetReportInfos 时,返回的都会是第二次 utility 执行的 ReportInfos。 在示例中(参见章节 Workspace creation(Workspace 创建)), utility“LinspaceExample” 演示了 GetReportInfos 的正确用法。

关闭 utility 向导后,即可将 AXSUtility 作为 test step 插入并执行:

../_images/AXSUtility_3.png

在报告中,映射到自身的 utility(即同时提供接口和实现)可通过动作 “UTILITY -> UTL” 识别:

../_images/AXSUtility_2.png

UserUtility

UserUtility 的具体结构请参见 UserUtility API 文档。 更新用户自定义 utility 并通过菜单项 “Update user libraries” (快捷键 Ctrl+Shift+R)重新加载后,必须关闭并重新打开正在使用它们的已打开 Package, 更新才会生效。