Jenkins集成SonarQube代码质量检测_jenkins集成sonar代码检查

上一篇文章> Jenkins发布Kubernetes(K8s)集群(基于containerd)

一、SonarQube简介

---

1、简介

SonarQube是管理代码质量一个开放平台，可以快速的定位代码中潜在的或者明显的错误

2、下载

https://www.sonarsource.com/products/sonarqube/downloads/

二、实验环境

---

1、k8s环境

版本v1.26.5，容器为containerd
二进制安装Kubernetes(K8s)集群(基于containerd)—从零安装教程（带证书）

2、jenkins环境

jenkins入门与安装
容器为docker

三、SonarQube安装

---

1、下载镜像

[root@jenkins ~]# docker pull postgres
[root@jenkins ~]# docker pull sonarqube:9.9.2-community
1
2

2、启动

[root@jenkins ~]# mkdir sonarqube
[root@jenkins ~]# cd sonarqube
[root@jenkins sonarqube]# cat docker-compose.yaml
version: "3.1"
services:
  postgres:
    image: postgres
    container_name: postgres
    restart: always
    ports:
      - 5432:5432
    networks:
      - sonarnet
    environment:
      TZ: Asia/Shanghai
      POSTGRES_USER: sonar
      POSTGRES_PASSWORD: sonar
      POSTGRES_DB: sonar
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ./postgres/data:/var/lib/postgresql/data
  sonarqube:
    image: sonarqube:9.9.2-community
    privileged: true
    restart: always
    container_name: sonarqube
    environment:
      TZ: Asia/Shanghai
      SONAR_JDBC_URL: jdbc:postgresql://postgres:5432/sonar
      SONAR_JDBC_USERNAME: sonar
      SONAR_JDBC_PASSWORD: sonar
    depends_on:
      - postgres
    ports:
      - "9000:9000"
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ./sonarqube/extensions:/opt/sonarqube/extensions
      - ./sonarqube/logs:/opt/sonarqube/logs
      - ./sonarqube/data:/opt/sonarqube/data
      - ./sonarqube/conf:/opt/sonarqube/conf
    networks:
      - sonarnet
networks:
  sonarnet:
    driver: bridge

[root@jenkins sonarqube]# mkdir -p postgres/data sonarqube/{conf,data,extensions,logs}
[root@jenkins sonarqube]# chmod -R 777 sonarqube
[root@jenkins sonarqube]# docker-compose up -d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

3、报错处理

（1）权限报错

添加privileged: true即可

[root@jenkins sonarqube]# docker logs -f sonarqube
[0.056s][warning][os,thread] Failed to start thread "VM Thread" - pthread_create failed (EPERM) for attributes: stacksize: 1024k, guardsize: 4k, detached.
Error occurred during initialization of VM
1
2
3

（2）vm.max_map_count报错

如果报错此导致容器无法启动成功

ERROR: [1] bootstrap checks failed. You must address the points described in the following [1] lines before starting Elasticsearch.
bootstrap check failure [1] of [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]
ERROR: Elasticsearch did not exit normally - check the logs at /opt/sonarqube/logs/sonarqube.log
1
2
3

宿主机中添加：

[root@jenkins sonarqube]# cat /etc/sysctl.conf
vm.max_map_count = 262144

[root@jenkins sonarqube]# sysctl -p
1
2
3
4

4、浏览器访问

http://10.10.10.10:9000/
默认账号密码：admin/admin

5、配置中文字体

（1）下载字体


（2）重启sonarqube

[root@jenkins sonarqube]# docker restart sonarqube
1

（3）重新登录查看

四、sonarqube测试代码

---

1、Maven（方式一）

（1）配置setting

[root@jenkins ~]# vim /usr/local/maven/conf/settings.xml
    <profile>
        <id>sonar</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <sonar.login>admin</sonar.login>
            <sonar.password>1</sonar.password>
            <sonar.host.url>http://10.10.10.10:9000</sonar.host.url>
        </properties>
    </profile>
1
2
3
4
5
6
7
8
9
10
11
12

（2）测试

这里是有个之前的项目，进入自己对应的项目中即可

[root@jenkins ~]# docker exec -it jenkins /bin/bash
root@67460f5b7c78:/# cd /var/jenkins_home/workspace/java-k8s
root@67460f5b7c78:/var/jenkins_home/workspace/java-k8s# ls
Dockerfile  Jenkinsfile  LICENSE  README.md  db  pipeline.yaml  pom.xml  src  target
root@67460f5b7c78:/var/jenkins_home/workspace/java-k8s# /usr/local/maven/bin/mvn sonar:sonar
1
2
3
4
5

（3）查看结果

2、sonar-scanner（方式二）

（1）生成token

（2）下载文件

下载地址：https://docs.sonarqube.org/latest/analyzing-source-code/scanners/sonarscanner/

[root@jenkins ~]# unzip sonar-scanner-cli-4.8.0.2856-linux.zip
[root@jenkins ~]# mv sonar-scanner-4.8.0.2856-linux /usr/local/sonar-scanner
1
2

（3）重启jenkins

[root@jenkins ~]# docker stop jenkins
[root@jenkins ~]# docker rm jenkins
[root@jenkins ~]# docker run -d --name jenkins -p 8080:8080 -p 50000:50000 -u root \
-v /opt/jenkins_home:/var/jenkins_home \
-v /usr/local/maven:/usr/local/maven \
-v /usr/local/jdk:/usr/local/jdk \
-v /etc/localtime:/etc/localtime \
-v /usr/bin/docker:/usr/bin/docker \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /usr/local/sonar-scanner:/usr/local/sonar-scanner \
--restart=always \
jenkins/jenkins:lts
1
2
3
4
5
6
7
8
9
10
11
12

（4）配置sonar-scanner.properties

[root@jenkins ~]# cat /usr/local/sonar-scanner/conf/sonar-scanner.properties
#Configure here general information about the environment, such as SonarQube server connection details for example
#No information about specific project should appear here

#----- Default SonarQube server
sonar.host.url=http://10.10.10.10:9000

#----- Default source code encoding
sonar.sourceEncoding=UTF-8
1
2
3
4
5
6
7
8
9

（5）测试

[root@jenkins ~]# cd /opt/jenkins_home/workspace/java-k8s
[root@jenkins java-k8s]# ls
db  Dockerfile  Jenkinsfile  LICENSE  pipeline.yaml  pom.xml  README.md  src  target
[root@jenkins java-k8s]# /usr/local/sonar-scanner/bin/sonar-scanner -Dsonar.source=./ -Dsonar.projectname=java-k8s -Dsonar.login=sqa_596d6ea2c88ab661eb56afcf72bfb48ef80bd8f2 -Dsonar.projectKey=java-k8s -D sonar.java.binaries=./target/
1
2
3
4

五、Jenkins安装sonar-scanner

---

1、下载sonar-scanner和Quality Gates

然后重启jenkins

2、配置sonar-scanner

（1）系统配置

系统管理–>系统配置

由于卡顿点不了，重新再次进入然后配置token

（2）全局工具配置

系统管理–>全局工具配置

（3）Sonar配置Webhook

配置 --> webhook -->创建

3、创建项目测试

（1）创建项目

（2）git配置

（3）sonarqube配置

JAVA_HOME=/usr/local/jdk
PATH=$PATH:$JAVA_HOME/bin
/usr/local/maven/bin/mvn clean package -Dmaven.test.skip=true
1
2
3

sonar.source=./
sonar.projectname=${JOB_NAME}
sonar.projectKey=${JOB_NAME}
sonar.java.binaries=./target/
1
2
3
4

（4）查看结果

六、通过流水线测试

---

1、创建流水线项目

2、查看文件

Dockerfile：

FROM harbor.wielun.com/library/tomcat:8.5.59
MAINTAINER Wielun
RUN rm -rf /usr/local/tomcat/webapps/*
ADD target/*.war /usr/local/tomcat/webapps/ROOT.war
1
2
3
4

pipeline.yaml：

apiVersion: apps/v1
kind: Deployment
metadata:
  namespace: test
  name: pipeline
  labels:
    app: pipeline
spec:
  replicas: 2
  selector:
    matchLabels:
      app: pipeline
  template:
    metadata:
      labels:
        app: pipeline
    spec:
      containers:
      - name: pipeline
        image: harbor.wielun.com/library/java-k8s:latest
        imagePullPolicy: Always
        ports:
        - containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  namespace: test
  name: pipeline
  labels:
    app: pipeline
spec:
  ports:
  - port: 8081
    targetPort: 8080
  selector:
    app: pipeline
  type: NodePort
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  namespace: test
  name: pipeline
spec:
  ingressClassName: nginx
  rules:
  - host: "harbor.wielun.com"
    http:
      paths:
      - pathType: Prefix
        path: /
        backend:
          service:
            name: pipeline
            port:
              number: 8081
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

3、修改Jenkinsfile

pipeline {
    agent any
	environment {
		harborUser = 'admin'
		harborPasswd = 'Harbor12345'
		HarborAddress = 'harbor.wielun.com'
		harborRepo = 'library'
		sonarLogin = 'sqa_596d6ea2c88ab661eb56afcf72bfb48ef80bd8f2'
	}
    stages {
        stage('git拉取代码') {
            steps {
				git credentialsId: '0c71c0f9-8277-xxxx-bb31-540a9324cf08', url: 'https://jihulab.com/xxxx/java-demo.git'
            }
        }
        stage('maven编译') { 
           steps {
                    sh '''JAVA_HOME=/usr/local/jdk
                    PATH=$PATH:$JAVA_HOME/bin
                    /usr/local/maven/bin/mvn clean package -Dmaven.test.skip=true'''
                }
        }
        stage('通过SonarQube完成代码质量检测') { 
           steps {
                    // sonarqube：系统配置SonarQube installations的Name
           			withSonarQubeEnv("sonarqube") {
           				sh "/usr/local/sonar-scanner/bin/sonar-scanner -Dsonar.source=./ -Dsonar.projectname=${JOB_NAME} -Dsonar.projectKey=${JOB_NAME} -Dsonar.java.binaries=./target/ -Dsonar.login=${sonarLogin}"
           			}
                    // 代码检测失败,将不再继续执行后面的任务,直接退出,报告返回的超时时长设为5分钟
                    timeout(time: 5,unit: 'MINUTES') {
                        waitForQualityGate abortPipeline: true
                    }
                }
        }
        stage('生成自定义镜像') { 
           steps {
                    sh '''docker build -t ${JOB_NAME}:latest .'''
                }
        }
        stage('上传自定义镜像到harbor') { 
           steps {
                    sh '''docker login -u ${harborUser} -p ${harborPasswd} ${HarborAddress}
                    docker tag ${JOB_NAME}:latest ${HarborAddress}/${harborRepo}/${JOB_NAME}:latest
                    docker push ${HarborAddress}/${harborRepo}/${JOB_NAME}:latest'''
                }
        }
        stage('发送yaml到k8s-master并部署') { 
           steps {
					sshPublisher(publishers: [sshPublisherDesc(configName: 'k8s-master', transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: '''
					/usr/local/bin/kubectl apply -f /tmp/${JOB_NAME}/pipeline.yaml''', execTimeout: 120000, flatten: false, makeEmptyDirs: false, noDefaultExcludes: false, patternSeparator: '[, ]+', remoteDirectory: '${JOB_NAME}', remoteDirectorySDF: false, removePrefix: '', sourceFiles: 'pipeline.yaml')], usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
                }
        } 
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

4、查看结果

下一篇文章> Jenkins通过OpenSSH发布WinServer2016