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.
84 lines
3.0 KiB
C#
84 lines
3.0 KiB
C#
using Akka.Actor;
|
|
using Akka.TestKit.Xunit2;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging.Abstractions;
|
|
using NSubstitute;
|
|
using ZB.MOM.WW.Audit;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Notifications;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Tests;
|
|
|
|
/// <summary>
|
|
/// Verifies <see cref="NotificationOutboxActor"/> accepts an
|
|
/// <see cref="ICentralAuditWriter"/> at construction so subsequent bundle tasks
|
|
/// (B2/B3) can route attempt + terminal lifecycle events through the central
|
|
/// direct-write audit path.
|
|
/// </summary>
|
|
public class NotificationOutboxActorAuditInjectionTests : TestKit
|
|
{
|
|
private static IServiceProvider BuildEmptyProvider()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddScoped(_ => OutboxRepositorySubstitute.Healthy());
|
|
services.AddScoped(_ => Substitute.For<INotificationRepository>());
|
|
return services.BuildServiceProvider();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Inline NoOp writer that records calls — used to assert later tasks emit
|
|
/// events without depending on a concrete CentralAuditWriter.
|
|
/// </summary>
|
|
private sealed class RecordingCentralAuditWriter : ICentralAuditWriter
|
|
{
|
|
/// <summary>Gets the audit events recorded by this writer.</summary>
|
|
public List<AuditEvent> Events { get; } = new();
|
|
|
|
/// <inheritdoc />
|
|
public Task WriteAsync(AuditEvent evt, CancellationToken ct = default)
|
|
{
|
|
lock (Events)
|
|
{
|
|
Events.Add(evt);
|
|
}
|
|
return Task.CompletedTask;
|
|
}
|
|
}
|
|
|
|
/// <summary>Verifies that the actor can be constructed with an audit writer without throwing.</summary>
|
|
[Fact]
|
|
public void Actor_ConstructedWith_ICentralAuditWriter_NoException()
|
|
{
|
|
var writer = new RecordingCentralAuditWriter();
|
|
// Long dispatch interval so PreStart's timer never fires during the test.
|
|
var options = new NotificationOutboxOptions { DispatchInterval = TimeSpan.FromHours(1) };
|
|
|
|
var actor = Sys.ActorOf(Props.Create(() => new NotificationOutboxActor(
|
|
BuildEmptyProvider(),
|
|
options,
|
|
writer,
|
|
NullLogger<NotificationOutboxActor>.Instance)));
|
|
|
|
Assert.NotNull(actor);
|
|
// No event has been emitted yet — the writer is purely injected at this stage.
|
|
lock (writer.Events)
|
|
{
|
|
Assert.Empty(writer.Events);
|
|
}
|
|
}
|
|
|
|
/// <summary>Verifies that constructing the actor with a null audit writer throws.</summary>
|
|
[Fact]
|
|
public void Actor_NullAuditWriter_Throws()
|
|
{
|
|
var options = new NotificationOutboxOptions { DispatchInterval = TimeSpan.FromHours(1) };
|
|
|
|
Assert.Throws<ArgumentNullException>(() => new NotificationOutboxActor(
|
|
BuildEmptyProvider(),
|
|
options,
|
|
auditWriter: null!,
|
|
NullLogger<NotificationOutboxActor>.Instance));
|
|
}
|
|
}
|