Breaking Jenkins CodeScan builds using Pipelines

To fail a Jenkins job based on the outcome of your Quality gate takes a bit of setting up but is a great way to track the heath of your projects from Jenkins.

Requirements

You will need:

• CodeScan (v4.0+)
• SonarQube (v6.7+)
• Jenkins (v2.6.1)

Setup

• Open Jenkins in your browser and add your SonarQube server in the Manage Jenkins > Configure System menu
• Open SonarQube in your browser and set the following webhook in the Administration > Configuration > Webhooks menu.
  • http://<your Jenkins instance>/sonarqube-webhook/
• In Jenkins, create a new Pipeline.
• In the Pipeline script section you will need the following code with your own values where applicable:

node {
  stage('Pull from Git') {
    git 'https://github.com/username/repo.git'
  }
  stage('CodeScan') {
    withSonarQubeEnv('Your SonarQube Server Name') {
      sh 'ant -f ~/path/to/your/antbuild.xml sonar -Dsonar.projectKey=yourProjectKey "-Dsonar.projectName=Your Project Name"'
    } // SonarQube taskId is automatically attached to the pipeline context
  }
}
 
stage("Fetch Quality Gate") {
  timeout(time: 1, unit: 'HOURS') { // Pipeline will be killed after this timeout
    def qualitygate = waitForQualityGate() 
    if (qualitygate.status != 'OK') {
      error "Pipeline aborted due to Quality Gate failure: ${qualitygate.status}"
    }
  }
}

• Run the pipeline.  If everything is set up correctly and your Quality Gate passes, you will be able to see the following in your stage view:
• If your quality gate fails, you will see the Pipeline aborted due to Quality Gate failure error in the final stage of the build.