Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.AuditLog.Tests/Central/SiteAuditReconciliationOptionsValidatorTests.cs
T
Joseph Doherty 513fa1aa16 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.
2026-10-07 15:05:49 -04:00

71 lines
3.1 KiB
C#

using ZB.MOM.WW.ScadaBridge.AuditLog.Central;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Central;
/// <summary>
/// Eager startup validation for <see cref="SiteAuditReconciliationOptions"/>
/// (arch-review 08 round 2 NF4). A zero tick interval spins the reconciliation
/// singleton, a zero batch pulls nothing, and a zero stalled-cycle threshold
/// would fire the stalled signal on the first non-draining cycle.
/// <see cref="SiteAuditReconciliationOptions.ReconciliationIntervalOverride"/>
/// is test-only and left unvalidated.
/// </summary>
public class SiteAuditReconciliationOptionsValidatorTests
{
/// <summary>Verifies that the batch size is valid only up to the RPC ceiling.</summary>
/// <param name="size">The batch size under test.</param>
/// <param name="valid">Whether the batch size is expected to validate.</param>
[Theory]
[InlineData(1, true)]
[InlineData(2000, true)]
[InlineData(2001, false)]
[InlineData(int.MaxValue, false)]
public void BatchSize_MatchesRpcCeiling(int size, bool valid)
=> Assert.Equal(valid, new SiteAuditReconciliationOptionsValidator().Validate(null,
new SiteAuditReconciliationOptions { BatchSize = size }).Succeeded);
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
var validator = new SiteAuditReconciliationOptionsValidator();
Assert.True(validator.Validate(null, new SiteAuditReconciliationOptions()).Succeeded);
}
/// <summary>Verifies that a zero reconciliation interval fails validation.</summary>
[Fact]
public void ZeroReconciliationInterval_Fails()
{
var validator = new SiteAuditReconciliationOptionsValidator();
var result = validator.Validate(null,
new SiteAuditReconciliationOptions { ReconciliationIntervalSeconds = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditReconciliationOptions.ReconciliationIntervalSeconds), StringComparison.Ordinal));
}
/// <summary>Verifies that a zero batch size fails validation.</summary>
[Fact]
public void ZeroBatchSize_Fails()
{
var validator = new SiteAuditReconciliationOptionsValidator();
var result = validator.Validate(null,
new SiteAuditReconciliationOptions { BatchSize = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditReconciliationOptions.BatchSize), StringComparison.Ordinal));
}
/// <summary>Verifies that a zero stalled-cycle threshold fails validation.</summary>
[Fact]
public void ZeroStalledCycles_Fails()
{
var validator = new SiteAuditReconciliationOptionsValidator();
var result = validator.Validate(null,
new SiteAuditReconciliationOptions { StalledAfterNonDrainingCycles = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditReconciliationOptions.StalledAfterNonDrainingCycles), StringComparison.Ordinal));
}
}