[BUG]: AzureWebAppContainer@1 should error if App Service Resource Kind is not a container (such as "app,linux")

[qqii]

New issue checklist

• I searched for existing GitHub issues
• I read pipeline troubleshooting guide
• I checked how to collect logs

Task name

AzureWebAppContainer

Task version

1

Issue Description

This is related, but not the same as #14805.

AzureWebAppContainer should validate and error if the App Service Resource Kind is not within the supported osTypeMap

azure-pipelines-tasks/Tasks/AzureWebAppContainerV1/taskparameters.ts

Lines 8 to 11 in e973086

	const osTypeMap = new Map([
	[ 'app,container,xenon', 'Windows' ],
	[ 'app,linux,container', 'Linux' ]
	]);

I have just spent a day tracking down why AzureWebAppContainer doesn't work for our configuration. We are migrating to use containers with App Service. Since the docs makes no mention of changing the resource kind, I had foolishly left it as app,linux.

What caused the most confusion was the successful task, and the Azure Portal which showed the correct container image.

I dug into this a little bit, and I've figured out what is going wrong. When the App Service Resource Kind is not within the osTypeMap, the getWebAppKind returns osType as undefined.

azure-pipelines-tasks/Tasks/AzureWebAppContainerV1/taskparameters.ts

Lines 53 to 74 in e973086

	private static async getWebAppKind(taskParameters: TaskParameters): Promise<any> {
	let resourceGroupName: string = (taskParameters.DeployToSlotOrASEFlag) ? taskParameters.ResourceGroupName : "";
	let osType: string;
	if (!resourceGroupName) {
	var resources = new Resources(taskParameters.azureEndpoint);
	var appDetails = await resources.getAppDetails(taskParameters.WebAppName);
	resourceGroupName = appDetails["resourceGroupName"];
	osType = osTypeMap.get(appDetails["kind"]) ? osTypeMap.get(appDetails["kind"]) : appDetails["kind"];
	tl.debug(`Resource Group: ${resourceGroupName}`);
	}
	else {
	var appService = new AzureAppService(taskParameters.azureEndpoint, taskParameters.ResourceGroupName, taskParameters.WebAppName);
	var configSettings = await appService.get(true);
	osType = osTypeMap.get(configSettings.kind) ? osTypeMap.get(configSettings.kind) : configSettings.kind;
	}
	return {
	resourceGroupName: resourceGroupName,
	osType: osType
	};
	}

This propagates uncaught to deployWebAppImage because it uses properties: any, which in turn calls _updateConfigurationDetails.

azure-pipelines-tasks/Tasks/AzureWebAppContainerV1/operations/ContainerBasedDeploymentUtility.ts

Lines 56 to 73 in e973086

	if(isLinuxApp) {
	if(isMultiContainer) {
	let fileData = fs.readFileSync(multicontainerConfigFile);
	appSettingsNewProperties.linuxFxVersion = {
	'value': "COMPOSE|" + (new Buffer(fileData).toString('base64'))
	}
	}
	else {
	appSettingsNewProperties.linuxFxVersion = {
	'value': "DOCKER|" + imageName
	}
	}
	}
	else {
	appSettingsNewProperties.windowsFxVersion = {
	'value': "DOCKER|" + imageName
	}
	}

Here, since isLinuxApp = undefined and undefined is falsy, windowsFxVersion gets set to the specified image. This in turn is displayed under the Azure Portal under "Properties > Web App > {Publishing model, Container Image}", fooling me into thinking something else was going wrong.

It would be really useful if AzureWebAppContainer validated the kind parameter and creates a runtime error instead of silently continuing!

Environment type (Please select at least one enviroment where you face this issue)

• Self-Hosted
• Microsoft Hosted
• VMSS Pool
• Container

Azure DevOps Server type

dev.azure.com (formerly visualstudio.com)

Relevant log output

Starting: *snip*
==============================================================================
Task         : Azure Web App for Containers
Description  : Deploy containers to Azure App Service
Version      : 1.233.1
Author       : Microsoft Corporation
Help         : https://aka.ms/azurewebappcontainertroubleshooting
==============================================================================
Got service connection details for Azure App Service:'*snip*'
Single-container Deployment to the webapp '*snip*' as only the image detail was specified.
Trying to update App Service Configuration settings. Data: {"appCommandLine":null,"windowsFxVersion":"DOCKER|****snip*"}
Updated App Service Configuration settings.
Restarting App Service : *snip*
App Service '*snip*' restarted successfully.
Successfully updated deployment History at *snip*
App Service Application URL: *snip*
Finishing: *snip*

Repro steps

1. Create an app service with kind "app,linux"
2. Run a pipeline with AzureWebAppContainer
3. It succeeds, and the UI now shows "Publishing model" and "Container Image"

[qqii]

A further bug, when taskParameters.DeployToSlotOrASEFlag = true, getWebAppKind assumes that all slots of the app service has the same kind. This may not be the case.

azure-pipelines-tasks/Tasks/AzureWebAppContainerV1/taskparameters.ts

Lines 53 to 74 in e973086

	private static async getWebAppKind(taskParameters: TaskParameters): Promise<any> {
	let resourceGroupName: string = (taskParameters.DeployToSlotOrASEFlag) ? taskParameters.ResourceGroupName : "";
	let osType: string;
	if (!resourceGroupName) {
	var resources = new Resources(taskParameters.azureEndpoint);
	var appDetails = await resources.getAppDetails(taskParameters.WebAppName);
	resourceGroupName = appDetails["resourceGroupName"];
	osType = osTypeMap.get(appDetails["kind"]) ? osTypeMap.get(appDetails["kind"]) : appDetails["kind"];
	tl.debug(`Resource Group: ${resourceGroupName}`);
	}
	else {
	var appService = new AzureAppService(taskParameters.azureEndpoint, taskParameters.ResourceGroupName, taskParameters.WebAppName);
	var configSettings = await appService.get(true);
	osType = osTypeMap.get(configSettings.kind) ? osTypeMap.get(configSettings.kind) : configSettings.kind;
	}
	return {
	resourceGroupName: resourceGroupName,
	osType: osType
	};
	}