手机版
你好,游客 登录 注册 搜索
背景:
阅读新闻

在Jenkins中使用sonar进行静态代码检查

[日期:2018-05-25] 来源:Linux社区  作者:calvinK [字体: ]

要解决的问题

Jenkins自动构建完成后,希望能通过sonar静态代码检查生成一份报告,给与开发人员对当前代码的做一个质量评估和修改意见。

1.安装并配置sonar服务器

懒得说,跟着官方文档走就行,这边主要的开发语言是.net core 和 typescript,所以在sonar server中的应用市场搜索对应语言安装就完事
安装参考地址:https://docs.sonarqube.org/display/SONAR/Setup+and+Upgrade

2.jenkins机器下载sonar扫描器

.net core 扫描器:https://docs.sonarqube.org/display/SCAN/Scanning+on+Linux+or+macOS+with+Scanner+4.0.x
typescript 扫描器:https://docs.sonarqube.org/display/PLUG/SonarTS

路径地址替换自己的
.net core :/opt/sonar-scanner-netcore/sonar-scanner-3.1.0.1141/conf
默认扫描器:/opt/sonar-scanner/conf
该路径下有配置文件:sonar-scanner.properties
修改该配置文件中的sonar.host.url=http://192.168.1.133:9000 为自己的sonar server服务器地址。

3.创建jenkins构建任务

选择创建流水线任务,也就是pipeline。因为我们有一个自动化流程管理工具,所以job的触发构建动作是在自动化工具中实现的。这里只是怎么调用sonar-scanner。
自动化流程工具传递参数(需要扫描的站点名称,类型),进入jenkins的sonar扫描任务,
脚本做这么几个事情:
1.根据传入的站点名称,获取当前站点名称在jenkins的配置,然后从配置文件中获取源代码地址,
2.拉取源代码
3.sonar-scanner。
jenkins 内部对象api文档地址:http://javadoc.jenkins-ci.org/allclasses-noframe.html
jenkins pipeline参考地址:https://jenkins.io/doc/book/pipeline/syntax/
pipeline script脚本如下:

//@NonCPS 标记当前方法的返回值不需要序列话,因为 def job,这里的job对象不能被序列化。
@NonCPS
def getUrl(){
    def job=jenkins.model.Jenkins.getInstanceOrNull().getItem("${site_name}");
    if(job==null){
        throw new hudson.AbortException("not found jenkins job ${site_name}")
    }
    def jobScmUrl=job.getScm().getUserRemoteConfigs().get(0).getUrl();
//获得站点的git源代码地址
    return jobScmUrl;
}
node { 
//typescript扫描器需要运行tsc命令,但是我们的项目是全局安装的typescript,所以这里要指定NODE_PATH
    environment {
        NODE_PATH = '/usr/local/node/lib/node_modules';
    }
    stage('checkout') {
        deleteDir();//删除当前构建的workspace
        def scmUrl=getUrl();
    // git 拉取代码到workspace,指定分支为master,并指定git使用的SSH证书id(3e6da11b-9f1d-42e2-8cb0-e8616ec0709e)
        def scmOut=checkout([
            $class: 'GitSCM',
            branches: [[name: 'master']],
            doGenerateSubmoduleConfigurations: false,
            extensions: [],
            submoduleCfg: [],
            userRemoteConfigs: [[
                credentialsId: '3e6da11b-9f1d-42e2-8cb0-e8616ec0709e',
                url: scmUrl]]]);
    }
    if("${language}" == "netcore"){
        //如果是.net core 类型的站点
        stage('sonar-begin') {
            sh script: "dotnet /opt/sonar-scanner-netcore/SonarScanner.MSBuild.dll begin /k:\"${site_name}\" /d:sonar.exclusions=/**/*.js"
        }
        stage('sonar-build') {
            sh script: 'dotnet build';
        }
        stage('sonar-end') {
            sh script: 'dotnet /opt/sonar-scanner-netcore/SonarScanner.MSBuild.dll end';
        }
    } else if("${language}" == "nodejs"){
        stage('sonar-scanner') {
            sh script: 'echo "------------$NODE_PATH"'
            sh script: "sh /opt/sonar-scanner/bin/sonar-scanner  -Dsonar.projectKey=${site_name} -Dsonar.sources=."
        }
    }
    else{
        echo 'not support language ${language}';
        throw new hudson.AbortException("not support language ${language}")
    }
}

4.成果展示


配置Sonar、Jenkins进行持续审查 https://www.linuxidc.com/Linux/2016-08/133877.htm
sonarQube代码质量管理工具环境筹建笔记 https://www.linuxidc.com/Linux/2016-08/133878.htm
SonarQube代码质量管理平台安装与使用  https://www.linuxidc.com/Linux/2016-08/133879.htm
SonarQube升级过程记录  https://www.linuxidc.com/Linux/2016-08/133880.htm
Ubuntu 16.04下安装配置SonarQube+MySQL  https://www.linuxidc.com/Linux/2017-05/143860.htm
Fedora 21上搭建Jenkins+SonarQube的Maven项目自动化测试平台  https://www.linuxidc.com/Linux/2017-02/140780.htm
使用 Sonar 进行代码质量管理  https://www.linuxidc.com/Linux/2016-08/133876.htm
Red Hat Enterprise Linux 6.5 安装 Sonar  https://www.linuxidc.com/Linux/2017-12/149927.htm

Sonar 的详细介绍请点这里
Sonar 的下载地址请点这里

本文永久更新链接地址https://www.linuxidc.com/Linux/2018-05/152541.htm

linux
本文评论   查看全部评论 (0)
表情: 表情 姓名: 字数

       

评论声明
  • 尊重网上道德,遵守中华人民共和国的各项有关法律法规
  • 承担一切因您的行为而直接或间接导致的民事或刑事法律责任
  • 本站管理人员有权保留或删除其管辖留言中的任意内容
  • 本站有权在网站内转载或引用您的评论
  • 参与本评论即表明您已经阅读并接受上述条款