自定义检查¶
ecu.test 可以通过针对 Package、Project 和 Analysis Package 的自定义检查进行扩展。自定义检查以 Python 类实现,并从 UserPyModules 加载。
Overview¶
自定义检查通过模块级常量 MODULE_TYPE 以及匹配的
基类来发现:
'PACKAGE_CHECK'withAbstractPackageCheck'PROJECT_CHECK'withAbstractProjectCheck'ANALYSIS_PACKAGE_CHECK'withAbstractAnalysisPackageCheck
Info
该接口包含在 ecu.test Interface Python Library
ecutest-interface 中。
位置与结构¶
将自定义检查模块放在 Workspace 下的 UserPyModules 中。
该类必须提供:
GetName()Run(item)返回CheckResult条目列表
最简 Package 检查示例¶
from tts.interface.customCheck import AbstractPackageCheck, CheckResult
MODULE_TYPE = 'PACKAGE_CHECK'
class MyPackageCheck(AbstractPackageCheck):
def __init__(self, internalApi):
self._internalApi = internalApi
def GetName(self):
return 'MyPackageCheck'
def Run(self, package):
checkResults = []
if len(package.GetDescription()) == 0:
checkResults.append(CheckResult('Description must not be empty!'))
return checkResults
检查结果与严重级别¶
每项发现由 CheckResult 表示。
支持的严重级别包括:
notewarningerrorexception
ID 与 origin 字段¶
CheckResult 还支持可选字段 id 和 origin。
id标识发现项的类型。可以由用户代码设置(例如invalid-var-name、deprecated-parameter)。origin库 Workspace 的命名空间,或对于内置校验为 ‘internal’。该值由 ecu.test 设置。
带 id 的示例¶
from tts.interface.customCheck import CheckResult, Severity
result = CheckResult(
'Variable name does not match naming convention.',
severity=Severity.WARNING,
id='invalid-var-name',
)
可选修复¶
自定义检查可提供修复项,这些修复项会显示在同一检查对话框的上下文菜单中。
修复项由 Fix 定义,并返回 FixResult。
回调会接收被检查项和一个进度对象。
import os
from tts.interface.customCheck import AbstractPackageCheck, CheckResult
MODULE_TYPE = 'PACKAGE_CHECK'
class DesignerPackageCheck(AbstractPackageCheck):
def __init__(self, internalApi):
self._internalApi = internalApi
def GetName(self):
return 'MyDesignerPackageCheck'
def InsertDesigner(self, package, progress):
progress.SetCaption('Applying fix...')
package.Attributes.SetValue('Designer', os.getlogin())
return FixResult(Result.FIXED, 'Fix applied.')
def Run(self, package):
checkResults = []
if 'Designer' not in package.Attributes.GetNamesAndValues():
checkResults.append(
CheckResult(
'Designer must not be empty!',
severity=Severity.WARNING,
fixes=[
Fix('Insert currently logged in user', self.InsertDesigner),
],
)
)
Info
ecu.test 包含自定义检查的模板,可在启动应用程序时将这些模板复制到 Workspace 中。