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
-2
@@ -15,7 +15,7 @@ using DeploymentsPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deploym
|
||||
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
|
||||
|
||||
/// <summary>
|
||||
/// Regression tests for CentralUI-006. Component-CentralUI "Real-Time Updates"
|
||||
/// Regression tests for deployment status push updates. Component-CentralUI "Real-Time Updates"
|
||||
/// states deployment status transitions push to the UI immediately via SignalR
|
||||
/// with no polling. The page previously ran a 10-second <c>Timer</c> that
|
||||
/// reloaded every deployment record + instance map per tick. The fix removes
|
||||
@@ -61,11 +61,15 @@ public class DeploymentsPushUpdateTests : BunitContext
|
||||
private sealed class StubAuthStateProvider : AuthenticationStateProvider
|
||||
{
|
||||
private readonly AuthenticationState _state;
|
||||
/// <summary>Initializes the provider with the authentication state it returns.</summary>
|
||||
/// <param name="state">The authentication state to return.</param>
|
||||
public StubAuthStateProvider(AuthenticationState state) => _state = state;
|
||||
/// <inheritdoc />
|
||||
public override Task<AuthenticationState> GetAuthenticationStateAsync()
|
||||
=> Task.FromResult(_state);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the Deployments page does not poll and has no refresh timer.</summary>
|
||||
[Fact]
|
||||
public void Deployments_DoesNotPoll_HasNoRefreshTimer()
|
||||
{
|
||||
@@ -76,6 +80,7 @@ public class DeploymentsPushUpdateTests : BunitContext
|
||||
Assert.Null(timerField);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a deployment status change notification triggers a reload of the page.</summary>
|
||||
[Fact]
|
||||
public void Deployments_StatusChange_TriggersReload()
|
||||
{
|
||||
@@ -95,6 +100,7 @@ public class DeploymentsPushUpdateTests : BunitContext
|
||||
Arg.Any<DeploymentListFilter>(), Arg.Any<int>(), Arg.Any<int>(), Arg.Any<CancellationToken>()));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that disposing the page unsubscribes it from the status notifier.</summary>
|
||||
[Fact]
|
||||
public void Deployments_Dispose_UnsubscribesFromNotifier()
|
||||
{
|
||||
@@ -225,7 +231,7 @@ public class DeploymentsPushUpdateTests : BunitContext
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Regression test for CentralUI-022. The notifier is a process singleton:
|
||||
/// Regression test for the dispose race. The notifier is a process singleton:
|
||||
/// it can read its subscriber list and begin invoking
|
||||
/// <c>OnDeploymentStatusChanged</c> on the DeploymentManager thread an
|
||||
/// instant before the component is disposed. The handler must no-op against
|
||||
@@ -242,6 +248,7 @@ public class DeploymentsPushUpdateTests : BunitContext
|
||||
Assert.Equal(typeof(bool), field!.FieldType);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a status change delivered after disposal neither throws nor reloads the page.</summary>
|
||||
[Fact]
|
||||
public void Deployments_StatusChangeAfterDispose_DoesNotThrowOrReload()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user