SonarQube 代码扫描配置简单说明

支持PDF插件的版本下载地址
https://gitee.com/zzulj/sonar-pdf-plugin

workbook:默认的,概述、问题分析、问题详情、质量配置
executive:概述、问题分析(TOP)

Sonar 配置

1.点击右上角的+创建新项目
2.创建上传令牌
3.查看参考命令

后面创建不需要在sonar先创建项目,只需按参考命令配置不同的ID即可

Jenkins 配置

第一次使用

需要在 Jenkins 任务执行机器 Maven 的 conf/settings.xml 配置插件和服务器地址,参考官方教程(参考命令图里的“Maven扫描器官方文档”):
https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven/

配置插件时多配一个 jacoco 覆盖率插件,即

    <pluginGroup>org.jacoco</pluginGroup>
    <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>

查看 maven 位置

mvn -v
Apache Maven 3.0.5 (Red Hat 3.0.5-17)
Maven home: /usr/share/maven
Java version: 1.8.0_242, vendor: Oracle Corporation
Java home: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.242.b08-0.el7_7.x86_64/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "3.10.0-327.el7.x86_64", arch: "amd64", family: "unix"

下载 GitLab 插件略

Jenkins 任务

创建 自由风格的项目,设置拉取代码 略

image.png

先运行覆盖率测试再运行 sonar,如果多个项目用不同的 setting 可以用 -s 定义

mvn jacoco:prepare-agent test sonar:sonar \
  -Dsonar.projectName="显示名称,建议中文+英文" \
  -Dsonar.projectKey=项目标识 \
  -Dsonar.host.url=你的Sonar服务器url \
  -Dsonar.login=令牌 \
  -s /usr/share/maven/conf/settings-自定义后缀.xml

sonar 不会创建 class 文件夹,运行时可以暂时配置成 sonar 文件夹避免报错,这里先跑了测试所以不会报这个错

  -Dsonar.java.binaries=target/sonar

测试质量较差时可以增加如下命令行参数跳过编译失败和测试失败
···
-Dmaven.compiler.failOnError=false
-Dmaven.test.failure.ignore=true
···

配置GitLab提交代码时触发任务

拷贝 GitLab webhook URL

配置GitLab提交时触发
Secret token

打开 GitLab 项目配置


配置到GitLab
保存并测试效果

效果图

效果图-指标

典型用法

右上角搜索框搜索自己动过的文件,重点关注虫子标志的地方。
或者在问题中使用过滤器筛选作者是自己的部分:


过滤器

典型错误

7.x版本

日期 YYYY
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS3986
字符串==
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS4973
自己给自己赋值(部分无效 set 方法可能导致数据库没记录数据)
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS1656
"".equals(Map)
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS2159
+= 写成 =+
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS2757
除0
http://[YouSonarQubeHost]/issues?resolved=false&rules=squid%3AS3518&
SQL注入
http://[YouSonarQubeHost]/issues?resolved=false&sonarsourceSecurity=sql-injection

Web 扫描

第一次使用需安装 SonarScanner:
https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/
解压添加到环境变量后授权

chmod 755 .../sonar-scanner-4.3.0.2102-linux/bin/sonar-scanner
chmod 755 .../sonar-scanner-4.3.0.2102-linux/bin/sonar-scanner-debug
chmod 755 .../sonar-scanner-4.3.0.2102-linux/jre/bin/java
# 否则会报如下错误,实际读取的并不是 JAVA_HOME 而是 sonar-scanner 目录内的 jre
# Could not find 'java' executable in JAVA_HOME or PATH

安装后Ant项目、难以编译的Maven项目、下面的SQL等都可以用它扫描

sonar-scanner \
  -Dsonar.sources=. \
  -Dsonar.java.binaries=. \
  -Dsonar.projectName="显示名称,建议中文+英文" \
  -Dsonar.projectKey=项目标识 \
  -Dsonar.host.url=你的Sonar服务器url \
  -Dsonar.login=令牌

插件使用

下载 SQL 扫描插件放到extensions/plugins目录重启

重启服务

SQL 扫描

下面两个插件用了同一个文件同一个ID,只能选一个
SQL 有 21 条规则
https://github.com/gretard/sonar-sql-plugin/releases
plsqlopen 有 59 条规则
https://github.com/felipebz/zpa/releases

MyBatis 风险 SQL 扫描 MyBatisLint XML 有 7 条规则
https://github.com/donhui/sonar-mybatis/releases/

商业版的 SQL 扫描更为全面

商业版里
T-SQL 有 79 条
https://rules.sonarsource.com/tsql
PL/SQL 有 186 条
https://rules.sonarsource.com/plsql

SVN 项目常见问题

Jenkins 拉取 svn 不是最新

在路径最后加 @HEAD

E170001: Authentication required

[ERROR] Failed to execute goal org.sonarsource.scanner.maven:sonar-maven-plugin:3.7.0.1746:sonar (default-cli) on project project-name: Error when executing blame for file xxx.java: svn: E170001: Authentication required for 'svn://ip:prot hash' -> [Help 1]

SVN blame 报错解决

配置技巧

质量配置
修改标识
回收令牌
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342