2197050 Validate tool versions before running them (#453)

* 2197050 Validate tool versions before running them

* Review Points addressed

* Review Points addressed

* Review Points addressed

Author: PhilipsonJoseph

common-npm-packages/azure-arm-rest/azCliUtility.ts

@@ -5,6 +5,7 @@ import { IExecSyncResult } from 'azure-pipelines-task-lib/toolrunner';
 import { getHandlerFromToken, WebApi } from "azure-devops-node-api";
 import { ITaskApi } from "azure-devops-node-api/TaskApi";
 import { TaskHubOidcToken } from "azure-devops-node-api/interfaces/TaskAgentInterfaces";
+import * as webClient from "./webClient";
 import Q = require('q');
 
 tl.setResourcePath(path.join(__dirname, 'module.json'), true);
@@ -188,4 +189,45 @@ function isAzVersionGreaterOrEqual(azVersionResultOutput: string, versionToCompa
         tl.error(`Error checking Azure CLI version: ${error.message}`);
         return false;
     }
+}
+
+async function getLatestAzureModuleReleaseVersion(moduleName: string): Promise<string> {
+    try {
+        let request = new webClient.WebRequest();
+        request.uri = `https://api.github.com/repos/Azure/${moduleName}/releases`;
+        request.method = 'GET';
+        request.headers = request.headers || {};
+        const response = await webClient.sendRequest(request);
+        const lastestCliRelease = moduleName === "azure-powershell" ? response?.body?.filter(x => x?.tag_name?.match(/^v\d+\.\d+\.0/))?.[0] : response?.body?.[0];
+        return lastestCliRelease?.tag_name
+    } catch (err) {
+        tl.error(`Error checking Azure version: ${err.message}`);
+    }
+}
+
+export async function validateAzModuleVersion(moduleName: string, currentVersion: string, displayName: string, versionTolerance: number, checkOnlyMajorVersion: boolean = false): Promise<void> {
+    const DisplayWarningForOlderAzVersion: boolean = tl.getPipelineFeature("ShowWarningOnOlderAzureModules");
+    try {
+        if (DisplayWarningForOlderAzVersion) {
+            const latestRelease: string = await getLatestAzureModuleReleaseVersion(moduleName);
+            if (latestRelease) {
+                const [latestsemver, latestMajor, latestMinor] = latestRelease.match(/(\d+).(\d+).(\d+)/);
+                const [currentsemver, currentMajor, currentMinor] = currentVersion.match(/(\d+).(\d+).(\d+)/);
+                tl.debug(`For the module ${moduleName} the current semver Version is ${currentsemver} and the latest semver version is ${latestsemver}`)
+                let displayWarning = false;
+                if (checkOnlyMajorVersion && Number(currentMajor) < Number(latestMajor) - versionTolerance) {
+                    displayWarning = true;
+                }
+                if (!checkOnlyMajorVersion && (Number(currentMajor) < Number(latestMajor) || Number(currentMinor) < Number(latestMinor) - versionTolerance)) {
+                    displayWarning = true;
+                }
+                if (displayWarning) {
+                    tl.warning(tl.loc('lowerAzWarning', displayName, currentsemver, latestsemver))
+                }
+            }
+        }
+    } catch (err) {
+        tl.error(`Error on validating Azure version: ${err.message}`);
+    }
+    
 }

common-npm-packages/azure-arm-rest/module.json

@@ -188,6 +188,7 @@
         "VirtualApplicationDoesNotExist": "Virtual application doesn't exists : %s",
         "CantDownloadClusterCredentials": "Failed to fetch credentials for the cluster %s. Reason %s. Make sure the service connection is assigned an appropriate Azure RBAC role: https://aka.ms/azdo-aks-rm-access.",
         "KubernetesClusterResourceGroup": "Kubernetes cluster %s, resource group %s.",
-        "SettingAzureCloud": "Setting active cloud to: %s"
+        "SettingAzureCloud": "Setting active cloud to: %s",
+        "lowerAzWarning": "%s version %s is out of date, the latest version is %s"
     }
 }

common-npm-packages/azure-arm-rest/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "azure-pipelines-tasks-azure-arm-rest",
-    "version": "3.256.1",
+    "version": "3.257.0",
     "description": "Common Lib for Azure ARM REST apis",
     "repository": {
         "type": "git",