Joseph Doherty
30faee0d0e
GetTraceEventsAsync widens its channel filter to ScriptTrace ∪ ApiOutbound ∪ DbOutbound ∪ Notification ∪ (ApiInbound & InboundRequest) (plan D6); SecuredWrite, Cluster and InboundAuthFailure rows in the same tree stay excluded. The site SqliteAuditWriter.ReadByExecutionIdsAsync already had no channel predicate — pinned by a test. Interface doc updated to match. Claude-Session: https://claude.ai/code/session_01NcMG6xXdsJbmD2wYAgkK29
141 lines
9.0 KiB
C#
141 lines
9.0 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 outside the replay channel set: a secured-write row — excluded
|
|
// (outbound-call plan 2026-09-06 D6 widened the set; SecuredWrite stays out).
|
|
var outbound = ScadaBridgeAuditEventFactory.Create(AuditChannel.SecuredWrite, AuditKind.SecuredWriteSubmit, 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()));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Outbound-calls plan (2026-09-06, D6): replay returns the chain's ScriptTrace, ApiOutbound,
|
|
/// DbOutbound and Notification rows plus the InboundRequest row, in (OccurredAtUtc, EventId)
|
|
/// order; SecuredWrite, Cluster and InboundAuthFailure rows in the same tree stay excluded.
|
|
/// </summary>
|
|
[SkippableFact]
|
|
public async Task IncludesOutboundApiDbAndNotificationRows_ExcludesOtherChannels()
|
|
{
|
|
Skip.IfNot(_fixture.Available, _fixture.SkipReason);
|
|
var siteId = "test-trace-" + Guid.NewGuid().ToString("N")[..8];
|
|
var t0 = new DateTime(2026, 9, 6, 12, 0, 0, DateTimeKind.Utc);
|
|
var root = Guid.NewGuid();
|
|
var siteRun = 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 apiSubmit = ScadaBridgeAuditEventFactory.Create(AuditChannel.ApiOutbound, AuditKind.CachedSubmit, AuditStatus.Submitted,
|
|
occurredAtUtc: t0.AddMilliseconds(30), target: "Delmia.AckRecipe", executionId: siteRun, parentExecutionId: root,
|
|
sourceSiteId: siteId, correlationId: Guid.NewGuid());
|
|
var dbWrite = ScadaBridgeAuditEventFactory.Create(AuditChannel.DbOutbound, AuditKind.DbWrite, AuditStatus.Delivered,
|
|
occurredAtUtc: t0.AddMilliseconds(40), target: "MesDb", executionId: siteRun, parentExecutionId: root, sourceSiteId: siteId);
|
|
var notify = ScadaBridgeAuditEventFactory.Create(AuditChannel.Notification, AuditKind.NotifySend, AuditStatus.Submitted,
|
|
occurredAtUtc: t0.AddMilliseconds(50), target: "Planners", executionId: siteRun, parentExecutionId: root,
|
|
sourceSiteId: siteId, correlationId: Guid.NewGuid());
|
|
// Same execution ids, but channels outside the replay set — all excluded.
|
|
var secured = ScadaBridgeAuditEventFactory.Create(AuditChannel.SecuredWrite, AuditKind.SecuredWriteSubmit, AuditStatus.Delivered,
|
|
occurredAtUtc: t0.AddMilliseconds(35), target: "Tag", executionId: siteRun, parentExecutionId: root, sourceSiteId: siteId);
|
|
var authFailure = ScadaBridgeAuditEventFactory.Create(AuditChannel.ApiInbound, AuditKind.InboundAuthFailure, AuditStatus.Failed,
|
|
occurredAtUtc: t0.AddMilliseconds(1), actor: "key", target: "M", executionId: root, sourceSiteId: siteId);
|
|
var cluster = ScadaBridgeAuditEventFactory.Create(AuditChannel.Cluster, AuditKind.ManualFailover, AuditStatus.Delivered,
|
|
occurredAtUtc: t0.AddMilliseconds(45), actor: "admin", target: "central-a", executionId: root, sourceSiteId: siteId);
|
|
|
|
await using (var ctx = CreateContext())
|
|
{
|
|
var repo = new AuditLogRepository(ctx);
|
|
foreach (var e in new[] { notify, secured, dbWrite, cluster, run, authFailure, apiSubmit, inbound, route })
|
|
await repo.InsertIfNotExistsAsync(e);
|
|
}
|
|
|
|
await using (var ctx = CreateContext())
|
|
{
|
|
var repo = new AuditLogRepository(ctx);
|
|
foreach (var entry in new[] { root, siteRun })
|
|
{
|
|
var events = await repo.GetTraceEventsAsync(entry);
|
|
Assert.Equal(
|
|
new[] { inbound.EventId, route.EventId, run.EventId, apiSubmit.EventId, dbWrite.EventId, notify.EventId },
|
|
events.Select(e => e.EventId).ToArray());
|
|
Assert.Equal(apiSubmit, events[3]);
|
|
Assert.Equal(dbWrite, events[4]);
|
|
Assert.Equal(notify, events[5]);
|
|
var decomposed = events.Select(AuditRowProjection.Decompose).ToList();
|
|
Assert.DoesNotContain(decomposed, v => v.Channel is AuditChannel.SecuredWrite or AuditChannel.Cluster);
|
|
Assert.DoesNotContain(decomposed, v => v.Kind == AuditKind.InboundAuthFailure);
|
|
}
|
|
}
|
|
}
|
|
}
|