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.Communication.Grpc;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// WP1.6: a send to a site with no configured gRPC channel must fail the caller's Ask immediately
|
||||
/// A send to a site with no configured gRPC channel must fail the caller's Ask immediately
|
||||
/// (<see cref="Status.Failure"/> wrapping <see cref="SiteChannelUnavailableException"/>) instead of
|
||||
/// warning-and-dropping the message and leaving the Ask to expire at its full timeout.
|
||||
/// </summary>
|
||||
@@ -31,6 +31,7 @@ public class GrpcSiteTransportFailFastTests : TestKit
|
||||
Opts,
|
||||
NullLogger<GrpcSiteTransport>.Instance);
|
||||
|
||||
/// <summary>Verifies that a send to an unconfigured site faults the Ask quickly instead of timing out.</summary>
|
||||
[Fact]
|
||||
public void Send_ToUnconfiguredSite_FaultsTheAskFastInsteadOfTimingOut()
|
||||
{
|
||||
@@ -57,6 +58,8 @@ public class GrpcSiteTransportFailFastTests : TestKit
|
||||
Assert.Contains("unconfigured-site", cause.Message);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an Ask against an unconfigured site completes faulted and fast via a Tell of a status failure.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Ask_AgainstUnconfiguredSite_CompletesFaultedFastViaTellStatusFailure()
|
||||
{
|
||||
@@ -81,6 +84,8 @@ public class GrpcSiteTransportFailFastTests : TestKit
|
||||
/// <summary>Relays an Ask into the transport, exactly as <c>CentralCommunicationActor</c> does.</summary>
|
||||
private sealed class EchoingAskTarget : ReceiveActor
|
||||
{
|
||||
/// <summary>Initializes the actor to relay every site envelope into the given transport.</summary>
|
||||
/// <param name="transport">The transport that receives each relayed envelope.</param>
|
||||
public EchoingAskTarget(GrpcSiteTransport transport)
|
||||
{
|
||||
Receive<SiteEnvelope>(env => transport.Send(env, Sender));
|
||||
@@ -89,7 +94,9 @@ public class GrpcSiteTransportFailFastTests : TestKit
|
||||
|
||||
private sealed class NoKeyProvider : ISitePskProvider
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public ValueTask<string> GetAsync(string siteId, CancellationToken ct) => new("k");
|
||||
/// <inheritdoc />
|
||||
public void Invalidate(string siteId) { }
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user