如何在 jenkins 中为 js/ts/react 项目设置 SonarQube 扫描仪

IT技术 javascript reactjs typescript jenkins sonarqube
2022-07-10 02:11:30

当我的项目在jenkins中构建时,我想在我的项目上运行声纳扫描仪。

像这样的东西, 像这样的东西

大多数教程似乎只从 Java 的角度解决这个过程,所以我想知道如果有的话,如何做到这一点。

我正在我的项目中使用 Jenkinsfile 做一些工作:

stage('SonarQube') {
  environment {
    scannerHome = tool 'SonarQubeScanner'
  }
  steps {
    withSonarQubeEnv('SonarQubeScanner') {
      sh "${scannerHome}/bin/sonar-scanner"
    }
  }
}

我使用以下链接在 SonarQube 中获取项目:https ://nickkorbel.com/2020/02/05/configuring-sonar-with-a-create-react-app-in-typescript/

在 Jenkins 构建期间尝试运行扫描时出现几个不同的错误:

错误 1

Could not find executable in "/opt/app-root/src/.sonar/native-sonar-scanner".

Proceed with download of the platform binaries for SonarScanner...
 Creating /opt/app-root/src/.sonar/native-sonar-scanner

Downloading from https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.4.0.2170-linux.zip

(executable will be saved in cache folder: /opt/app-root/src/.sonar/native-sonar-scanner)

ERROR: impossible to download and extract binary: connect ETIMEDOUT 

错误 2

ERROR: Failed to download https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.4.0.2170-linux.zip from agent; will retry from master

SonarQube installation defined in this job (sonarqube) does not match any configured installation. Number of installations that can be configured: 1.
2个回答

错误 2 是关于缺少与 sonarqube 服务器的集成。

完整安装 sonarqube:

  1. 安装 SonarQube 服务器
  2. 为 Jenkins 安装 SonarQube Scanner 插件。
  3. 配置您的 SonarQube 服务器:
  • 以管理员身份登录 Jenkins,然后转到管理 Jenkins > 配置系统。
  • 向下滚动到 SonarQube 配置部分,单击添加 SonarQube,然后添加系统提示您输入的值。
  • 服务器身份验证令牌应创建为“秘密文本”凭据。

withSonarQubeEnv('SonarQubeScanner')- “SonarQubeScanner”是指步骤 3 中的 Sonarqube 服务器的名称。

在管道中,您应该传递声纳扫描仪工具的参数,例如:

stage('SonarQube analysis') {
        environment {
            scannerHome = tool 'SonarQube_4.3.0'
        }
        steps {
            withSonarQubeEnv('Your Sonar Server Name here') {
                sh '''
                ${scannerHome}/bin/sonar-scanner \
                -D sonar.projectKey=YOUR_PROJECT_KEY_HERE \
                -D sonar.projectName=YOUR_PROJECT_NAME_HERE \
                -D sonar.projectVersion=YOUR_PROJECT_VERSION_HERE \
                -D sonar.languages=js,ts \  // DEPRECATED, do not use this option
                -D sonar.sources=./src \
                -D sonar.test.inclusions=YOUR_INCLUSIONS_HERE \
                -D sonar.exclusions=YOUR_EXCLUSIONS_HERE
                '''
            }
        }
    }

假设修复错误 2 后错误 1 ​​将得到修复。请查看官方文档here

在我的情况下,任何初始化scannerHomevar 的方法都不成功。所以我按照我的方式做了:

stage("SonarQube analysis") {
    steps {
        script {
            withSonarQubeEnv('SonarQube Server') {
                sh '''
                  ${JENKINS_HOME}/tools/hudson.plugins.sonar.SonarRunnerInstallation/SonarQube_Scanner/bin/sonar-scanner \
                   -Dsonar.host.url=URL_TO_SONAR \
                   -Dsonar.login=SONAR_TOKEN \
                   -Dsonar.projectKey=PROJECT_KEY \
                   -Dsonar.projectName=PROJECT_NAME
                '''
            }
        }
    }
}