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

package/internal.js

@@ -1,6 +1,7 @@
 "use strict";
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._exposeCertSettings = exports._exposeProxySettings = exports._normalizeSeparators = exports._isRooted = exports._getDirectoryName = exports._ensureRooted = exports._isUncPath = exports._loadData = exports._ensurePatternRooted = exports._getFindInfoFromPattern = exports._cloneMatchOptions = exports._legacyFindFiles_convertPatternToRegExp = exports._which = exports._checkPath = exports._exist = exports._debug = exports._error = exports._warning = exports._command = exports._getVariableKey = exports._getVariable = exports._loc = exports._setResourcePath = exports._setErrStream = exports._setStdStream = exports._writeLine = exports._endsWith = exports._startsWith = exports._vault = exports._knownVariableMap = void 0;
+exports.isSigPipeError = exports._exposeCertSettings = exports._exposeProxySettings = exports._normalizeSeparators = exports._isRooted = exports._getDirectoryName = exports._ensureRooted = exports._isUncPath = exports._loadData = exports._ensurePatternRooted = exports._getFindInfoFromPattern = exports._cloneMatchOptions = exports._legacyFindFiles_convertPatternToRegExp = exports._which = exports._checkPath = exports._exist = exports._debug = exports._error = exports._warning = exports._command = exports._getVariableKey = exports._getVariable = exports._loc = exports._setResourcePath = exports._setErrStream = exports._setStdStream = exports._writeLine = exports._truncateBeforeSensitiveKeyword = exports._endsWith = exports._startsWith = exports.IssueAuditAction = exports.IssueSource = exports._vault = exports._knownVariableMap = void 0;
 var fs = require("fs");
 var path = require("path");
 var os = require("os");
@@ -20,12 +21,26 @@ var crypto = require("crypto");
  *  3) to know the real variable name and not just the formatted env var name.
  */
 exports._knownVariableMap = {};
+var _commandCorrelationId;
+//-----------------------------------------------------
+// Enums
+//-----------------------------------------------------
+var IssueSource;
+(function (IssueSource) {
+    IssueSource["CustomerScript"] = "CustomerScript";
+    IssueSource["TaskInternal"] = "TaskInternal";
+})(IssueSource = exports.IssueSource || (exports.IssueSource = {}));
+var IssueAuditAction;
+(function (IssueAuditAction) {
+    IssueAuditAction[IssueAuditAction["Unknown"] = 0] = "Unknown";
+    IssueAuditAction[IssueAuditAction["ShellTasksValidation"] = 1] = "ShellTasksValidation";
+})(IssueAuditAction = exports.IssueAuditAction || (exports.IssueAuditAction = {}));
 //-----------------------------------------------------
 // Validation Checks
 //-----------------------------------------------------
 // async await needs generators in node 4.x+
 if (semver.lt(process.versions.node, '4.2.0')) {
-    _warning('Tasks require a new agent.  Upgrade your agent or node to 4.2.0 or later');
+    _warning('Tasks require a new agent.  Upgrade your agent or node to 4.2.0 or later', IssueSource.TaskInternal);
 }
 //-----------------------------------------------------
 // String convenience
@@ -38,6 +53,17 @@ function _endsWith(str, end) {
     return str.slice(-end.length) == end;
 }
 exports._endsWith = _endsWith;
+function _truncateBeforeSensitiveKeyword(str, sensitiveKeywordsPattern) {
+    if (!str) {
+        return str;
+    }
+    var index = str.search(sensitiveKeywordsPattern);
+    if (index <= 0) {
+        return str;
+    }
+    return "".concat(str.substring(0, index), "...");
+}
+exports._truncateBeforeSensitiveKeyword = _truncateBeforeSensitiveKeyword;
 //-----------------------------------------------------
 // General Helpers
 //-----------------------------------------------------
@@ -116,7 +142,7 @@ function _loadLocStrings(resourceFile, culture) {
         }
     }
     else {
-        _warning('LIB_ResourceFile does not exist');
+        _warning('LIB_ResourceFile does not exist', IssueSource.TaskInternal);
     }
     return locStrings;
 }
@@ -148,10 +174,9 @@ function _setResourcePath(path, ignoreWarnings) {
     }
     else {
         if (ignoreWarnings) {
-            _debug(_loc('LIB_ResourceFileAlreadySet', path));
         }
         else {
-            _warning(_loc('LIB_ResourceFileAlreadySet', path));
+            _warning(_loc('LIB_ResourceFileAlreadySet', path), IssueSource.TaskInternal);
         }
     }
 }
@@ -185,10 +210,10 @@ function _loc(key) {
     }
     else {
         if (Object.keys(_resourceFiles).length <= 0) {
-            _warning("Resource file haven't been set, can't find loc string for key: " + key);
+            _warning("Resource file haven't been set, can't find loc string for key: ".concat(key), IssueSource.TaskInternal);
         }
         else {
-            _warning("Can't find loc string for key: " + key);
+            _warning("Can't find loc string for key: ".concat(key));
         }
         locString = key;
     }
@@ -248,16 +273,33 @@ function _command(command, properties, message) {
     _writeLine(taskCmd.toString());
 }
 exports._command = _command;
-function _warning(message) {
-    _command('task.issue', { 'type': 'warning' }, message);
+function _warning(message, source, auditAction) {
+    if (source === void 0) { source = IssueSource.TaskInternal; }
+    _command('task.issue', {
+        'type': 'warning',
+        'source': source,
+        'correlationId': _commandCorrelationId,
+        'auditAction': auditAction
+    }, message);
 }
 exports._warning = _warning;
-function _error(message) {
-    _command('task.issue', { 'type': 'error' }, message);
+function _error(message, source, auditAction) {
+    if (source === void 0) { source = IssueSource.TaskInternal; }
+    _command('task.issue', {
+        'type': 'error',
+        'source': source,
+        'correlationId': _commandCorrelationId,
+        'auditAction': auditAction
+    }, message);
 }
 exports._error = _error;
+var debugMode = ((_a = _getVariable('system.debug')) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'true';
+var shouldCheckDebugMode = ((_b = _getVariable('DistributedTask.Tasks.Node.SkipDebugLogsWhenDebugModeOff')) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === 'true';
 function _debug(message) {
-    _command('task.debug', null, message);
+    if (!shouldCheckDebugMode
+        || (shouldCheckDebugMode && debugMode)) {
+        _command('task.debug', null, message);
+    }
 }
 exports._debug = _debug;
 // //-----------------------------------------------------
@@ -327,7 +369,7 @@ function _which(tool, check) {
             }
         }
     }
-    _debug("which '" + tool + "'");
+    _debug("which '".concat(tool, "'"));
     try {
         // build the list of extensions to try
         var extensions = [];
@@ -343,7 +385,7 @@ function _which(tool, check) {
         if (_isRooted(tool)) {
             var filePath = _tryGetExecutablePath(tool, extensions);
             if (filePath) {
-                _debug("found: '" + filePath + "'");
+                _debug("found: '".concat(filePath, "'"));
                 return filePath;
             }
             _debug('not found');
@@ -374,7 +416,7 @@ function _which(tool, check) {
             var directory = directories_1[_d];
             var filePath = _tryGetExecutablePath(directory + path.sep + tool, extensions);
             if (filePath) {
-                _debug("found: '" + filePath + "'");
+                _debug("found: '".concat(filePath, "'"));
                 return filePath;
             }
         }
@@ -418,7 +460,7 @@ function _tryGetExecutablePath(filePath, extensions) {
     }
     catch (err) {
         if (err.code != 'ENOENT') {
-            _debug("Unexpected error attempting to determine if executable file exists '" + filePath + "': " + err);
+            _debug("Unexpected error attempting to determine if executable file exists '".concat(filePath, "': ").concat(err));
         }
     }
     // try each extension
@@ -444,7 +486,7 @@ function _tryGetExecutablePath(filePath, extensions) {
                         }
                     }
                     catch (err) {
-                        _debug("Unexpected error attempting to determine the actual case of the file '" + filePath_1 + "': " + err);
+                        _debug("Unexpected error attempting to determine the actual case of the file '".concat(filePath_1, "': ").concat(err));
                     }
                     return filePath_1;
                 }
@@ -457,7 +499,7 @@ function _tryGetExecutablePath(filePath, extensions) {
         }
         catch (err) {
             if (err.code != 'ENOENT') {
-                _debug("Unexpected error attempting to determine if executable file exists '" + filePath_1 + "': " + err);
+                _debug("Unexpected error attempting to determine if executable file exists '".concat(filePath_1, "': ").concat(err));
             }
         }
     }
@@ -476,7 +518,7 @@ function _legacyFindFiles_convertPatternToRegExp(pattern) {
         .replace(/\\\*\\\*/g, '.*') // replace remaining globstars with a wildcard that can span directory separators, e.g. /hello/**dll
         .replace(/\\\*/g, '[^\/]*') // replace asterisks with a wildcard that cannot span directory separators, e.g. /hello/*.dll
         .replace(/\\\?/g, '[^\/]'); // replace single character wildcards, e.g. /hello/log?.dll
-    pattern = "^" + pattern + "$";
+    pattern = "^".concat(pattern, "$");
     var flags = process.platform == 'win32' ? 'i' : '';
     return new RegExp(pattern, flags);
 }
@@ -642,6 +684,9 @@ function _loadData() {
         }
     }
     _debug('loaded ' + loaded);
+    var correlationId = process.env["COMMAND_CORRELATION_ID"];
+    delete process.env["COMMAND_CORRELATION_ID"];
+    _commandCorrelationId = correlationId ? String(correlationId) : "";
     // store public variable metadata
     var names;
     try {
@@ -876,10 +921,18 @@ function _exposeTaskLibSecret(keyFile, secret) {
     if (secret) {
         var encryptKey = crypto.randomBytes(256);
         var cipher = crypto.createCipher("aes-256-ctr", encryptKey);
-        var encryptedContent = cipher.update(secret, "utf8", "hex");
+        var encryptedContent = cipher.update(secret, "utf8", "hex"); // CodeQL [SM01511] agent need to retrieve password later to connect to proxy server
         encryptedContent += cipher.final("hex");
         var storageFile = path.join(_getVariable('Agent.TempDirectory') || _getVariable("agent.workFolder") || process.cwd(), keyFile);
         fs.writeFileSync(storageFile, encryptKey.toString('base64'), { encoding: 'utf8' });
         return new Buffer(storageFile).toString('base64') + ':' + new Buffer(encryptedContent).toString('base64');
     }
 }
+function isSigPipeError(e) {
+    var _a;
+    if (!e || typeof e !== 'object') {
+        return false;
+    }
+    return e.code === 'EPIPE' && ((_a = e.syscall) === null || _a === void 0 ? void 0 : _a.toUpperCase()) === 'WRITE';
+}
+exports.isSigPipeError = isSigPipeError;

package/lib.json

@@ -1,37 +1,41 @@
 {
   "messages": {
-    "LIB_UnhandledEx": "Unhandled: %s",
+    "LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s",
+    "LIB_DirectoryStackEmpty": "Directory stack is empty",
+    "LIB_EndpointAuthNotExist": "Endpoint auth data not present: %s",
+    "LIB_EndpointDataNotExist": "Endpoint data parameter %s not present: %s",
+    "LIB_EndpointNotExist": "Endpoint not present: %s",
     "LIB_FailOnCode": "Failure return code: %d",
+    "LIB_InputRequired": "Input required: %s",
+    "LIB_InvalidEndpointAuth": "Invalid endpoint auth: %s",
+    "LIB_InvalidPattern": "Invalid pattern: '%s'",
+    "LIB_InvalidSecureFilesInput": "Invalid secure file input: %s",
+    "LIB_LocStringNotFound": "Can\\'t find loc string for key: %s",
+    "LIB_MergeTestResultNotSupported": "Merging test results from multiple files to one test run is not supported on this version of build agent for OSX/Linux, each test result file will be published as a separate test run in VSO/TFS.",
     "LIB_MkdirFailed": "Unable to create directory '%s'. %s",
     "LIB_MkdirFailedFileExists": "Unable to create directory '%s'. Conflicting file exists: '%s'",
     "LIB_MkdirFailedInvalidDriveRoot": "Unable to create directory '%s'. Root directory does not exist: '%s'",
     "LIB_MkdirFailedInvalidShare": "Unable to create directory '%s'. Unable to verify the directory exists: '%s'. If directory is a file share, please verify the share name is correct, the share is online, and the current process has permission to access the share.",
     "LIB_MultilineSecret": "Secrets cannot contain multiple lines",
+    "LIB_NotFoundPreviousDirectory": "Could not find previous directory",
+    "LIB_OperationFailed": "Failed %s: %s",
+    "LIB_ParameterIsRequired": "%s not supplied",
+    "LIB_PathHasNullByte": "Path cannot contain null bytes",
+    "LIB_PathIsNotADirectory": "Path is not a directory: %s",
+    "LIB_PathNotFound": "Not found %s: %s",
+    "LIB_PlatformNotSupported": "Platform not supported: %s",
     "LIB_ProcessError": "There was an error when attempting to execute the process '%s'. This may indicate the process failed to start. Error: %s",
     "LIB_ProcessExitCode": "The process '%s' failed with exit code %s",
     "LIB_ProcessStderr": "The process '%s' failed because one or more lines were written to the STDERR stream",
-    "LIB_ReturnCode": "Return code: %d",
-    "LIB_ResourceFileNotExist": "Resource file doesn\\'t exist: %s",
     "LIB_ResourceFileAlreadySet": "Resource file has already set to: %s",
+    "LIB_ResourceFileNotExist": "Resource file doesn\\'t exist: %s",
     "LIB_ResourceFileNotSet": "Resource file haven\\'t set, can\\'t find loc string for key: %s",
+    "LIB_ReturnCode": "Return code: %d",
     "LIB_StdioNotClosed": "The STDIO streams did not close within %s seconds of the exit event from process '%s'. This may indicate a child process inherited the STDIO streams and has not yet exited.",
-    "LIB_WhichNotFound_Linux": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.",
-    "LIB_WhichNotFound_Win": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.",
-    "LIB_LocStringNotFound": "Can\\'t find loc string for key: %s",
-    "LIB_ParameterIsRequired": "%s not supplied",
-    "LIB_InputRequired": "Input required: %s",
-    "LIB_InvalidPattern": "Invalid pattern: '%s'",
-    "LIB_EndpointNotExist": "Endpoint not present: %s",
-    "LIB_EndpointDataNotExist": "Endpoint data parameter %s not present: %s",
-    "LIB_EndpointAuthNotExist": "Endpoint auth data not present: %s",
-    "LIB_InvalidEndpointAuth": "Invalid endpoint auth: %s",
-    "LIB_InvalidSecureFilesInput": "Invalid secure file input: %s",
-    "LIB_PathNotFound": "Not found %s: %s",
-    "LIB_PathHasNullByte": "Path cannot contain null bytes",
-    "LIB_OperationFailed": "Failed %s: %s",
+    "LIB_UndefinedNodeVersion": "Node version is undefined.",
+    "LIB_UnhandledEx": "Unhandled: %s",
     "LIB_UseFirstGlobMatch": "Multiple workspace matches. using first.",
-    "LIB_MergeTestResultNotSupported": "Merging test results from multiple files to one test run is not supported on this version of build agent for OSX/Linux, each test result file will be published as a separate test run in VSO/TFS.",
-    "LIB_PlatformNotSupported": "Platform not supported: %s",
-    "LIB_CopyFileFailed": "Error while copying the file. Attempts left: %s"
-  } 
-}
+    "LIB_WhichNotFound_Linux": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.",
+    "LIB_WhichNotFound_Win": "Unable to locate executable file: '%s'. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file."
+  }
+}

package/mock-answer.d.ts

@@ -26,6 +26,9 @@ export interface TaskLibAnswers {
     getPlatform?: {
         [key: string]: task.Platform;
     };
+    getNodeMajorVersion?: {
+        [key: string]: Number;
+    };
     getAgentMode?: {
         [key: string]: task.AgentHostedMode;
     };
@@ -50,7 +53,7 @@ export interface TaskLibAnswers {
         [key: string]: string;
     };
 }
-export declare type MockedCommand = keyof TaskLibAnswers;
+export type MockedCommand = keyof TaskLibAnswers;
 export declare class MockAnswers {
     private _answers;
     initialize(answers: TaskLibAnswers): void;

package/mock-answer.js

@@ -11,12 +11,12 @@ var MockAnswers = /** @class */ (function () {
         this._answers = answers;
     };
     MockAnswers.prototype.getResponse = function (cmd, key, debug) {
-        debug("looking up mock answers for " + JSON.stringify(cmd) + ", key '" + JSON.stringify(key) + "'");
+        debug("looking up mock answers for ".concat(JSON.stringify(cmd), ", key '").concat(JSON.stringify(key), "'"));
         if (!this._answers) {
             throw new Error('Must initialize');
         }
         if (!this._answers[cmd]) {
-            debug("no mock responses registered for " + JSON.stringify(cmd));
+            debug("no mock responses registered for ".concat(JSON.stringify(cmd)));
             return null;
         }
         var cmd_answer = this._answers[cmd];

package/mock-task.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import Q = require('q');
 import fs = require('fs');
 import task = require('./task');
@@ -58,6 +59,7 @@ export interface FsOptions {
 export declare function writeFile(file: string, data: string | Buffer, options?: string | FsOptions): void;
 export declare function osType(): string;
 export declare function getPlatform(): task.Platform;
+export declare function getNodeMajorVersion(): Number;
 export declare function getAgentMode(): task.AgentHostedMode;
 export declare function cwd(): string;
 export declare function cd(path: string): void;
@@ -74,6 +76,7 @@ export declare function find(findPath: string): string[];
 export declare function rmRF(path: string): void;
 export declare function mv(source: string, dest: string, force: boolean, continueOnError?: boolean): boolean;
 export declare function exec(tool: string, args: any, options?: trm.IExecOptions): Q.Promise<number>;
+export declare function execAsync(tool: string, args: any, options?: trm.IExecOptions): Promise<number>;
 export declare function execSync(tool: string, args: any, options?: trm.IExecSyncOptions): trm.IExecSyncResult;
 export declare function tool(tool: string): trm.ToolRunner;
 export interface MatchOptions {

package/mock-task.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.legacyFindFiles = exports.findMatch = exports.tool = exports.execSync = exports.exec = exports.mv = exports.rmRF = exports.find = exports.retry = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.checkPath = exports.popd = exports.pushd = exports.cd = exports.cwd = exports.getAgentMode = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.FsStats = exports.loc = exports.setResourcePath = exports.setAnswers = void 0;
+exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.legacyFindFiles = exports.findMatch = exports.tool = exports.execSync = exports.execAsync = exports.exec = exports.mv = exports.rmRF = exports.find = exports.retry = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.checkPath = exports.popd = exports.pushd = exports.cd = exports.cwd = exports.getAgentMode = exports.getNodeMajorVersion = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.FsStats = exports.loc = exports.setResourcePath = exports.setAnswers = void 0;
 var path = require("path");
 var task = require("./task");
 var tcm = require("./taskcommand");
@@ -27,6 +27,7 @@ module.exports.Platform = task.Platform;
 module.exports.setStdStream = task.setStdStream;
 module.exports.setErrStream = task.setErrStream;
 module.exports.setResult = task.setResult;
+module.exports.setSanitizedResult = task.setSanitizedResult;
 //-----------------------------------------------------
 // Loc Helpers
 //-----------------------------------------------------
@@ -60,6 +61,7 @@ module.exports.getInput = task.getInput;
 module.exports.getInputRequired = task.getInputRequired;
 module.exports.getBoolInput = task.getBoolInput;
 module.exports.getBoolFeatureFlag = task.getBoolFeatureFlag;
+module.exports.getPipelineFeature = task.getPipelineFeature;
 module.exports.getDelimitedInput = task.getDelimitedInput;
 module.exports.filePathSupplied = task.filePathSupplied;
 function getPathInput(name, required, check) {
@@ -189,6 +191,10 @@ function getPlatform() {
     return mock.getResponse('getPlatform', 'getPlatform', module.exports.debug);
 }
 exports.getPlatform = getPlatform;
+function getNodeMajorVersion() {
+    return mock.getResponse('getNodeMajorVersion', 'getNodeMajorVersion', module.exports.debug);
+}
+exports.getNodeMajorVersion = getNodeMajorVersion;
 function getAgentMode() {
     return mock.getResponse('getAgentMode', 'getAgentMode', module.exports.debug);
 }
@@ -267,7 +273,7 @@ function cp(source, dest) {
 }
 exports.cp = cp;
 function retry(func, args, retryOptions) {
-    module.exports.debug("trying to execute " + (func === null || func === void 0 ? void 0 : func.name) + "(" + args.toString() + ") with " + retryOptions.retryCount + " retries");
+    module.exports.debug("trying to execute ".concat(func === null || func === void 0 ? void 0 : func.name, "(").concat(args.toString(), ") with ").concat(retryOptions.retryCount, " retries"));
 }
 exports.retry = retry;
 function find(findPath) {
@@ -299,6 +305,18 @@ function exec(tool, args, options) {
     return tr.exec(options);
 }
 exports.exec = exec;
+//-----------------------------------------------------
+// Exec convenience wrapper
+//-----------------------------------------------------
+function execAsync(tool, args, options) {
+    var toolPath = which(tool, true);
+    var tr = this.tool(toolPath);
+    if (args) {
+        tr.arg(args);
+    }
+    return tr.execAsync(options);
+}
+exports.execAsync = execAsync;
 function execSync(tool, args, options) {
     var toolPath = which(tool, true);
     var tr = this.tool(toolPath);

package/mock-test.d.ts

@@ -1,5 +1,5 @@
 export declare class MockTestRunner {
-    constructor(testPath: string, taskJsonPath?: string);
+    constructor(testPath?: string, taskJsonPath?: string);
     private _testPath;
     private _taskJsonPath;
     nodePath: string;
@@ -10,13 +10,14 @@ export declare class MockTestRunner {
     succeeded: boolean;
     errorIssues: string[];
     warningIssues: string[];
+    LoadAsync(testPath?: string, taskJsonPath?: string): Promise<MockTestRunner>;
     get failed(): boolean;
     ran(cmdline: string): boolean;
     createdErrorIssue(message: string): boolean;
     createdWarningIssue(message: string): boolean;
     stdOutContained(message: string): boolean;
     stdErrContained(message: string): boolean;
-    run(nodeVersion?: number): void;
+    runAsync(nodeVersion?: number): Promise<void>;
     private getNodePath;
     private getNodeVersion;
     private getTaskJsonPath;