azure-pipelines-task-lib 5.0.0-preview.0 → 5.0.0

package/mock-toolrunner.js

@@ -7,6 +7,8 @@ var __extends = (this && this.__extends) || (function () {
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
@@ -130,6 +132,99 @@ var ToolRunner = /** @class */ (function (_super) {
     // Exec - use for long running tools where you need to stream live output as it runs
     //        returns a promise with return code.
     //
+    ToolRunner.prototype.execAsync = function (options) {
+        var _this = this;
+        this._debug('exec tool: ' + this.toolPath);
+        this._debug('Arguments:');
+        this.args.forEach(function (arg) {
+            _this._debug('   ' + arg);
+        });
+        var success = true;
+        options = options || {};
+        var ops = {
+            cwd: options.cwd || process.cwd(),
+            env: options.env || process.env,
+            silent: options.silent || false,
+            outStream: options.outStream || process.stdout,
+            errStream: options.errStream || process.stderr,
+            failOnStdErr: options.failOnStdErr || false,
+            ignoreReturnCode: options.ignoreReturnCode || false,
+            windowsVerbatimArguments: options.windowsVerbatimArguments
+        };
+        var argString = this.args.join(' ') || '';
+        var cmdString = this.toolPath;
+        if (argString) {
+            cmdString += (' ' + argString);
+        }
+        // Using split/join to replace the temp path
+        cmdString = this.ignoreTempPath(cmdString);
+        if (!ops.silent) {
+            if (this.pipeOutputToTool) {
+                var pipeToolArgString = this.pipeOutputToTool.args.join(' ') || '';
+                var pipeToolCmdString = this.ignoreTempPath(this.pipeOutputToTool.toolPath);
+                if (pipeToolArgString) {
+                    pipeToolCmdString += (' ' + pipeToolArgString);
+                }
+                cmdString += ' | ' + pipeToolCmdString;
+            }
+            ops.outStream.write('[command]' + cmdString + os.EOL);
+        }
+        // TODO: filter process.env
+        var res = mock.getResponse('exec', cmdString, debug);
+        if (res.stdout) {
+            this.emit('stdout', res.stdout);
+            if (!ops.silent) {
+                ops.outStream.write(res.stdout + os.EOL);
+            }
+            var stdLineArray = res.stdout.split(os.EOL);
+            for (var _i = 0, _a = stdLineArray.slice(0, -1); _i < _a.length; _i++) {
+                var line = _a[_i];
+                this.emit('stdline', line);
+            }
+            if (stdLineArray.length > 0 && stdLineArray[stdLineArray.length - 1].length > 0) {
+                this.emit('stdline', stdLineArray[stdLineArray.length - 1]);
+            }
+        }
+        if (res.stderr) {
+            this.emit('stderr', res.stderr);
+            success = !ops.failOnStdErr;
+            if (!ops.silent) {
+                var s = ops.failOnStdErr ? ops.errStream : ops.outStream;
+                s.write(res.stderr + os.EOL);
+            }
+            var stdErrArray = res.stderr.split(os.EOL);
+            for (var _b = 0, _c = stdErrArray.slice(0, -1); _b < _c.length; _b++) {
+                var line = _c[_b];
+                this.emit('errline', line);
+            }
+            if (stdErrArray.length > 0 && stdErrArray[stdErrArray.length - 1].length > 0) {
+                this.emit('errline', stdErrArray[stdErrArray.length - 1]);
+            }
+        }
+        var code = res.code;
+        if (!ops.silent) {
+            ops.outStream.write('rc:' + res.code + os.EOL);
+        }
+        if (code != 0 && !ops.ignoreReturnCode) {
+            success = false;
+        }
+        if (!ops.silent) {
+            ops.outStream.write('success:' + success + os.EOL);
+        }
+        return new Promise(function (resolve, reject) {
+            if (success) {
+                resolve(code);
+            }
+            else {
+                reject(new Error(_this.toolPath + ' failed with return code: ' + code));
+            }
+        });
+    };
+    /**
+     * Exec - use for long running tools where you need to stream live output as it runs
+     * @deprecated use `execAsync` instead
+     * @returns a promise with return code.
+     */
     ToolRunner.prototype.exec = function (options) {
         var _this = this;
         var defer = Q.defer();
@@ -224,7 +319,6 @@ var ToolRunner = /** @class */ (function (_super) {
     //
     ToolRunner.prototype.execSync = function (options) {
         var _this = this;
-        var defer = Q.defer();
         this._debug('exec tool: ' + this.toolPath);
         this._debug('Arguments:');
         this.args.forEach(function (arg) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "5.0.0-preview.0",
+  "version": "5.0.0",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",
@@ -27,11 +27,12 @@
   },
   "homepage": "https://github.com/Microsoft/azure-pipelines-task-lib",
   "dependencies": {
+    "adm-zip": "^0.5.10",
     "minimatch": "3.0.5",
+    "nodejs-file-downloader": "^4.11.1",
     "q": "^1.5.1",
-    "semver": "^5.1.0",
+    "semver": "^5.7.2",
     "shelljs": "^0.8.5",
-    "sync-request": "6.1.0",
     "uuid": "^3.0.1"
   },
   "devDependencies": {

package/task.d.ts

@@ -1,8 +1,11 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import Q = require('q');
 import fs = require('fs');
 import im = require('./internal');
 import trm = require('./toolrunner');
+type OptionCases<T extends string> = `-${Uppercase<T> | Lowercase<T>}`;
+type OptionsPermutations<T extends string, U extends string = ''> = T extends `${infer First}${infer Rest}` ? OptionCases<`${U}${First}`> | OptionCases<`${First}${U}`> | OptionsPermutations<Rest, `${U}${First}`> | OptionCases<First> : OptionCases<U> | '';
 export declare enum TaskResult {
     Succeeded = 0,
     SucceededWithIssues = 1,
@@ -32,6 +35,7 @@ export declare enum FieldType {
     DataParameter = 1,
     Url = 2
 }
+export declare const IssueSource: typeof im.IssueSource;
 /** Platforms supported by our build agent */
 export declare enum Platform {
     Windows = 0,
@@ -60,6 +64,18 @@ export declare const setErrStream: typeof im._setErrStream;
  */
 export declare function setResult(result: TaskResult.Succeeded, message?: string, done?: boolean): void;
 export declare function setResult(result: Exclude<TaskResult, 'Succeeded'>, message: string, done?: boolean): void;
+/**
+ * Sets the result of the task with sanitized message.
+ *
+ * @param result    TaskResult enum of Succeeded, SucceededWithIssues, Failed, Cancelled or Skipped.
+ * @param message   A message which will be logged as an error issue if the result is Failed. Message will be truncated
+ *                  before first occurence of wellknown sensitive keyword.
+ * @param done      Optional. Instructs the agent the task is done. This is helpful when child processes
+ *                  may still be running and prevent node from fully exiting. This argument is supported
+ *                  from agent version 2.142.0 or higher (otherwise will no-op).
+ * @returns         void
+ */
+export declare function setSanitizedResult(result: TaskResult, message: string, done?: boolean): void;
 export declare const setResourcePath: typeof im._setResourcePath;
 export declare const loc: typeof im._loc;
 export declare const getVariable: typeof im._getVariable;
@@ -134,12 +150,20 @@ export declare function getInputRequired(name: string): string;
 export declare function getBoolInput(name: string, required?: boolean): boolean;
 /**
  * Gets the value of an feature flag and converts to a bool.
- *
+ * @IMPORTANT This method is only for internal Microsoft development. Do not use it for external tasks.
  * @param     name     name of the feature flag to get.
  * @param     defaultValue default value of the feature flag in case it's not found in env. (optional. Default value = false)
  * @returns   boolean
+ * @deprecated Don't use this for new development. Use getPipelineFeature instead.
  */
 export declare function getBoolFeatureFlag(ffName: string, defaultValue?: boolean): boolean;
+/**
+ * Gets the value of an task feature and converts to a bool.
+ * @IMPORTANT This method is only for internal Microsoft development. Do not use it for external tasks.
+ * @param     name     name of the feature to get.
+ * @returns   boolean
+ */
+export declare function getPipelineFeature(featureName: string): boolean;
 /**
  * Gets the value of an input and splits the value using a delimiter (space, comma, etc).
  * Empty values are removed.  This function is useful for splitting an input containing a simple
@@ -298,8 +322,6 @@ export declare const command: typeof im._command;
 export declare const warning: typeof im._warning;
 export declare const error: typeof im._error;
 export declare const debug: typeof im._debug;
-export interface FsStats extends fs.Stats {
-}
 /**
  * Get's stat on a path.
  * Useful for checking whether a file or directory.  Also getting created, modified and accessed time.
@@ -308,7 +330,7 @@ export interface FsStats extends fs.Stats {
  * @param     path      path to check
  * @returns   fsStat
  */
-export declare function stats(path: string): FsStats;
+export declare function stats(path: string): fs.Stats;
 export declare const exist: typeof im._exist;
 export declare function writeFile(file: string, data: string | Buffer, options?: BufferEncoding | fs.WriteFileOptions): void;
 /**
@@ -325,6 +347,11 @@ export declare function osType(): string;
  * @throws {Error} Platform is not supported by our agent
  */
 export declare function getPlatform(): Platform;
+/**
+ * Resolves major version of Node.js engine used by the agent.
+ * @returns {Number} Node's major version.
+ */
+export declare function getNodeMajorVersion(): Number;
 /**
  * Return hosted type of Agent
  * @returns {AgentHostedMode}
@@ -341,29 +368,30 @@ export declare const checkPath: typeof im._checkPath;
 /**
  * Change working directory.
  *
- * @param     path      new working directory path
- * @returns   void
+ * @param   {string} path - New working directory path
+ * @returns {void}
  */
 export declare function cd(path: string): void;
 /**
  * Change working directory and push it on the stack
  *
- * @param     path      new working directory path
- * @returns   void
+ * @param   {string} dir - New working directory path
+ * @returns {void}
  */
-export declare function pushd(path: string): void;
+export declare function pushd(dir?: string): string[];
 /**
  * Change working directory back to previously pushed directory
  *
- * @returns   void
+ * @param   {string} index - Index to remove from the stack
+ * @returns {void}
  */
-export declare function popd(): void;
+export declare function popd(index?: string): string[];
 /**
- * Make a directory.  Creates the full path with folders in between
+ * Make a directory. Creates the full path with folders in between
  * Will throw if it fails
  *
- * @param     p       path to create
- * @returns   void
+ * @param   {string} p - Path to create
+ * @returns {void}
  */
 export declare function mkdirP(p: string): void;
 /**
@@ -375,32 +403,78 @@ export declare function mkdirP(p: string): void;
  */
 export declare function resolve(...pathSegments: any[]): string;
 export declare const which: typeof im._which;
+type ListOptionsVariants = OptionsPermutations<'ra'>;
+/**
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {ListOptionsVariants} options - Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
+ * @param  {...string[]}         paths   - Paths to search.
+ * @return {string[]}                    - An array of files in the given path(s).
+ */
+export declare function ls(options: ListOptionsVariants, ...paths: string[]): string[];
 /**
- * Returns array of files in the given path, or in current directory if no path provided.  See shelljs.ls
- * @param  {string}   options  Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
- * @param  {string[]} paths    Paths to search.
- * @return {string[]}          An array of files in the given path(s).
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {ListOptionsVariants} options - Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
+ * @param  {string[]}            paths   - Paths to search.
+ * @return {string[]}                    - An array of files in the given path(s).
  */
-export declare function ls(options: string, paths: string[]): string[];
+export declare function ls(options: ListOptionsVariants, paths: string[]): string[];
+/**
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {ListOptionsVariants} options - Available options: -R (recursive), -A (all files, include files beginning with ., except for . and ..)
+ * @param  {string}              paths   - Paths to search.
+ * @return {string[]}                    - An array of files in the given path(s).
+ */
+export declare function ls(options: ListOptionsVariants, paths: string): string[];
+/**
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {string}   path - Paths to search.
+ * @return {string[]}      - An array of files in the given path(s).
+ */
+export declare function ls(path: string): string[];
+/**
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {string[]} paths - Paths to search.
+ * @return {string[]}       - An array of files in the given path(s).
+ */
+export declare function ls(paths: string[]): string[];
+/**
+ * Returns array of files in the given path, or in current directory if no path provided.
+ * @param  {...string[]} paths - Paths to search.
+ * @return {string[]}          - An array of files in the given path(s).
+ */
+export declare function ls(...paths: string[]): string[];
+type CopyOptionsVariants = OptionsPermutations<'frn'>;
 /**
  * Copies a file or folder.
- *
- * @param     source     source path
- * @param     dest       destination path
- * @param     options    string -r, -f or -rf for recursive and force
- * @param     continueOnError optional. whether to continue on error
- * @param     retryCount optional. Retry count to copy the file. It might help to resolve intermittent issues e.g. with UNC target paths on a remote host.
+ * @param   {string}  source                   - Source path.
+ * @param   {string}  destination              - Destination path.
+ * @param   {string}  [options]                - Options string '-r', '-f' , '-n' or '-rfn' for recursive, force and no-clobber.
+ * @param   {boolean} [continueOnError=false]  - Optional. Whether to continue on error.
+ * @param   {number}  [retryCount=0]           - Optional. Retry count to copy the file. It might help to resolve intermittent issues e.g. with UNC target paths on a remote host.
+ * @returns {void}
+ */
+export declare function cp(source: string, destination: string, options?: CopyOptionsVariants, continueOnError?: boolean, retryCount?: number): void;
+/**
+ * Copies a file or folder.
+ * @param   {string}  options                  - Options string '-r', '-f' , '-n' or '-rfn' for recursive, force and no-clobber.
+ * @param   {string}  source                   - Source path.
+ * @param   {string}  [destination]            - Destination path.
+ * @param   {boolean} [continueOnError=false]  - Optional. Whether to continue on error.
+ * @param   {number}  [retryCount=0]           - Optional. Retry count to copy the file. It might help to resolve intermittent issues e.g. with UNC target paths on a remote host.
+ * @returns {void}
  */
-export declare function cp(source: string, dest: string, options?: string, continueOnError?: boolean, retryCount?: number): void;
+export declare function cp(options: CopyOptionsVariants, source: string, destination: string, continueOnError?: boolean, retryCount?: number): void;
+type MoveOptionsVariants = OptionsPermutations<'fn'>;
 /**
  * Moves a path.
  *
- * @param     source     source path
- * @param     dest       destination path
- * @param     options    string -f or -n for force and no clobber
- * @param     continueOnError optional. whether to continue on error
+ * @param  {string}              source            - Source path.
+ * @param  {string}              dest              - Destination path.
+ * @param  {MoveOptionsVariants} [options]         - Option string -f or -n for force and no clobber.
+ * @param  {boolean}             [continueOnError] - Optional. Whether to continue on error.
+ * @returns {void}
  */
-export declare function mv(source: string, dest: string, options?: string, continueOnError?: boolean): void;
+export declare function mv(source: string, dest: string, options?: MoveOptionsVariants, continueOnError?: boolean): void;
 /**
  * Interface for FindOptions
  * Contains properties to control whether to follow symlinks
@@ -472,8 +546,9 @@ export declare function legacyFindFiles(rootDirectory: string, pattern: string,
 /**
  * Remove a path recursively with force
  *
- * @param     inputPath path to remove
- * @throws    when the file or directory exists but could not be deleted.
+ * @param  {string} inputPath - Path to remove
+ * @return {void}
+ * @throws When the file or directory exists but could not be deleted.
  */
 export declare function rmRF(inputPath: string): void;
 /**
@@ -486,6 +561,18 @@ export declare function rmRF(inputPath: string): void;
  * @param     options  optional exec options.  See IExecOptions
  * @returns   number
  */
+export declare function execAsync(tool: string, args: any, options?: trm.IExecOptions): Promise<number>;
+/**
+ * Exec a tool.  Convenience wrapper over ToolRunner to exec with args in one call.
+ * Output will be streamed to the live console.
+ * Returns promise with return code
+ *
+ * @deprecated Use the {@link execAsync} method that returns a native Javascript Promise instead
+ * @param     tool     path to tool to exec
+ * @param     args     an arg string or array of args
+ * @param     options  optional exec options.  See IExecOptions
+ * @returns   number
+ */
 export declare function exec(tool: string, args: any, options?: trm.IExecOptions): Q.Promise<number>;
 /**
  * Exec a tool synchronously.  Convenience wrapper over ToolRunner to execSync with args in one call.
@@ -735,3 +822,4 @@ export declare function addBuildTag(value: string): void;
  * @returns         void
  */
 export declare function updateReleaseName(name: string): void;
+export {};