【DevOps】第五章 SonarQube与jenkins集成和优化（二）

已于 2022-06-05 17:09:51 修改
阅读量826 收藏 1
点赞数 2
分类专栏： DevOps 文章标签： jenkins devops ci
于 2022-06-05 16:45:37 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44802620/article/details/125133724
版权

文章目录

一、添加流水线步骤实现代码自动扫描

1、在共享库中创建sonarqube.groovy文件

1.1 生成流水线语法

通过创建时间戳，添加项目标签，后边项目即可看到效果。
在这里插入图片描述

1.2 在gitlab共享库中创建sonarqube.groovy文件

在这里插入图片描述

  • 文件内容
package org.devops


//scan
def SonarScan(projectName,projectDesc,projectPath){
    def scannerHome = "/usr/local/sonar-scanner/"
    def sonarServer = "http://192.168.223.92:9000"
    def sonarDate = sh  returnStdout: true, script: 'date  +%Y%m%d%H%M%S'
    sonarDate = sonarDate - "\n"

    sh """ 
        ${scannerHome}/bin/sonar-scanner -Dsonar.host.url=${sonarServer} \
        -Dsonar.projectKey=${projectName} \
        -Dsonar.projectName=${projectName} \
        -Dsonar.projectVersion=${sonarDate} \
        -Dsonar.login=admin \
        -Dsonar.password=yanglt123. \
        -Dsonar.ws.timeout=30 \
        -Dsonar.projectDescription=${projectDesc} \
        -Dsonar.links.homepage=http://www.baidu.com \
        -Dsonar.sources=${projectPath} \
        -Dsonar.sourceEncoding=UTF-8 \
        -Dsonar.java.binaries=target/classes \
        -Dsonar.java.test.binaries=target/test-classes \
        -Dsonar.java.surefire.report=target/surefire-reports
    """
}

**文件内容说明: **
def scannerHome = “/usr/local/sonar-scanner/” #定义扫描器的安装目录变量
def sonarServer = “http://192.168.223.92:9000” #定义sonarqubede 的web地址变量
sonar.projectKey= #sonar平台中相对应项目的key
key sonar.projectName= #sonar平台中相对应项目的名字

2、修改jenkinsfile

在jenkinsfile加载共享库，并进行类的实例化。

#!groovy
@Library('jenkinslib@master')_

//func from sharelibrary
....
def sonar = new org.devops.sonarqube()

#在pipeline中添加stage步骤：
        stage ("QA"){
            steps {
                script{
                    tools.PrintMes("代码扫描","green")
                    sonar.SonarScan("$JOB_NAME","$JOB_NAME","src")
                }
            }
        }
  • 完整jenkins文件如下：
#!groovy
@Library('jenkinslib@master')_

//func from sharelibrary
def build = new org.devops.build()
def deploy = new org.devops.deploy()
def tools = new org.devops.tools()
def gitlab = new org.devops.gitlab()
def toemail = new org.devops.toemail()
def sonar = new org.devops.sonarqube()

//env
String buildType = "${env.buildType}"
String buildShell = "${env.buildShell}"
String deployHosts = "${env.deployHosts}"

String srcUrl = "${env.srcUrl}"
String branchName = "${env.branchName}"


if("${runOpts}" == "GitlabPush"){
    branchName = branch - "refs/heads/"
    currentBuild.description = "Trigger by ${userName} ${branch}"
    gitlab.ChangeCommitStatus(projectId,commitSha,"running")
}

//pipeline
pipeline{
    //agent { node{label 'master'}}
    agent any

    stages {
        stage("CheckOut"){
            steps{
                script{
                    println("${branchName}")

                    tools.PrintMes("获取代码","green")
                    checkout([$class: 'GitSCM', branches: [[name: '${branchName}']], extensions: [], userRemoteConfigs: [[credentialsId: '112fd041-4195-49e6-aeb6-004f40dcd437', url: '${srcUrl}']]])
                }
            }
        }
        stage ("build"){
            steps{
                script{
                    tools.PrintMes("执行打包","green")
                    build.Build(buildType,buildShell)
                    //deploy.SaltDeploy("${deployHosts}", "test.ping") 
                    //deploy.AnsibleDeploy("$deployHosts", "-m ping")
                }
            }
        }
        stage ("QA"){
            steps {
                script{
                    tools.PrintMes("代码扫描","green")
                    sonar.SonarScan("$JOB_NAME","$JOB_NAME","src")
                }
            }
        }
    }
    post {
        //(1)不管失败与否，都执行
        always{
            script{
                tools.PrintMes("总是执行","green")
            }
        }
    
        success{
            script{
                tools.PrintMes("sucess","green")
                gitlab.ChangeCommitStatus(projectId,commitSha,"success")  
                //参数：构建状态-给谁发信息
                toemail.Email("流水线成功了！",userEmail)      
            }
        }
        failure{
            script{
                tools.PrintMes("failure","red")
                gitlab.ChangeCommitStatus(projectId,commitSha,"failed")
                toemail.Email("流水线失败了！",userEmail)     
            }
        }
    
        aborted{
            script{
                println("aborted")
                gitlab.ChangeCommitStatus(projectId,commitSha,"canceled")
                toemail.Email("流水线被取消了！",userEmail)     
            }
        }
    }  
}

3、提交项目触发流水线

修改项目文件README.md，提交触发流线。

在这里插入图片描述
在这里插入图片描述

4、扫描结果展示

在这里插入图片描述
在这里插入图片描述
再次提交代码
在这里插入图片描述

查看代码扫描记录（文章开头配置的时间戳项目标签）
在这里插入图片描述

二、使用sonar插件完成代码扫描

1、在jenkins中安装SonarQube Scanner插件

插件名称：SonarQube Scanner

在这里插入图片描述

2、配置SonarQbue服务器

2.1 登录sonarqube的web端获取令牌
在这里插入图片描述


点击->生成->生成如下令牌
在这里插入图片描述

2.2 登录jenkins使用sonarqube中获取的token创建凭据

在这里插入图片描述

3、 在jenkins中配置SonarQube服务器

jenkins配置–>系统配置–>SonarQube servers

在这里插入图片描述

4、修改流水线

官网文档：https://docs.sonarqube.org/8.9/analysis/scan/sonarscanner-for-jenkins/

使用Jenkins管道，提供了一个withSonarQubeEnv块，允许你选择要与之交互的 SonarQube 服务器。在 Jenkins 全局配置中配置的连接详细信息将自动传递给扫描仪。

修改共享库文件：sonarqube.groov

withSonarQubeEnv("${sonarqube-test}"){
}

#使用个该参数，就不用管在pipline中指定用户名密码了

package org.devops


//scan
def SonarScan(projectName,projectDesc,projectPath){
    withSonarQubeEnv("sonarqube-test"){
        def scannerHome = "/usr/local/sonar-scanner/"
        def sonarDate = sh  returnStdout: true, script: 'date  +%Y%m%d%H%M%S'
        sonarDate = sonarDate - "\n"

        sh """ 
            ${scannerHome}/bin/sonar-scanner -Dsonar.projectKey=${projectName} \
            -Dsonar.projectName=${projectName} \
            -Dsonar.projectVersion=${sonarDate} \
            -Dsonar.ws.timeout=30 \
            -Dsonar.projectDescription=${projectDesc} \
            -Dsonar.links.homepage=http://www.baidu.com \
            -Dsonar.sources=${projectPath} \
            -Dsonar.sourceEncoding=UTF-8 \
            -Dsonar.java.binaries=target/classes \
            -Dsonar.java.test.binaries=target/test-classes \
            -Dsonar.java.surefire.report=target/surefire-reports
        """
    }
}

5、使用jenkins插件的效果：

如图会多出一个sonar图标

在这里插入图片描述
点击图标：

在这里插入图片描述

6、支持多sonar服务方式

package org.devops


//scan
def SonarScan(sonarServer,projectName,projectDesc,projectPath){

    //定义服务器列表
    def servers = ["test":"sonarqube-test","prod":"sonarqube-prod"]
    
    withSonarQubeEnv("sonarqube-test"){
        def scannerHome = "/usr/local/sonar-scanner/"
        def sonarDate = sh  returnStdout: true, script: 'date  +%Y%m%d%H%M%S'
        sonarDate = sonarDate - "\n"

        sh """ 
            ${scannerHome}/bin/sonar-scanner -Dsonar.projectKey=${projectName} \
            -Dsonar.projectName=${projectName} \
            -Dsonar.projectVersion=${sonarDate} \
            -Dsonar.ws.timeout=30 \
            -Dsonar.projectDescription=${projectDesc} \
            -Dsonar.links.homepage=http://www.baidu.com \
            -Dsonar.sources=${projectPath} \
            -Dsonar.sourceEncoding=UTF-8 \
            -Dsonar.java.binaries=target/classes \
            -Dsonar.java.test.binaries=target/test-classes \
            -Dsonar.java.surefire.report=target/surefire-reports
        """
    }
}

添加sonarServer参数，
//定义服务器列表
def servers = [“test”:“sonarqube-test”,“prod”:“sonarqube-prod”]

在这里插入图片描述

修改pipline的ci.jenkinsfile文件，传递test参数

#!groovy
@Library('jenkinslib@master')_

//func from sharelibrary
def build = new org.devops.build()
def deploy = new org.devops.deploy()
def tools = new org.devops.tools()
def gitlab = new org.devops.gitlab()
def toemail = new org.devops.toemail()
def sonar = new org.devops.sonarqube()

//env
String buildType = "${env.buildType}"
String buildShell = "${env.buildShell}"
String deployHosts = "${env.deployHosts}"

String srcUrl = "${env.srcUrl}"
String branchName = "${env.branchName}"


if("${runOpts}" == "GitlabPush"){
    branchName = branch - "refs/heads/"
    currentBuild.description = "Trigger by ${userName} ${branch}"
    gitlab.ChangeCommitStatus(projectId,commitSha,"running")
}

//pipeline
pipeline{
    //agent { node{label 'master'}}
    agent any

    stages {
        stage("CheckOut"){
            steps{
                script{
                    println("${branchName}")

                    tools.PrintMes("获取代码","green")
                    checkout([$class: 'GitSCM', branches: [[name: '${branchName}']], extensions: [], userRemoteConfigs: [[credentialsId: '112fd041-4195-49e6-aeb6-004f40dcd437', url: '${srcUrl}']]])
                }
            }
        }
        stage ("build"){
            steps{
                script{
                    tools.PrintMes("执行打包","green")
                    build.Build(buildType,buildShell)
                    //deploy.SaltDeploy("${deployHosts}", "test.ping") 
                    //deploy.AnsibleDeploy("$deployHosts", "-m ping")
                }
            }
        }
        stage ("QA"){
            steps {
                script{
                    tools.PrintMes("代码扫描","green")
                    sonar.SonarScan("test","$JOB_NAME","$JOB_NAME","src")
                }
            }
        }
    }
    post {
        //(1)不管失败与否，都执行
        always{
            script{
                tools.PrintMes("总是执行","green")
            }
        }
    
        success{
            script{
                tools.PrintMes("sucess","green")
                gitlab.ChangeCommitStatus(projectId,commitSha,"success")  
                //参数：构建状态-给谁发信息
                toemail.Email("流水线成功了！",userEmail)      
            }
        }
        failure{
            script{
                tools.PrintMes("failure","red")
                gitlab.ChangeCommitStatus(projectId,commitSha,"failed")
                toemail.Email("流水线失败了！",userEmail)     
            }
        }
    
        aborted{
            script{
                println("aborted")
                gitlab.ChangeCommitStatus(projectId,commitSha,"canceled")
                toemail.Email("流水线被取消了！",userEmail)     
            }
        }
    }  
}

在这里插入图片描述
再次修改项目提交：
在这里插入图片描述

查看jenkins效果
在这里插入图片描述

另一种方法：可以根据项目名称选择不同的环境

旅行者-Ylt
关注
专栏目录
K8s+Jenkins+GitLab+Harbor+CICD+SonarQube持续集成、持续部署实战
作者的博客园已搬家到CSDN，访问博客园主页将默认跳转至CSDN
05-20 1315
通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`docker`方式用`docker`命令部署到服务器。 ### Pipeline部署到K8s 通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`k8s`的`yaml`配置清单方式，用`kubectl`命令部
【SpringCloud微服务实战10】DevOps自动化部署微服务项目(Jenkins+Docker+K8s)
李维山的博客
03-28 1403
DevOps 是一种重视软件开发人员（Developer）和运维人员（Operations）之间沟通与协作的文化、运动或实践，目标在于快速交付高质量的软件产品和服务。DevOps 强调自动化流程、持续集成与交付（CI/CD）、以及通过工具链、敏捷方法论和跨职能团队协作来增强软件的可靠性和安全性。在 DevOps 中，开发、测试、部署和监控等多个环节紧密连接，形成一个高效的工作流。
Jenkins SonarQube CI 流水线集成 命令行方式优化
小楼一夜听春雨，深巷明朝卖杏花
09-03 612
本次集成重点演示两种方式： 1. 使用命令行方式 2. 使用Jenkins扩展插件的方式。 命令行方式 流水线中添加代码扫描阶段， 然后在script标签中定义一段脚本。 （其实这段脚本就是我们手动在服务器上面执行的sonar-scanner的命令和参数组成的）【可以先运行该段代码确保扫描成功，然后进一步优化】 stage("SonarScan"){ steps{ script{ sh """ .
Jenkins流水线集成Sonarqube
最新发布
cnzzs的博客
08-11 503
1 环境准备1.1 安装sonarqube/app/module/sonarqube1.2 安装sonar-scanner/app/module/sonar-scanner1.3 安装SonarQube Scanner插件略1.4 Jenkins配置sonar凭据1.5 Jenkins配置Sonarqube服务地址1.6 ...
Jenkins集成sonarQube
皮肤
03-10 1049
sonarqube是一款自动化代码审查工具，用于检测代码中的错误、漏洞和代码异味。它可以与你现有的工作流集成，以支持跨项目分支和拉取请求的连续代码检查。其工作流程如下：如图如图sonarqube由以下4个组件组成：webserver：供开发人员，管理人员浏览高质量的快照并配置sonarqube实例searchserver：基于elasticsearch的searchserver从ui进行后退搜索(历史)computeengine：负责处理代码分析报告并将其保存在sonarqube数据库中。
Jenkins集成SonarQube
wuxingge的博客
05-30 504
安装SonarQube 安装MySQL https://blog.csdn.net/wuxingge/article/details/100774308
【微服务部署】六、使用Jenkins+SonarQube进行代码质量检查配置步骤详解
全栈程序猿的专栏
09-05 1664
如果安装时出现错误，一般是安装的插件和当前SonarQube版本不兼容，此时需要到插件官网下载SonarQube对应版本的插件放到，我们的目录下/data/docker/ci/sonarqube/extensions/downloads，然后通过 配置>系统>重启服务器，即可使插件生效。
【DevOps实战|基于Jenkins与Gitlab构建企业级持续集成环境系统】（Jenkins+Gitlab+Keepalived+Haproxy+Sonarqube+Http+灰度自动部署）
wei的博客
01-17 2421
（Jenkins+Gitlab+Keepalived+Haproxy+Sonarqube+Http+灰度自动部署）详细完整+手机电脑浏览器访问你的外网linux的web服务器+花生壳配置linux实现内网穿透+解决the change you requested was rejected.gitlab版本回滚，递归回滚，跨版本回滚解决configure: error: !!! OpenSSL is not properly installed on your system. !!!
DevOps ：Jenkins pipeline + sonarQube 完成静态检测 + junit 覆盖率报告。
qq_16681279的博客
03-18 8406
项目基础： 1，maven3.3.9 + java 1.8 2，jenkins 2.138.2 3，sonarQube6.7.5 + 汉化 前言：jenkins maven java1.8 环境安装过程不在描述，我们采用jenkins pipeline 来实现标题的功能，希望小编踩过的坑对后来人能够提供帮助~good luck. 参考博文： SonarQube 的安装...
Jenkins与SonarQube集成实现代码质量检测
# 1. 介绍Jenkins和SonarQube ## 1.1 什么是Jenkins? Jenkins是一个用于自动化构建、测试和部署软件项目的开源持续集成工具。它通过提供可扩展的插件...集成Jenkins和SonarQube可以实现代码质量检测的自动化，并将检测
jenkinsfile sonarqube步骤，sonarqube task status is in_progress是什么状态，但是sonarqube客户端已经显示已经成功了，为什么jenkins
weixin_46453070的博客
08-26 276
如果SonarQube客户端已经显示为"已成功"，但是Jenkins仍然显示为"in_progress"状态，可能是由于Jenkins与SonarQube服务器之间的通信延迟或者同步问题导致的。当SonarQube服务器完成分析后，状态会更新为"success"或者"failed"。jenkinsfile sonarqube步骤，sonarqube task status is in_progress是什么状态，但是sonarqube客户端已经显示已经成功了，为什么jenkins一直是这个状态。
idea解决程序包不存在报错
热门推荐
过于丰富，无法简介
10-22 6万+
报错效果 楼主发生报错的情况很奇怪，实在SVN上把代码down下来之后导入SVN报的错，理论上代码同事和自己公司电脑都能跑，在自己电脑上跑不了，所以坚信认为是idea的配置问题，但找了好久都没办法弄好，最后在快要绝望的时候弄好了，太意外了。楼主报错的时候idea的Maven仓库地址以及自动导入环境配置好了，但依旧报错，在此集百家之长，总结一下 解决方式（楼主使用的最后一种方式解决的） 1、修改Maven的setting.xml文件配置 设置方式：File—>Setting—>Build
Jenkins 集成 SonarQube（五）
qq_34125999的博客
08-30 1790
1 安装插件 2 配置 生成sonarqube令牌： 73f631bb0e020919b1a42a0c4d60ee7e60ecf51c 创建凭证： 配置sonarqube： 3 sonar-project.properties配置文件 #SonarQube 实例名称，唯一 sonar.projectKey=springboot-web #项目名称 sonar.projectName=springboot-web #版本号 sonar.projectVersion=1.0 #指定扫描目
如何使用SonarQube来优化你的代码
lovely_yoshino的博客
01-18 7678
0. 简介 最近一直苦于自己写的代码的开发的质量不高，急需要一种可以适用于C++代码的代码质量检测工具，这里发现SonarQube可以很好的适用于Ubuntu环境，并能够很好的与Gitlab兼容，从而保证代码的敏捷式开发。 1. SonarQube安装 ubuntu中安装jdk 详细过程可参考：https://blog.csdn.net/qq_26709459/article/details/80466239 ubuntu中安装mysql 详细过程可参考：https://blog.csdn.net/
sonarqube-jenkins-config
weixin_30819085的博客
07-23 433
Sonar Config .Jenkinsfile config stage('SonarQube analysis') { steps { script { scannerHome = tool 'SonarScanner4'; } withSonarQubeEnv('SonarQube') { ...
Jenkins骚操作第七章sonarqube代码审查
HYMajor的博客
02-18 1512
文章目录一、sonarqube简介二、安装MYSQL 一、sonarqube简介 SonarQube是一个用于管理代码质量的开放平台，可以快速的定位代码中潜在的或者明显的错误。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十几种编程语言的代码质量管理与检 测，底层使用elasticsearch作为代码检索工具 官网：https://www.sonarqube.org/ | 软件 服务器 版本 jdk 192.168.1
Jenkins+SonarQube代码审查 (2) 实现代码审查
weixin_44449869的博客
04-26 339
Jenkins+SonarQube代码审查 实现代码审查
Jenkins+sonarqube实现代码自动扫描
weixin_43557605的博客
05-10 2481
1. 整体流程 上传代码到git仓库—>触发Jenkins构建代码—>编译、打包、测试—>代码扫描—>发布 2. sonarqube的配置 1）设置账户强制登陆 设置之后访问首页不再直接出现首页，登录后才可以看到首页 未设置之前如下图： 设置完成后，登陆9000端口，页面如下 2）项目的私有性 3）权限管理 先创建用户 创建群组： 向组内加入成员t...
使用gitlab+harbor+sonarqube+jenkins+maven实践DevOps自动化流程
"本文将介绍如何使用gitlab、harbor、sonarqube、jenkins和maven构建一套完整的DevOps解决方案，实现自动化开发、测试和部署流程。" 在DevOps实践中，目标是打破传统的开发、测试和运维之间的壁垒，通过自动化工具...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

旅行者-Ylt

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值