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:
@@ -8,7 +8,7 @@ using ZB.MOM.WW.ScadaBridge.Communication.Actors;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Regression tests for Communication-004 — coordinator actors must declare an
|
||||
/// Regression tests that coordinator actors must declare an
|
||||
/// explicit <c>Resume</c> supervision strategy per the CLAUDE.md decision
|
||||
/// ("Resume for coordinator actors"). A child fault under the default
|
||||
/// (Restart) strategy would wipe a child's in-memory state; the long-lived
|
||||
@@ -23,9 +23,14 @@ public class CoordinatorSupervisionTests : TestKit
|
||||
/// </summary>
|
||||
private sealed class CentralCommunicationActorProbe : CentralCommunicationActor
|
||||
{
|
||||
/// <summary>Initializes the probe with the dependencies required by the central communication actor.</summary>
|
||||
/// <param name="sp">The service provider passed to the base actor.</param>
|
||||
/// <param name="transport">The site command transport passed to the base actor.</param>
|
||||
public CentralCommunicationActorProbe(IServiceProvider sp, ISiteCommandTransport transport)
|
||||
: base(sp, transport) { }
|
||||
|
||||
/// <summary>Returns the actor's configured supervisor strategy.</summary>
|
||||
/// <returns>The supervisor strategy declared by the actor.</returns>
|
||||
public SupervisorStrategy GetSupervisorStrategy() => SupervisorStrategy();
|
||||
}
|
||||
|
||||
@@ -34,9 +39,15 @@ public class CoordinatorSupervisionTests : TestKit
|
||||
/// </summary>
|
||||
private sealed class SiteCommunicationActorProbe : SiteCommunicationActor
|
||||
{
|
||||
/// <summary>Initializes the probe with the dependencies required by the site communication actor.</summary>
|
||||
/// <param name="siteId">The site identifier passed to the base actor.</param>
|
||||
/// <param name="options">The communication options passed to the base actor.</param>
|
||||
/// <param name="dm">The deployment manager reference passed to the base actor.</param>
|
||||
public SiteCommunicationActorProbe(string siteId, CommunicationOptions options, IActorRef dm)
|
||||
: base(siteId, options, dm) { }
|
||||
|
||||
/// <summary>Returns the actor's configured supervisor strategy.</summary>
|
||||
/// <returns>The supervisor strategy declared by the actor.</returns>
|
||||
public SupervisorStrategy GetSupervisorStrategy() => SupervisorStrategy();
|
||||
}
|
||||
|
||||
@@ -50,6 +61,7 @@ public class CoordinatorSupervisionTests : TestKit
|
||||
return services.BuildServiceProvider();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the central communication actor declares a Resume supervisor strategy.</summary>
|
||||
[Fact]
|
||||
public void CentralCommunicationActor_SupervisorStrategy_IsResume()
|
||||
{
|
||||
@@ -66,6 +78,7 @@ public class CoordinatorSupervisionTests : TestKit
|
||||
Assert.Equal(Directive.Resume, directive);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the site communication actor declares a Resume supervisor strategy.</summary>
|
||||
[Fact]
|
||||
public void SiteCommunicationActor_SupervisorStrategy_IsResume()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user