Sonarqube PLSQL 用于检测 SQL 脚本文件中正确的 SQL 终止符分号的自定义规则

Question

我正在使用Jenkins和SONARQUBE PL/SQL插件进行Oracle SQL代码分析， 我需要使用XPATH创建自定义规则，以便对通过 Jenkins 发送以进行部署的 SQL 脚本文件进行质量分析。

我正在尝试创建一个自定义规则，以检测任何 SQL 命令末尾是否缺少分号 (" ; "(。 SQL 终止("分号"(对于使用 SQLPLUS 部署 SQL 脚本非常重要。

代码示例

insert into table_name values('wait','for','completion'); -- compliant with script 
insert into table_name values('somename','for','good'); -- compliant with script 
**insert into table_name values('someplace','for','game')** -- non compliant as semicolon missing
insert into table_name values('something','for','change'); -- compliant with script 
delete from table_name ; -- compliant with script 
delete from table_name ; -- compliant with script 
update table_name set name='james' where id='22';

有一个插入查询缺少分号，因此 SonarQube 应该检测到这一点并失败 Jenkins 构建或未通过 SONAR 质量测试。

请帮助创建 PLSQL 自定义规则，以通过分号检测正确的 SQL 终止。

XPath的例子是：/COMPILATION_UNIT/ANY_DML_EXPRESSION/follow-sibling：：SEMICOLON -- 像这样

Answer 1

您可以按照指南"使用自定义规则创建插件"，使用模板项目plsql-custom-rules。
这比向 XPATH 添加规则更复杂，但您将拥有更多控制权。

要创建检查，可以创建org.sonar.plsqlopen.checks.AbstractBaseCheck的子类。
您可以使用org.sonar.check.Rule和org.sonar.squidbridge.annotations.SqaleConstantRemediation注释来配置检查元数据(名称、描述、密钥等(。

通常，您只需要覆盖两种方法：

• init()：订阅所需的语法规则
• visitNode(AstNode)：分析与订阅的语法规则匹配的节点

但首先，如问题 21 所示，请检查您的代码是否没有错误并显示"无法解析文件"消息。

我只需要知道像声纳库贝分析这样的解析器来检测脚本文件中的编译错误

检查您的案例是否不是可选的分号，如"CREATE VIEW中不需要分号"。
查看该源代码是检查解析器(如 sonarqube 分析(如何检测脚本文件中的编译错误的好方法。

Answer 2

我们过去一直在使用它，只是略有修改。您可以从实现相同逻辑的规则开始：

https://github.com/gretard/sonar-tsql-plugin/wiki/Custom-rules#creating-more-complex-custom-rule-with-distance