Allow passing in sonarqube plugin version in gradle task (#4233)

Tasks/Gradle/CodeAnalysis/SonarQube/common.ts

@@ -22,6 +22,19 @@ export function isSonarQubeAnalysisEnabled(): boolean {
     return tl.getBoolInput('sqAnalysisEnabled', false);
 }
 
+/**
+ * Returns the SonarQube Gradle plugin version.
+ * @returns {string}
+ */
+export function getSonarQubeGradlePluginVersion(): string {
+    let pluginVersion = '2.0.1';
+    let userSpecifiedVersion = tl.getInput('sqGradlePluginVersion');
+    if (userSpecifiedVersion) {
+        pluginVersion = userSpecifiedVersion.trim();
+    }
+    return pluginVersion;
+}
+
 /**
  * Apply all parameters necessary for SonarQube operation to the given ToolRunner.
  * @param toolRunner Master ToolRunner object that will be executed on the command line.

Tasks/Gradle/CodeAnalysis/gradlesonar.ts

@@ -1,6 +1,7 @@
 /// <reference path="../../../definitions/vsts-task-lib.d.ts" />
 import Q = require('q');
 import path = require('path');
+import fs = require('fs');
 
 import tl = require('vsts-task-lib/task');
 import trm = require('vsts-task-lib/toolrunner');
@@ -17,7 +18,12 @@ export function applyEnabledSonarQubeArguments(gradleRun: trm.ToolRunner): trm.T
 
     // #1: Inject custom script to the Gradle build, triggering a SonarQube run
     // Add a custom initialisation script to the Gradle run that will apply the SonarQube plugin and task
+    // Set the SonarQube Gralde plugin version in the script
     let initScriptPath: string = path.join(__dirname, 'sonar.gradle');
+    let pluginVersion: string = sqCommon.getSonarQubeGradlePluginVersion();
+    let scriptContents: string= fs.readFileSync(initScriptPath, 'utf8');
+    scriptContents = scriptContents.replace('SONARQUBE_GRADLE_PLUGIN_VERSION', pluginVersion);
+    tl.writeFile(initScriptPath, scriptContents);
 
     // Specify that the build should run the init script
     gradleRun.arg(['sonarqube']);

Tasks/Gradle/CodeAnalysis/sonar.gradle

@@ -7,7 +7,7 @@ allprojects {
             }
         }
         dependencies {
-            classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.0.1"
+            classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:SONARQUBE_GRADLE_PLUGIN_VERSION"
         }
     }
 

Tasks/Gradle/Strings/resources.resjson/en-US/resources.resjson

@@ -47,6 +47,8 @@
   "loc.input.help.sqProjectKey": "The SonarQube project unique key, i.e. sonar.projectKey.",
   "loc.input.label.sqProjectVersion": "SonarQube Project Version",
   "loc.input.help.sqProjectVersion": "The SonarQube project version, i.e. sonar.projectVersion.",
+  "loc.input.label.sqGradlePluginVersion": "SonarQube Gradle Plugin Version",
+  "loc.input.help.sqGradlePluginVersion": "The SonarQube Gradle plugin version to use. Refer to https://plugins.gradle.org/plugin/org.sonarqube for all available versions.",
   "loc.input.label.sqDbDetailsRequired": "The SonarQube server version is lower than 5.2",
   "loc.input.help.sqDbDetailsRequired": "If using a SonarQube server 5.1 or lower, you must specify the database connection details.",
   "loc.input.label.sqDbUrl": "Db Connection String",

Tasks/Gradle/task.json

@@ -16,7 +16,7 @@
     "version": {
         "Major": 1,
         "Minor": 117,
-        "Patch": 0 
+        "Patch": 1
     },
     "demands": [
         "java"
@@ -255,6 +255,16 @@
             "groupName": "CodeAnalysis",
             "visibleRule": "sqAnalysisEnabled = true"
         },
+        {
+            "name": "sqGradlePluginVersion",
+            "type": "string",
+            "label": "SonarQube Gradle Plugin Version",
+            "required": true,
+            "defaultValue": "2.0.1",
+            "helpMarkDown": "The SonarQube Gradle plugin version to use. Refer to https://plugins.gradle.org/plugin/org.sonarqube for all available versions.",
+            "groupName": "CodeAnalysis",
+            "visibleRule": "sqAnalysisEnabled = true"
+        },
         {
             "name": "sqDbDetailsRequired",
             "type": "boolean",

Tasks/Gradle/task.loc.json

@@ -16,7 +16,7 @@
   "version": {
     "Major": 1,
     "Minor": 117,
-    "Patch": 0
+    "Patch": 1
   },
   "demands": [
     "java"
@@ -255,6 +255,16 @@
       "groupName": "CodeAnalysis",
       "visibleRule": "sqAnalysisEnabled = true"
     },
+    {
+      "name": "sqGradlePluginVersion",
+      "type": "string",
+      "label": "ms-resource:loc.input.label.sqGradlePluginVersion",
+      "required": true,
+      "defaultValue": "2.0.1",
+      "helpMarkDown": "ms-resource:loc.input.help.sqGradlePluginVersion",
+      "groupName": "CodeAnalysis",
+      "visibleRule": "sqAnalysisEnabled = true"
+    },
     {
       "name": "sqDbDetailsRequired",
       "type": "boolean",