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:
+15
-1
@@ -10,7 +10,7 @@ namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
|
||||
/// <para>
|
||||
/// These are <b>specifications, written before the deletion they justify</b>. The bespoke
|
||||
/// <c>ReplicationService</c> (an explicit Add/Remove/Park/Requeue operation stream over Akka)
|
||||
/// is deleted at Task 14 and replaced by LocalDb's trigger-based change capture. Each test
|
||||
/// was deleted and replaced by LocalDb's trigger-based change capture. Each test
|
||||
/// here is one behaviour the old mechanism provided, restated as an outcome the replacement
|
||||
/// must still deliver — so the cutover has something to be judged against other than "it
|
||||
/// compiles".
|
||||
@@ -83,6 +83,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
|
||||
// ---- scenarios --------------------------------------------------------------------
|
||||
|
||||
/// <summary>Verifies that a buffered message materialises on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task BufferedMessage_MaterialisesOnThePeer()
|
||||
{
|
||||
@@ -94,6 +96,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
"a message buffered on node A to appear on node B");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a delivered message disappears from the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task DeliveredMessage_DisappearsFromThePeer()
|
||||
{
|
||||
@@ -110,6 +114,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
"the delivered message to be gone from node B");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a parked message shows as parked on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ParkedMessage_ShowsAsParkedOnThePeer()
|
||||
{
|
||||
@@ -124,6 +130,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
"the parked status to reach node B");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a requeued message resets its status and retry count on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task RequeuedMessage_ResetsStatusAndRetryCountOnThePeer()
|
||||
{
|
||||
@@ -145,6 +153,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
"node B to show the requeued message as Pending with retry_count 0");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a message that is added and then removed never converges to present on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task MessageAddedThenRemoved_NeverConvergesToPresent()
|
||||
{
|
||||
@@ -182,6 +192,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
Assert.True(await ExistsAsync(B, "msg-ordering-control"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a message buffered twice converges to the newer state on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task SameMessage_BufferedTwice_ConvergesToTheNewerState()
|
||||
{
|
||||
@@ -199,6 +211,8 @@ public sealed class LocalDbStoreAndForwardConvergenceTests : LocalDbSitePairHarn
|
||||
"the newer state to win on node B");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a park arriving without its preceding add still materialises the row on the peer.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ParkArrivingWithoutItsAdd_StillMaterialisesTheRow()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user