通过Groovy脚本配置Jenkins中SonarQube服务及Scanner设置遇问题

Hey there, let's work through that Groovy script error you're facing when setting up SonarQube configurations in Jenkins via the script console. I’ve dealt with similar issues before, so here’s a step-by-step breakdown to get you sorted:

1. First, Check Script Compatibility with Your Jenkins/SonarQube Versions #

Groovy scripts for Jenkins are super version-dependent. If you grabbed a script from GitHub, it might be built for an older (or newer) version of the SonarQube plugin or Jenkins core, which is probably why you’re hitting that groovy.lang.Groovy... error.

• Start by confirming your SonarQube plugin version: Head to Manage Jenkins > Plugins > Installed Plugins, find the SonarQube plugin, and note its version number.
• Match the script to your plugin’s API. For example, newer plugin versions use SonarQubeInstallation instead of older class names, or have updated setter methods that the old script doesn’t account for.

2. Use a Valid, Version-Aligned Groovy Script #

Here are tested script snippets that work for most recent SonarQube plugin versions (v2.10+). Pick the one you need, adjust the values to match your setup, and run it in the script console.

Configure SonarQube Server (Manage Jenkins > Configure System > SonarQube Servers) #

import jenkins.model.Jenkins
import hudson.plugins.sonar.SonarQubeInstallation

def jenkins = Jenkins.get()
def sonarServerName = "My SonarQube Server"
def sonarServerUrl = "http://your-sonar-host:9000"
def sonarAuthToken = "your-sonar-admin-token" // For better security, store this in Jenkins credentials instead

// Optional: Remove existing server config with the same name to avoid duplicates
jenkins.getDescriptorByType(hudson.plugins.sonar.SonarQubeInstallation.DescriptorImpl.class)
       .getInstallations().each {
    if (it.name == sonarServerName) {
        jenkins.getDescriptorByType(hudson.plugins.sonar.SonarQubeInstallation.DescriptorImpl.class)
               .remove(it)
    }
}

// Create new SonarQube server configuration
def sonarInstallation = new SonarQubeInstallation(
    sonarServerName,
    sonarServerUrl,
    sonarAuthToken,
    null, // Optional additional properties
    null, // Server ID (not required for most setups)
    null  // Credential ID (use this if you stored the token in Jenkins credentials)
)

// Save the configuration
jenkins.getDescriptorByType(hudson.plugins.sonar.SonarQubeInstallation.DescriptorImpl.class)
       .setInstallations(sonarInstallation)
jenkins.save()

println "Successfully configured SonarQube Server: ${sonarServerName}"

Configure SonarQube Scanner (Manage Jenkins > Global Tool Configuration > SonarQube Scanner) #

import jenkins.model.Jenkins
import hudson.plugins.sonar.SonarRunnerInstallation

def jenkins = Jenkins.get()
def scannerName = "SonarQube Scanner"
def scannerVersion = "4.8.0.2856" // Use the scanner version compatible with your SonarQube server

// Optional: Remove existing scanner config to avoid duplicates
jenkins.getDescriptorByType(SonarRunnerInstallation.DescriptorImpl.class)
       .getInstallations().each {
    if (it.name == scannerName) {
        jenkins.getDescriptorByType(SonarRunnerInstallation.DescriptorImpl.class)
               .remove(it)
    }
}

// Create auto-installing scanner configuration
def scannerInstallation = new SonarRunnerInstallation(
    scannerName,
    "", // Leave empty to let Jenkins auto-install the scanner
    new hudson.tools.InstallSourceProperty([
        new hudson.plugins.sonar.SonarRunnerInstaller(scannerVersion)
    ])
)

// Save the configuration
jenkins.getDescriptorByType(SonarRunnerInstallation.DescriptorImpl.class)
       .setInstallations(scannerInstallation)
jenkins.save()

println "Successfully configured SonarQube Scanner: ${scannerName} (version ${scannerVersion})"

3. Fix Common Script Execution Errors #

Let’s break down the most likely causes for that groovy.lang.Groovy... error:

• MissingMethodException: This means the script is calling a method that doesn’t exist in your plugin version. Double-check class names (e.g., older scripts might use SonarRunner instead of SonarQubeScanner) and method signatures.
• SecurityException: If you hit a permission error, make sure you’re running the script as a user with Overall/Administer permissions. Also, check Manage Jenkins > In-process Script Approval—Jenkins might be blocking certain method calls that need your approval.
• ClassNotFoundException: This happens if the SonarQube plugin isn’t installed correctly. Reinstall the plugin, restart Jenkins, and try the script again.

4. Verify Your Configuration #

After running the script successfully:

• Head to Manage Jenkins > Configure System > SonarQube Servers to confirm your server is listed.
• Check Manage Jenkins > Global Tool Configuration > SonarQube Scanner to ensure the scanner setup looks right.
• Test with a sample Jenkins job that runs SonarQube analysis to make sure everything works end-to-end.

内容的提问来源于stack exchange，提问作者Ciado