本主题介绍如何通过修改内置静态分析规则或创建您自己的静态分析规则,以检查自定义需求或根据您的独特需求定制现有规则。
章节目录:
自定义参数化规则
许多规则都是参数化的,这意味着您可以通过修改可用的规则参数自定义规则的性质。许多命名约定规则都是参数化的,因此可以指定要检查的命名约定。其他规则是参数化的,这样您就可以控制规则选项,比如检查的范围,或者在规则的不同解释之间进行选择。在测试配置对话框静态> 规则树选项卡中的参数化规则用一个特殊的图标标记(带有单选按钮的巫师帽):
如果规则是参数化的,则在规则的描述中描述其参数。若要查看规则说明,则右键点击代表该规则的节点,选择查看规则文档。
若要编辑参数化规则:
- 请前往 Parasoft> 测试配置或选择运行测试工具栏按钮下拉菜单中的测试配置,打开测试配置对话框。
- 为任务测试配置打开静态> 规则树选项卡。修改后的规则参数将应用于所有测试配置,因此在此步骤中选择哪个测试配置并不重要。
- 展开规则的类别分支。
- 右键点击要修改的参数化规则,然后选择查看/改变规则参数。
- 在打开的对话框中修改规则参数。
- 点击 OK 保存更改。
关于 RuleWizard
本节介绍使用 RuleWizard 自定义现有规则和创建新规则的一般工作流程。请参阅 RuleWizard 用户指南了解有关 RuleWizard 功能和用法的详细信息。
RuleWizard(只在架构师和自动化版本中可用)允许您创建自定义静态分析规则。SOAtest 可以自动执行在 RuleWizard 中创建的任何有效规则。通过创建和检查自定义规则,团队可以验证独特的项目和组织需求,并防止最常见的错误再次发生。
使用 RuleWizard,可以图形化地创建规则(通过创建类似于流程图的规则表示形式),也可以自动地创建规则(通过提供演示违反规则示例的代码)。编写或修改规则不需要编写代码或了解解析器。
打开 RuleWizard 有两种方法:
- 前往 Parasoft> 启动 RuleWizard。
- 点击测试配置面板静态选项卡中的新建。
然后,打开 RuleWizard 用户界面。“RuleWizard 用户指南”包含如何修改、创建和启用自定义规则的信息。您可以访问帮助 > 帮助内容或 Parasoft > 帮助(取决于您的安装程序),然后打开“SOAtest RuleWizard 用户指南”。
使用 RuleWizard 自定义内置规则
使用 SOAtest Architect Edition 和 Automation Edition,您可以使用 RuleWizard 在测试配置面板的规则树中自定义任何标有以下巫师帽 + 魔杖图标的规则:
我们强烈建议您保留 SOAtest 内建规则;与其修改内建规则,不如复制这些规则并修改复制的规则:
若要自定义 RuleWizard 中的内建规则:
- 请前往 Parasoft> 测试配置或选择运行测试工具栏按钮下拉菜单中的测试配置,打开测试配置对话框。
- 为任务测试配置打开静态> 规则树选项卡。
- 右键点击要修改的规则并选择复制。一个重复的规则节点(带有文件图标)将被添加到规则树中。
- 右键点击复制的规则并选择在 RuleWizard 中编辑规则。
然后,打开 RuleWizard 用户界面。“RuleWizard 用户指南”(可在 RuleWizard GUI 中选择帮助> 文档来访问)包含关于如何修改和保存自定义规则的信息。修改规则后,请务必保存规则,然后按照配置策略的测试配置和规则或使用自定义规则中的说明启用规则。
在 Parasoft 测试系列产品中,此过程是相同的。详情请参阅配置策略的测试配置和规则。
创建新规则
可以使用 SOAtest RuleWizard 模块轻松地创建您自己的静态分析规则(或修改内置规则),该模块是 SOAtest(架构师版本)和 SOAtest(自动化版本)中提供的图形化规则创建和定制工具。
使用 RuleWizard,可以图形化地创建规则(通过创建类似于流程图的规则表示形式),也可以自动地创建规则(通过提供演示违反规则示例的代码)。编写或修改规则不需要编写代码或了解解析器。
要打开 RuleWizard,请前往 Parasoft > 启动 RuleWizard。
然后,打开 RuleWizard 用户界面。“RuleWizard 用户指南”(可在 RuleWizard GUI 中选择帮助> 文档来访问)包含关于如何修改、创建、保存自定义规则的信息。
在检查自定义规则之前,必须配置 SOAtest 来导入并检查。有关如何配置 SOAtest 以识别和检查这些规则的详情,请参阅配置策略的测试配置和规则或使用自定义规则。
规则 ID 注意事项
导入到工具中的每个规则必须具有唯一的规则 ID。不应导入具有相同规则 ID 的多个规则。
使用自定义规则
在检查 RuleWizard 中设计的自定义编码规则之前,需要配置 SOAtest 来访问和检查这些规则。
要配置 SOAtest 以导入和检查自定义规则:
- 请前往 Parasoft> 测试配置或选择运行测试工具栏按钮下拉菜单中的 Parasoft > 测试配置,打开测试配置对话框。
- 选择任何测试配置分类。新规则将在所有可用的测试配置中可用。
- 打开静态> 规则树选项卡。
- 如果有新规则应归类到一个新分类中,则按以下方式创建新分类:
- 点击编辑 Rulemap。
- 打开分类选项卡。
- 点击新建。将添加一个新的条目到分类表中。
- 在新条目中输入分类 ID 和分类描述。例如,组织可能选择使用 ACME 作为分类 ID,使用 ACME INTERNAL RULES 作为描述。
- 点击 OK,保存新分类。
- 点击规则树右侧的导入。将打开导入 RuleWizard 规则对话框。
- 使用导入 RuleWizard 规则对话框指定要导入哪个规则,以及是否要覆盖现有规则文件(如果导入的规则文件具有与现有规则文件相同的名称)。
- 点击 OK。规则将显示在指定的分类下,默认情况下将禁用。
- 启用要检查的新规则。
- 点击应用或关闭提交修改后的设置。