Add e2e test to verify config changes are observed

Author: halter73

src/DefaultBuilder/test/Microsoft.AspNetCore.FunctionalTests/WebApplicationFunctionalTests.cs

@@ -1,12 +1,10 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.IO;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Testing;
 using Microsoft.Extensions.Logging;
-using Xunit;
+using Microsoft.Extensions.Logging.EventLog;
 
 namespace Microsoft.AspNetCore.Tests
 {
@@ -15,9 +13,12 @@ public class WebApplicationFunctionalTests : LoggedTest
         [Fact]
         public async Task LoggingConfigurationSectionPassedToLoggerByDefault()
         {
+            var contentRootPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            Directory.CreateDirectory(contentRootPath);
+
             try
             {
-                await File.WriteAllTextAsync("appsettings.json", @"
+                await File.WriteAllTextAsync(Path.Combine(contentRootPath, "appsettings.json"), @"
 {
     ""Logging"": {
         ""LogLevel"": {
@@ -26,7 +27,7 @@ await File.WriteAllTextAsync("appsettings.json", @"
     }
 }");
 
-                await using var app = WebApplication.Create();
+                await using var app = WebApplication.Create(new[] { "--contentRoot", contentRootPath });
 
                 var factory = (ILoggerFactory)app.Services.GetService(typeof(ILoggerFactory));
                 var logger = factory.CreateLogger("Test");
@@ -48,16 +49,19 @@ await File.WriteAllTextAsync("appsettings.json", @"
             }
             finally
             {
-                File.Delete("appsettings.json");
+                Directory.Delete(contentRootPath, recursive: true);
             }
         }
 
         [Fact]
         public async Task EnvironmentSpecificLoggingConfigurationSectionPassedToLoggerByDefault()
         {
+            var contentRootPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            Directory.CreateDirectory(contentRootPath);
+
             try
             {
-                await File.WriteAllTextAsync("appsettings.Development.json", @"
+                await File.WriteAllTextAsync(Path.Combine(contentRootPath, "appsettings.Development.json"), @"
 {
     ""Logging"": {
         ""LogLevel"": {
@@ -66,13 +70,7 @@ await File.WriteAllTextAsync("appsettings.Development.json", @"
     }
 }");
 
-                var app = WebApplication.Create(new[] { "--environment", "Development" });
-
-                // TODO: Make this work! I think it should be possible if we register our Configuration
-                // as a ChainedConfigurationSource instead of copying over the bootstrapped IConfigurationSources.
-                //var builder = WebApplication.CreateBuilder();
-                //builder.Environment.EnvironmentName = "Development";
-                //await using var app = builder.Build();
+                var app = WebApplication.Create(new[] { "--environment", "Development", "--contentRoot", contentRootPath });
 
                 var factory = (ILoggerFactory)app.Services.GetService(typeof(ILoggerFactory));
                 var logger = factory.CreateLogger("Test");
@@ -94,9 +92,86 @@ await File.WriteAllTextAsync("appsettings.Development.json", @"
             }
             finally
             {
-                File.Delete("appsettings.json");
+                Directory.Delete(contentRootPath, recursive: true);
             }
         }
 
+        [Fact]
+        public async Task LoggingConfigurationReactsToRuntimeChanges()
+        {
+            var contentRootPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            Directory.CreateDirectory(contentRootPath);
+
+            try
+            {
+                await File.WriteAllTextAsync(Path.Combine(contentRootPath, "appsettings.json"), @"
+{
+    ""Logging"": {
+        ""LogLevel"": {
+            ""Default"": ""Error""
+        }
+    }
+}");
+
+                var builder = WebApplication.CreateBuilder(new WebApplicationOptions
+                {
+                    ContentRootPath = contentRootPath,
+                });
+
+                // Disable the EventLogLoggerProvider because HostBuilder.ConfigureDefaults() configures it to log everything warning and higher which overrides non-provider-specific config.
+                // https://github.com/dotnet/runtime/blob/8048fe613933a1cd91e3fad6d571c74f726143ef/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs#L238
+                builder.Logging.AddFilter<EventLogLoggerProvider>(_ => false);
+
+                await using var app = builder.Build();
+
+                var factory = (ILoggerFactory)app.Services.GetService(typeof(ILoggerFactory));
+                var logger = factory.CreateLogger("Test");
+
+                Assert.False(logger.IsEnabled(LogLevel.Warning));
+
+                logger.Log(LogLevel.Warning, 0, "Message", null, (s, e) =>
+                {
+                    Assert.True(false);
+                    return string.Empty;
+                });
+
+                // Lower log level from Error to Warning and wait for logging to react to the config changes.
+                var configChangedTcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
+                using var registration = app.Configuration.GetReloadToken().RegisterChangeCallback(
+                    tcs => ((TaskCompletionSource)tcs).SetResult(), configChangedTcs);
+
+                await File.WriteAllTextAsync(Path.Combine(contentRootPath, "appsettings.json"), @"
+{
+    ""Logging"": {
+        ""LogLevel"": {
+            ""Default"": ""Warning""
+        }
+    }
+}");
+
+                // Wait for a config change notification because logging will not react until this is fired. Even then, it won't react immediately
+                // so we loop until success or a timeout.
+                await configChangedTcs.Task.DefaultTimeout();
+
+                var timeoutTicks = Environment.TickCount64 + Testing.TaskExtensions.DefaultTimeoutDuration;
+                var logWritten = false;
+
+                while (!logWritten && Environment.TickCount < timeoutTicks)
+                {
+                    logger.Log(LogLevel.Warning, 0, "Message", null, (s, e) =>
+                    {
+                        logWritten = true;
+                        return string.Empty;
+                    });
+                }
+
+                Assert.True(logWritten);
+                Assert.True(logger.IsEnabled(LogLevel.Warning));
+            }
+            finally
+            {
+                Directory.Delete(contentRootPath, recursive: true);
+            }
+        }
     }
 }

src/Shared/TaskExtensions.cs

@@ -25,9 +25,9 @@ static class TaskExtensions
 #if DEBUG
         // Shorter duration when running tests with debug.
         // Less time waiting for hang unit tests to fail in aspnetcore solution.
-        private const int DefaultTimeoutDuration = 5 * 1000;
+        public const int DefaultTimeoutDuration = 5 * 1000;
 #else
-        private const int DefaultTimeoutDuration = 30 * 1000;
+        public const int DefaultTimeoutDuration = 30 * 1000;
 #endif
 
         public static TimeSpan DefaultTimeoutTimeSpan { get; } = TimeSpan.FromMilliseconds(DefaultTimeoutDuration);