Add handlers option to downloadTool (#53)

* Add handlers option to downloadTool

* Add handlers to scrape

Author: RobiNino

test/tests/toolTests.ts

@@ -3,6 +3,7 @@ import path = require('path');
 import fs = require('fs');
 import shell = require('shelljs');
 import os = require('os');
+import hm = require('typed-rest-client/Handlers');
 
 import * as mocha from 'mocha';
 process.env['AGENT_VERSION'] = '2.115.0';
@@ -171,4 +172,38 @@ describe('Tool Tests', function () {
             }
         });
     });
+
+    it('download with basic authentication', function () {
+        this.timeout(2000);
+
+        return new Promise<void>(async (resolve, reject) => {
+            // General parameters:
+            let username: string = "usr";
+            let correctPassword: string = "pass";
+            let url: string = "http://httpbin.org/basic-auth/" + username + "/" + correctPassword;
+
+            // First try downloading with WRONG credentials and verify receiving status code 401:
+            try {
+                let basicAuthHandler: hm.BasicCredentialHandler[] = [new hm.BasicCredentialHandler(username, "WrongPassword")];
+                let downPath: string = await toolLib.downloadTool(url, null, basicAuthHandler);
+
+                reject(new Error('Should have received status code 401 when downloading with bad credentials'));
+            }
+            catch (err){
+                try {
+                    assert.equal(err['httpStatusCode'], 401, 'Should have received status code 401 when downloading with bad credentials');
+
+                    // Then try downloading with the CORRECT credentials and verify file downloaded:
+                    let basicAuthHandler: hm.BasicCredentialHandler[] = [new hm.BasicCredentialHandler(username, correctPassword)];
+                    let downPath: string = await toolLib.downloadTool(url, null, basicAuthHandler);
+
+                    assert(tl.exist(downPath), 'File should have been downloaded');
+                    resolve()
+                }
+                catch (err){
+                    reject(err);
+                }
+            }
+        });
+    });
 });

tool.ts

@@ -19,7 +19,6 @@ let requestOptions = {
     proxy: tl.getHttpProxyConfiguration(),
     cert: tl.getHttpCertConfiguration()
 } as ifm.IRequestOptions;
-let http: httpm.HttpClient = new httpm.HttpClient(userAgent, null, requestOptions);
 tl.setResourcePath(path.join(__dirname, 'lib.json'));
 
 export function debug(message: string): void {
@@ -194,10 +193,13 @@ export function findLocalToolVersions(toolName: string, arch?: string) {
  *
  * @param url       url of tool to download
  * @param fileName  optional fileName.  Should typically not use (will be a guid for reliability). Can pass fileName with an absolute path.
+ * @param handlers  optional handlers array.  Auth handlers to pass to the HttpClient for the tool download.
  */
-export async function downloadTool(url: string, fileName?: string): Promise<string> {
+export async function downloadTool(url: string, fileName?: string, handlers?: ifm.IRequestHandler[]): Promise<string> {
     return new Promise<string>(async (resolve, reject) => {
         try {
+            handlers = handlers || null;
+            let http: httpm.HttpClient = new httpm.HttpClient(userAgent, handlers, requestOptions);
             tl.debug(fileName);
             fileName = fileName || uuidV4();
 
@@ -519,8 +521,11 @@ function _createExtractFolder(dest?: string): string {
  *
  * @param url       url to scrape
  * @param regex     regex to use for version matches
+ * @param handlers  optional handlers array.  Auth handlers to pass to the HttpClient for the tool download.
  */
-export async function scrape(url: string, regex: RegExp): Promise<string[]> {
+export async function scrape(url: string, regex: RegExp, handlers?: ifm.IRequestHandler[]): Promise<string[]> {
+    handlers = handlers || null;
+    let http: httpm.HttpClient = new httpm.HttpClient(userAgent, handlers, requestOptions);
     let output: string = await (await http.get(url)).readBody();
 
     let matches = output.match(regex);
@@ -556,4 +561,4 @@ function _getAgentTemp(): string {
     }
 
     return tempDirectory;
-}
+}