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:
@@ -9,7 +9,7 @@ using ZB.MOM.WW.ScadaBridge.TestSupport;
|
||||
namespace ZB.MOM.WW.ScadaBridge.StoreAndForward.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Task 5 (#22 Retry/Discard relay): tests the site-side execution of a
|
||||
/// Retry/Discard relay: tests the site-side execution of a
|
||||
/// central→site <see cref="RetryParkedOperation"/> / <see cref="DiscardParkedOperation"/>
|
||||
/// relay command on the <see cref="ParkedMessageHandlerActor"/>. The cached
|
||||
/// call's S&F buffer message id is the <see cref="TrackedOperationId"/>, so
|
||||
@@ -23,6 +23,7 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
private readonly StoreAndForwardStorage _storage;
|
||||
private readonly StoreAndForwardService _service;
|
||||
|
||||
/// <summary>Initializes a new instance of the <c>ParkedOperationRelayTests</c> class.</summary>
|
||||
public ParkedOperationRelayTests()
|
||||
{
|
||||
_localDb = TestLocalDb.CreateTemp("RelayTests");
|
||||
@@ -40,10 +41,15 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
_storage, options, NullLogger<StoreAndForwardService>.Instance);
|
||||
}
|
||||
|
||||
/// <summary>Initializes the storage before the tests run.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task InitializeAsync() => await _storage.InitializeAsync();
|
||||
|
||||
/// <summary>Does nothing; storage is released in <c>Dispose</c>.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public Task DisposeAsync() => Task.CompletedTask;
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override void Dispose(bool disposing)
|
||||
{
|
||||
if (disposing)
|
||||
@@ -70,6 +76,8 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
await _service.RetryPendingMessagesAsync();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that retrying a parked cached call resets it to pending and reports the change as applied.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task RetryParkedOperation_ParkedCachedCall_ResetsToPendingAndApplied()
|
||||
{
|
||||
@@ -90,6 +98,8 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
Assert.Equal(StoreAndForwardMessageStatus.Pending, msg!.Status);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that discarding a parked cached call removes its row and reports the change as applied.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task DiscardParkedOperation_ParkedCachedCall_RemovesRowAndApplied()
|
||||
{
|
||||
@@ -107,6 +117,7 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
Assert.Null(msg);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that retrying an unknown operation is a safe no-op.</summary>
|
||||
[Fact]
|
||||
public void RetryParkedOperation_UnknownOperation_IsSafeNoOp()
|
||||
{
|
||||
@@ -120,6 +131,8 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
Assert.Null(ack.ErrorMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that retrying a non-parked operation is a safe no-op that does not corrupt the row.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task RetryParkedOperation_NonParkedOperation_IsSafeNoOpAndDoesNotCorrupt()
|
||||
{
|
||||
@@ -148,6 +161,8 @@ public class ParkedOperationRelayTests : TestKit, IAsyncLifetime, IDisposable
|
||||
Assert.Equal(before.RetryCount, after.RetryCount);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that discarding a non-parked operation is a safe no-op.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task DiscardParkedOperation_NonParkedOperation_IsSafeNoOp()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user