Jenkins中集成sonar检查

一. Linux服务器搭建sonar

https://www.digitalocean.com/community/tutorials/how-to-ensure-code-quality-with-sonarqube-on-ubuntu-16-04

官网下载sonar的zip包

我是mac本地以前下好的,也可以在服务器上从官网直接获取:

sudo wget https://sonarsource.bintray.com/Distribution/sonarqube/sonarqube-7.0.zip

从本地scp到服务器/home/hehetc/software/sonar目录下,并解压到/opt/sonar目录下:

scp sonarqube-7.1.zip hehetc@47.93.250.185:/home/hehetc/software/sonar

要解压,需下载zip:sudo apt-get install unzip

配置环境变量

把sonar安装目录(到/bin)加入环境变量

这里加入hehetc这个用户的.bashrc

vi ~/.bashrc

最后面加上:

SONAR_HOME=/opt/sonar/sonarqube-7.1

SONAR_SCANNER_HOME=/opt/sonar/sonar-scanner-4.0.0.1744-linux

export PATH=$PATH:$SONAR_HOME/bin:$SONAR_SCANNER_HOME/bin

这里已经把后面sonar-scanner的也加了

改完后source ~/.bashrc

配置sonar的配置文件

配置文件:/opt/sonar/sonarqube-7.1/conf/sonar.properties

主要配置数据库地址、用户名、密码

SonarQube server配置服务

创建一个文件: sudo vi /etc/systemd/system/sonarqube.service

文件内容:

[Unit]

Description=SonarQube service

After=syslog.target network.target

[Service]

Type=forking

ExecStart=/opt/sonar/sonarqube-7.1/bin/linux-x86-64/sonar.sh start

ExecStop=/opt/sonar/sonarqube-7.1/bin/linux-x86-64/sonar.sh stop

User=sonarqube

Group=sonarqube

Restart=always

[Install]

WantedBy=multi-user.target

作为服务启动


创建非root系统用户

Linux系统中创建一个sonarqube用户,来运行SonarQube services

sudo adduser --system --no-create-home--group --disabled-loginsonarqube

让新建的sonarqube用户拥有我们安装目录的权限:

sudo chown -Rsonarqube:sonarqube/opt/sonar

mysql中建sonar数据库

mysql -u root -p

CREATE DATABASE sonarqube;

EXIT;

创建一个mysql用户,用于sonar来访问,并赋予sonarqube库下的权限(可修改数据):

CREATE USER sonarqube@'localhost'IDENTIFIED BY'sonarqube';

GRANT ALL ON sonarqube.* to sonarqube@'localhost';

这里我设置用户名密码都是sonarqube

FLUSH PRIVILEGES;

EXIT;

启动sonar

sudo service sonarqube start

看状态:service sonarqube status

登陆sonar

http://47.93.250.185:9000/

登陆默认用户名密码都是admin

初次登陆:

hehetc: e1914d433997e40b4d0ebfe0db75f13a622bf6e9

登陆后菜单会多出administration。在market下搜索Chinese Pack安装中文包。

新建用户:新建了hehetc用户密码yc123456

生成了令牌:hehetc:a5ef52df04c1df7c7b7744ab72bd8e7114cb097c

配置权限:设为必须登陆才能访问

二. 安装并运行sonar-scanner

下载解压

下载安装包解压到sonar同一个目录即可:

hehetc@iZ2zefiv0zhc0j39v6bod6Z:/opt/sonar$ ls

__MACOSX  sonarqube-7.1  sonar-scanner-4.0.0.1744-linux

配置环境变量

见sonar配置环境变量,已配置好

修改配置文件

修改conf/sonar-scanner.properties,配上sonar地址:

cd /opt/sonar/sonar-scanner-4.0.0.1744-linux/conf

sudo vi sonar-scanner.properties

#----- Default SonarQube server

sonar.host.url=http://localhost:9000

#----- Default source code encoding

#sonar.sourceEncoding=UTF-8

这里都在一台服务器上,localhost即可

sudo chmod +x sonar-scanner-3.0.3.778-linux/bin/sonar-scanner

建立命令链接

把sonar-scanner安装目录下的bin目录和系统命令bin目录链接起来,以便无前缀随处都可使用命令

sudo ln -s /opt/sonar/sonar-scanner-3.0.3.778-linux/bin/sonar-scanner/usr/local/bin/sonar-scanner

此时应该可以sonar-scanner –h看到结果了

运行sonar-scanner

在/home/hehetc/sonar-scanner-workspace目录下新建了这个workspace。在里面下载一个sonar的示例工程:

wget https://github.com/SonarSource/sonar-scanning-examples/archive/master.zip

解压:

unzip master.zip

rm master.zip

cdsonar-scanning-examples-master/sonarqube-scanner

命令行直接调用sonar-scanner

运行命令:

sonar-scanner -D

sonar.login=your_token_here (网页中生成的hehetc的token)

访问sonar页面,可看到扫描结果了:


Jenkins中集成sonar

https://www.jianshu.com/p/b35674bd2fad

Jenkins中下载sonarqube-scanner 插件

Jenkins系统配置:配置sonar服务器

token是提前新建好的访问sonar的token(在sonar页面为用户名生成的)

sonar中的token:

maven配置settings.xml

主要是配置sonar数据库和服务器地址

进入服务器上maven安装位置,vi setting.xml

找到服务器maven安装目录:mvn –v可以看到

复制setting配置文件到用户自己目录下,这样改了不会影响全局(修改自己的也不要sudo):

cp /usr/share/maven/conf/settings.xml

~/.m2/settings.xml

分别把标黄部分加到对应标签下(注意看setting文件中是否已经放开了这俩标签,放开的话,必须放进去,不能直接复制到末尾,否则会重复):


修改maven工程的pom文件

这里我直接到github上meeting-server这个springboot工程的pom文件里修改了:

添加一个sonar依赖,用于下载sonar的maven插件。

jenkins中配置sonar服务器

系统管理-系统设置:

token用在sonar的web页面中生成的token


建一个jenkins job

构建步骤:调用顶层maven目标

sonar:sonar-Dsonar.java.binaries=target/sonar -Dmaven.test.skip=true

发现报错:

经查错,发现是因为sonar web中配置了不允许非登陆访问。放开之后就好了。

另一种办法是,在maven的setting文件配置中加上sonar登陆的用户名密码:

<sonar.login></sonar.login>,但试了发现不行,没找到原因。

Jenkins中配置sonar-scanner

目前部门前端扫描才需要sonar-scanner

在系统管理-全局工具配置(注意不在系统配置)

把服务器上装sonar-scanner的目录配上:/opt/sonar/sonar-scanner-4.0.0.1744-linux

使用sonar-scanner插件扫描job

创建一个自由风格的项目:配置构建,选sonar scanner插件


其中sonar.projectKey对应工程pom文件里的tool

sonar.projectName是sonar里显示的名称,改为了tool-for-show,下面sonar里显示的就变了。

pipeline job中加sonar

创建一个pipeline job:

脚本:

pipeline1

pipeline{

   agent any

   // tools{

   //     maven 'maven-3.6.0'

   // }

   stages{

       stage('Build'){

           steps{

               checkout([$class: 'GitSCM',branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false,extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: '22fb3725-0e8c-4619-94d8-2b05a0af0369',url: 'https://github.com/hehetc/meeting-server.git']]])

               sh ' mvn clean install'

           }

       }

       stage('SonarCheck'){

           steps{

                sh ' mvnorg.codehaus.mojo:sonar-maven-plugin:3.6.0.1398:sonar-DprojectName="project-name" -U '

           }

       }

}


credentialsId: 填入的是jenkins 系统配置里的github的credentialID

pipeline2:

pipeline{

   agent any

   // tools{

   //     maven 'maven-3.6.0'

   // }

   stages{

       stage('Build'){

           steps{

               checkout([$class: 'GitSCM',branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false,extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId:'22fb3725-0e8c-4619-94d8-2b05a0af0369', url:'https://github.com/hehetc/meeting-server.git']]])

               sh ' mvn clean compile'

           }

       }

       stage('SonarCheck'){

           steps{

                echo "starting codeAnalyzewith SonarQube......"

                withSonarQubeEnv('sonarqube7.1'){

                    sh "mvnsonar:sonar"

                }

           }           


       }

}


withSonarQubeEvn里面填的是jenkins系统配置里sonar服务器名称,主要用于有多个sonar服务器时指定一个。


看日志每一步做了什么:

maven clean compile:

Building tool 0.0.1-SNAPSHOT

[INFO] Deleting/var/lib/jenkins/workspace/pipeline-sonar/target

[INFO] Compiling 8 source files to/var/lib/jenkins/workspace/pipeline-sonar/target/classes


mvn sonar:sonar


sonar-maven-plugin:3.6.0.1398:sonar

[INFO] Base dir: /var/lib/jenkins/workspace/pipeline-sonar[INFO] Working dir: /var/lib/jenkins/workspace/pipeline-sonar/target/sonar


pipeline3——加入质量门:

pipeline{

   agent any

   // tools{

   //     maven 'maven-3.6.0'

   // }

   stages{

       stage('Build'){

           steps{

               checkout([$class: 'GitSCM',branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false,extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId:'22fb3725-0e8c-4619-94d8-2b05a0af0369', url: 'https://github.com/hehetc/meeting-server.git']]])

               sh ' mvn clean compile'

           }

       }

       stage('SonarCheck'){

           steps{

                echo "starting codeAnalyzewith SonarQube......"

               withSonarQubeEnv('sonarqube7.1'){

                    sh "mvnsonar:sonar"

                }

                script {

                timeout(10) {

                    //利用sonar

webhook功能通知pipeline代码检测结果,未通过质量阈,pipeline将会fail

                    def qg =waitForQualityGate()

                       if (qg.status != 'OK'){

                            error "未通过Sonarqube的代码质量阈检查,请及时修改!failure: ${qg.status}"

                        }

                    }

                }

           }



       }

    }

}


目前还没有配置质量门,所以是通过了的。

在sonar中加入质量门:

此时再运行,报错质量门未通过:

修改质量门为警告不通过,但还没达到error,则日志里failure:qg.status显示为warn。

*47.93.250.185服务器上的jenkins

home:/var/lib/Jenkins

进入home:

job存放位置:/var/lib/jenkins/jobs

每个job一个config.xml对应job的配置

每个job下一个builds文件夹存放构建历史。

builds下,每次构建一个文件夹:

每此构建下有构建结果

build.xml changelog.xml  log

构建的工程存放位置:

/var/lib/jenkins/workspace

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

推荐阅读更多精彩内容