Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteEventLogging.Tests/SiteEventLoggerTests.cs
T
Joseph Doherty 0d8a80aa27 feat(localdb): rewire SiteEventLogger onto the consolidated site database
Completes Task 5a of the LocalDb Phase 1 adoption plan. The GUID-id half landed
with Task 2 (727fa48c) because leaving it out would have committed a writer that
could not satisfy site_events.id NOT NULL; this is the connection half, which
was blocked on Task 3.

SiteEventLogger owned a SqliteConnection built from SiteEventLogOptions
.DatabasePath. It now takes ILocalDb and gets that connection from
CreateConnection() - already open, pragma-configured, and carrying the
zb_hlc_next() UDF that site_events' capture triggers call. It still owns and
disposes the connection; WithConnection's signature and locking semantics are
untouched, so EventLogQueryService and EventLogPurgeService are unaffected.

The connectionStringOverride seam is deleted rather than preserved. site_events
is a replicated table, so a raw connection lacks the UDF and fails closed on
every insert - an override could only produce a logger that cannot write. It had
no callers outside this class (the connectionStringOverride hits elsewhere in the
tree belong to SqliteAuditWriter, a different type).

Tests: a shared TestLocalDb helper gives each fixture a real ILocalDb over a temp
file. Real rather than stubbed on purpose - a stub handing back a bare
SqliteConnection would pass today and fail closed the moment the table is
registered, which is exactly the silent-wiring failure mode this family has hit
three times. ServiceWiringTests' DI path also needed AddZbLocalDb, mirroring
SiteServiceRegistration.

Verified: build 0 warnings; SiteEventLogging 70/70, Host 294/294,
SiteRuntime 530/530.

Claude-Session: https://claude.ai/code/session_01BL2Vu1ESDQ9SCN4gVKkdts
2026-07-19 09:07:49 -04:00

187 lines
7.2 KiB
C#

using Microsoft.Data.Sqlite;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.SiteEventLogging.Tests;
public class SiteEventLoggerTests : IDisposable
{
private readonly SiteEventLogger _logger;
private readonly SqliteConnection _verifyConnection;
private readonly string _dbPath;
private readonly TestLocalDb _localDb;
public SiteEventLoggerTests()
{
_dbPath = Path.Combine(Path.GetTempPath(), $"test_events_{Guid.NewGuid()}.db");
var options = Options.Create(new SiteEventLogOptions { DatabasePath = _dbPath });
_localDb = TestLocalDb.Create(_dbPath);
_logger = new SiteEventLogger(options, NullLogger<SiteEventLogger>.Instance, _localDb.Db);
// Separate connection for verification queries
_verifyConnection = new SqliteConnection($"Data Source={_dbPath}");
_verifyConnection.Open();
}
public void Dispose()
{
_verifyConnection.Dispose();
_logger.Dispose();
_localDb.Dispose();
TestLocalDb.DeleteFiles(_dbPath);
}
[Fact]
public async Task LogEventAsync_InsertsRecord()
{
await _logger.LogEventAsync("script", "Error", "inst-1", "ScriptActor:Monitor", "Script failed", "{\"stack\":\"...\"}");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT COUNT(*) FROM site_events";
var count = (long)cmd.ExecuteScalar()!;
Assert.Equal(1, count);
}
[Fact]
public async Task LogEventAsync_StoresAllFields()
{
await _logger.LogEventAsync("alarm", "Warning", "inst-2", "AlarmActor:TempHigh", "Alarm triggered", "{\"value\":95}");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT event_type, severity, instance_id, source, message, details FROM site_events LIMIT 1";
using var reader = cmd.ExecuteReader();
Assert.True(reader.Read());
Assert.Equal("alarm", reader.GetString(0));
Assert.Equal("Warning", reader.GetString(1));
Assert.Equal("inst-2", reader.GetString(2));
Assert.Equal("AlarmActor:TempHigh", reader.GetString(3));
Assert.Equal("Alarm triggered", reader.GetString(4));
Assert.Equal("{\"value\":95}", reader.GetString(5));
}
[Fact]
public async Task LogEventAsync_NullableFieldsAllowed()
{
await _logger.LogEventAsync("deployment", "Info", null, "DeploymentManager", "Deployed instance");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT instance_id, details FROM site_events LIMIT 1";
using var reader = cmd.ExecuteReader();
Assert.True(reader.Read());
Assert.True(reader.IsDBNull(0));
Assert.True(reader.IsDBNull(1));
}
[Fact]
public async Task LogEventAsync_StoresIso8601UtcTimestamp()
{
await _logger.LogEventAsync("connection", "Info", null, "DCL", "Connected");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT timestamp FROM site_events LIMIT 1";
var ts = (string)cmd.ExecuteScalar()!;
var parsed = DateTimeOffset.Parse(ts);
Assert.Equal(TimeSpan.Zero, parsed.Offset);
}
[Fact]
public async Task LogEventAsync_ThrowsOnEmptyEventType()
{
await Assert.ThrowsAsync<ArgumentException>(() =>
_logger.LogEventAsync("", "Info", null, "Source", "Message"));
}
[Fact]
public async Task LogEventAsync_ThrowsOnEmptySeverity()
{
await Assert.ThrowsAsync<ArgumentException>(() =>
_logger.LogEventAsync("script", "", null, "Source", "Message"));
}
[Fact]
public async Task LogEventAsync_ThrowsOnEmptySource()
{
await Assert.ThrowsAsync<ArgumentException>(() =>
_logger.LogEventAsync("script", "Info", null, "", "Message"));
}
[Fact]
public async Task LogEventAsync_ThrowsOnEmptyMessage()
{
await Assert.ThrowsAsync<ArgumentException>(() =>
_logger.LogEventAsync("script", "Info", null, "Source", ""));
}
[Fact]
public async Task LogEventAsync_MultipleEvents_GetDistinctApplicationMintedIds()
{
// Replaces LogEventAsync_MultipleEvents_AutoIncrementIds. Ids are no longer
// server-minted autoincrement integers: under LocalDb replication the site pair
// converges by last-writer-wins on the primary key, so both nodes issuing 1, 2,
// 3... for unrelated events would silently overwrite each other on sync.
//
// The invariant is therefore uniqueness, NOT monotonicity — ordering is carried
// by the timestamp column, which is what the query and purge paths sort on.
await _logger.LogEventAsync("script", "Info", null, "S1", "First");
await _logger.LogEventAsync("script", "Info", null, "S2", "Second");
await _logger.LogEventAsync("script", "Info", null, "S3", "Third");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT id FROM site_events ORDER BY timestamp";
using var reader = cmd.ExecuteReader();
var ids = new List<string>();
while (reader.Read()) ids.Add(reader.GetString(0));
Assert.Equal(3, ids.Count);
Assert.All(ids, id => Assert.False(string.IsNullOrWhiteSpace(id)));
Assert.Equal(3, ids.Distinct(StringComparer.Ordinal).Count());
Assert.All(ids, id => Assert.True(Guid.TryParseExact(id, "N", out _),
$"Event id '{id}' is not a GUID in 'N' format."));
}
[Fact]
public async Task AllEventTypes_Accepted()
{
var types = new[] { "script", "alarm", "deployment", "connection", "store_and_forward", "instance_lifecycle" };
foreach (var t in types)
{
await _logger.LogEventAsync(t, "Info", null, "Test", $"Event type: {t}");
}
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT COUNT(DISTINCT event_type) FROM site_events";
var count = (long)cmd.ExecuteScalar()!;
Assert.Equal(6, count);
}
// --- SiteEventLogging-020: severity validation against the closed set ---
[Theory]
[InlineData("info")] // wrong casing
[InlineData("warn")] // abbreviation
[InlineData("ERROR")] // wrong casing
[InlineData("Debug")] // not in set
[InlineData("Critical")] // not in set
public async Task LogEventAsync_ThrowsOnUnknownSeverity(string badSeverity)
{
var ex = await Assert.ThrowsAsync<ArgumentException>(
() => _logger.LogEventAsync("script", badSeverity, null, "Source", "Message"));
Assert.Contains(badSeverity, ex.Message);
Assert.Contains("Info, Warning, Error", ex.Message);
}
[Theory]
[InlineData("Info")]
[InlineData("Warning")]
[InlineData("Error")]
public async Task LogEventAsync_AcceptsAllDocumentedSeverities(string severity)
{
await _logger.LogEventAsync("script", severity, null, "Source", "Message");
using var cmd = _verifyConnection.CreateCommand();
cmd.CommandText = "SELECT severity FROM site_events";
var stored = (string)cmd.ExecuteScalar()!;
Assert.Equal(severity, stored);
}
}