using System.Net; using System.Net.Http.Json; using System.Text; using System.Text.Json; using System.Text.Json.Nodes; using System.Text.RegularExpressions; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Chronos.Core.Diagnostics; using Chronos.Protocol; using Chronos.Server.Configuration; using Chronos.Server.Hosting; using Chronos.Testing; using CoreLog = Chronos.Core.Diagnostics.Log; using LogLevel = Microsoft.Extensions.Logging.LogLevel; namespace Chronos.Server.Tests.Hosting; /// /// The server's log settings (owner review 2, R11). Serial: the engine's is one per process, its /// sink the last server's started and its level the lower of that server's two. /// [Category("server")] [Serial] public sealed partial class LoggingTests(TestContext context) { [Test] public async Task DebugLinesReachTheFilesWhenTheLevelAsksForThem() { // The files' logger stopped at Information whatever CHRONOS_LOG_LEVEL said. var root = context.CreateTempDirectory("debug-variable"); var variable = ServerOptions.Load(new Dictionary { ["CHRONOS_DATA_PATH"] = root, ["CHRONOS_DB"] = "postgres", ["CHRONOS_LOG_LEVEL"] = "Debug" }); Assert.Equal((LogLevel.Debug, LogLevel.Debug), (variable.LogLevel, variable.ConsoleLogLevel)); // The console stays at Warning, so the test log stays readable: the files have their own level. await using var server = await TestServer.StartAsync(context, o => o.LogLevel = variable.LogLevel); var marker = Guid.NewGuid().ToString("N"); var logger = server.Services.GetRequiredService().CreateLogger("Chronos.Server.Tests"); logger.LogDebug("debug {Marker}", marker); logger.LogTrace("trace {Marker}", marker); CoreLog.Debug("tests", "engine debug " + marker); // ASP.NET Core's own lines stay at Warning and above. server.Services.GetRequiredService().CreateLogger("Microsoft.AspNetCore.Routing").LogDebug("routing {Marker}", marker); var text = Logs(server); Assert.Contains("Debug Chronos.Server.Tests: debug " + marker, text); Assert.Contains("Debug Chronos.tests: engine debug " + marker, text); Assert.False(text.Contains("trace " + marker, StringComparison.Ordinal), "Trace is below Debug"); Assert.False(text.Contains("routing " + marker, StringComparison.Ordinal), "request lines stay out"); var logging = server.Services.GetRequiredService(); Assert.Equal((LogLevel.Debug, LogLevel.Warning, Chronos.Core.Diagnostics.LogLevel.Debug), (logging.FileLevel, logging.ConsoleLevel, CoreLog.MinimumLevel)); } [Test] public async Task TheFileLevelChangesWhileTheServerRuns() { await using var server = await TestServer.StartAsync(context, o => o.LogLevel = LogLevel.Debug); var admin = await server.AdminAsync(); var logger = server.Services.GetRequiredService().CreateLogger("Chronos.Server.Tests"); var marker = Guid.NewGuid().ToString("N"); logger.LogDebug("before {Marker}", marker); var settings = await SettingsAsync(admin); Assert.Equal(("debug", "warning"), (settings.Logs.FileLevel, settings.Logs.ConsoleLevel)); // The test server listens on ports the system chose (0), which no request may set. var edited = settings with { HttpPort = 18080, HttpsPort = 18443, Logs = settings.Logs with { FileLevel = "information" } }; using (var saved = await admin.PutAsJsonAsync("/api/v1/server/settings", edited, ProtocolJson.Default.ServerSettingsDto)) Assert.Equal("information", (await saved.ReadAsync(ProtocolJson.Default.ServerSettingsDto)).Logs.FileLevel); logger.LogDebug("after {Marker}", marker); CoreLog.Debug("tests", "engine after " + marker); logger.LogInformation("information {Marker}", marker); var text = Logs(server); Assert.Contains("before " + marker, text); Assert.Contains("information " + marker, text); Assert.False(text.Contains("after " + marker, StringComparison.Ordinal), "Debug stopped at once"); Assert.Equal((LogLevel.Information, Chronos.Core.Diagnostics.LogLevel.Info), (server.Options.LogLevel, CoreLog.MinimumLevel)); var file = JsonNode.Parse(await File.ReadAllTextAsync(server.Options.SettingsFile))!.AsObject(); Assert.Equal("Information", file["LogLevel"]!.GetValue()); Assert.False(file.ContainsKey("ConsoleLogLevel"), "only what changed is written"); } [Test] public async Task LogSettingsAreSavedAppliedAndValidated() { await using var server = await TestServer.StartAsync(context); var admin = await server.AdminAsync(); var settings = await SettingsAsync(admin); Assert.Equal(new LogSettingsDto("warning", "warning", 14, 50, 1024, "daily", 0, 4), settings.Logs); var edited = settings with { HttpPort = 18080, HttpsPort = 18443, Logs = new LogSettingsDto("Debug", "error", 30, 10, 200, "Hourly", 365, 8) }; using (var saved = await admin.PutAsJsonAsync("/api/v1/server/settings", edited, ProtocolJson.Default.ServerSettingsDto)) Assert.Equal(new LogSettingsDto("debug", "error", 30, 10, 200, "hourly", 365, 8), (await saved.ReadAsync(ProtocolJson.Default.ServerSettingsDto)).Logs); var o = server.Options; Assert.Equal((LogLevel.Debug, LogLevel.Error, 30, 10, 200), (o.LogLevel, o.ConsoleLogLevel, o.LogRetentionDays, o.LogMaxFileMb, o.LogMaxTotalMb)); Assert.Equal((LogRotation.Hourly, 365, 8), (o.LogRotation, o.AuditRetentionDays, o.DiagnosticsLogMb)); var logging = server.Services.GetRequiredService(); Assert.Equal(new LogFileOptions { Level = Chronos.Core.Diagnostics.LogLevel.Debug, RetentionDays = 30, MaxFileMb = 10, MaxTotalMb = 200, Rotation = LogRotation.Hourly }, logging.Sink.Options); Assert.Equal((LogLevel.Debug, LogLevel.Error), (logging.FileLevel, logging.ConsoleLevel)); // Without a restart, the next line goes to an hourly file. var marker = Guid.NewGuid().ToString("N"); server.Services.GetRequiredService().CreateLogger("Chronos.Server.Tests").LogWarning("hourly {Marker}", marker); Assert.True(Directory.EnumerateFiles(o.LogPath).Any(f => HourlyName().IsMatch(Path.GetFileName(f)) && Read(f).Contains(marker, StringComparison.Ordinal)), "an hourly file holds the line"); // server.json takes the names it reads back at the next start. var file = JsonNode.Parse(await File.ReadAllTextAsync(o.SettingsFile))!.AsObject(); Assert.Equal(("Debug", "Error", "Hourly", 30, 365), (file["LogLevel"]!.GetValue(), file["ConsoleLogLevel"]!.GetValue(), file["LogRotation"]!.GetValue(), file["LogRetentionDays"]!.GetValue(), file["AuditRetentionDays"]!.GetValue())); var restarted = ServerOptions.Load(new Dictionary { ["CHRONOS_DATA_PATH"] = o.DataPath, ["CHRONOS_DB"] = "postgres" }); Assert.Equal((LogLevel.Debug, LogLevel.Error, LogRotation.Hourly, 10, 200, 8), (restarted.LogLevel, restarted.ConsoleLogLevel, restarted.LogRotation, restarted.LogMaxFileMb, restarted.LogMaxTotalMb, restarted.DiagnosticsLogMb)); // A panel that knows no log group keeps them as they are. var older = JsonSerializer.SerializeToNode(edited with { ServerName = "Older panel" }, ProtocolJson.Default.ServerSettingsDto)!.AsObject(); Assert.True(older.Remove("logs")); using (var content = new StringContent(older.ToJsonString(), Encoding.UTF8, "application/json")) using (var saved = await admin.PutAsync("/api/v1/server/settings", content)) Assert.Equal(new LogSettingsDto("debug", "error", 30, 10, 200, "hourly", 365, 8), (await saved.ReadAsync(ProtocolJson.Default.ServerSettingsDto)).Logs); var logs = edited.Logs; foreach (var (invalid, setting) in new (LogSettingsDto, string)[] { (logs with { FileLevel = "verbose" }, "LogLevel"), (logs with { ConsoleLevel = "3" }, "ConsoleLogLevel"), (logs with { Rotation = "weekly" }, "LogRotation"), (logs with { RetentionDays = 0 }, "LogRetentionDays"), (logs with { MaxFileMb = -1 }, "LogMaxFileMb"), (logs with { MaxFileMb = 300 }, "LogMaxTotalMb"), (logs with { MaxTotalMb = -5 }, "LogMaxTotalMb"), (logs with { AuditRetentionDays = -1 }, "AuditRetentionDays"), (logs with { DiagnosticsLogMb = 0 }, "DiagnosticsLogMb"), }) { using var refused = await admin.PutAsJsonAsync("/api/v1/server/settings", edited with { Logs = invalid }, ProtocolJson.Default.ServerSettingsDto); Assert.Equal(setting, (await refused.ExpectErrorAsync(HttpStatusCode.BadRequest, "invalid_setting")).Details); } // No limits at all are a choice too. using (var unlimited = await admin.PutAsJsonAsync("/api/v1/server/settings", edited with { Logs = logs with { MaxFileMb = 0, MaxTotalMb = 0 } }, ProtocolJson.Default.ServerSettingsDto)) await unlimited.ExpectAsync(HttpStatusCode.OK); Assert.Equal((0, 0), (logging.Sink.Options.MaxFileMb, logging.Sink.Options.MaxTotalMb)); } [Test] public async Task LevelsSetByTheEnvironmentAreLocked() { await using var server = await TestServer.StartAsync(context, o => o.Locked = [nameof(ServerOptions.LogLevel), nameof(ServerOptions.ConsoleLogLevel)]); var admin = await server.AdminAsync(); var settings = await SettingsAsync(admin); Assert.Contains("ConsoleLogLevel", settings.Locked); var edited = settings with { HttpPort = 18080, HttpsPort = 18443 }; using (var refused = await admin.PutAsJsonAsync("/api/v1/server/settings", edited with { Logs = edited.Logs with { ConsoleLevel = "debug" } }, ProtocolJson.Default.ServerSettingsDto)) Assert.Equal("ConsoleLogLevel", (await refused.ExpectErrorAsync(HttpStatusCode.Conflict, "setting_locked")).Details); Assert.Equal(LogLevel.Warning, server.Options.ConsoleLogLevel); // The settings no variable fixes still save. using (var saved = await admin.PutAsJsonAsync("/api/v1/server/settings", edited with { Logs = edited.Logs with { RetentionDays = 7 } }, ProtocolJson.Default.ServerSettingsDto)) await saved.ExpectAsync(HttpStatusCode.OK); Assert.Equal(7, server.Options.LogRetentionDays); } private static async Task SettingsAsync(HttpClient admin) { using var read = await admin.GetAsync("/api/v1/server/settings"); return await read.ReadAsync(ProtocolJson.Default.ServerSettingsDto); } /// Every server log file, read beside the sink that may still be writing it. private static string Logs(TestServer server) => string.Concat(Directory.EnumerateFiles(server.Options.LogPath, "server-*.log").Order(StringComparer.Ordinal).Select(Read)); private static string Read(string path) { using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite); using var reader = new StreamReader(stream); return reader.ReadToEnd(); } [GeneratedRegex(@"^server-\d{8}-\d{2}(\.\d+)?\.log$")] private static partial Regex HourlyName(); }