Expand Environment variables in SonarQube Scanner for Jenkins

BasieP · November 29, 2018, 10:59am

Hi there,

We are using Jenkins for building our products, but we have more then 90 .NET projects.
We like to use as many as possible variables in the build scripts to keep them more generic.

In the ‘old’ scanner (the non msbuild one) we could use all environment variables
We use stuff like %JOB_NAME% and %GIT_VERSION% environment variables

Our analysis properties looked like this:
sonar.projectKey=myProject:%JOB_NAME:~0,-10%
sonar.projectName=%JOB_NAME:~0,-10%
sonar.projectVersion=%GIT_COMMIT%

But since we need to move to the new style of running sonarscanner (the msbuild version) we have the 3 fields (key, name and version) we need to set in a separate field. Those fields don’t expand environment variables.

So, the question is simple: can we expand the environment variables for alle fields?

Colin · November 29, 2018, 1:44pm

Bas,

You should be able to use this format of using environment variables

${JOB_NAME}

I tested this in a Jenkins job just now.

(I am moving this topic to “Get Help”, but feel free to chime in if you disagree with this!)

Colin

BasieP · November 29, 2018, 1:45pm

that is on linux… but i have a windows buildserver

Julien_HENRY · November 29, 2018, 1:49pm

Hi,

I haven’t tested, but the code is there to evaluate env variables, and it should not depend on the OS, since it is a Jenkins level env expension:

github.com

SonarSource/sonar-scanner-jenkins/blob/e2d3bf9c430729a8071de3f40e91851de4a2c9b3/src/main/java/hudson/plugins/sonar/MsBuildSQRunnerBegin.java#L126


  if (!StringUtils.isBlank(tokenPlainText)) {
    map.put("sonar.login", tokenPlainText);
  }


  return map;
}


private void addArgsTo(ArgumentListBuilder args, SonarInstallation sonarInst, EnvVars env, Map<String, String> props) {
  args.add("begin");


  args.add("/k:" + env.expand(projectKey) + "");
  args.add("/n:" + env.expand(projectName) + "");
  args.add("/v:" + env.expand(projectVersion) + "");


  // expand macros using itself
  EnvVars.resolve(props);


  for (Map.Entry<String, String> e : props.entrySet()) {
    if (!StringUtils.isEmpty(e.getValue())) {
      // expand macros using environment variables and hide token
      boolean hide = e.getKey().contains("sonar.login");

You should use Jenkins syntax, which is $XXX