azure-pipelines-task-lib 4.1.0 → 4.3.0

package/README.md

@@ -13,9 +13,9 @@ Cross platform tasks are written in TypeScript.  It is the preferred way to writ
 
 Step by Step: [Create Task](https://docs.microsoft.com/en-us/azure/devops/extend/develop/add-build-task?view=vsts)
 
-Documentation: [TypeScript API](docs/azure-pipelines-task-lib.md), [task JSON schema](https://aka.ms/vsts-tasks.schema.json)
+Documentation: [TypeScript API](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/node/docs/azure-pipelines-task-lib.md), [task JSON schema](https://aka.ms/vsts-tasks.schema.json)
 
-Guidance: [Finding Files](docs/findingfiles.md), [Minimum agent version](docs/minagent.md), [Proxy](docs/proxy.md), [Certificate](docs/cert.md)
+Guidance: [Finding Files](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/node/docs/findingfiles.md), [Minimum agent version](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/node/docs/minagent.md), [Proxy](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/node/docs/proxy.md), [Certificate](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/node/docs/cert.md)
 
 ## Node 10 Upgrade Notice
 
@@ -37,7 +37,7 @@ The [ShellScript Task](https://github.com/Microsoft/azure-pipelines-tasks/tree/m
 
 We are accepting contributions and we try to stay on top of issues.
 
-[Contribution Guide](../CONTRIBUTING.md).
+[Contribution Guide](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/CONTRIBUTING.md).
 
 [Logging Issues](https://github.com/Microsoft/azure-pipelines-task-lib/issues)
 
@@ -63,9 +63,9 @@ Set environment variable TASK_TEST_TRACE=1 to display test output.
 
 We also maintain a PowerShell library for Windows task development.
 
-Library: [Powershell Library](../powershell)
+Library: [Powershell Library](https://github.com/microsoft/azure-pipelines-task-lib/tree/master/powershell)
 
-Usage: [Consuming the SDK](../powershell/Docs/Consuming.md)
+Usage: [Consuming the SDK](https://github.com/microsoft/azure-pipelines-task-lib/blob/master/powershell/Docs/Consuming.md)
 
 ## Third Party Notices
 To generate/update third party notice file run:

package/mock-answer.d.ts

@@ -26,6 +26,9 @@ export interface TaskLibAnswers {
     getPlatform?: {
         [key: string]: task.Platform;
     };
+    getAgentMode?: {
+        [key: string]: task.AgentHostedMode;
+    };
     legacyFindFiles?: {
         [key: string]: string[];
     };

package/mock-task.d.ts

@@ -58,6 +58,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 getAgentMode(): task.AgentHostedMode;
 export declare function cwd(): string;
 export declare function cd(path: string): void;
 export declare function pushd(path: string): void;

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.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.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;
 var path = require("path");
 var task = require("./task");
 var tcm = require("./taskcommand");
@@ -188,6 +188,10 @@ function getPlatform() {
     return mock.getResponse('getPlatform', 'getPlatform', module.exports.debug);
 }
 exports.getPlatform = getPlatform;
+function getAgentMode() {
+    return mock.getResponse('getAgentMode', 'getAgentMode', module.exports.debug);
+}
+exports.getAgentMode = getAgentMode;
 function cwd() {
     return mock.getResponse('cwd', 'cwd', module.exports.debug);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

package/task.d.ts

@@ -38,6 +38,11 @@ export declare enum Platform {
     MacOS = 1,
     Linux = 2
 }
+export declare enum AgentHostedMode {
+    Unknown = 0,
+    SelfHosted = 1,
+    MsHosted = 2
+}
 export declare const setStdStream: typeof im._setStdStream;
 export declare const setErrStream: typeof im._setErrStream;
 /**
@@ -311,6 +316,11 @@ export declare function osType(): string;
  * @throws {Error} Platform is not supported by our agent
  */
 export declare function getPlatform(): Platform;
+/**
+ * Return hosted type of Agent
+ * @returns {AgentHostedMode}
+ */
+export declare function getAgentMode(): AgentHostedMode;
 /**
  * Returns the process's current working directory.
  * see [process.cwd](https://nodejs.org/api/process.html#process_process_cwd)

package/task.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateReleaseName = exports.addBuildTag = exports.updateBuildNumber = exports.uploadBuildLog = exports.associateArtifact = exports.uploadArtifact = exports.logIssue = exports.logDetail = exports.setProgress = exports.setEndpoint = exports.addAttachment = exports.uploadSummary = exports.prependPath = exports.uploadFile = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.findMatch = exports.filter = exports.match = exports.tool = exports.execSync = exports.exec = exports.rmRF = exports.legacyFindFiles = exports.find = exports.retry = exports.mv = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.popd = exports.pushd = exports.cd = exports.checkPath = exports.cwd = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.debug = exports.error = exports.warning = exports.command = exports.setTaskVariable = exports.getTaskVariable = exports.getSecureFileTicket = exports.getSecureFileName = exports.getEndpointAuthorization = exports.getEndpointAuthorizationParameterRequired = exports.getEndpointAuthorizationParameter = exports.getEndpointAuthorizationSchemeRequired = exports.getEndpointAuthorizationScheme = exports.getEndpointDataParameterRequired = exports.getEndpointDataParameter = exports.getEndpointUrlRequired = exports.getEndpointUrl = exports.getPathInputRequired = exports.getPathInput = exports.filePathSupplied = exports.getDelimitedInput = exports.getBoolInput = exports.getInputRequired = exports.getInput = exports.setSecret = exports.setVariable = exports.getVariables = exports.assertAgent = exports.getVariable = exports.loc = exports.setResourcePath = exports.setResult = exports.setErrStream = exports.setStdStream = exports.Platform = exports.FieldType = exports.ArtifactType = exports.IssueType = exports.TaskState = exports.TaskResult = void 0;
+exports.updateReleaseName = exports.addBuildTag = exports.updateBuildNumber = exports.uploadBuildLog = exports.associateArtifact = exports.uploadArtifact = exports.logIssue = exports.logDetail = exports.setProgress = exports.setEndpoint = exports.addAttachment = exports.uploadSummary = exports.prependPath = exports.uploadFile = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.findMatch = exports.filter = exports.match = exports.tool = exports.execSync = exports.exec = exports.rmRF = exports.legacyFindFiles = exports.find = exports.retry = exports.mv = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.popd = exports.pushd = exports.cd = exports.checkPath = exports.cwd = exports.getAgentMode = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.debug = exports.error = exports.warning = exports.command = exports.setTaskVariable = exports.getTaskVariable = exports.getSecureFileTicket = exports.getSecureFileName = exports.getEndpointAuthorization = exports.getEndpointAuthorizationParameterRequired = exports.getEndpointAuthorizationParameter = exports.getEndpointAuthorizationSchemeRequired = exports.getEndpointAuthorizationScheme = exports.getEndpointDataParameterRequired = exports.getEndpointDataParameter = exports.getEndpointUrlRequired = exports.getEndpointUrl = exports.getPathInputRequired = exports.getPathInput = exports.filePathSupplied = exports.getDelimitedInput = exports.getBoolInput = exports.getInputRequired = exports.getInput = exports.setSecret = exports.setVariable = exports.getVariables = exports.assertAgent = exports.getVariable = exports.loc = exports.setResourcePath = exports.setResult = exports.setErrStream = exports.setStdStream = exports.AgentHostedMode = exports.Platform = exports.FieldType = exports.ArtifactType = exports.IssueType = exports.TaskState = exports.TaskResult = void 0;
 var shell = require("shelljs");
 var childProcess = require("child_process");
 var fs = require("fs");
@@ -52,6 +52,12 @@ var Platform;
     Platform[Platform["MacOS"] = 1] = "MacOS";
     Platform[Platform["Linux"] = 2] = "Linux";
 })(Platform = exports.Platform || (exports.Platform = {}));
+var AgentHostedMode;
+(function (AgentHostedMode) {
+    AgentHostedMode[AgentHostedMode["Unknown"] = 0] = "Unknown";
+    AgentHostedMode[AgentHostedMode["SelfHosted"] = 1] = "SelfHosted";
+    AgentHostedMode[AgentHostedMode["MsHosted"] = 2] = "MsHosted";
+})(AgentHostedMode = exports.AgentHostedMode || (exports.AgentHostedMode = {}));
 //-----------------------------------------------------
 // General Helpers
 //-----------------------------------------------------
@@ -97,6 +103,20 @@ process.on('uncaughtException', function (err) {
     setResult(TaskResult.Failed, exports.loc('LIB_UnhandledEx', err.message));
     exports.error(String(err.stack));
 });
+//
+// Catching unhandled rejections from promises and rethrowing them as exceptions
+// For example, a promise that is rejected but not handled by a .catch() handler in node 10 
+// doesn't cause an uncaughtException but causes in Node 16.
+// For types definitions(Error | Any) see https://nodejs.org/docs/latest-v16.x/api/process.html#event-unhandledrejection
+//
+process.on('unhandledRejection', function (reason) {
+    if (reason instanceof Error) {
+        throw reason;
+    }
+    else {
+        throw new Error(reason);
+    }
+});
 //-----------------------------------------------------
 // Loc Helpers
 //-----------------------------------------------------
@@ -594,6 +614,19 @@ function getPlatform() {
     }
 }
 exports.getPlatform = getPlatform;
+/**
+ * Return hosted type of Agent
+ * @returns {AgentHostedMode}
+ */
+function getAgentMode() {
+    var agentCloudId = exports.getVariable('Agent.CloudId');
+    if (agentCloudId === undefined)
+        return AgentHostedMode.Unknown;
+    if (agentCloudId)
+        return AgentHostedMode.MsHosted;
+    return AgentHostedMode.SelfHosted;
+}
+exports.getAgentMode = getAgentMode;
 /**
  * Returns the process's current working directory.
  * see [process.cwd](https://nodejs.org/api/process.html#process_process_cwd)

package/toolrunner.d.ts

@@ -122,7 +122,7 @@ export declare class ToolRunner extends events.EventEmitter {
      * @param     val     string cmdline or array of strings
      * @returns   ToolRunner
      */
-    argIf(condition: any, val: any): this;
+    argIf(condition: unknown, val: string | string[]): ToolRunner;
     /**
      * Pipe output of exec() to another tool
      * @param tool