Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests/Repositories/AuditLogRepositoryTraceEventsTests.cs
T
Joseph Doherty 9300bc1a4f feat(audit): GetTraceEventsAsync returns the ScriptTrace chain for Replay
Flow Debugger (design 2026-09-05 §7.1): IAuditLogRepository.GetTraceEventsAsync walks any
entry id to its root and down the Edges/Chain CTE exactly as GetExecutionTreeAsync, then
returns the chain's ScriptTrace rows plus the ApiInbound.InboundRequest row via the canonical
row mapper, ordered (OccurredAtUtc, EventId). Test doubles implement the new member with a
NotSupported stub.

Claude-Session: https://claude.ai/code/session_01GSLkkHKz9JrAtmJjmQK3cP
2026-09-05 23:59:08 -04:00

77 lines
4.4 KiB
C#

using Microsoft.EntityFrameworkCore;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Debugging;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase;
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Repositories;
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests.Migrations;
using Xunit;
namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests.Repositories;
/// <summary>
/// Flow Debugger Replay (design 2026-09-05 §7.1): <see cref="AuditLogRepository.GetTraceEventsAsync"/>
/// returns the whole chain's ScriptTrace rows plus the inbound row, from ANY entry id, ordered,
/// and excludes unrelated and non-trace rows. Runs against the shared MSSQL fixture.
/// </summary>
public class AuditLogRepositoryTraceEventsTests : IClassFixture<MsSqlMigrationFixture>
{
private readonly MsSqlMigrationFixture _fixture;
public AuditLogRepositoryTraceEventsTests(MsSqlMigrationFixture fixture) => _fixture = fixture;
private ScadaBridgeDbContext CreateContext() => new(
new DbContextOptionsBuilder<ScadaBridgeDbContext>().UseSqlServer(_fixture.ConnectionString).Options);
[SkippableFact]
public async Task ReturnsInboundPlusChainTraceRows_Ordered_FromAnyEntry()
{
Skip.IfNot(_fixture.Available, _fixture.SkipReason);
var siteId = "test-trace-" + Guid.NewGuid().ToString("N")[..8];
var t0 = new DateTime(2026, 9, 5, 12, 0, 0, DateTimeKind.Utc);
var root = Guid.NewGuid();
var siteRun = Guid.NewGuid();
var cascade = Guid.NewGuid();
var inbound = ScadaBridgeAuditEventFactory.Create(AuditChannel.ApiInbound, AuditKind.InboundRequest, AuditStatus.Delivered,
occurredAtUtc: t0, actor: "key", target: "M", executionId: root, sourceSiteId: siteId, responseSummary: "{}");
var route = ScadaBridgeAuditEventFactory.Create(AuditChannel.ScriptTrace, AuditKind.RouteCall, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(10), target: "I.S", executionId: root, sourceSiteId: siteId,
extra: new ScriptTraceExtra { ChildExecutionId = siteRun }.ToJson());
var run = ScadaBridgeAuditEventFactory.Create(AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(20), target: "S", executionId: siteRun, parentExecutionId: root, sourceSiteId: siteId);
var write = ScadaBridgeAuditEventFactory.Create(AuditChannel.ScriptTrace, AuditKind.AttributeWrite, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(30), target: "A", executionId: siteRun, parentExecutionId: root, sourceSiteId: siteId);
var cascadeRun = ScadaBridgeAuditEventFactory.Create(AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(40), target: "C", executionId: cascade, parentExecutionId: siteRun, sourceSiteId: siteId);
// Same chain but NOT a trace row: an outbound API call the site script made — excluded.
var outbound = ScadaBridgeAuditEventFactory.Create(AuditChannel.ApiOutbound, AuditKind.ApiCall, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(25), target: "ERP.x", executionId: siteRun, parentExecutionId: root, sourceSiteId: siteId);
// Unrelated chain.
var other = ScadaBridgeAuditEventFactory.Create(AuditChannel.ScriptTrace, AuditKind.ScriptRun, AuditStatus.Delivered,
occurredAtUtc: t0.AddMilliseconds(5), target: "Z", executionId: Guid.NewGuid(), sourceSiteId: siteId);
await using (var ctx = CreateContext())
{
var repo = new AuditLogRepository(ctx);
foreach (var e in new[] { cascadeRun, other, write, outbound, inbound, run, route })
await repo.InsertIfNotExistsAsync(e);
}
await using (var ctx = CreateContext())
{
var repo = new AuditLogRepository(ctx);
foreach (var entry in new[] { root, siteRun, cascade })
{
var events = await repo.GetTraceEventsAsync(entry);
Assert.Equal(
new[] { inbound.EventId, route.EventId, run.EventId, write.EventId, cascadeRun.EventId },
events.Select(e => e.EventId).ToArray());
Assert.Equal(inbound, events[0]);
Assert.Equal(cascadeRun, events[4]);
}
Assert.Empty(await repo.GetTraceEventsAsync(Guid.NewGuid()));
}
}
}