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:
+22
-3
@@ -3,7 +3,7 @@ using Microsoft.Extensions.Options;
|
||||
namespace ZB.MOM.WW.ScadaBridge.ClusterInfrastructure.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// CI-004: Tests that <see cref="ClusterOptionsValidator"/> rejects the
|
||||
/// Tests that <see cref="ClusterOptionsValidator"/> rejects the
|
||||
/// catastrophic misconfigurations the design doc warns against — a
|
||||
/// <c>MinNrOfMembers</c> other than 1, an unsupported split-brain strategy,
|
||||
/// empty seed nodes, and timings where the heartbeat is not below the
|
||||
@@ -22,6 +22,7 @@ public class ClusterOptionsValidatorTests
|
||||
DownIfAlone = true
|
||||
};
|
||||
|
||||
/// <summary>Verifies that the default options are valid.</summary>
|
||||
[Fact]
|
||||
public void DefaultOptions_AreValid()
|
||||
{
|
||||
@@ -30,6 +31,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a minimum member count other than one fails validation.</summary>
|
||||
[Fact]
|
||||
public void MinNrOfMembers_NotOne_FailsValidation()
|
||||
{
|
||||
@@ -42,6 +44,8 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("MinNrOfMembers", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an unsupported split-brain strategy fails validation.</summary>
|
||||
/// <param name="strategy">The unsupported strategy name.</param>
|
||||
[Theory]
|
||||
[InlineData("keep-majority")]
|
||||
[InlineData("static-quorum")]
|
||||
@@ -57,6 +61,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("SplitBrainResolverStrategy", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an empty seed node list fails validation.</summary>
|
||||
[Fact]
|
||||
public void EmptySeedNodes_FailsValidation()
|
||||
{
|
||||
@@ -69,6 +74,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("SeedNodes", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a single seed node without acknowledgement fails validation.</summary>
|
||||
[Fact]
|
||||
public void SingleSeed_WithoutAcknowledgement_Fails()
|
||||
{
|
||||
@@ -81,6 +87,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("AllowSingleNodeCluster", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a single seed node passes when single-node clusters are explicitly allowed.</summary>
|
||||
[Fact]
|
||||
public void SingleSeed_WithAllowSingleNodeCluster_Passes()
|
||||
{
|
||||
@@ -96,6 +103,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an empty seed list fails even when single-node clusters are allowed.</summary>
|
||||
[Fact]
|
||||
public void EmptySeeds_FailsEvenWithFlag()
|
||||
{
|
||||
@@ -110,10 +118,11 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("SeedNodes", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a single seed node fails validation.</summary>
|
||||
[Fact]
|
||||
public void SingleSeedNode_FailsValidation()
|
||||
{
|
||||
// CI-012: design doc says "both nodes are seed nodes" — a single-seed
|
||||
// The design doc says "both nodes are seed nodes" — a single-seed
|
||||
// configuration defeats the no-startup-ordering-dependency guarantee and
|
||||
// must be rejected by the contract owner's validator, not just by the
|
||||
// Host's startup validator.
|
||||
@@ -127,6 +136,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("2", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a heartbeat interval that is not below the failure threshold fails validation.</summary>
|
||||
[Fact]
|
||||
public void HeartbeatNotBelowFailureThreshold_FailsValidation()
|
||||
{
|
||||
@@ -140,6 +150,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("HeartbeatInterval", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a non-positive stable-after duration fails validation.</summary>
|
||||
[Fact]
|
||||
public void NonPositiveStableAfter_FailsValidation()
|
||||
{
|
||||
@@ -152,6 +163,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("StableAfter", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that disabling down-if-alone under the keep-oldest strategy fails validation.</summary>
|
||||
[Fact]
|
||||
public void DownIfAloneFalse_UnderKeepOldest_FailsValidation()
|
||||
{
|
||||
@@ -165,6 +177,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("DownIfAlone", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the auto-down strategy passes validation.</summary>
|
||||
[Fact]
|
||||
public void AutoDownStrategy_Passes()
|
||||
{
|
||||
@@ -179,6 +192,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that disabling down-if-alone under the auto-down strategy passes validation.</summary>
|
||||
[Fact]
|
||||
public void DownIfAloneFalse_UnderAutoDown_Passes()
|
||||
{
|
||||
@@ -193,6 +207,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that validation accumulates every failure rather than stopping at the first.</summary>
|
||||
[Fact]
|
||||
public void Validate_AccumulatesAllFailures()
|
||||
{
|
||||
@@ -216,8 +231,9 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("HeartbeatInterval", result.FailureMessage);
|
||||
}
|
||||
|
||||
// ---- BootstrapGuard timing validation (Gitea #33) ----
|
||||
// ---- BootstrapGuard timing validation ----
|
||||
|
||||
/// <summary>Verifies that a disabled bootstrap guard with zero timings passes validation.</summary>
|
||||
[Fact]
|
||||
public void BootstrapGuard_disabled_with_zero_timings_passes_validation()
|
||||
{
|
||||
@@ -237,6 +253,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an enabled bootstrap guard with default timings passes validation.</summary>
|
||||
[Fact]
|
||||
public void BootstrapGuard_enabled_with_default_timings_passes_validation()
|
||||
{
|
||||
@@ -248,6 +265,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.True(result.Succeeded, result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an enabled bootstrap guard with non-positive probe seconds fails validation.</summary>
|
||||
[Fact]
|
||||
public void BootstrapGuard_enabled_with_nonpositive_probe_seconds_fails_validation()
|
||||
{
|
||||
@@ -262,6 +280,7 @@ public class ClusterOptionsValidatorTests
|
||||
Assert.Contains("PartnerProbeSeconds", result.FailureMessage);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an enabled bootstrap guard with a non-positive interval or timeout fails validation.</summary>
|
||||
[Fact]
|
||||
public void BootstrapGuard_enabled_with_nonpositive_interval_or_timeout_fails_validation()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user