azure-pipelines-tasks-azurermdeploycommon 3.222.1 → 3.226.0

package/operations/ContainerBasedDeploymentUtility.d.ts

@@ -5,16 +5,6 @@ export declare class ContainerBasedDeploymentUtility {
     constructor(appService: AzureAppService);
     deployWebAppImage(properties: any, restart?: boolean): Promise<void>;
     private _updateConfigurationDetails;
-    private _getAzureContainerImageName;
-    private _getDockerHubImageName;
-    private _constructImageName;
-    private _getPrivateRegistryImageName;
-    private _updateWebAppSettings;
-    private _getImageName;
-    private _getContainerRegistrySettings;
-    private _getAzureContainerRegistrySettings;
-    private _getDockerPrivateRegistrySettings;
-    private _deleteRegistryConnectionSettings;
     private updateImagesInConfigFile;
     private tokenizeImages;
 }

package/operations/ContainerBasedDeploymentUtility.js

@@ -11,19 +11,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContainerBasedDeploymentUtility = void 0;
 const tl = require("azure-pipelines-task-lib/task");
-const url = require("url");
-const util = require("util");
 const ParameterParserUtility_1 = require("./ParameterParserUtility");
 const AzureAppServiceUtility_1 = require("./AzureAppServiceUtility");
 const fs = require("fs");
 const path = require("path");
 var deployUtility = require('../webdeployment-common/utility.js');
-var registryTypes;
-(function (registryTypes) {
-    registryTypes[registryTypes["AzureContainerRegistry"] = 0] = "AzureContainerRegistry";
-    registryTypes[registryTypes["Registry"] = 1] = "Registry";
-    registryTypes[registryTypes["PrivateRegistry"] = 2] = "PrivateRegistry";
-})(registryTypes || (registryTypes = {}));
 class ContainerBasedDeploymentUtility {
     constructor(appService) {
         this._appService = appService;
@@ -83,128 +75,6 @@ class ContainerBasedDeploymentUtility {
             yield this._appServiceUtility.updateConfigurationSettings(appSettingsNewProperties);
         });
     }
-    _getAzureContainerImageName() {
-        var registry = tl.getInput('AzureContainerRegistryLoginServer', true) + ".azurecr.io";
-        var image = tl.getInput('AzureContainerRegistryImage', true);
-        var tag = tl.getInput('AzureContainerRegistryTag', false);
-        return this._constructImageName(registry, image, tag);
-    }
-    _getDockerHubImageName() {
-        var namespace = tl.getInput('DockerNamespace', true);
-        var image = tl.getInput('DockerRepository', true);
-        var tag = tl.getInput('DockerImageTag', false);
-        return this._constructImageName(namespace, image, tag);
-    }
-    _constructImageName(namespace, repository, tag) {
-        var imageName = null;
-        /*
-            Special Case : If release definition is not linked to build artifacts
-            then $(Build.BuildId) variable don't expand in release. So clearing state
-            of dockerImageTag if $(Build.BuildId) not expanded in value of dockerImageTag.
-        */
-        if (tag && (tag.trim() == "$(Build.BuildId)")) {
-            tag = null;
-        }
-        if (tag) {
-            imageName = namespace.toLowerCase() + "/" + repository.toLowerCase() + ":" + tag;
-        }
-        else {
-            imageName = namespace.toLowerCase() + "/" + repository.toLowerCase();
-        }
-        return imageName.replace(/ /g, "");
-    }
-    _getPrivateRegistryImageName() {
-        var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true);
-        var loginServer = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'url', true);
-        var registry = url.parse(loginServer).hostname;
-        var image = tl.getInput('PrivateRegistryImage', true);
-        var tag = tl.getInput('PrivateRegistryTag', false);
-        return this._constructImageName(registry, image, tag);
-    }
-    _updateWebAppSettings(appSettingsParameters, webAppSettings) {
-        // In case of public repo, clear the connection details of a registry
-        var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', true);
-        // Uncomment the below lines while supprting all registry types.
-        // if(dockerRespositoryAccess === "public")
-        // {
-        //     deleteRegistryConnectionSettings(webAppSettings);
-        // }
-        var parsedAppSettings = ParameterParserUtility_1.parse(appSettingsParameters);
-        for (var settingName in parsedAppSettings) {
-            var setting = settingName.trim();
-            var settingVal = parsedAppSettings[settingName].value;
-            settingVal = settingVal ? settingVal.trim() : "";
-            if (setting) {
-                webAppSettings["properties"][setting] = settingVal;
-            }
-        }
-    }
-    _getImageName() {
-        var registryType = tl.getInput('ImageSource', true);
-        var imageName = null;
-        switch (registryType) {
-            case registryTypes[registryTypes.AzureContainerRegistry]:
-                imageName = this._getAzureContainerImageName();
-                break;
-            case registryTypes[registryTypes.Registry]:
-                imageName = this._getDockerHubImageName();
-                break;
-            case registryTypes[registryTypes.PrivateRegistry]:
-                imageName = this._getPrivateRegistryImageName();
-                break;
-        }
-        return imageName;
-    }
-    _getContainerRegistrySettings(imageName, endPoint) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var containerRegistryType = 'Registry';
-            var containerRegistrySettings = "-DOCKER_CUSTOM_IMAGE_NAME " + imageName;
-            var containerRegistryAuthParamsFormatString = "-DOCKER_REGISTRY_SERVER_URL %s -DOCKER_REGISTRY_SERVER_USERNAME %s -DOCKER_REGISTRY_SERVER_PASSWORD %s";
-            switch (containerRegistryType) {
-                case registryTypes[registryTypes.AzureContainerRegistry]:
-                    containerRegistrySettings = yield this._getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                    break;
-                case registryTypes[registryTypes.Registry]:
-                    var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', false);
-                    if (dockerRespositoryAccess === "private") {
-                        containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                    }
-                    break;
-                case registryTypes[registryTypes.PrivateRegistry]:
-                    containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                    break;
-            }
-            return containerRegistrySettings;
-        });
-    }
-    _getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var registryServerName = tl.getInput('AzureContainerRegistryLoginServer', true);
-            var registryUrl = "https://" + registryServerName + ".azurecr.io";
-            tl.debug("Azure Container Registry Url: " + registryUrl);
-            var registryName = tl.getInput('AzureContainerRegistry', true);
-            var resourceGroupName = ''; // await azureRESTUtility.getResourceGroupName(endPoint, registryName, "Microsoft.ContainerRegistry/registries");
-            tl.debug("Resource group name of a registry: " + resourceGroupName);
-            var creds = null; //await azureRESTUtility.getAzureContainerRegistryCredentials(endPoint, registryName, resourceGroupName);
-            tl.debug("Successfully retrieved the registry credentials");
-            var username = creds.username;
-            var password = creds["passwords"][0].value;
-            return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password);
-        });
-    }
-    _getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString) {
-        var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true);
-        var username = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'username', true);
-        var password = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'password', true);
-        var registryUrl = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'registry', true);
-        tl.debug("Docker or Private Container Registry Url: " + registryUrl);
-        return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password);
-    }
-    _deleteRegistryConnectionSettings(webAppSettings) {
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_URL"];
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_USERNAME"];
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_PASSWORD"];
-    }
     updateImagesInConfigFile(multicontainerConfigFile, images) {
         const tempDirectory = deployUtility.getTempDirectory();
         var contents = fs.readFileSync(multicontainerConfigFile).toString();

package/operations/ContainerBasedDeploymentUtility.ts

@@ -1,6 +1,4 @@
 import tl = require('azure-pipelines-task-lib/task');
-import url = require('url');
-import util = require('util');
 import { AzureAppService } from '../azure-arm-rest/azure-arm-app-service';
 import { parse }  from './ParameterParserUtility';
 import { AzureAppServiceUtility } from './AzureAppServiceUtility';
@@ -8,12 +6,6 @@ import fs = require('fs');
 import path = require('path');
 var deployUtility = require('../webdeployment-common/utility.js');
 
-enum registryTypes {
-    "AzureContainerRegistry",
-    "Registry", // TODO: Rename it to DockerHub while supporting all the registry types. Also add all these registry types in Task.json in ImageSource pick list.
-    "PrivateRegistry"
-}
-
 export class ContainerBasedDeploymentUtility {
     private _appService: AzureAppService;
     private _appServiceUtility: AzureAppServiceUtility;
@@ -81,156 +73,6 @@ export class ContainerBasedDeploymentUtility {
         await this._appServiceUtility.updateConfigurationSettings(appSettingsNewProperties);
     }
 
-    private _getAzureContainerImageName(): string {
-        var registry = tl.getInput('AzureContainerRegistryLoginServer', true) + ".azurecr.io";
-        var image = tl.getInput('AzureContainerRegistryImage', true);
-        var tag = tl.getInput('AzureContainerRegistryTag', false);
-    
-        return this._constructImageName(registry, image, tag);
-    }
-
-    private _getDockerHubImageName(): string {
-        var namespace = tl.getInput('DockerNamespace', true);
-        var image = tl.getInput('DockerRepository', true);
-        var tag = tl.getInput('DockerImageTag', false);
-    
-        return this._constructImageName(namespace, image, tag);
-    }
-
-    private _constructImageName(namespace, repository, tag): string {
-        var imageName = null;
-        /*
-            Special Case : If release definition is not linked to build artifacts
-            then $(Build.BuildId) variable don't expand in release. So clearing state
-            of dockerImageTag if $(Build.BuildId) not expanded in value of dockerImageTag.
-        */
-        if(tag && (tag.trim() == "$(Build.BuildId)")) {
-            tag = null;
-        }
-    
-        if(tag) {
-            imageName = namespace.toLowerCase() + "/" + repository.toLowerCase() + ":" + tag;
-        } else {
-            imageName = namespace.toLowerCase() + "/" + repository.toLowerCase();
-        }
-    
-        return imageName.replace(/ /g,"");
-    }
-
-    private _getPrivateRegistryImageName(): string {
-        var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true);
-        var loginServer = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'url', true);
-    
-        var registry = url.parse(loginServer).hostname;
-        var image = tl.getInput('PrivateRegistryImage', true);
-        var tag = tl.getInput('PrivateRegistryTag', false);
-    
-        return this._constructImageName(registry, image, tag);
-    }
-
-    private _updateWebAppSettings(appSettingsParameters, webAppSettings): void {
-        // In case of public repo, clear the connection details of a registry
-        var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', true);
-        
-        // Uncomment the below lines while supprting all registry types.
-        // if(dockerRespositoryAccess === "public")
-        // {
-        //     deleteRegistryConnectionSettings(webAppSettings);
-        // }
-        
-        var parsedAppSettings = parse(appSettingsParameters);
-        for (var settingName in parsedAppSettings) {
-            var setting = settingName.trim();
-            var settingVal = parsedAppSettings[settingName].value;
-            settingVal = settingVal ? settingVal.trim() : "";
-    
-            if(setting) {
-                webAppSettings["properties"][setting] = settingVal;
-            }
-        }
-    }
-
-    private _getImageName(): string {
-        var registryType = tl.getInput('ImageSource', true);
-        var imageName = null;
-    
-        switch(registryType) {        
-            case registryTypes[registryTypes.AzureContainerRegistry]:
-                imageName = this._getAzureContainerImageName();
-                break;
-    
-            case registryTypes[registryTypes.Registry]:
-                imageName = this._getDockerHubImageName();
-                break;
-    
-            case registryTypes[registryTypes.PrivateRegistry]:
-                imageName = this._getPrivateRegistryImageName();
-                break;
-        }
-    
-        return imageName;
-    }
-
-    private async _getContainerRegistrySettings(imageName, endPoint): Promise<string> {
-        var containerRegistryType: string = 'Registry';
-        var containerRegistrySettings: string = "-DOCKER_CUSTOM_IMAGE_NAME " + imageName;
-        var containerRegistryAuthParamsFormatString: string = "-DOCKER_REGISTRY_SERVER_URL %s -DOCKER_REGISTRY_SERVER_USERNAME %s -DOCKER_REGISTRY_SERVER_PASSWORD %s";
-    
-        switch(containerRegistryType) {
-            case registryTypes[registryTypes.AzureContainerRegistry]:
-                containerRegistrySettings = await this._getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                break;
-    
-            case registryTypes[registryTypes.Registry]:
-                var dockerRespositoryAccess = tl.getInput('DockerRepositoryAccess', false);
-                if(dockerRespositoryAccess === "private")
-                {
-                    containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                }
-                break;
-    
-            case registryTypes[registryTypes.PrivateRegistry]:
-                containerRegistrySettings = this._getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString);
-                break;           
-        }    
-    
-        return containerRegistrySettings;
-    }
-
-    private async _getAzureContainerRegistrySettings(endPoint, containerRegistrySettings, containerRegistryAuthParamsFormatString): Promise<string> {    
-        var registryServerName = tl.getInput('AzureContainerRegistryLoginServer', true);
-        var registryUrl = "https://" + registryServerName + ".azurecr.io";    
-        tl.debug("Azure Container Registry Url: " + registryUrl);
-    
-        var registryName = tl.getInput('AzureContainerRegistry', true);
-        var resourceGroupName = '';// await azureRESTUtility.getResourceGroupName(endPoint, registryName, "Microsoft.ContainerRegistry/registries");
-        tl.debug("Resource group name of a registry: " + resourceGroupName);
-    
-        var creds = null //await azureRESTUtility.getAzureContainerRegistryCredentials(endPoint, registryName, resourceGroupName);
-        tl.debug("Successfully retrieved the registry credentials");
-    
-        var username = creds.username;
-        var password = creds["passwords"][0].value;
-    
-        return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password);
-    }
-    
-    private _getDockerPrivateRegistrySettings(containerRegistrySettings, containerRegistryAuthParamsFormatString): string {
-        var registryConnectedServiceName = tl.getInput('RegistryConnectedServiceName', true);    
-        var username = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'username', true);
-        var password = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'password', true);    
-        var registryUrl = tl.getEndpointAuthorizationParameter(registryConnectedServiceName, 'registry', true);
-    
-        tl.debug("Docker or Private Container Registry Url: " + registryUrl);
-    
-        return containerRegistrySettings + " " + util.format(containerRegistryAuthParamsFormatString, registryUrl, username, password);
-    }
-
-    private _deleteRegistryConnectionSettings(webAppSettings): void {
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_URL"];
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_USERNAME"];
-        delete webAppSettings["properties"]["DOCKER_REGISTRY_SERVER_PASSWORD"];
-    }
 
     private updateImagesInConfigFile(multicontainerConfigFile, images): string {
         const tempDirectory = deployUtility.getTempDirectory();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "azure-pipelines-tasks-azurermdeploycommon",
-    "version": "3.222.1",
+    "version": "3.226.0",
     "description": "Common Lib for Azure ARM REST apis",
     "repository": {
         "type": "git",
@@ -28,7 +28,7 @@
         "q": "1.5.1",
         "typed-rest-client": "^1.8.4",
         "winreg": "1.2.2",
-        "xml2js": "0.4.13"
+        "xml2js": "0.6.2"
     },
     "devDependencies": {
         "typescript": "4.0.2"