allow for wrong-cased bundled nuget.exe

Author: jmyersmsft

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

@@ -106,15 +106,24 @@ interface LocateOptions {
 
     /** Array of filenames to use when searching for the tool. Defaults to the tool name. */
     toolFilenames?: string[];
+
+    /** Array of paths to search under. Defaults to agent NuGet locations */
+    searchPath?: string[];
+
+    /** root that searchPaths are relative to. Defaults to the Agent.HomeDirectory build variable */
+    root?: string;
 }
 
 function locateTool(tool: string, opts?: LocateOptions) {
-    let searchPath = ["externals/nuget", "agent/Worker/Tools/NuGetCredentialProvider", "agent/Worker/Tools"];
-    let agentRoot = tl.getVariable("Agent.HomeDirectory");
+    const defaultSearchPath = ["externals/nuget", "agent/Worker/Tools/NuGetCredentialProvider", "agent/Worker/Tools"];
+    const defaultAgentRoot = tl.getVariable("Agent.HomeDirectory");
 
     opts = opts || {};
     opts.toolFilenames = opts.toolFilenames || [tool];
 
+    let searchPath = opts.searchPath || defaultSearchPath;
+    let agentRoot = opts.root || defaultAgentRoot;
+
     tl.debug(`looking for tool ${tool}`);
 
     for (let thisVariant of opts.toolFilenames) {
@@ -271,5 +280,24 @@ export function isCredentialConfigEnabled(quirks: NuGetQuirks): boolean {
 }
 
 export function locateCredentialProvider(): string {
-    return path.join(__dirname, 'NuGet/CredentialProvider');
+    return path.join(__dirname, "NuGet/CredentialProvider");
 }
+
+export function getBundledNuGetLocation(uxOption: string): string {
+    let nuGetDir;
+    if (uxOption === "3.5.0.1829") {
+        nuGetDir = "NuGet/3.5.0";
+    }
+    else if (uxOption === "3.3.0") {
+        nuGetDir = "NuGet/3.3.0";
+    }
+    else {
+        throw new Error(tl.loc("NGCommon_UnabletoDetectNuGetVersion"));
+    }
+
+    return locateTool("NuGet", {
+        root: __dirname,
+        searchPath: [nuGetDir],
+        toolFilenames: ["NuGet.exe", "nuget.exe"],
+    });
+}

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

@@ -137,14 +137,4 @@ export function stripLeadingAndTrailingQuotes(path: string): string {
 
     // substring returns a value *not* including the character at right
     return path.substring(left, right + 1);
-}
-
-export function getBundledNuGetLocation(uxOption: string): string {
-    if (uxOption === "3.5.0.1829"){
-        return path.join(__dirname, 'NuGet/3.5.0/NuGet.exe')
-    }
-    else if (uxOption === "3.3.0"){
-        return path.join(__dirname, 'NuGet/3.3.0/NuGet.exe');
-    }
-    throw new Error(tl.loc("NGCommon_UnabletoDetectNuGetVersion"));
 }

Tasks/NuGetInstaller/nugetinstaller.ts

@@ -89,7 +89,7 @@ async function main(): Promise<void> {
                 throw new Error(tl.loc("NoNuGetSpecified"))
             }
             // Pull the pre-installed path for NuGet.
-            nuGetPath = nutil.getBundledNuGetLocation(nugetUxOption);
+            nuGetPath = ngToolRunner.getBundledNuGetLocation(nugetUxOption);
         }
 
         let serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);

Tasks/NuGetInstaller/task.json

@@ -9,7 +9,7 @@
     "version": {
         "Major": 0,
         "Minor": 2,
-        "Patch": 20
+        "Patch": 23
     },
     "minimumAgentVersion": "1.83.0",
     "groups": [

Tasks/NuGetInstaller/task.loc.json

@@ -9,7 +9,7 @@
   "version": {
     "Major": 0,
     "Minor": 2,
-    "Patch": 20
+    "Patch": 23
   },
   "minimumAgentVersion": "1.83.0",
   "groups": [

Tasks/NugetPublisher/nugetpublisher.ts

@@ -83,7 +83,7 @@ async function main(): Promise<void> {
             {
                 throw new Error(tl.loc("NoNuGetSpecified"))
             }
-            nuGetPath = nutil.getBundledNuGetLocation(nugetUxOption);
+            nuGetPath = ngToolRunner.getBundledNuGetLocation(nugetUxOption);
         }
 
         let serviceUri = tl.getEndpointUrl("SYSTEMVSSCONNECTION", false);

Tasks/NugetPublisher/task.json

@@ -9,7 +9,7 @@
     "version": {
         "Major": 0,
         "Minor": 2,
-        "Patch": 20
+        "Patch": 23
     },
     "demands": [
         "Cmd"

Tasks/NugetPublisher/task.loc.json

@@ -9,7 +9,7 @@
   "version": {
     "Major": 0,
     "Minor": 2,
-    "Patch": 20
+    "Patch": 23
   },
   "demands": [
     "Cmd"

definitions/nuget-task-common.d.ts

@@ -245,6 +245,7 @@ declare module 'nuget-task-common/NuGetToolRunner' {
 	export function isCredentialProviderEnabled(quirks: NuGetQuirks): boolean;
 	export function isCredentialConfigEnabled(quirks: NuGetQuirks): boolean;
 	export function locateCredentialProvider(): string;
+	export function getBundledNuGetLocation(version: string): string;
 
 }
 declare module 'nuget-task-common/INuGetCommandOptions' {
@@ -375,5 +376,4 @@ declare module 'nuget-task-common/Utility' {
 	export function resolveFilterSpec(filterSpec: string, basePath?: string, allowEmptyMatch?: boolean): string[];
 	export function resolveWildcardPath(pattern: string, allowEmptyWildcardMatch?: boolean): string[];
 	export function stripLeadingAndTrailingQuotes(path: string): string;
-	export function getBundledNuGetLocation(version: string): string;
 }