Maven task does not find the task-report.txt is some cases (#2559)

* Search for task-report.txt instead of picking it up from a fixed location

* Update Gradle to use the same aproach

* fs exists sync

* Remove unused var

Author: bgavrilMS

Tasks/Gradle/CodeAnalysis/SonarQube/common.ts

@@ -2,6 +2,7 @@
 
 import Q = require('q');
 import path = require('path');
+import glob = require('glob');
 
 import {ToolRunner} from 'vsts-task-lib/toolrunner';
 
@@ -40,9 +41,15 @@ export function applySonarQubeParameters(toolRunner: ToolRunner): ToolRunner {
  * @param sqBuildFolder
  * @returns {Promise<void>} Promise resolved when all SQ integration actions are complete.
  */
-export function processSonarQubeIntegration(sqBuildFolder:string):Q.Promise<void> {
-    var sqRunSettings:SonarQubeRunSettings = getSonarQubeRunSettings(sqBuildFolder);
-    var sqMetrics:SonarQubeMetrics = getSonarQubeMetrics(sqRunSettings);
+export function processSonarQubeIntegration(sqTaskReportGlob: string): Q.Promise<void> {
+
+    let sqTaskReportPath: string = findReportTaskFile(sqTaskReportGlob);
+    if (sqTaskReportPath === null) {
+        return Q.when();
+    }
+
+    var sqRunSettings: SonarQubeRunSettings = getSonarQubeRunSettings(sqTaskReportPath);
+    var sqMetrics: SonarQubeMetrics = getSonarQubeMetrics(sqRunSettings);
 
     // Wait for all promises to complete before proceeding (even if one or more promises reject).
     return Q.all([
@@ -58,28 +65,46 @@ export function processSonarQubeIntegration(sqBuildFolder:string):Q.Promise<void
  * Returns, as an object, the contents of the report-task.txt file created by SonarQube plugins
  * The returned object contains the following properties:
  *     projectKey, serverUrl, dashboardUrl, ceTaskId, ceTaskUrl
- * @param sonarPluginFolder The folder created by SonarQube integration during build
+ * @param sqTaskReportPath Path to the report-task.txt file
  * @returns {SonarQubeRunSettings} An object with fields corresponding to the properties exposed in report-task.txt, or null if PR build
  */
-function getSonarQubeRunSettings(sonarPluginFolder: string): SonarQubeRunSettings {
+function getSonarQubeRunSettings(sqTaskReportPath: string): SonarQubeRunSettings {
     if (VstsServerUtils.isPrBuild()) {
         return null;
     }
 
-    var reportFilePath:string = path.join(sonarPluginFolder, 'report-task.txt');
-    return SonarQubeRunSettings.createRunSettingsFromFile(reportFilePath);
+    return SonarQubeRunSettings.createRunSettingsFromFile(sqTaskReportPath);
 }
 
 /**
  * Returns the appropriate SQMetrics object for this build.
  * @param sqRunSettings An object with fields corresponding to the properties exposed in report-task.txt
  * @returns {SonarQubeMetrics} An SQMetrics instance for this build on the SQ server, or null if PR build
  */
-function getSonarQubeMetrics(sqRunSettings:SonarQubeRunSettings): SonarQubeMetrics {
+function getSonarQubeMetrics(sqRunSettings: SonarQubeRunSettings): SonarQubeMetrics {
     if (VstsServerUtils.isPrBuild()) {
         return null;
     }
 
-    var sqServer:ISonarQubeServer = new SonarQubeServer(SonarQubeEndpoint.getTaskSonarQubeEndpoint());
+    var sqServer: ISonarQubeServer = new SonarQubeServer(SonarQubeEndpoint.getTaskSonarQubeEndpoint());
     return new SonarQubeMetrics(sqServer, sqRunSettings.ceTaskId);
+}
+
+function findReportTaskFile(reportTaskGlob: string): string {
+
+    // the output folder may not be directly in the build root, for example if the entire project is in a top-lvel dir
+    let reportTaskGlobResults: string[] = glob.sync(reportTaskGlob);
+
+    tl.debug(`[SQ] Searching for ${reportTaskGlob} - found ${reportTaskGlobResults.length} file(s)`);
+
+    if (reportTaskGlobResults.length === 0) {
+        tl.warning(tl.loc('sqAnalysis_NoReportTask'));
+        return null;
+    }
+
+    if (reportTaskGlobResults.length > 1) {
+        tl.warning(tl.loc('sqAnalysis_MultipleReportTasks'));
+    }
+
+    return reportTaskGlobResults[0];
 }

Tasks/Gradle/CodeAnalysis/SonarQube/run-settings.ts

@@ -18,10 +18,10 @@ export class SonarQubeRunSettings {
      * @param ceTaskUrl    A string leading to the SonarQube Web API endpoint for the details of this analysis task
      */
     constructor(public projectKey: string,
-                public serverUrl: string,
-                public dashboardUrl: string,
-                public ceTaskId: string,
-                public ceTaskUrl: string) {
+        public serverUrl: string,
+        public dashboardUrl: string,
+        public ceTaskId: string,
+        public ceTaskUrl: string) {
         if (!projectKey) {
             // Looks like: Failed to create TaskReport object. Missing field: projectKey
             throw new Error(tl.loc('sqCommon_CreateTaskReport_MissingField', 'projectKey'));
@@ -49,8 +49,9 @@ export class SonarQubeRunSettings {
      * @param filePath Path to a report-task.txt file generated by a SonarQube build plugin
      * @returns {SonarQubeRunSettings} A new SonarQubeRunSettings with appropriate fields filled
      */
-    public static createRunSettingsFromFile(filePath:string): SonarQubeRunSettings {
-        if (!tl.exist(filePath)) {
+    public static createRunSettingsFromFile(filePath: string): SonarQubeRunSettings {
+
+        if (!SonarQubeRunSettings.fsExistsSync(filePath)) {
             tl.debug('Task report not found at: ' + filePath);
             // Looks like: Invalid or missing task report. Check SonarQube finished successfully.
             throw new Error(tl.loc('sqAnalysis_TaskReportInvalid'));
@@ -76,19 +77,17 @@ export class SonarQubeRunSettings {
             // Looks like: Invalid or missing task report. Check SonarQube finished successfully.
             throw new Error(tl.loc('sqAnalysis_TaskReportInvalid'));
         }
-
-
     }
 
     /**
      * Transforms a string read of report-task.txt into a key-value map of the run settings.
      * @param runSettingsString The contents of report-task.txt as a string
      */
-    private static createRunSettingsMapFromString(runSettingsString:string):Map<string, string> {
+    private static createRunSettingsMapFromString(runSettingsString: string): Map<string, string> {
         var lines: string[] = runSettingsString.replace(/\r\n/g, '\n').split('\n'); // proofs against xplat line-ending issues
 
         var runSettingsMap = new Map<string, string>();
-        lines.forEach((line:string) => {
+        lines.forEach((line: string) => {
             var splitLine: string[] = line.split('=');
             if (splitLine.length > 1) {
                 runSettingsMap.set(splitLine[0], splitLine.slice(1, splitLine.length).join());
@@ -97,4 +96,13 @@ export class SonarQubeRunSettings {
 
         return runSettingsMap;
     }
+
+    private static fsExistsSync(filePath: string): boolean {
+        try {
+            fs.accessSync(filePath);
+            return true;
+        } catch (e) {
+            return false;
+        }
+    }
 }

Tasks/Gradle/CodeAnalysis/gradlesonar.ts

@@ -3,6 +3,7 @@
 import Q = require('q');
 import path = require('path');
 import fs = require('fs');
+import glob = require('glob');
 
 import tl = require('vsts-task-lib/task');
 import trm = require('vsts-task-lib/toolrunner');
@@ -50,6 +51,9 @@ export function processSonarQubeIntegration(): Q.Promise<void> {
         return Q.when();
     }
 
-    var sqBuildFolder: string = path.join(tl.getVariable('build.sourcesDirectory'), 'build', 'sonar');
-    return sqCommon.processSonarQubeIntegration(sqBuildFolder);
-}
+      // the output folder may not be directly in the build root, for example if the entire project is in a top-lvel dir
+    var reportTaskGlob: string = path.join(tl.getVariable('build.sourcesDirectory'), '**', 'build', 'sonar', 'report-task.txt');
+   
+    return sqCommon.processSonarQubeIntegration(reportTaskGlob);
+}
+

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

@@ -80,6 +80,8 @@
   "loc.messages.sqAnalysis_QualityGatePassed": "The SonarQube quality gate associated with this build has passed (status %s)",
   "loc.messages.sqAnalysis_UnknownComparatorString": "The SonarQube build summary encountered a problem: unknown comparator '%s'",
   "loc.messages.sqAnalysis_NoUnitsFound": "The list of SonarQube measurement units could not be retrieved from the server.",
+  "loc.messages.sqAnalysis_NoReportTask": "Could not find report-task.txt. Possible cause: the SonarQube analysis did not complete successfully.",
+  "loc.messages.sqAnalysis_MultipleReportTasks": "Multiple report-task.txt files found. Choosing the first one. The build summary and the build breaker may not be accurate. Possible cause: multiple SonarQube analysis during the same build, which is not supported.",
   "loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsSomeFiles": "%s found %d violations in %d files.",
   "loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsOneFile": "%s found %d violations in 1 file.",
   "loc.messages.codeAnalysisBuildSummaryLine_OneViolationOneFile": "%s found 1 violation in 1 file.",

Tasks/Gradle/task.json

@@ -12,7 +12,7 @@
     "version": {
         "Major": 1,
         "Minor": 0,
-        "Patch": 60
+        "Patch": 61
     },
     "demands": [
         "java"
@@ -344,6 +344,8 @@
         "sqAnalysis_QualityGatePassed": "The SonarQube quality gate associated with this build has passed (status %s)",
         "sqAnalysis_UnknownComparatorString": "The SonarQube build summary encountered a problem: unknown comparator '%s'",
         "sqAnalysis_NoUnitsFound": "The list of SonarQube measurement units could not be retrieved from the server.",
+        "sqAnalysis_NoReportTask": "Could not find report-task.txt. Possible cause: the SonarQube analysis did not complete successfully.",
+        "sqAnalysis_MultipleReportTasks": "Multiple report-task.txt files found. Choosing the first one. The build summary and the build breaker may not be accurate. Possible cause: multiple SonarQube analysis during the same build, which is not supported.",
         "codeAnalysisBuildSummaryLine_SomeViolationsSomeFiles": "%s found %d violations in %d files.",
         "codeAnalysisBuildSummaryLine_SomeViolationsOneFile": "%s found %d violations in 1 file.",
         "codeAnalysisBuildSummaryLine_OneViolationOneFile": "%s found 1 violation in 1 file.",

Tasks/Gradle/task.loc.json

@@ -12,7 +12,7 @@
   "version": {
     "Major": 1,
     "Minor": 0,
-    "Patch": 60
+    "Patch": 61
   },
   "demands": [
     "java"
@@ -344,6 +344,8 @@
     "sqAnalysis_QualityGatePassed": "ms-resource:loc.messages.sqAnalysis_QualityGatePassed",
     "sqAnalysis_UnknownComparatorString": "ms-resource:loc.messages.sqAnalysis_UnknownComparatorString",
     "sqAnalysis_NoUnitsFound": "ms-resource:loc.messages.sqAnalysis_NoUnitsFound",
+    "sqAnalysis_NoReportTask": "ms-resource:loc.messages.sqAnalysis_NoReportTask",
+    "sqAnalysis_MultipleReportTasks": "ms-resource:loc.messages.sqAnalysis_MultipleReportTasks",
     "codeAnalysisBuildSummaryLine_SomeViolationsSomeFiles": "ms-resource:loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsSomeFiles",
     "codeAnalysisBuildSummaryLine_SomeViolationsOneFile": "ms-resource:loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsOneFile",
     "codeAnalysisBuildSummaryLine_OneViolationOneFile": "ms-resource:loc.messages.codeAnalysisBuildSummaryLine_OneViolationOneFile",

Tasks/Maven/CodeAnalysis/SonarQube/common.ts

@@ -2,6 +2,7 @@
 
 import Q = require('q');
 import path = require('path');
+import glob = require('glob');
 
 import {ToolRunner} from 'vsts-task-lib/toolrunner';
 
@@ -40,9 +41,15 @@ export function applySonarQubeParameters(toolRunner: ToolRunner): ToolRunner {
  * @param sqBuildFolder
  * @returns {Promise<void>} Promise resolved when all SQ integration actions are complete.
  */
-export function processSonarQubeIntegration(sqBuildFolder:string):Q.Promise<void> {
-    var sqRunSettings:SonarQubeRunSettings = getSonarQubeRunSettings(sqBuildFolder);
-    var sqMetrics:SonarQubeMetrics = getSonarQubeMetrics(sqRunSettings);
+export function processSonarQubeIntegration(sqTaskReportGlob: string): Q.Promise<void> {
+
+    let sqTaskReportPath: string = findReportTaskFile(sqTaskReportGlob);
+    if (sqTaskReportPath === null) {
+        return Q.when();
+    }
+
+    var sqRunSettings: SonarQubeRunSettings = getSonarQubeRunSettings(sqTaskReportPath);
+    var sqMetrics: SonarQubeMetrics = getSonarQubeMetrics(sqRunSettings);
 
     // Wait for all promises to complete before proceeding (even if one or more promises reject).
     return Q.all([
@@ -58,28 +65,46 @@ export function processSonarQubeIntegration(sqBuildFolder:string):Q.Promise<void
  * Returns, as an object, the contents of the report-task.txt file created by SonarQube plugins
  * The returned object contains the following properties:
  *     projectKey, serverUrl, dashboardUrl, ceTaskId, ceTaskUrl
- * @param sonarPluginFolder The folder created by SonarQube integration during build
+ * @param sqTaskReportPath Path to the report-task.txt file
  * @returns {SonarQubeRunSettings} An object with fields corresponding to the properties exposed in report-task.txt, or null if PR build
  */
-function getSonarQubeRunSettings(sonarPluginFolder: string): SonarQubeRunSettings {
+function getSonarQubeRunSettings(sqTaskReportPath: string): SonarQubeRunSettings {
     if (VstsServerUtils.isPrBuild()) {
         return null;
     }
 
-    var reportFilePath:string = path.join(sonarPluginFolder, 'report-task.txt');
-    return SonarQubeRunSettings.createRunSettingsFromFile(reportFilePath);
+    return SonarQubeRunSettings.createRunSettingsFromFile(sqTaskReportPath);
 }
 
 /**
  * Returns the appropriate SQMetrics object for this build.
  * @param sqRunSettings An object with fields corresponding to the properties exposed in report-task.txt
  * @returns {SonarQubeMetrics} An SQMetrics instance for this build on the SQ server, or null if PR build
  */
-function getSonarQubeMetrics(sqRunSettings:SonarQubeRunSettings): SonarQubeMetrics {
+function getSonarQubeMetrics(sqRunSettings: SonarQubeRunSettings): SonarQubeMetrics {
     if (VstsServerUtils.isPrBuild()) {
         return null;
     }
 
-    var sqServer:ISonarQubeServer = new SonarQubeServer(SonarQubeEndpoint.getTaskSonarQubeEndpoint());
+    var sqServer: ISonarQubeServer = new SonarQubeServer(SonarQubeEndpoint.getTaskSonarQubeEndpoint());
     return new SonarQubeMetrics(sqServer, sqRunSettings.ceTaskId);
+}
+
+function findReportTaskFile(reportTaskGlob: string): string {
+
+    // the output folder may not be directly in the build root, for example if the entire project is in a top-lvel dir
+    let reportTaskGlobResults: string[] = glob.sync(reportTaskGlob);
+
+    tl.debug(`[SQ] Searching for ${reportTaskGlob} - found ${reportTaskGlobResults.length} file(s)`);
+
+    if (reportTaskGlobResults.length === 0) {
+        tl.warning(tl.loc('sqAnalysis_NoReportTask'));
+        return null;
+    }
+
+    if (reportTaskGlobResults.length > 1) {
+        tl.warning(tl.loc('sqAnalysis_MultipleReportTasks'));
+    }
+
+    return reportTaskGlobResults[0];
 }

Tasks/Maven/CodeAnalysis/SonarQube/run-settings.ts

@@ -18,10 +18,10 @@ export class SonarQubeRunSettings {
      * @param ceTaskUrl    A string leading to the SonarQube Web API endpoint for the details of this analysis task
      */
     constructor(public projectKey: string,
-                public serverUrl: string,
-                public dashboardUrl: string,
-                public ceTaskId: string,
-                public ceTaskUrl: string) {
+        public serverUrl: string,
+        public dashboardUrl: string,
+        public ceTaskId: string,
+        public ceTaskUrl: string) {
         if (!projectKey) {
             // Looks like: Failed to create TaskReport object. Missing field: projectKey
             throw new Error(tl.loc('sqCommon_CreateTaskReport_MissingField', 'projectKey'));
@@ -49,8 +49,9 @@ export class SonarQubeRunSettings {
      * @param filePath Path to a report-task.txt file generated by a SonarQube build plugin
      * @returns {SonarQubeRunSettings} A new SonarQubeRunSettings with appropriate fields filled
      */
-    public static createRunSettingsFromFile(filePath:string): SonarQubeRunSettings {
-        if (!tl.exist(filePath)) {
+    public static createRunSettingsFromFile(filePath: string): SonarQubeRunSettings {
+
+        if (!SonarQubeRunSettings.fsExistsSync(filePath)) {
             tl.debug('Task report not found at: ' + filePath);
             // Looks like: Invalid or missing task report. Check SonarQube finished successfully.
             throw new Error(tl.loc('sqAnalysis_TaskReportInvalid'));
@@ -76,19 +77,17 @@ export class SonarQubeRunSettings {
             // Looks like: Invalid or missing task report. Check SonarQube finished successfully.
             throw new Error(tl.loc('sqAnalysis_TaskReportInvalid'));
         }
-
-
     }
 
     /**
      * Transforms a string read of report-task.txt into a key-value map of the run settings.
      * @param runSettingsString The contents of report-task.txt as a string
      */
-    private static createRunSettingsMapFromString(runSettingsString:string):Map<string, string> {
+    private static createRunSettingsMapFromString(runSettingsString: string): Map<string, string> {
         var lines: string[] = runSettingsString.replace(/\r\n/g, '\n').split('\n'); // proofs against xplat line-ending issues
 
         var runSettingsMap = new Map<string, string>();
-        lines.forEach((line:string) => {
+        lines.forEach((line: string) => {
             var splitLine: string[] = line.split('=');
             if (splitLine.length > 1) {
                 runSettingsMap.set(splitLine[0], splitLine.slice(1, splitLine.length).join());
@@ -97,4 +96,13 @@ export class SonarQubeRunSettings {
 
         return runSettingsMap;
     }
+
+    private static fsExistsSync(filePath: string): boolean {
+        try {
+            fs.accessSync(filePath);
+            return true;
+        } catch (e) {
+            return false;
+        }
+    }
 }

Tasks/Maven/CodeAnalysis/mavensonar.ts

@@ -5,6 +5,7 @@ import path = require('path');
 import fs = require('fs');
 import util = require('util');
 
+
 import {ToolRunner} from 'vsts-task-lib/toolrunner';
 import tl = require('vsts-task-lib/task');
 
@@ -38,6 +39,8 @@ export function processSonarQubeIntegration(): Q.Promise<void> {
         return Q.when();
     }
 
-    var sqBuildFolder: string = path.join(tl.getVariable('build.sourcesDirectory'), 'target', 'sonar');
-    return sqCommon.processSonarQubeIntegration(sqBuildFolder);
+    // the output folder may not be directly in the build root, for example if the entire project is in a top-lvel dir
+    var reportTaskGlob: string = path.join(tl.getVariable('build.sourcesDirectory'), '**', 'target', 'sonar', 'report-task.txt');
+   
+    return sqCommon.processSonarQubeIntegration(reportTaskGlob);
 }

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

@@ -82,6 +82,8 @@
   "loc.messages.sqAnalysis_QualityGatePassed": "The SonarQube quality gate associated with this build has passed (status %s)",
   "loc.messages.sqAnalysis_UnknownComparatorString": "The SonarQube build summary encountered a problem: unknown comparator '%s'",
   "loc.messages.sqAnalysis_NoUnitsFound": "The list of SonarQube measurement units could not be retrieved from the server.",
+  "loc.messages.sqAnalysis_NoReportTask": "Could not find report-task.txt. Possible cause: the SonarQube analysis did not complete successfully.",
+  "loc.messages.sqAnalysis_MultipleReportTasks": "Multiple report-task.txt files found. Choosing the first one. The build summary and the build breaker may not be accurate. Possible cause: multiple SonarQube analysis during the same build, which is not supported.",
   "loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsSomeFiles": "%s found %d violations in %d files.",
   "loc.messages.codeAnalysisBuildSummaryLine_SomeViolationsOneFile": "%s found %d violations in 1 file.",
   "loc.messages.codeAnalysisBuildSummaryLine_OneViolationOneFile": "%s found 1 violation in 1 file.",