Unifying CV2 SKU/Environment checks (#9334)

Author: mathewc

src/WebJobs.Script.WebHost/ContainerManagement/LinuxContainerInitializationHostService.cs

@@ -41,7 +41,7 @@ public async Task StartAsync(CancellationToken cancellationToken)
             {
                 await ApplyStartContextIfPresent();
             }
-            else if (_environment.IsLinuxConsumptionOnLegion())
+            else if (_environment.IsFlexConsumptionSku())
             {
                 _logger.LogInformation("Container has (re)started. Waiting for specialization");
             }

src/WebJobs.Script.WebHost/Program.cs

@@ -91,7 +91,7 @@ private static void InitializeProcess()
             {
                 AppDomain.CurrentDomain.UnhandledException += CurrentDomainOnUnhandledExceptionInLinuxConsumption;
             }
-            else if (SystemEnvironment.Instance.IsLinuxConsumptionOnLegion())
+            else if (SystemEnvironment.Instance.IsFlexConsumptionSku())
             {
                 //todo: Replace with legion specific logger.
                 AppDomain.CurrentDomain.UnhandledException += CurrentDomainOnUnhandledExceptionInLinuxConsumption;

src/WebJobs.Script.WebHost/Security/Authentication/Jwt/ScriptJwtBearerExtensions.cs

@@ -74,7 +74,7 @@ public static AuthenticationBuilder AddScriptJwtBearer(this AuthenticationBuilde
         private static string[] GetValidAudiences()
         {
             if (SystemEnvironment.Instance.IsPlaceholderModeEnabled() &&
-                SystemEnvironment.Instance.IsLinuxConsumptionOnLegion())
+                SystemEnvironment.Instance.IsFlexConsumptionSku())
             {
                 return new string[]
                 {

src/WebJobs.Script.WebHost/WebHostServiceCollectionExtensions.cs

@@ -130,7 +130,7 @@ public static void AddWebJobsScriptHost(this IServiceCollection services, IConfi
             services.AddTransient<VirtualFileSystem>();
             services.AddTransient<VirtualFileSystemMiddleware>();
 
-            if (SystemEnvironment.Instance.IsLinuxConsumptionOnLegion())
+            if (SystemEnvironment.Instance.IsFlexConsumptionSku())
             {
                 services.AddSingleton<IInstanceManager, LegionInstanceManager>();
             }

src/WebJobs.Script/Environment/EnvironmentExtensions.cs

@@ -220,7 +220,14 @@ public static bool IsConsumptionSku(this IEnvironment environment)
         public static bool IsFlexConsumptionSku(this IEnvironment environment)
         {
             string value = environment.GetEnvironmentVariable(AzureWebsiteSku);
-            return string.Equals(value, ScriptConstants.FlexConsumptionSku, StringComparison.OrdinalIgnoreCase);
+            if (string.Equals(value, ScriptConstants.FlexConsumptionSku, StringComparison.OrdinalIgnoreCase))
+            {
+                return true;
+            }
+
+            // when in placeholder mode, site settings like SKU are not available
+            // to enable this check to run in both modes, we check additional settings
+            return environment.IsLinuxConsumptionOnLegion();
         }
 
         /// <summary>
@@ -299,7 +306,7 @@ public static bool IsManagedAppEnvironment(this IEnvironment environment)
         /// <returns><see cref="true"/> if running in a Linux Consumption App Service app; otherwise, false.</returns>
         public static bool IsAnyLinuxConsumption(this IEnvironment environment)
         {
-            return (environment.IsLinuxConsumptionOnAtlas() || environment.IsLinuxConsumptionOnLegion()) && !environment.IsManagedAppEnvironment();
+            return (environment.IsLinuxConsumptionOnAtlas() || environment.IsFlexConsumptionSku()) && !environment.IsManagedAppEnvironment();
         }
 
         public static bool IsLinuxConsumptionOnAtlas(this IEnvironment environment)
@@ -309,7 +316,7 @@ public static bool IsLinuxConsumptionOnAtlas(this IEnvironment environment)
                    string.IsNullOrEmpty(environment.GetEnvironmentVariable(LegionServiceHost));
         }
 
-        public static bool IsLinuxConsumptionOnLegion(this IEnvironment environment)
+        private static bool IsLinuxConsumptionOnLegion(this IEnvironment environment)
         {
             return !environment.IsAppService() &&
                    (!string.IsNullOrEmpty(environment.GetEnvironmentVariable(ContainerName)) ||

test/WebJobs.Script.Tests.Integration/ContainerManagement/LinuxContainerInitializationHostServiceTests.cs

@@ -59,7 +59,7 @@ public async Task Does_Not_Run_In_Linux_Container_On_Legion()
             _environment.SetEnvironmentVariable(LegionServiceHost, "1");
             Assert.True(_environment.IsAnyLinuxConsumption());
             Assert.False(_environment.IsLinuxConsumptionOnAtlas());
-            Assert.True(_environment.IsLinuxConsumptionOnLegion());
+            Assert.True(_environment.IsFlexConsumptionSku());
 
             var initializationHostService = new LinuxContainerInitializationHostService(_environment, _instanceManagerMock.Object, NullLogger<LinuxContainerInitializationHostService>.Instance, _startupContextProvider);
             await initializationHostService.StartAsync(CancellationToken.None);

test/WebJobs.Script.Tests.Integration/Host/StandbyManager/StandbyManagerE2ETests_Linux.cs

@@ -53,7 +53,7 @@ public async Task StandbyModeE2E_LinuxContainer()
             var environment = new TestEnvironment(vars);
 
             Assert.True(environment.IsLinuxConsumptionOnAtlas());
-            Assert.False(environment.IsLinuxConsumptionOnLegion());
+            Assert.False(environment.IsFlexConsumptionSku());
             Assert.True(environment.IsAnyLinuxConsumption());
 
             await InitializeTestHostAsync("Linux", environment);

test/WebJobs.Script.Tests/Environment/EnvironmentTests.cs

@@ -232,7 +232,7 @@ public void Returns_IsLinuxConsumption(string websiteInstanceId, string containe
             testEnvironment.SetEnvironmentVariable(EnvironmentSettingNames.LegionServiceHost, legionServiceHost);
             Assert.Equal(isLinuxConsumptionOnAtlas || isLinuxConsumptionOnLegion, testEnvironment.IsAnyLinuxConsumption());
             Assert.Equal(isLinuxConsumptionOnAtlas, testEnvironment.IsLinuxConsumptionOnAtlas());
-            Assert.Equal(isLinuxConsumptionOnLegion, testEnvironment.IsLinuxConsumptionOnLegion());
+            Assert.Equal(isLinuxConsumptionOnLegion, testEnvironment.IsFlexConsumptionSku());
             Assert.Equal(isLinuxConsumptionOnAtlas || isLinuxConsumptionOnLegion, testEnvironment.IsConsumptionSku());
             Assert.Equal(isLinuxConsumptionOnAtlas || isLinuxConsumptionOnLegion, testEnvironment.IsDynamicSku());
             Assert.False(isLinuxConsumptionOnAtlas ? isLinuxConsumptionOnLegion : isLinuxConsumptionOnAtlas);

test/WebJobs.Script.Tests/Extensions/EnvironmentExtensionsTests.cs

@@ -183,14 +183,21 @@ public void IsConsumptionSku_ReturnsExpectedResult(bool isLinuxConsumption, bool
         }
 
         [Theory]
-        [InlineData("FlexConsumption", true)]
-        [InlineData("Dynamic", false)]
-        [InlineData("ElasticPremium", false)]
-        [InlineData("", false)]
-        public void IsFlexConsumptionSku_ReturnsExpectedResult(string sku, bool expected)
+        [InlineData("FlexConsumption", "", "", "", true)] // not a valid configuration, but testing for thoroughness
+        [InlineData(null, "", "container-name", "1", true)] // simulate placeholder mode where SKU not available yet
+        [InlineData("FlexConsumption", "", "container-name", "1", true)] // expected state when specialized
+        [InlineData(null, "website-instance-id", "container-name", "1", false)] // not a valid configuration, but testing for thoroughness
+        [InlineData("Dynamic", "", "", "", false)]
+        [InlineData("ElasticPremium", "", "", "", false)]
+        [InlineData("", "", "", "", false)]
+        public void IsFlexConsumptionSku_ReturnsExpectedResult(string sku, string websiteInstanceId, string containerName, string legionServiceHost, bool expected)
         {
             IEnvironment env = new TestEnvironment();
             env.SetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteSku, sku);
+            env.SetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteInstanceId, websiteInstanceId);
+            env.SetEnvironmentVariable(EnvironmentSettingNames.ContainerName, containerName);
+            env.SetEnvironmentVariable(EnvironmentSettingNames.LegionServiceHost, legionServiceHost);
+
             Assert.Equal(expected, env.IsFlexConsumptionSku());
         }
 

test/WebJobs.Script.Tests/FunctionsSyncServiceTests.cs

@@ -131,6 +131,15 @@ public void IsSyncTriggersEnvironment_StandbyMode_ReturnsExpectedResult(bool isA
         {
             _mockWebHostEnvironment.SetupGet(p => p.InStandbyMode).Returns(standbyMode);
 
+            if (isConsumptionLinuxOnLegion)
+            {
+                _mockEnvironment.Setup(p => p.GetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteSku)).Returns(ScriptConstants.FlexConsumptionSku);
+            }
+            else
+            {
+                _mockEnvironment.Setup(p => p.GetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteSku)).Returns(ScriptConstants.DynamicSku);
+            }
+
             _mockEnvironment.Setup(p => p.GetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteInstanceId)).Returns(isAppService ? "1" : null);
             _mockEnvironment.Setup(p => p.GetEnvironmentVariable(EnvironmentSettingNames.WebSiteAuthEncryptionKey)).Returns(hasEncryptionKey ? "1" : null);
             _mockEnvironment.Setup(p => p.GetEnvironmentVariable(EnvironmentSettingNames.ContainerName)).Returns(isConsumptionLinuxOnAtlas || isConsumptionLinuxOnLegion ? "1" : null);