private string ResolveWorkerRuntimeVersion(WorkerRuntime workerRuntime)
{
var framework = GetEnvironmentVariableOrNull(OryxBuildConstants.OryxEnvVars.FrameworkSetting);
var frameworkVersion = GetEnvironmentVariableOrNull(OryxBuildConstants.OryxEnvVars.FrameworkVersionSetting);
// If either of them is not set we are not in a position to determine the version, and should let the caller
// switch to default
if (string.IsNullOrEmpty(framework) || string.IsNullOrEmpty(frameworkVersion))
{
return(FunctionAppSupportedWorkerRuntime.GetDefaultLanguageVersion(workerRuntime));
}
// If it's set to DOCKER, it could be a) a function app image b) a custom image
// For custom image, there's no point doing a build, so we just default them (the parser won't work).
// if it's indeed a function app image, we look for the right tag that tells us about the version.
//
// Or if it's set to a supported worker runtime that was inferred, we assume that the framework version
// that is set is the correct version requested.
if (framework.Equals("DOCKER", StringComparison.OrdinalIgnoreCase))
{
var parsedVersion = ParseRuntimeVersionFromImage(frameworkVersion);
if (!string.IsNullOrEmpty(parsedVersion))
{
return(parsedVersion);
}
}
else if (framework.Equals(workerRuntime.ToString(), StringComparison.OrdinalIgnoreCase))
{
return(frameworkVersion);
}
return(FunctionAppSupportedWorkerRuntime.GetDefaultLanguageVersion(workerRuntime));
}
public static bool IsLinuxFxVersionRuntimeMatched(string linuxFxVersion, WorkerRuntime runtime)
{
if (string.IsNullOrEmpty(linuxFxVersion))
{
// Suppress the check since when LinuxFxVersion == "", runtime image will depends on FUNCTIONS_WORKER_RUNTIME setting
return(true);
}
// Test if linux fx version matches any legacy runtime image (e.g. DOCKER|mcr.microsoft.com/azure-functions/dotnet)
bool isStartingWithDocker = linuxFxVersion.StartsWith("docker|", StringComparison.OrdinalIgnoreCase);
bool isLegacyImageMatched = false;
if (Constants.WorkerRuntimeImages.TryGetValue(runtime, out IEnumerable <string> legacyImages))
{
isLegacyImageMatched = legacyImages
.Any(image => linuxFxVersion.Contains(image, StringComparison.OrdinalIgnoreCase));
}
// Test if linux fx version matches any official runtime image (e.g. DOTNET, DOTNET|2)
bool isOfficialImageMatched = linuxFxVersion.StartsWith(runtime.ToString(), StringComparison.OrdinalIgnoreCase);
return(isOfficialImageMatched || (isStartingWithDocker && isLegacyImageMatched));
}
private static async Task WriteLocalSettingsJson(WorkerRuntime workerRuntime)
{
var localSettingsJsonContent = await StaticResources.LocalSettingsJson;
localSettingsJsonContent = localSettingsJsonContent.Replace($"{{{Constants.FunctionsWorkerRuntime}}}", workerRuntime.ToString());
var storageConnectionStringValue = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
? Constants.StorageEmulatorConnectionString
: string.Empty;
localSettingsJsonContent = localSettingsJsonContent.Replace($"{{{Constants.StorageEmulatorConnectionString}}}", storageConnectionStringValue);
await WriteFiles("local.settings.json", localSettingsJsonContent);
}
private async Task WriteLocalSettingsJson(WorkerRuntime workerRuntime)
{
var localSettingsJsonContent = await StaticResources.LocalSettingsJson;
localSettingsJsonContent = localSettingsJsonContent.Replace($"{{{Constants.FunctionsWorkerRuntime}}}", workerRuntime.ToString());
await WriteFiles("local.settings.json", localSettingsJsonContent);
}
private async Task <IDictionary <string, string> > ValidateFunctionAppPublish(Site functionApp, WorkerRuntime workerRuntime)
{
var result = new Dictionary <string, string>();
// Check version
if (!functionApp.IsLinux)
{
if (functionApp.AzureAppSettings.TryGetValue(Constants.FunctionsExtensionVersion, out string version))
{
// v2 can be either "~2", "beta", or an exact match like "2.0.11961-alpha"
if (!version.Equals("~2") &&
!version.StartsWith("2.0") &&
!version.Equals("beta", StringComparison.OrdinalIgnoreCase))
{
if (Force)
{
result.Add(Constants.FunctionsExtensionVersion, "~2");
}
else
{
throw new CliException("You're trying to publish to a non-v2 function app from v2 tooling.\n" +
"You can pass --force to force update the app to v2, or switch to v1 or v3 tooling for publishing");
}
}
}
}
if (functionApp.AzureAppSettings.TryGetValue(Constants.FunctionsWorkerRuntime, out string workerRuntimeStr))
{
var resolution = $"You can pass --force to update your Azure app with '{workerRuntime}' as a '{Constants.FunctionsWorkerRuntime}'";
try
{
var azureWorkerRuntime = WorkerRuntimeLanguageHelper.NormalizeWorkerRuntime(workerRuntimeStr);
if (azureWorkerRuntime != workerRuntime)
{
if (Force)
{
ColoredConsole.WriteLine(WarningColor($"Setting '{Constants.FunctionsWorkerRuntime}' to '{workerRuntime}' because --force was passed"));
result[Constants.FunctionsWorkerRuntime] = workerRuntime.ToString();
}
else
{
throw new CliException($"Your Azure Function App has '{Constants.FunctionsWorkerRuntime}' set to '{azureWorkerRuntime}' while your local project is set to '{workerRuntime}'.\n"
+ resolution);
}
}
}
catch (ArgumentException) when(Force)
{
result[Constants.FunctionsWorkerRuntime] = workerRuntime.ToString();
}
catch (ArgumentException) when(!Force)
{
throw new CliException($"Your app has an unknown {Constants.FunctionsWorkerRuntime} defined '{workerRuntimeStr}'. Only {WorkerRuntimeLanguageHelper.AvailableWorkersRuntimeString} are supported.\n" +
resolution);
}
}
if (!functionApp.AzureAppSettings.ContainsKey("AzureWebJobsStorage") && functionApp.IsDynamic)
{
throw new CliException($"'{FunctionAppName}' app is missing AzureWebJobsStorage app setting. That setting is required for publishing consumption linux apps.");
}
if (functionApp.IsLinux && !functionApp.IsDynamic && !string.IsNullOrEmpty(functionApp.LinuxFxVersion))
{
// If linuxFxVersion does not match any of our images
if (PublishHelper.IsLinuxFxVersionUsingCustomImage(functionApp.LinuxFxVersion))
{
ColoredConsole.WriteLine($"Your functionapp is using a custom image {functionApp.LinuxFxVersion}.\nAssuming that the image contains the correct framework.\n");
}
// If there the functionapp is our image but does not match the worker runtime image, we either fail or force update
else if (!PublishHelper.IsLinuxFxVersionRuntimeMatched(functionApp.LinuxFxVersion, workerRuntime))
{
if (Force)
{
var updatedSettings = new Dictionary <string, string>
{
[Constants.LinuxFxVersion] = $"DOCKER|{Constants.WorkerRuntimeImages.GetValueOrDefault(workerRuntime).FirstOrDefault()}"
};
var settingsResult = await AzureHelper.UpdateWebSettings(functionApp, updatedSettings, AccessToken, ManagementURL);
if (!settingsResult.IsSuccessful)
{
ColoredConsole.Error
.WriteLine(ErrorColor("Error updating linux image version:"))
.WriteLine(ErrorColor(settingsResult.ErrorResult));
}
}
else
{
throw new CliException($"Your Linux dedicated app has the container image version (LinuxFxVersion) set to {functionApp.LinuxFxVersion} which is not expected for the worker runtime {workerRuntime}. " +
$"To force publish use --force. This will update your app to the expected image for worker runtime {workerRuntime}\n");
}
}
}
return(result);
}
private IDictionary <string, string> ValidateFunctionAppPublish(Site functionApp, WorkerRuntime workerRuntime)
{
var result = new Dictionary <string, string>();
// Check version
if (!functionApp.IsLinux)
{
if (functionApp.AzureAppSettings.TryGetValue(Constants.FunctionsExtensionVersion, out string version))
{
// v2 can be either "~2", "beta", or an exact match like "2.0.11961-alpha"
if (!version.Equals("~2") &&
!version.StartsWith("2.0") &&
!version.Equals("beta", StringComparison.OrdinalIgnoreCase))
{
if (Force)
{
result.Add(Constants.FunctionsExtensionVersion, "~2");
}
else
{
throw new CliException("You're trying to publish to a v1 function app from v2 tooling.\n" +
"You can pass --force to force update the app to v2, or downgrade to v1 tooling for publishing");
}
}
}
}
if (functionApp.AzureAppSettings.TryGetValue(Constants.FunctionsWorkerRuntime, out string workerRuntimeStr))
{
var resolution = $"You can pass --force to update your Azure app with '{workerRuntime}' as a '{Constants.FunctionsWorkerRuntime}'";
try
{
var azureWorkerRuntime = WorkerRuntimeLanguageHelper.NormalizeWorkerRuntime(workerRuntimeStr);
if (azureWorkerRuntime != workerRuntime)
{
if (Force)
{
ColoredConsole.WriteLine(WarningColor($"Setting '{Constants.FunctionsWorkerRuntime}' to '{workerRuntime}' because --force was passed"));
result[Constants.FunctionsWorkerRuntime] = workerRuntime.ToString();
}
else
{
throw new CliException($"Your Azure Function App has '{Constants.FunctionsWorkerRuntime}' set to '{azureWorkerRuntime}' while your local project is set to '{workerRuntime}'.\n"
+ resolution);
}
}
}
catch (ArgumentException) when(Force)
{
result[Constants.FunctionsWorkerRuntime] = workerRuntime.ToString();
}
catch (ArgumentException) when(!Force)
{
throw new CliException($"Your app has an unknown {Constants.FunctionsWorkerRuntime} defined '{workerRuntimeStr}'. Only {WorkerRuntimeLanguageHelper.AvailableWorkersRuntimeString} are supported.\n" +
resolution);
}
}
if (!functionApp.AzureAppSettings.ContainsKey("AzureWebJobsStorage") && functionApp.IsDynamic)
{
throw new CliException($"'{FunctionAppName}' app is missing AzureWebJobsStorage app setting. That setting is required for publishing consumption linux apps.");
}
if (functionApp.IsLinux &&
functionApp.IsDynamic &&
functionApp.AzureAppSettings.ContainsKey("WEBSITE_CONTENTAZUREFILECONNECTIONSTRING"))
{
if (Force)
{
result.Add("WEBSITE_CONTENTSHARE", null);
result.Add("WEBSITE_CONTENTAZUREFILECONNECTIONSTRING", null);
}
else
{
throw new CliException("Your app is configured with Azure Files for editing from Azure Portal.\nTo force publish use --force. This will remove Azure Files from your app.");
}
}
return(result);
}
private static async Task WriteLocalSettingsJson(WorkerRuntime workerRuntime)
{
var localSettingsJsonContent = await StaticResources.LocalSettingsJson;
localSettingsJsonContent = localSettingsJsonContent.Replace($"{{{Constants.FunctionsWorkerRuntime}}}", workerRuntime.ToString());
var storageConnectionStringValue = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
? Constants.StorageEmulatorConnectionString
: string.Empty;
localSettingsJsonContent = localSettingsJsonContent.Replace($"{{{Constants.AzureWebJobsStorage}}}", storageConnectionStringValue);
if (workerRuntime == Helpers.WorkerRuntime.powershell)
{
localSettingsJsonContent = AddWorkerVersion(localSettingsJsonContent, Constants.PowerShellWorkerDefaultVersion);
}
await WriteFiles("local.settings.json", localSettingsJsonContent);
}
