Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
78 lines
2.6 KiB
C#
78 lines
2.6 KiB
C#
using Serilog;
|
|
using Serilog.Events;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
|
|
|
|
/// <summary>
|
|
/// Tests for Serilog structured logging with enriched properties.
|
|
/// </summary>
|
|
public class SerilogTests
|
|
{
|
|
/// <summary>Verifies that the Serilog logger enriches events with node properties.</summary>
|
|
[Fact]
|
|
public void SerilogLogger_EnrichesWithNodeProperties()
|
|
{
|
|
var sink = new InMemorySink();
|
|
|
|
var logger = new LoggerConfiguration()
|
|
.Enrich.WithProperty("SiteId", "TestSite")
|
|
.Enrich.WithProperty("NodeHostname", "test-node1")
|
|
.Enrich.WithProperty("NodeRole", "Site")
|
|
.WriteTo.Sink(sink)
|
|
.CreateLogger();
|
|
|
|
logger.Information("Test log message");
|
|
|
|
Assert.Single(sink.LogEvents);
|
|
var logEvent = sink.LogEvents[0];
|
|
|
|
Assert.True(logEvent.Properties.ContainsKey("SiteId"));
|
|
Assert.Equal("\"TestSite\"", logEvent.Properties["SiteId"].ToString());
|
|
|
|
Assert.True(logEvent.Properties.ContainsKey("NodeHostname"));
|
|
Assert.Equal("\"test-node1\"", logEvent.Properties["NodeHostname"].ToString());
|
|
|
|
Assert.True(logEvent.Properties.ContainsKey("NodeRole"));
|
|
Assert.Equal("\"Site\"", logEvent.Properties["NodeRole"].ToString());
|
|
}
|
|
|
|
/// <summary>Verifies that the logger enriches events with a site id of Central for the central role.</summary>
|
|
[Fact]
|
|
public void SerilogLogger_CentralRole_EnrichesSiteIdAsCentral()
|
|
{
|
|
var sink = new InMemorySink();
|
|
|
|
var logger = new LoggerConfiguration()
|
|
.Enrich.WithProperty("SiteId", "central")
|
|
.Enrich.WithProperty("NodeHostname", "central-node1")
|
|
.Enrich.WithProperty("NodeRole", "Central")
|
|
.WriteTo.Sink(sink)
|
|
.CreateLogger();
|
|
|
|
logger.Warning("Central warning");
|
|
|
|
Assert.Single(sink.LogEvents);
|
|
var logEvent = sink.LogEvents[0];
|
|
|
|
Assert.Equal(LogEventLevel.Warning, logEvent.Level);
|
|
Assert.Equal("\"central\"", logEvent.Properties["SiteId"].ToString());
|
|
Assert.Equal("\"Central\"", logEvent.Properties["NodeRole"].ToString());
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Simple in-memory Serilog sink for testing.
|
|
/// </summary>
|
|
public class InMemorySink : Serilog.Core.ILogEventSink
|
|
{
|
|
/// <summary>Gets the log events captured so far.</summary>
|
|
public List<LogEvent> LogEvents { get; } = new();
|
|
|
|
/// <summary>Stores the log event for later assertions.</summary>
|
|
/// <param name="logEvent">The log event to capture.</param>
|
|
public void Emit(LogEvent logEvent)
|
|
{
|
|
LogEvents.Add(logEvent);
|
|
}
|
|
}
|