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:
Joseph Doherty
+26
-2
@@ -14,6 +14,7 @@ public class CommunicationOptionsValidatorTests
|
||||
private static ValidateOptionsResult Validate(CommunicationOptions options) =>
|
||||
new CommunicationOptionsValidator().Validate(Options.DefaultName, options);
|
||||
|
||||
/// <summary>Verifies that the default options are valid.</summary>
|
||||
[Fact]
|
||||
public void DefaultOptions_AreValid()
|
||||
{
|
||||
@@ -21,6 +22,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a zero deployment timeout is rejected.</summary>
|
||||
[Fact]
|
||||
public void ZeroDeploymentTimeout_IsRejected()
|
||||
{
|
||||
@@ -29,8 +31,9 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("DeploymentTimeout", result.FailureMessage);
|
||||
}
|
||||
|
||||
// ── Audit-ingest timeout ladder (arch-review phase-2 residual #2) ────────────
|
||||
// ── Audit-ingest timeout ladder ────────────
|
||||
|
||||
/// <summary>Verifies that the audit ingest timeout ladder is strictly monotonic end to end.</summary>
|
||||
[Fact]
|
||||
public void TheAuditIngestTimeoutLadder_IsStrictlyMonotonic_EndToEnd()
|
||||
{
|
||||
@@ -45,6 +48,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Equal(TimeSpan.FromSeconds(30), ZB.MOM.WW.ScadaBridge.Communication.Grpc.SiteStreamGrpcServer.AuditIngestAskTimeout);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an audit forward timeout equal to the ask timeout is rejected.</summary>
|
||||
[Fact]
|
||||
public void AuditForwardTimeout_EqualToTheAskTimeout_IsRejected()
|
||||
{
|
||||
@@ -59,6 +63,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("AuditForwardTimeout", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an audit forward timeout shorter than the ask timeout is rejected.</summary>
|
||||
[Fact]
|
||||
public void AuditForwardTimeout_ShorterThanTheAskTimeout_IsRejected()
|
||||
{
|
||||
@@ -71,6 +76,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("AuditForwardTimeout", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the audit forward timeout is still configurable upwards.</summary>
|
||||
[Fact]
|
||||
public void AuditForwardTimeout_IsStillConfigurableUpwards()
|
||||
{
|
||||
@@ -82,6 +88,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a non-positive gRPC max concurrent streams value is rejected.</summary>
|
||||
[Fact]
|
||||
public void NonPositiveGrpcMaxConcurrentStreams_IsRejected()
|
||||
{
|
||||
@@ -92,6 +99,7 @@ public class CommunicationOptionsValidatorTests
|
||||
|
||||
// ── R2: site→central stream event batching ──────────────────────────────────
|
||||
|
||||
/// <summary>Verifies that the default stream batch options are valid.</summary>
|
||||
[Fact]
|
||||
public void DefaultStreamBatchOptions_AreValid()
|
||||
{
|
||||
@@ -101,6 +109,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(Validate(options).Succeeded);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a stream batch max events value of one is valid and means batching is disabled.</summary>
|
||||
[Fact]
|
||||
public void StreamBatchMaxEventsOfOne_IsValid_AndMeansBatchingDisabled()
|
||||
{
|
||||
@@ -108,6 +117,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a non-positive stream batch max events value is rejected.</summary>
|
||||
[Fact]
|
||||
public void NonPositiveStreamBatchMaxEvents_IsRejected()
|
||||
{
|
||||
@@ -116,6 +126,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("GrpcStreamBatchMaxEvents", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a zero stream batch window is valid.</summary>
|
||||
[Fact]
|
||||
public void ZeroStreamBatchWindow_IsValid()
|
||||
{
|
||||
@@ -125,6 +136,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a negative stream batch window is rejected.</summary>
|
||||
[Fact]
|
||||
public void NegativeStreamBatchWindow_IsRejected()
|
||||
{
|
||||
@@ -136,6 +148,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("GrpcStreamBatchWindow", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a stream batch window at or above the latency budget is rejected.</summary>
|
||||
[Fact]
|
||||
public void StreamBatchWindowAtOrAboveTheLatencyBudget_IsRejected()
|
||||
{
|
||||
@@ -157,8 +170,9 @@ public class CommunicationOptionsValidatorTests
|
||||
}).Succeeded);
|
||||
}
|
||||
|
||||
// ── Aggregated live alarm cache options (plan #10, Task 6) ───────────────────
|
||||
// ── Aggregated live alarm cache options ───────────────────
|
||||
|
||||
/// <summary>Verifies that a zero live alarm cache linger is valid.</summary>
|
||||
[Fact]
|
||||
public void ZeroLiveAlarmCacheLinger_IsValid()
|
||||
{
|
||||
@@ -167,6 +181,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a negative live alarm cache linger is rejected.</summary>
|
||||
[Fact]
|
||||
public void NegativeLiveAlarmCacheLinger_IsRejected()
|
||||
{
|
||||
@@ -175,6 +190,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("LiveAlarmCacheLinger", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a zero live alarm cache reconcile interval is rejected.</summary>
|
||||
[Fact]
|
||||
public void ZeroLiveAlarmCacheReconcileInterval_IsRejected()
|
||||
{
|
||||
@@ -183,6 +199,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("LiveAlarmCacheReconcileInterval", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a zero live alarm cache seed concurrency is rejected.</summary>
|
||||
[Fact]
|
||||
public void ZeroLiveAlarmCacheSeedConcurrency_IsRejected()
|
||||
{
|
||||
@@ -191,6 +208,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("LiveAlarmCacheSeedConcurrency", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an excessive live alarm cache seed concurrency is rejected.</summary>
|
||||
[Fact]
|
||||
public void ExcessiveLiveAlarmCacheSeedConcurrency_IsRejected()
|
||||
{
|
||||
@@ -199,6 +217,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("LiveAlarmCacheSeedConcurrency", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a zero live alarm cache max subscribers per site is rejected.</summary>
|
||||
[Fact]
|
||||
public void ZeroLiveAlarmCacheMaxSubscribersPerSite_IsRejected()
|
||||
{
|
||||
@@ -209,6 +228,7 @@ public class CommunicationOptionsValidatorTests
|
||||
|
||||
// ── R2 T10: live-delta publish-coalescing window (N6) ────────────────────────
|
||||
|
||||
/// <summary>Verifies that a zero live alarm cache publish coalesce is valid.</summary>
|
||||
[Fact]
|
||||
public void ZeroLiveAlarmCachePublishCoalesce_IsValid()
|
||||
{
|
||||
@@ -217,6 +237,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a negative live alarm cache publish coalesce is rejected.</summary>
|
||||
[Fact]
|
||||
public void NegativeLiveAlarmCachePublishCoalesce_IsRejected()
|
||||
{
|
||||
@@ -231,6 +252,7 @@ public class CommunicationOptionsValidatorTests
|
||||
// entries; an EMPTY list is valid (central nodes legitimately declare none). The role-aware
|
||||
// "a Site must list at least one endpoint" rule lives in StartupValidator, tested there.
|
||||
|
||||
/// <summary>Verifies that an empty endpoint list is valid.</summary>
|
||||
[Fact]
|
||||
public void EmptyEndpoints_IsValid()
|
||||
{
|
||||
@@ -242,6 +264,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a blank endpoint is rejected.</summary>
|
||||
[Fact]
|
||||
public void BlankEndpoint_IsRejected()
|
||||
{
|
||||
@@ -253,6 +276,7 @@ public class CommunicationOptionsValidatorTests
|
||||
Assert.Contains("CentralGrpcEndpoints", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a configured endpoint list is valid.</summary>
|
||||
[Fact]
|
||||
public void Endpoints_IsValid()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user