docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)
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.
This commit is contained in:
+7
-1
@@ -15,7 +15,7 @@ using ZB.MOM.WW.ScadaBridge.NotificationOutbox.Delivery;
|
||||
namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Task 13 (arch-review 04) — verifies that an operator-initiated Retry on a parked
|
||||
/// Verifies that an operator-initiated Retry on a parked
|
||||
/// notification emits a <see cref="AuditChannel.Notification"/>/<see cref="AuditKind.NotifyDeliver"/>
|
||||
/// audit row with status <see cref="AuditStatus.Submitted"/> and the operator as
|
||||
/// <c>Actor</c>, closing the forensic gap (previously the lifecycle read
|
||||
@@ -31,9 +31,12 @@ public class NotificationOutboxActorRetryEmissionTests : TestKit
|
||||
|
||||
private sealed class RecordingCentralAuditWriter : ICentralAuditWriter
|
||||
{
|
||||
/// <summary>Gets the audit rows recorded by the writer.</summary>
|
||||
public List<AuditRowProjection.AuditRowValues> Events { get; } = new();
|
||||
/// <summary>Gets or sets a callback invoked on each write, allowing a test to simulate a failing writer.</summary>
|
||||
public Func<AuditEvent, Task>? OnWrite { get; set; }
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task WriteAsync(AuditEvent evt, CancellationToken ct = default)
|
||||
{
|
||||
lock (Events)
|
||||
@@ -85,6 +88,7 @@ public class NotificationOutboxActorRetryEmissionTests : TestKit
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that retrying a parked notification emits a submitted notify-deliver audit row carrying the operator.</summary>
|
||||
[Fact]
|
||||
public void Retry_OnParked_Emits_Submitted_NotifyDeliver_AuditRow_With_Operator()
|
||||
{
|
||||
@@ -110,6 +114,7 @@ public class NotificationOutboxActorRetryEmissionTests : TestKit
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>Verifies that discarding a parked notification emits a discarded audit row carrying the operator.</summary>
|
||||
[Fact]
|
||||
public void Discard_OnParked_Emits_Discarded_AuditRow_With_Operator()
|
||||
{
|
||||
@@ -130,6 +135,7 @@ public class NotificationOutboxActorRetryEmissionTests : TestKit
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an audit write failure does not fail the retry.</summary>
|
||||
[Fact]
|
||||
public void Retry_AuditFailure_DoesNotFail_TheRetry()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user