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
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Host.Actors;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// Host-006: the Akka HOCON document must be assembled with every interpolated value
/// The Akka HOCON document must be assembled with every interpolated value
/// quoted/escaped, so a hostname, seed-node URI or split-brain strategy containing a
/// quote, backslash or whitespace cannot corrupt the document or be silently
/// misparsed.
@@ -26,6 +26,7 @@ public class HoconBuilderTests
FailureDetectionThreshold = TimeSpan.FromSeconds(10),
};
/// <summary>Verifies that the cluster leave phase timeout exceeds the drain budget.</summary>
[Fact]
public void BuildHocon_ClusterLeavePhaseTimeout_ExceedsDrainBudget()
{
@@ -43,6 +44,7 @@ public class HoconBuilderTests
$"cluster-leave phase timeout ({phaseTimeout}) must exceed the 10s singleton GracefulStop budget");
}
/// <summary>Verifies that plain values produce a parseable document that preserves them.</summary>
[Fact]
public void BuildHocon_PlainValues_ParsesAndPreservesValues()
{
@@ -62,6 +64,7 @@ public class HoconBuilderTests
Assert.Equal("keep-oldest", config.GetString("akka.cluster.split-brain-resolver.active-strategy"));
}
/// <summary>Verifies that a hostname containing a quote does not corrupt the HOCON document.</summary>
[Fact]
public void BuildHocon_HostnameWithQuote_DoesNotCorruptDocument()
{
@@ -85,6 +88,7 @@ public class HoconBuilderTests
Assert.Equal(1, config.GetInt("akka.cluster.min-nr-of-members"));
}
/// <summary>Verifies that a strategy value containing whitespace remains quoted.</summary>
[Fact]
public void BuildHocon_StrategyWithWhitespace_RemainsQuoted()
{
@@ -112,10 +116,11 @@ public class HoconBuilderTests
RemotingPort = 8081,
};
/// <summary>Verifies that setting DownIfAlone to true emits the on token.</summary>
[Fact]
public void BuildHocon_DownIfAloneTrue_EmitsOn()
{
// Host-012: BuildHocon must consume ClusterOptions.DownIfAlone, not
// BuildHocon must consume ClusterOptions.DownIfAlone, not
// hard-code the down-if-alone token.
var cluster = DefaultCluster();
cluster.DownIfAlone = true;
@@ -129,10 +134,11 @@ public class HoconBuilderTests
"akka.cluster.split-brain-resolver.keep-oldest.down-if-alone"));
}
/// <summary>Verifies that setting DownIfAlone to false emits the off token.</summary>
[Fact]
public void BuildHocon_DownIfAloneFalse_EmitsOff()
{
// Host-012: setting DownIfAlone=false must actually flip the emitted token.
// Setting DownIfAlone=false must actually flip the emitted token.
var cluster = DefaultCluster();
cluster.DownIfAlone = false;
@@ -145,10 +151,11 @@ public class HoconBuilderTests
"akka.cluster.split-brain-resolver.keep-oldest.down-if-alone"));
}
/// <summary>Verifies that sub-second timings are preserved without rounding.</summary>
[Fact]
public void BuildHocon_SubSecondTimings_PreservedWithoutRounding()
{
// Host-013: cluster timing values below one second must not be rounded to
// Cluster timing values below one second must not be rounded to
// whole seconds. A 750ms heartbeat must survive as 750ms, not collapse to
// 1s — and a 500ms value must not collapse to a degenerate 0s.
var cluster = DefaultCluster();
@@ -178,6 +185,7 @@ public class HoconBuilderTests
config.GetTimeSpan("akka.remote.transport-failure-detector.acceptable-heartbeat-pause"));
}
/// <summary>Verifies that the document enables the split-brain resolver downing provider.</summary>
[Fact]
public void BuildHocon_EnablesSplitBrainResolverDowningProvider()
{
@@ -196,6 +204,7 @@ public class HoconBuilderTests
config.GetString("akka.cluster.downing-provider-class"));
}
/// <summary>Verifies that the auto-down strategy emits the auto-downing provider.</summary>
[Fact]
public void BuildHocon_AutoDownStrategy_EmitsAutoDowningProvider()
{
@@ -222,6 +231,7 @@ public class HoconBuilderTests
Assert.False(config.HasPath("akka.cluster.split-brain-resolver.active-strategy"));
}
/// <summary>Verifies that the auto-down strategy name is case-insensitive and the document stays intact.</summary>
[Fact]
public void BuildHocon_AutoDownStrategy_IsCaseInsensitive_AndDocumentStaysIntact()
{