azure-devops-task-utils 3.0.0 → 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 David Polania
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,2 +1,51 @@
-# azure-devops-task-utils
-library to create tasks of azure devops
+# Azure DevOps task utils
+Library with useful functionalities for azure devops tasks
+
+- Create client
+- Update variable
+- retries
+- etc
+
+# Usage
+
+```sh-session
+$ npm install --save azure-devops-task-utils
+...
+
+```
+
+````
+import * as common from 'azure-devops-task-utils';
+import * as nodeApi from 'azure-devops-node-api';
+
+async function sample() {
+
+    common.banner('Init Configuration');
+    common.heading('Title');
+
+
+    const webApi: nodeApi.WebApi = await common.getWebApi();
+    const gitApi: GitApi.IGitApi = await webApi.getGitApi();
+    const project: string = common.getProject();
+
+    ///
+    gitApi.
+    .
+    .
+    .
+}
+
+
+````
+
+To do local tests export the variables y en la variable 'SYSTEM_ACCESSTOKEN' a personal access token
+
+export SYSTEM_ACCESSTOKEN=xxxxx
+
+export SYSTEM_TEAMPROJECTID=xxxxx-xxx-xx
+
+export SYSTEM_TEAMFOUNDATIONCOLLECTIONURI=https://dev.azure.com/xxxxxxxx/
+
+Nota: In Azure DevOps you must activate the option to use auth script in the agents
+
+"Allow scripts to access the OAuth token"

package/lib/api.d.ts

@@ -0,0 +1,7 @@
+import { ConfigurationVariableValue, Release } from 'azure-devops-node-api/interfaces/ReleaseInterfaces';
+import { WebApi } from 'azure-devops-node-api';
+import { ConnectionData } from 'azure-devops-node-api/interfaces/LocationsInterfaces';
+import { IRequestOptions } from 'azure-devops-node-api/interfaces/common/VsoBaseInterfaces';
+export declare function testConnection(webApi: WebApi): Promise<ConnectionData>;
+export declare function createWebApi(serverUrl: string, token: string, apiOptions?: IRequestOptions): WebApi;
+export declare function setReleaseVariableFromApi(webApi: WebApi, project: string, releaseId: number, variableName: string, configurationVariable: ConfigurationVariableValue): Promise<Release>;

package/lib/api.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setReleaseVariableFromApi = exports.createWebApi = exports.testConnection = void 0;
+const azure_devops_node_api_1 = require("azure-devops-node-api");
+function testConnection(webApi) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const connData = yield webApi.connect();
+        const name = connData && connData.authenticatedUser && connData.authenticatedUser.providerDisplayName;
+        console.log(`Hello ${name}`);
+        return connData;
+    });
+}
+exports.testConnection = testConnection;
+function createWebApi(serverUrl, token, apiOptions) {
+    try {
+        const authHandler = (0, azure_devops_node_api_1.getHandlerFromToken)(token);
+        const webApi = new azure_devops_node_api_1.WebApi(serverUrl, authHandler, apiOptions);
+        return webApi;
+    }
+    catch (err) {
+        throw new Error(err.message);
+    }
+}
+exports.createWebApi = createWebApi;
+function setReleaseVariableFromApi(webApi, project, releaseId, variableName, configurationVariable) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const releaseApi = yield webApi.getReleaseApi();
+            const release = yield releaseApi.getRelease(project, releaseId);
+            if (release.variables) {
+                release.variables[variableName] = configurationVariable;
+                return yield releaseApi.updateRelease(release, project, Number(releaseId));
+            }
+            else {
+                throw new Error('Variables is undefined');
+            }
+        }
+        catch (error) {
+            throw new Error(error.message);
+        }
+    });
+}
+exports.setReleaseVariableFromApi = setReleaseVariableFromApi;

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { setReleaseVariableFromApi, createWebApi, testConnection } from './api';
+export { isVariable, getVariableRequired, getProject, getWebApi, setReleaseVariable } from './task';
+export { banner, heading, retryFunction, retryPromise } from './utils';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retryPromise = exports.retryFunction = exports.heading = exports.banner = exports.setReleaseVariable = exports.getWebApi = exports.getProject = exports.getVariableRequired = exports.isVariable = exports.testConnection = exports.createWebApi = exports.setReleaseVariableFromApi = void 0;
+var api_1 = require("./api");
+Object.defineProperty(exports, "setReleaseVariableFromApi", { enumerable: true, get: function () { return api_1.setReleaseVariableFromApi; } });
+Object.defineProperty(exports, "createWebApi", { enumerable: true, get: function () { return api_1.createWebApi; } });
+Object.defineProperty(exports, "testConnection", { enumerable: true, get: function () { return api_1.testConnection; } });
+var task_1 = require("./task");
+Object.defineProperty(exports, "isVariable", { enumerable: true, get: function () { return task_1.isVariable; } });
+Object.defineProperty(exports, "getVariableRequired", { enumerable: true, get: function () { return task_1.getVariableRequired; } });
+Object.defineProperty(exports, "getProject", { enumerable: true, get: function () { return task_1.getProject; } });
+Object.defineProperty(exports, "getWebApi", { enumerable: true, get: function () { return task_1.getWebApi; } });
+Object.defineProperty(exports, "setReleaseVariable", { enumerable: true, get: function () { return task_1.setReleaseVariable; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "banner", { enumerable: true, get: function () { return utils_1.banner; } });
+Object.defineProperty(exports, "heading", { enumerable: true, get: function () { return utils_1.heading; } });
+Object.defineProperty(exports, "retryFunction", { enumerable: true, get: function () { return utils_1.retryFunction; } });
+Object.defineProperty(exports, "retryPromise", { enumerable: true, get: function () { return utils_1.retryPromise; } });

package/lib/task.d.ts

@@ -0,0 +1,8 @@
+import { Release } from 'azure-devops-node-api/interfaces/ReleaseInterfaces';
+import { IRequestOptions } from 'azure-devops-node-api/interfaces/common/VsoBaseInterfaces';
+import { WebApi } from 'azure-devops-node-api';
+export declare function isVariable(name: string): boolean;
+export declare function getVariableRequired(name: string, customMessage?: string): string;
+export declare function getProject(): string;
+export declare function getWebApi(apiOptions?: IRequestOptions): WebApi;
+export declare function setReleaseVariable(releaseId: number, variableName: string, variableValue: string, allowOverride?: boolean, isSecret?: boolean): Promise<Release>;

package/lib/task.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setReleaseVariable = exports.getWebApi = exports.getProject = exports.getVariableRequired = exports.isVariable = void 0;
+const api_1 = require("./api");
+const azure_pipelines_task_lib_1 = require("azure-pipelines-task-lib");
+function isVariable(name) {
+    return !!(0, azure_pipelines_task_lib_1.getVariable)(name);
+}
+exports.isVariable = isVariable;
+function getVariableRequired(name, customMessage) {
+    const value = (0, azure_pipelines_task_lib_1.getVariable)(name);
+    if (!value) {
+        console.log(customMessage);
+        console.error(name + ' env var not set. It is not found in the agent variables');
+        throw new Error(`Variable required: ${name}`);
+    }
+    (0, azure_pipelines_task_lib_1.debug)(`${name} = ${value}`);
+    return value;
+}
+exports.getVariableRequired = getVariableRequired;
+function getProject() {
+    return getVariableRequired('SYSTEM_TEAMPROJECTID');
+}
+exports.getProject = getProject;
+function getWebApi(apiOptions) {
+    const serverUrl = getVariableRequired('SYSTEM_TEAMFOUNDATIONCOLLECTIONURI');
+    const token = getVariableRequired('SYSTEM_ACCESSTOKEN', 'Remember to enable in the agent "Allow scripts to access the OAuth token"');
+    return (0, api_1.createWebApi)(serverUrl, token, apiOptions);
+}
+exports.getWebApi = getWebApi;
+function setReleaseVariable(releaseId, variableName, variableValue, allowOverride = true, isSecret = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const webApi = getWebApi();
+            const project = getProject();
+            const variableConfiguration = {
+                allowOverride,
+                isSecret,
+                value: variableValue
+            };
+            (0, azure_pipelines_task_lib_1.setVariable)(variableName, variableValue, isSecret);
+            return yield (0, api_1.setReleaseVariableFromApi)(webApi, project, releaseId, variableName, variableConfiguration);
+        }
+        catch (error) {
+            throw new Error(error.message);
+        }
+    });
+}
+exports.setReleaseVariable = setReleaseVariable;

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+export { retryFunction, retryPromise } from 'polallel/lib/retry';
+export declare function banner(title: string): void;
+export declare function heading(title: string): void;

package/lib/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.heading = exports.banner = exports.retryPromise = exports.retryFunction = void 0;
+var retry_1 = require("polallel/lib/retry");
+Object.defineProperty(exports, "retryFunction", { enumerable: true, get: function () { return retry_1.retryFunction; } });
+Object.defineProperty(exports, "retryPromise", { enumerable: true, get: function () { return retry_1.retryPromise; } });
+function banner(title) {
+    console.log();
+    console.log('=======================================');
+    console.log('\t' + title);
+    console.log('=======================================');
+    console.log();
+}
+exports.banner = banner;
+function heading(title) {
+    console.log();
+    console.log('> ' + title);
+}
+exports.heading = heading;

package/package.json

@@ -1,22 +1,17 @@
 {
   "name": "azure-devops-task-utils",
-  "version": "3.0.0",
-  "description": "Library to create tasks of azure devops",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "4.0.0",
+  "description": "Utility library for Azure DevOps tasks",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
-    "dist/**/*"
+    "lib/**/*"
   ],
   "scripts": {
-    "test": " echo test run ",
     "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
-    "preversion": "npm run lint",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "prebuild": "rimraf ./lib",
+    "format": "prettier --config .prettierrc 'src/**/*.ts' --write",
+    "lint": "eslint . --ext .ts"
   },
   "repository": {
     "type": "git",
@@ -26,26 +21,28 @@
     "azure",
     "devops",
     "tasks",
-    "utlis"
+    "utils"
   ],
-  "author": "David Polania",
-  "license": "ISC",
+  "author": "davidpolaniaac",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/davidpolaniaac/azure-devops-task-utils/issues"
   },
   "homepage": "https://github.com/davidpolaniaac/azure-devops-task-utils.git#readme",
   "dependencies": {
-    "azure-devops-node-api": "^10.1.1",
-    "azure-pipelines-task-lib": "^2.9.5"
+    "azure-devops-node-api": "^11.2.0",
+    "azure-pipelines-task-lib": "^3.3.1",
+    "polallel": "^1.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^23.3.14",
-    "@types/node": "^10.14.9",
-    "jest": "^23.6.0",
-    "prettier": "^1.18.2",
-    "ts-jest": "^23.10.5",
-    "tslint": "^5.17.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.5.2"
+    "@types/node": "^14.14.31",
+    "@typescript-eslint/eslint-plugin": "^5.38.0",
+    "@typescript-eslint/parser": "^5.38.0",
+    "eslint": "^8.24.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.7.1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.8.3"
   }
 }

package/dist/index.d.ts

@@ -1,8 +0,0 @@
-import * as vm from 'azure-devops-node-api';
-import * as ReleaseInterfaces from 'azure-devops-node-api/interfaces/ReleaseInterfaces';
-export declare function getWebApi(): Promise<vm.WebApi>;
-export declare function getApi(serverUrl: string, optionApi?: any): Promise<vm.WebApi>;
-export declare function getProject(): string;
-export declare function banner(title: string): void;
-export declare function heading(title: string): void;
-export declare function setReleaseVariable(releaseId: number, variableName: string, variableValue: string, allowOverride?: boolean, isSecret?: boolean): Promise<ReleaseInterfaces.Release>;

package/dist/index.js

@@ -1,103 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const vm = require("azure-devops-node-api");
-const tl = require("azure-pipelines-task-lib/task");
-function getEnv(name) {
-    const val = tl.getVariable(name);
-    if (!val) {
-        console.error(name + ' env var not set');
-        name.includes('SYSTEM_ACCESSTOKEN')
-            ? console.log('Remember to enable in the agent "Allow scripts to access the OAuth token"')
-            : console.log('It is not found in the agent variables');
-        tl.setResult(tl.TaskResult.Failed, 'env var not set');
-        process.exit(1);
-    }
-    return val;
-}
-function validateEnv(name) {
-    return !!tl.getVariable(name);
-}
-function getWebApi() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const serverUrl = getEnv('SYSTEM_TEAMFOUNDATIONCOLLECTIONURI');
-        return yield getApi(serverUrl);
-    });
-}
-exports.getWebApi = getWebApi;
-function getApi(serverUrl, optionApi) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const token = validateEnv('SYSTEM_ACCESSTOKEN_LOCAL')
-                    ? getEnv('SYSTEM_ACCESSTOKEN_LOCAL')
-                    : getEnv('SYSTEM_ACCESSTOKEN');
-                const authHandler = validateEnv('SYSTEM_ACCESSTOKEN_LOCAL')
-                    ? vm.getPersonalAccessTokenHandler(token)
-                    : vm.getBearerHandler(token);
-                const option = optionApi;
-                const vsts = new vm.WebApi(serverUrl, authHandler, option);
-                const connData = yield vsts.connect();
-                resolve(vsts);
-            }
-            catch (err) {
-                reject(err);
-            }
-        }));
-    });
-}
-exports.getApi = getApi;
-function getProject() {
-    return getEnv('SYSTEM_TEAMPROJECTID');
-}
-exports.getProject = getProject;
-function banner(title) {
-    console.log();
-    console.log('=======================================');
-    console.log('\t' + title);
-    console.log('=======================================');
-    console.log();
-}
-exports.banner = banner;
-function heading(title) {
-    console.log();
-    console.log('> ' + title);
-}
-exports.heading = heading;
-function setReleaseVariable(releaseId, variableName, variableValue, allowOverride = true, isSecret = false) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const webApi = yield getWebApi();
-                const releaseApi = yield webApi.getReleaseApi();
-                const project = getProject();
-                tl.setVariable(variableName, variableValue);
-                const release = yield releaseApi.getRelease(project, releaseId);
-                const variableConfiguration = {
-                    allowOverride,
-                    isSecret,
-                    value: variableValue
-                };
-                if (release.variables) {
-                    release.variables[variableName] = variableConfiguration;
-                    const newRelease = yield releaseApi.updateRelease(release, project, Number(releaseId));
-                    resolve(newRelease);
-                }
-                else {
-                    reject(new Error('Variables is undefined'));
-                }
-            }
-            catch (error) {
-                reject(error);
-            }
-        }));
-    });
-}
-exports.setReleaseVariable = setReleaseVariable;