Use downloadToolWithRetries in place of all downloadTool calls (#133)

mcafaro · web-flow · commit e1efb928af74 · 2024-10-09T11:18:29.000-04:00
* Use downloadToolWithRetries in place of all downloadTool calls

* Replace stub uses of downloadTool with downloadToolWithRetries
diff --git a/tasks/install-matlab/v0/main.ts b/tasks/install-matlab/v0/main.ts
@@ -91,7 +91,7 @@ function installRoot(programName: string) {
 // similar to "curl | sh"
 async function curlsh(url: string, args: string | string[]) {
     // download script
-    const scriptPath = await toolLib.downloadTool(url);
+    const scriptPath = await toolLib.downloadToolWithRetries(url);
 
     // execute script
     const bashPath = taskLib.which("bash", true);
diff --git a/tasks/install-matlab/v0/test/downloadAndExecuteLinux.ts b/tasks/install-matlab/v0/test/downloadAndExecuteLinux.ts
@@ -35,7 +35,7 @@ tlClone.assertAgent = (variable: string) => {
 tr.registerMock("azure-pipelines-task-lib/mock-task", tlClone);
 
 tr.registerMock("azure-pipelines-tool-lib/tool", {
-    downloadTool(url: string) {
+    downloadToolWithRetries(url: string) {
         if (url === "https://ssd.mathworks.com/supportfiles/ci/matlab-deps/v0/install.sh") {
             return "install.sh";
         } else if (url === "https://ssd.mathworks.com/supportfiles/ci/ephemeral-matlab/v0/ci-install.sh") {
diff --git a/tasks/install-matlab/v0/test/downloadAndExecutePrivate.ts b/tasks/install-matlab/v0/test/downloadAndExecutePrivate.ts
@@ -35,7 +35,7 @@ tlClone.assertAgent = (variable: string) => {
 tr.registerMock("azure-pipelines-task-lib/mock-task", tlClone);
 
 tr.registerMock("azure-pipelines-tool-lib/tool", {
-    downloadTool(url: string) {
+    downloadToolWithRetries(url: string) {
         if (url === "https://ssd.mathworks.com/supportfiles/ci/matlab-deps/v0/install.sh") {
             return "install.sh";
         } else if (url === "https://ssd.mathworks.com/supportfiles/ci/ephemeral-matlab/v0/ci-install.sh") {
diff --git a/tasks/install-matlab/v0/test/downloadAndExecuteWindows.ts b/tasks/install-matlab/v0/test/downloadAndExecuteWindows.ts
@@ -35,7 +35,7 @@ tlClone.assertAgent = (variable: string) => {
 tr.registerMock("azure-pipelines-task-lib/mock-task", tlClone);
 
 tr.registerMock("azure-pipelines-tool-lib/tool", {
-    downloadTool(url: string) {
+    downloadToolWithRetries(url: string) {
         if (url === "https://ssd.mathworks.com/supportfiles/ci/ephemeral-matlab/v0/ci-install.sh") {
             return "ci-install.sh";
         } else if (url === "https://ssd.mathworks.com/supportfiles/ci/matlab-batch/v0/install.sh") {
diff --git a/tasks/install-matlab/v0/test/failDownload.ts b/tasks/install-matlab/v0/test/failDownload.ts
@@ -25,7 +25,7 @@ tlClone.assertAgent = (variable: string) => {
 tr.registerMock("azure-pipelines-task-lib/mock-task", tlClone);
 
 tr.registerMock("azure-pipelines-tool-lib/tool", {
-    downloadTool() {
+    downloadToolWithRetries() {
         throw new Error("Download failed");
     },
 });
diff --git a/tasks/install-matlab/v0/test/failExecute.ts b/tasks/install-matlab/v0/test/failExecute.ts
@@ -26,7 +26,7 @@ tlClone.assertAgent = (variable: string) => {
 tr.registerMock("azure-pipelines-task-lib/mock-task", tlClone);
 
 tr.registerMock("azure-pipelines-tool-lib/tool", {
-    downloadTool(url: string) {
+    downloadToolWithRetries(url: string) {
         if (url === "https://ssd.mathworks.com/supportfiles/ci/matlab-deps/v0/install.sh") {
             return "install.sh";
         } else if (url === "https://ssd.mathworks.com/supportfiles/ci/ephemeral-matlab/v0/ci-install.sh") {
diff --git a/tasks/install-matlab/v1/src/matlab.ts b/tasks/install-matlab/v1/src/matlab.ts
@@ -6,7 +6,7 @@ import * as fs from "fs";
 import * as https from "https";
 import * as path from "path";
 import * as script from "./script";
-import { downloadTool } from "./utils";
+import { downloadToolWithRetries } from "./utils";
 
 export interface Release {
     name: string;
@@ -137,7 +137,7 @@ export async function setupBatch(platform: string, architecture: string) {
             return Promise.reject(Error(`This task is not supported on ${platform} runners.`));
     }
 
-    const tempPath = await downloadTool(matlabBatchUrl, `matlab-batch${matlabBatchExt}`);
+    const tempPath = await downloadToolWithRetries(matlabBatchUrl, `matlab-batch${matlabBatchExt}`);
     const matlabBatchPath = await toolLib.cacheFile(tempPath, `matlab-batch${matlabBatchExt}`, "matlab-batch", "1.0.0");
     try {
         toolLib.prependPath(matlabBatchPath);
@@ -174,7 +174,7 @@ async function installAppleSiliconRosetta() {
 }
 
 async function installAppleSiliconJdk() {
-    const jdk = await downloadTool(
+    const jdk = await downloadToolWithRetries(
         "https://corretto.aws/downloads/resources/8.402.08.1/amazon-corretto-8.402.08.1-macosx-aarch64.pkg",
         "jdk.pkg",
     );
diff --git a/tasks/install-matlab/v1/src/mpm.ts b/tasks/install-matlab/v1/src/mpm.ts
@@ -2,7 +2,7 @@
 
 import * as taskLib from "azure-pipelines-task-lib/task";
 import * as matlab from "./matlab";
-import { downloadTool } from "./utils";
+import { downloadToolWithRetries } from "./utils";
 
 export async function setup(platform: string, architecture: string): Promise<string> {
     const mpmRootUrl: string = "https://www.mathworks.com/mpm/";
@@ -15,11 +15,11 @@ export async function setup(platform: string, architecture: string): Promise<str
     switch (platform) {
         case "win32":
             mpmUrl = mpmRootUrl + "win64/mpm";
-            mpm = await downloadTool(mpmUrl, "mpm.exe");
+            mpm = await downloadToolWithRetries(mpmUrl, "mpm.exe");
             break;
         case "linux":
             mpmUrl = mpmRootUrl + "glnxa64/mpm";
-            mpm = await downloadTool(mpmUrl, "mpm");
+            mpm = await downloadToolWithRetries(mpmUrl, "mpm");
             exitCode = await taskLib.exec("chmod", ["+x", mpm]);
             if (exitCode !== 0) {
                 return Promise.reject(Error("Unable to set up mpm."));
@@ -31,7 +31,7 @@ export async function setup(platform: string, architecture: string): Promise<str
             } else {
                 mpmUrl = mpmRootUrl + "maca64/mpm";
             }
-            mpm = await downloadTool(mpmUrl, "mpm");
+            mpm = await downloadToolWithRetries(mpmUrl, "mpm");
             exitCode = await taskLib.exec("chmod", ["+x", mpm]);
             if (exitCode !== 0) {
                 return Promise.reject(Error("Unable to set up mpm."));
diff --git a/tasks/install-matlab/v1/src/script.ts b/tasks/install-matlab/v1/src/script.ts
@@ -5,7 +5,7 @@ import * as toolLib from "azure-pipelines-tool-lib/tool";
 import * as path from "path";
 
 export async function downloadAndRunScript(platform: string, url: string, args: string | string[]) {
-    const scriptPath = await toolLib.downloadTool(url);
+    const scriptPath = await toolLib.downloadToolWithRetries(url);
     const bashPath = await taskLib.which("bash", true);
     const sudoPath = await taskLib.which("sudo", false);
     let bash;
diff --git a/tasks/install-matlab/v1/src/utils.ts b/tasks/install-matlab/v1/src/utils.ts
@@ -4,7 +4,7 @@ import * as taskLib from "azure-pipelines-task-lib/task";
 import * as toolLib from "azure-pipelines-tool-lib/tool";
 import * as path from "path";
 
-export async function downloadTool(url: string, fileName: string): Promise<string> {
+export async function downloadToolWithRetries(url: string, fileName: string): Promise<string> {
     let destPath: string;
     if (path.isAbsolute(fileName)) {
         destPath = fileName;
@@ -17,6 +17,6 @@ export async function downloadTool(url: string, fileName: string): Promise<strin
     }
 
     taskLib.rmRF(destPath);
-    await toolLib.downloadTool(url, destPath);
+    await toolLib.downloadToolWithRetries(url, destPath);
     return destPath;
 }
diff --git a/tasks/install-matlab/v1/test/matlab.test.ts b/tasks/install-matlab/v1/test/matlab.test.ts
@@ -189,7 +189,7 @@ export default function suite() {
         stubCacheFile.callsFake((srcFile, desFile, tool, ver) => {
           return Promise.resolve(matlabBatchPath);
         });
-        stubDownloadTool = sinon.stub(toolLib, "downloadTool");
+        stubDownloadTool = sinon.stub(toolLib, "downloadToolWithRetries");
         stubDownloadTool.callsFake((url, name) => {
           return Promise.resolve(matlabBatchPath);
         });
@@ -359,7 +359,7 @@ export default function suite() {
 
             stubDownloadAndRun = sinon.stub(script, "downloadAndRunScript");
             stubDownloadAndRun.resolves(0);
-            stubDownloadTool = sinon.stub(utils, "downloadTool");
+            stubDownloadTool = sinon.stub(utils, "downloadToolWithRetries");
             stubDownloadTool.resolves("/path/to/jdk.pkg");
             stubExec = sinon.stub(taskLib, "exec");
             stubExec.resolves(0);
diff --git a/tasks/install-matlab/v1/test/mpm.test.ts b/tasks/install-matlab/v1/test/mpm.test.ts
@@ -16,7 +16,7 @@ export default function suite() {
     describe("mpm.ts test suite", () => {
         beforeEach(() => {
             // setup stubs
-            stubDownloadTool = sinon.stub(toolLib, "downloadTool");
+            stubDownloadTool = sinon.stub(toolLib, "downloadToolWithRetries");
             stubDownloadTool.callsFake((url, fileName) => {
                 return Promise.resolve(`${agentTemp}/fileName`);
             });
diff --git a/tasks/install-matlab/v1/test/script.test.ts b/tasks/install-matlab/v1/test/script.test.ts
@@ -30,7 +30,7 @@ export default function suite() {
     describe("script.ts test suite", () => {
         beforeEach(() => {
             // setup stubs
-            stubDownloadTool = sinon.stub(toolLib, "downloadTool");
+            stubDownloadTool = sinon.stub(toolLib, "downloadToolWithRetries");
             stubDownloadTool.callsFake((url, fileName?, handlers?) => {
                 return Promise.resolve("/path/to/script");
             });

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import * as taskLib from "azure-pipelines-task-lib/task";`
`4`	`4`	`import * as toolLib from "azure-pipelines-tool-lib/tool";`
`5`	`5`	`import * as path from "path";`
`6`	`6`
`7`		`-export async function downloadTool(url: string, fileName: string): Promise<string> {`
	`7`	`+export async function downloadToolWithRetries(url: string, fileName: string): Promise<string> {`
`8`	`8`	`let destPath: string;`
`9`	`9`	`if (path.isAbsolute(fileName)) {`
`10`	`10`	`destPath = fileName;`
`@@ -17,6 +17,6 @@ export async function downloadTool(url: string, fileName: string): Promise<strin`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`taskLib.rmRF(destPath);`
`20`		`- await toolLib.downloadTool(url, destPath);`
	`20`	`+ await toolLib.downloadToolWithRetries(url, destPath);`
`21`	`21`	`return destPath;`
`22`	`22`	`}`