sonar-java 手写一个规则-单元测试分析

前言

最近做项目，定制sonar规则，提高Java代码质量，在编写的sonar规则，做验证时，使用单元测试有一些简单的心得感悟，分享出来。

自定义规则模式

sonar的自定义规则很简单，一般而言有2种模式可以使用：

1. 自定义扫描代码逻辑，并对分类的Tree的结构处理

2. 使用已扫描的分类，对分好类的Tree进行分析

BaseTreeVisitor&JavaFileScanner

extends BaseTreeVisitor implements JavaFileScanner

继承Tree的访问器，实现Java文件扫描器

TreeVisitor定义了很多Tree的读取过程，当然我们也可以扩展这个过程，Tree是哪里来的呢，scan的接口实现的

IssuableSubscriptionVisitor

extends IssuableSubscriptionVisitor

继承发布订阅访问器，意思是sonar的sdk默认扫描出来，我们需要定义那些是我们需要的，就订阅处理相关的Tree处理，推荐使用这种方式，开发便捷，性能可以得到保障，毕竟扫描文件的算法，如果写的性能差，扫描会很久。

比如我们写一个扫描检查Java代码里的SQL的drop table语句

@Rule(key = "DropTableSQLCheck")
public class DropTableSQLCheck extends IssuableSubscriptionVisitor {private static final String RECOMMENDATION_DROP_MESSAGE = "Make sure that drop table \"%s\" is expected here instead of sql platform.";private static final String DROP_TABLE_STR = "DROP TABLE";//告诉sonar插件，我需要访问这个，这里定义了字符串，插件定义了很多，如果不符合要求就需要自定义扩展，同时需要扩展扫描器@Overridepublic List<Tree.Kind> nodesToVisit() {return Collections.singletonList(Tree.Kind.STRING_LITERAL);}// 访问我们刚刚要求的类型，已经安装Kind过滤了，扫描文件，归类的逻辑，已经sonar的API实现了，如果不符合要求才需要扩展@Overridepublic void visitNode(Tree tree) {if (!tree.is(Tree.Kind.STRING_LITERAL)) return;SyntaxToken syntaxToken = tree.firstToken();if (syntaxToken == null) return;String str = syntaxToken.text();if (StringUtils.isBlank(str)) return;String originStr = str;str = str.trim().toUpperCase();if (str.contains(DROP_TABLE_STR)) {reportIssue(tree, String.format(RECOMMENDATION_DROP_MESSAGE, originStr));}}
}

这里没有考虑xml的SQL，包括字符串多个空格的考虑，理论上应该按照分析drop，然后为index逐个字符读取，如果是空格就读取下一个，如果是非t就return，如果下一个是非a就return，当然也可以使用正则。这里使用简化算法，做一个Demo

加上规则类，仿造写sonarqube的元数据

到此规则编写完成，后面分析单元测试逻辑

源码分析

简单分析下，代码执行逻辑，类似Java agent插件

从main的class执行

上下文加扩展，这里是一个注册扫描规则，一个注册扫描元数据，当然也可以合二为一，架构建议分离，所以Demo是分离的

元数据规则是sonarqube server启动实例化，启动就可以看到检查类别，检查类规则是代码分析时实例化

注册规则类，这里又分了是否用于test，上面的手写规则需要注入这个里面

元数据信息是路径扫描读取的，所以只要放在那个路径就行，通过@Rule的名称匹配文件名

 这里的repository_key是sonarqube显式的规则名称，同时这里也可以扫描其他语言，比如xml

这里写好后，如果需要本地验证，则需要单元测试。

单元测试

编写单元测试代码，即使是不能编译的代码也可以扫描

class A {private final String SQL = "drop table xxx";void foo() {String SQL1 = "drop table xxx"; // NoncompliantdoSomething(SQL1);}@SQL("drop table xxx")public void doSomething(String SQL){// do something}
}

 编写test

public class DropTableSQLCheckTest {@Testvoid test() {((InternalCheckVerifier) CheckVerifier.newVerifier()).onFile("src/test/files/DropTableSQLCheck.java").withCheck(new DropTableSQLCheck()).withQuickFixes().verifyIssues();}
}

载入需要扫描的文件和使用那个规则类检查 

单元测试分析

单元测试写好后，出现这个错误

这并不是规则写的有问题或者规则没命中，而是一种断言，sonar的单元测试jar定义

如果扫描出问题，那么需要对有问题的行打上

// Noncompliant

开头的注释，否则断言不通过

规则来源于org.sonar.java.checks.verifier.internal.Expectations的

collectExpectedIssues

方法中

    private static final String NONCOMPLIANT_FLAG = "Noncompliant";private final Set<SyntaxTrivia> visitedComments = new HashSet<>();private Pattern nonCompliantComment = Pattern.compile("//\\s+" + NONCOMPLIANT_FLAG);private void collectExpectedIssues(String comment, int line) {// 此处断言，收集断言有问题的代码行if (nonCompliantComment.matcher(comment).find()) {ParsedComment parsedComment = parseIssue(comment, line);if (parsedComment.issue.get(QUICK_FIXES) != null && !collectQuickFixes) {throw new AssertionError("Add \".withQuickFixes()\" to the verifier. Quick fixes are expected but the verifier is not configured to test them.");}// 放进预估issues.computeIfAbsent(LINE.get(parsedComment.issue), k -> new ArrayList<>()).add(parsedComment.issue);parsedComment.flows.forEach(f -> flows.computeIfAbsent(f.id, k -> newFlowSet()).add(f));}if (FLOW_COMMENT.matcher(comment).find()) {parseFlows(comment, line).forEach(f -> flows.computeIfAbsent(f.id, k -> newFlowSet()).add(f));}if (collectQuickFixes) {parseQuickFix(comment, line);}}

同理，如果一个问题都没用，那么验证不了规则，直接断言失败

org.sonar.java.checks.verifier.internal.InternalCheckVerifier

  private void assertMultipleIssues(Set<AnalyzerMessage> issues, Map<TextSpan, List<JavaQuickFix>> quickFixes) throws AssertionError {if (issues.isEmpty()) { // 没有错误示例，就断言失败throw new AssertionError("No issue raised. At least one issue expected");}List<Integer> unexpectedLines = new LinkedList<>();Expectations.RemediationFunction remediationFunction = Expectations.remediationFunction(issues.iterator().next());Map<Integer, List<Expectations.Issue>> expected = expectations.issues;for (AnalyzerMessage issue : issues) {validateIssue(expected, unexpectedLines, issue, remediationFunction);}// expected就是我们通过注释断言的sonar需要扫描出来的问题，如果有部分没有预计断言出来就会if (!expected.isEmpty() || !unexpectedLines.isEmpty()) {Collections.sort(unexpectedLines);List<Integer> expectedLines = expected.keySet().stream().sorted().collect(Collectors.toList());throw new AssertionError(new StringBuilder() //这里抛出断言缺失的错误或者错误断言的错误.append(expectedLines.isEmpty() ? "" : String.format("Expected at %s", expectedLines)).append(expectedLines.isEmpty() || unexpectedLines.isEmpty() ? "" : ", ").append(unexpectedLines.isEmpty() ? "" : String.format("Unexpected at %s", unexpectedLines)).toString());}assertSuperfluousFlows();if (collectQuickFixes) {new QuickFixesVerifier(expectations.quickFixes(), quickFixes).accept(issues);}}

总结

sonar扫描实际上现在已经非常完善了，尤其是心得API的提供，很大程度不需要我们写什么东西，专注核心的扫描算法与Tree的解析，甚至大部分扫描算法都不需要写了，使用发布订阅即可，得益于心得API的提供，目前使用的很多API还是@Beta注解，但是开发效率极大的提升了，毕竟以前旧的sonar版本，需要我们自己写各种扫描与分析逻辑。不过sonar的单元测试与传统的单元测试是有一定区别的，sonar的测试逻辑是必须有一个问题测试案例，且需要打上

// Noncompliant

注释，注释的行既是命中的行，sonar使用行号作为map的key，这样sonar才认为是命中规则的。如果断言错误，或者断言的数量不对，那么也一样会单元测试失败。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://xiahunao.cn/news/2809485.html

如若内容造成侵权/违法违规/事实不符，请联系瞎胡闹网进行投诉反馈，一经查实，立即删除！

相关文章

JAVA工程师面试专题-《Mysql》篇

JAVA工程师面试专题-《Mysql》篇

目录 一、基础 1、mysql可以使用多少列创建索引&#xff1f; 2、mysql常用的存储引擎有哪些 3、MySQL 存储引擎&#xff0c;两者区别 4、mysql默认的隔离级别 5、数据库三范式 6、drop、delete 与 truncate 区别&#xff1f; 7、IN与EXISTS的区别 二、索引 1、索引及索…
阅读更多...
数据库应用：Windows 部署 MySQL 8.0.36

数据库应用：Windows 部署 MySQL 8.0.36

目录 一、实验 1.环境 2.Windows 部署 MySQL 8.0.36 3.Windows配置环境变量 4.Navicat链接MySQL 二、问题 1.安装MySQL 报错 一、实验 1.环境 &#xff08;1&#xff09;主机 表1 主机 主机软件版本IP备注WindowsMySQL8.0.36localhost 2.Windows 部署 MySQL 8.0.…
阅读更多...
云原生之容器编排实践-ruoyi-cloud项目部署到K8S：MySQL8

云原生之容器编排实践-ruoyi-cloud项目部署到K8S：MySQL8

背景 前面搭建好了 Kubernetes 集群与私有镜像仓库&#xff0c;终于要进入服务编排的实践环节了。本系列拿 ruoyi-cloud 项目进行练手&#xff0c;按照 MySQL &#xff0c; Nacos &#xff0c; Redis &#xff0c; Nginx &#xff0c; Gateway &#xff0c; Auth &#xff0c;…
阅读更多...
顺序表知识点——顺序表的增删查改

顺序表知识点——顺序表的增删查改

目录 准备文件 创建顺序表蓝图 顺序表初始化函数接口 顺序表的销毁函数接口 顺序表的打印函数接口 顺序表的插入函数接口 顺序表的删除函数接口 从本节开始&#xff0c; 复习数据结构。 空间复杂度还有时间复杂度之后利用例题学习。 这节先学习顺序表的增删查改。 首…
阅读更多...
Android Gradle开发与应用 (二) : Groovy基础语法

Android Gradle开发与应用 (二) : Groovy基础语法

1. Groovy是什么 Groovy是基于JVM虚拟机的一种动态语言&#xff0c;语法和Java非常相似&#xff0c;并能够无缝地与Java代码集成和互操作&#xff0c;增加了很多动态类型和灵活的特性。(闭包、DSL) 语法和Java非常相似这个特点&#xff0c;意味着&#xff0c;如果我们完全不懂…
阅读更多...
[ffmpeg] x264 配置参数解析

[ffmpeg] x264 配置参数解析

背景 创建 x264 编码器后&#xff0c;其有一组默认的编码器配置参数&#xff0c;也可以根据需要修改参数&#xff0c;来满足编码要求。 具体参数 可修改的参数&#xff0c;比较多&#xff0c;这边只列举一些常用的。 获取可以配置的参数 方式1 查看 ffmpeg源码 libx264.c…
阅读更多...
通用检测大模型 | 华科白翔团队提出以对象为中心的基础模型GLEE

通用检测大模型 | 华科白翔团队提出以对象为中心的基础模型GLEE

本文首发: AIWalker https://arxiv.org/abs/2312.09158 https://glee-vision.github.io AIWalker后台回复【GLEE】即可下载原文与译文。 在这项工作中&#xff0c;我们提出了GLEE&#xff1a;一个对象级的基础模型&#xff0c;用于定位和识别图像和视频中的对象。 通过一个统一…
阅读更多...
第二节：Vben Admin 登录逻辑梳理和对接后端准备

第二节：Vben Admin 登录逻辑梳理和对接后端准备

系列文章目录 上一节&#xff1a;第一节&#xff1a;Vben Admin介绍和初次运行 文章目录 系列文章目录前言项目路径的概述一、登录逻辑梳理loginApi接口查看Mock 二、后端程序对接准备关闭Mock 总结 前言 第一节&#xff0c;我们已经配置了前端环境&#xff0c;运行起来了我们…
阅读更多...
查看笔记本电池健康状态-windows11

查看笔记本电池健康状态-windows11

在 Windows 11 中获取详细的电池报告 Windows 11 中内置的 Powerfg 命令行选项来生成电池报告。 在任务栏上选择“搜索”&#xff0c;键入“cmd”&#xff0c;长按&#xff08;或右键单击&#xff09;“命令提示符”&#xff0c;然后选择“以管理员身份运行” ->“是”。 …
阅读更多...
【Flink精讲】Flink性能调优：CPU核数与并行度

【Flink精讲】Flink性能调优：CPU核数与并行度

常见问题 举个例子 提交任务命令&#xff1a; bin/flink run \ -t yarn-per-job \ -d \ -p 5 \ 指定并行度 -Dyarn.application.queuetest \ 指定 yarn 队列 -Djobmanager.memory.process.size2048mb \ JM2~4G 足够 -Dtaskmanager.memory.process.size4096mb \ 单个 TM2~8G 足…
阅读更多...
自动驾驶---行业发展及就业环境杂谈

自动驾驶---行业发展及就业环境杂谈

进入21世纪以来&#xff0c;自动驾驶行业有着飞速的发展&#xff0c;自动驾驶技术&#xff08;L2---L3&#xff09;也逐渐落地量产到寻常百姓家。虽然最早期量产FSD的特斯拉有着深厚的技术积累&#xff0c;但是进入2010年以后&#xff0c;国内的公司也逐渐发展起来自己的自动驾…
阅读更多...
【Java程序员面试专栏 算法思维】二 高频面试算法题：二分查找

【Java程序员面试专栏 算法思维】二 高频面试算法题：二分查找

一轮的算法训练完成后，对相关的题目有了一个初步理解了，接下来进行专题训练，以下这些题目就是汇总的高频题目，本篇主要聊聊二分查找，包括基础二分，寻找目标值的左右边界，搜索旋转数组以及波峰，以及x的平方根问题，所以放到一篇Blog中集中练习 题目关键字解题思路时间空…
阅读更多...
python常用文件操作

python常用文件操作

1.文件夹创建&#xff0c;删除&#xff0c;重命名&#xff0c;路径连接&#xff0c;文件打开&#xff0c;关闭读写 #文件夹创建 path ./test newpath "./new" #判断文件夹是否存在 ret os.path.exists(path) if ret:pass else:#创建文件夹os.mkdir(path)#文件夹重…
阅读更多...
查看mysql数据库的版本

查看mysql数据库的版本

要查看MySQL数据库的版本&#xff0c;可以使用以下几种方法&#xff1a; 命令行&#xff08;已连接到MySQL服务器&#xff09;&#xff1a; 登录到MySQL服务器后&#xff0c;在MySQL提示符下执行&#xff1a; mysql> SELECT VERSION(); 或者&#xff0c;也可以执行 STATUS; …
阅读更多...
[C++]C++中memcpy和memmove的区别总结

[C++]C++中memcpy和memmove的区别总结

这篇文章主要介绍了C中memcpy和memmove的区别总结,这个问题经常出现在C的面试题目中,需要的朋友可以参考下 变态的命名 我们在写程序时&#xff0c;一般讲究见到变量的命名&#xff0c;就能让别人基本知道该变量的含义。memcpy内存拷贝&#xff0c;没有问题;memmove&#xff…
阅读更多...
大数据开发项目--音乐排行榜

大数据开发项目--音乐排行榜

环境&#xff1a;windows10&#xff0c;centos7.9&#xff0c;hadoop3.2、hbase2.5.3和zookeeper3.8完全分布式&#xff1b; 环境搭建具体操作请参考以下文章&#xff1a; CentOS7 Hadoop3.X完全分布式环境搭建 Hadoop3.x完全分布式环境搭建Zookeeper和Hbase 1. 集成MapReduce…
阅读更多...
【03】逆序数组

【03】逆序数组

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 目录 一、逆序函数是什么&#xff1f; 二、逆序函数原码 1.直接逆序 2.创建临时数组逆序 三、结言 &#x1f4a5;一、逆序函数是什么&#xff1f; 示例&#xff1a;输入1 4 …
阅读更多...
springBoot整合Redis（一、Jedis操作Redis）

springBoot整合Redis（一、Jedis操作Redis）

在springboot环境下连接redis的方法有很多&#xff0c;首先最简单的就是直接通过jedis类来连接&#xff0c;jedis类就相当于是redis的客户端表示。 但是因为现在比较常用的是&#xff1a;StringRedisTemplate和RedisTemplate&#xff0c;所以jedis只做简单的介绍。 一、Jedis…
阅读更多...
强化学习（GPS）

强化学习（GPS）

GPS——Guided Policy Search引导策略搜索 基于模型的强化学习算法 GPS目前被作为基础算法广泛应用于各种强化学习任务中&#xff0c;其出发点在于纯粹的策略梯度方法在更新参数时不会用到环境模型因而属于一种无模型强化学习算法。由于没有利用任何环境的内在属性&#xff0…
阅读更多...
在线网络代理转发NPClient

在线网络代理转发NPClient

NPClient操作方式&#xff1a; 用浏览器打开网站http://101.35.247.87:9000/ 点击注册 输入注册的用户名和密码&#xff0c;就会进入如下界面&#xff1a; 点击登录 输入用户名和密码后进入如下界面&#xff1a; 点击下载代理客户端&#xff0c;下载时要稍微等一下&#xff0c…
阅读更多...
最新文章

Copyright @ 2022~2023