PR feedback

Author: jmyersmsft

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

@@ -91,28 +91,24 @@ export function createNuGetToolRunner(nuGetExePath: string, settings: NuGetEnvir
     return runner;
 }
 
-export interface LocateOptions {
-    optional?: boolean;
-    userPath?: string;
+interface LocateOptions {
+    /** if true, search along the system path in addition to the hard-coded NuGet tool paths */
     fallbackToSystemPath?: boolean;
+
+    /** Array of filenames to use when searching for the tool. Defaults to the tool name. */
+    toolFilenames?: string[];
 }
 
-export function locateTool(tool: string | string[], opts?: LocateOptions) {
-    let toolVariants: string[] = typeof tool === 'string' ? [tool] : tool;
+function locateTool(tool: string, opts?: LocateOptions) {
     let searchPath = ["externals/nuget", "agent/Worker/Tools/NuGetCredentialProvider", "agent/Worker/Tools"];
     let agentRoot = tl.getVariable("Agent.HomeDirectory");
 
     opts = opts || {};
+    opts.toolFilenames = opts.toolFilenames || [tool];
 
     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;
-    }
-
-    for (let thisVariant of toolVariants)
+    for (let thisVariant of opts.toolFilenames)
     {
         tl.debug(`looking for tool variant ${thisVariant}`);
 
@@ -136,9 +132,29 @@ export function locateTool(tool: string | string[], opts?: LocateOptions) {
         tl.debug("not found");
     }
 
-    if (!opts.optional) {
-        throw new Error(tl.loc("NGCommon_UnableToFindTool", toolVariants[0]));
+    return null;
+}
+
+export function locateNuGetExe(userNuGetExePath: string): string {
+    if (userNuGetExePath) {
+        tl.debug(`using user-supplied NuGet path ${userNuGetExePath}`)
+        tl.checkPath(userNuGetExePath, 'NuGet');
+        return userNuGetExePath;
+    }
+
+    var toolPath = locateTool('NuGet', {
+        fallbackToSystemPath: os.platform() !== 'win32',
+        toolFilenames: ['nuget.exe', 'NuGet.exe', 'nuget', 'NuGet']
+    });
+
+    
+    if (!toolPath) {
+        throw new Error(tl.loc("NGCommon_UnableToFindTool", 'NuGet'));
     }
 
-    return null;
+    return toolPath;
+}
+
+export function locateCredentialProvider(): string {
+    return locateTool('CredentialProvider.TeamBuild.exe');
 }

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

@@ -44,17 +44,6 @@ export function resolveFilterSpec(filterSpec: string, basePath?: string, allowEm
 
 export function resolveWildcardPath(pattern: string, allowEmptyWildcardMatch?: boolean): string[] {
     let isWindows = os.platform() === 'win32';
-    let toPosixPath = (path: string) => path;
-    let toNativePath = (path: string) => path;
-    if (isWindows) {
-        // minimatch assumes paths use /, so on Windows, make paths use /
-        // This needs to be done both to the pattern and to the filenames.
-        toPosixPath = (path: string) => path.replace(/\\/g, "/");
-
-        // tl.find always returns forward slashes. This is problematic with UNC paths because NuGet
-        // interprets that as a switch argument instead of a path.
-        toNativePath = (path: string) => path.replace(/\//g, "\\");
-    }
 
     // Resolve files for the specified value or pattern
     var filesList: string[];
@@ -93,9 +82,9 @@ export function resolveWildcardPath(pattern: string, allowEmptyWildcardMatch?: b
         var allFiles = tl.find(findPathRoot);
 
         // Now matching the pattern against all files
-        // Turn off a bunch of minimatch features to replicate the be
+        // Turn off a bunch of minimatch features to replicate the behavior of Find-Files in the old PowerShell tasks
         let patternFilter = tl.filter(
-            toPosixPath(pattern), {
+            pattern, {
                 matchBase: true,
                 nobrace: true,
                 noext: true,
@@ -105,13 +94,20 @@ export function resolveWildcardPath(pattern: string, allowEmptyWildcardMatch?: b
                 dot: isWindows
             });
 
-        filesList = allFiles.filter((file, index, array) => patternFilter(toPosixPath(file), index, array));
+        filesList = allFiles.filter(patternFilter);
 
         // Fail if no matching .sln files were found
         if (!allowEmptyWildcardMatch && (!filesList || filesList.length == 0)) {
             throw new Error('No matching files were found with search pattern: ' + pattern);
         }
     }
 
-    return filesList.map(toNativePath);
+    if (!isWindows)
+    {
+        return filesList;
+    }
+    else
+    {
+        return filesList.map(file => file.split("/").join("\\"));
+    }
 }

Tasks/NuGetInstaller/nugetinstaller.ts

@@ -66,9 +66,8 @@ if (!tl.filePathSupplied('nuGetPath')) {
 var serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);
 
 //find nuget location to use
-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 nuGetPathToUse = ngToolRunner.locateNuGetExe(userNuGetPath);
+var credProviderPath = ngToolRunner.locateCredentialProvider();
 
 var credProviderDir: string = null;
 if (credProviderPath) {

Tasks/NugetPublisher/nugetpublisher.ts

@@ -63,9 +63,8 @@ if (!tl.filePathSupplied('nuGetPath')) {
 var serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);
 
 //find nuget location to use
-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 nuGetPathToUse = ngToolRunner.locateNuGetExe(userNuGetPath);
+var credProviderPath = ngToolRunner.locateCredentialProvider();
 
 var credProviderDir: string = null;
 if (credProviderPath) {

definitions/nuget-task-common.d.ts

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