nuget-tasks-common: expand locateTool to optionally include system path and multiple variants of the tool name

Author: jmyersmsft

Tasks/Common/nuget-task-common/NuGetToolRunner.ts

@@ -91,29 +91,53 @@ export function createNuGetToolRunner(nuGetExePath: string, settings: NuGetEnvir
     return runner;
 }
 
-export function locateTool(tool: string, userPath?: string, optional?: boolean) {
-    tl.debug("looking for tool " + tool);
-    if (userPath) {
-        tl.debug("using user-supplied path " + userPath)
-        tl.checkPath(userPath, 'nuget');
-        return userPath;
-    }
+export interface LocateOptions {
+    optional?: boolean;
+    userPath?: string;
+    fallbackToSystemPath?: boolean;
+}
 
+export function locateTool(tool: string | string[], opts?: LocateOptions) {
+    let toolVariants: string[] = typeof tool === 'string' ? [tool] : tool;
     let searchPath = ["externals/nuget", "agent/Worker/Tools/NuGetCredentialProvider", "agent/Worker/Tools"];
-
     let agentRoot = tl.getVariable("Agent.HomeDirectory");
-    for (let possibleLocation of searchPath) {
-        let fullPath = path.join(agentRoot, possibleLocation, tool);
-        tl.debug("checking " + fullPath);
-        if (tl.exist(fullPath)) {
-            return fullPath;
-        }
+
+    opts = opts || {};
+
+    tl.debug(`looking for tool ${tool}`)
+
+    if (opts.userPath) {
+        tl.debug(`using user-supplied path ${opts.userPath}`)
+        tl.checkPath(opts.userPath, toolVariants[0]);
+        return opts.userPath;
     }
 
-    tl.debug("not found");
+    for (let thisVariant of toolVariants)
+    {
+        tl.debug(`looking for tool variant ${thisVariant}`);
+
+        for (let possibleLocation of searchPath) {
+            let fullPath = path.join(agentRoot, possibleLocation, thisVariant);
+            tl.debug(`checking ${fullPath}`);
+            if (tl.exist(fullPath)) {
+                return fullPath;
+            }
+        }
+
+        if (opts.fallbackToSystemPath) {
+            tl.debug('Checking system path');
+            let whichResult = tl.which(thisVariant);
+            if (whichResult) {
+                tl.debug(`found ${whichResult}`);
+                return whichResult;
+            }
+        }
+
+        tl.debug("not found");
+    }
 
-    if (!optional) {
-        throw new Error(tl.loc("NGCommon_UnableToFindTool", tool));
+    if (!opts.optional) {
+        throw new Error(tl.loc("NGCommon_UnableToFindTool", toolVariants[0]));
     }
 
     return null;

Tasks/NuGetInstaller/nugetinstaller.ts

@@ -14,6 +14,7 @@ import * as ngToolRunner from 'nuget-task-common/NuGetToolRunner';
 import * as nutil from 'nuget-task-common/Utility';
 import * as auth from 'nuget-task-common/Authentication'
 import {NuGetConfigHelper} from 'nuget-task-common/NuGetConfigHelper'
+import * as os from 'os';
 
 class RestoreOptions {
     constructor(
@@ -65,8 +66,9 @@ if (!tl.filePathSupplied('nuGetPath')) {
 var serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);
 
 //find nuget location to use
-var nuGetPathToUse = ngToolRunner.locateTool('nuget.exe', userNuGetPath);
-var credProviderPath = ngToolRunner.locateTool('CredentialProvider.TeamBuild.exe', null, true);
+var nuGetExeVariants = ['nuget.exe', 'NuGet.exe', 'nuget', 'NuGet']
+var nuGetPathToUse = ngToolRunner.locateTool(nuGetExeVariants, {userPath: userNuGetPath, fallbackToSystemPath: os.platform() !== 'win32'});
+var credProviderPath = ngToolRunner.locateTool('CredentialProvider.TeamBuild.exe', {optional: true});
 
 var credProviderDir: string = null;
 if (credProviderPath) {

Tasks/NugetPublisher/nugetpublisher.ts

@@ -15,6 +15,7 @@ import * as nutil from 'nuget-task-common/Utility';
 import * as auth from 'nuget-task-common/Authentication';
 import {NuGetConfigHelper} from 'nuget-task-common/NuGetConfigHelper';
 import * as locationApi from 'nuget-task-common/LocationApi';
+import * as os from 'os';
 
 class PublishOptions {
     constructor(
@@ -62,8 +63,9 @@ if (!tl.filePathSupplied('nuGetPath')) {
 var serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);
 
 //find nuget location to use
-var nuGetPathToUse = ngToolRunner.locateTool('nuget.exe', userNuGetPath);
-var credProviderPath = ngToolRunner.locateTool('CredentialProvider.TeamBuild.exe', null, true);
+var nuGetExeVariants = ['nuget.exe', 'NuGet.exe', 'nuget', 'NuGet']
+var nuGetPathToUse = ngToolRunner.locateTool(nuGetExeVariants, {userPath: userNuGetPath, fallbackToSystemPath: os.platform() !== 'win32'});
+var credProviderPath = ngToolRunner.locateTool('CredentialProvider.TeamBuild.exe', {optional: true});
 
 var credProviderDir: string = null;
 if (credProviderPath) {

definitions/nuget-task-common.d.ts

@@ -101,7 +101,12 @@ declare module 'nuget-task-common/NuGetToolRunner' {
 	    exec(options?: IExecOptions): Q.Promise<number>;
 	}
 	export function createNuGetToolRunner(nuGetExePath: string, settings: NuGetEnvironmentSettings): NuGetToolRunner;
-	export function locateTool(tool: string, userPath?: string, optional?: boolean): string;
+	export interface LocateOptions {
+	    optional?: boolean;
+	    userPath?: string;
+	    fallbackToSystemPath?: boolean;
+	}
+	export function locateTool(tool: string | string[], opts?: LocateOptions): string;
 
 }
 declare module 'nuget-task-common/NuGetConfigHelper' {