Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteCallAudit.Tests/SiteCallAuditOptionsValidatorTests.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

101 lines
4.1 KiB
C#

using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit.Tests;
/// <summary>
/// Arch-review 08 §1.5: <see cref="SiteCallAuditOptions"/> drives stuck-call
/// detection, KPI windowing, the central→site relay Ask timeout, and the two
/// central-singleton scheduler cadences plus their retention window. A
/// zero/negative duration or non-positive count must be rejected at startup with
/// a clear, key-naming message rather than making an Akka scheduler spin or a KPI
/// query silently degrade. The <c>Resolved*</c> computed properties clamp away
/// bad cadence values, so the BASE properties are validated here.
/// </summary>
public class SiteCallAuditOptionsValidatorTests
{
private static ValidateOptionsResult Validate(SiteCallAuditOptions options) =>
new SiteCallAuditOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the reconciliation batch size is valid only up to the RPC ceiling.</summary>
/// <param name="size">The reconciliation batch size under test.</param>
/// <param name="valid">Whether the batch size is expected to pass validation.</param>
[Theory]
[InlineData(1, true)]
[InlineData(2000, true)]
[InlineData(2001, false)]
[InlineData(int.MaxValue, false)]
public void ReconciliationBatchSize_MatchesRpcCeiling(int size, bool valid)
=> Assert.Equal(valid, Validate(new SiteCallAuditOptions { ReconciliationBatchSize = size }).Succeeded);
/// <summary>Verifies that the default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
var result = Validate(new SiteCallAuditOptions());
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero stuck-age threshold is rejected.</summary>
[Fact]
public void ZeroStuckAgeThreshold_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { StuckAgeThreshold = TimeSpan.Zero });
Assert.True(result.Failed);
Assert.Contains("StuckAgeThreshold", result.FailureMessage);
}
/// <summary>Verifies that a zero KPI interval is rejected.</summary>
[Fact]
public void ZeroKpiInterval_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { KpiInterval = TimeSpan.Zero });
Assert.True(result.Failed);
Assert.Contains("KpiInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero relay timeout is rejected.</summary>
[Fact]
public void ZeroRelayTimeout_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { RelayTimeout = TimeSpan.Zero });
Assert.True(result.Failed);
Assert.Contains("RelayTimeout", result.FailureMessage);
}
/// <summary>Verifies that a zero reconciliation interval is rejected.</summary>
[Fact]
public void ZeroReconciliationInterval_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { ReconciliationInterval = TimeSpan.Zero });
Assert.True(result.Failed);
Assert.Contains("ReconciliationInterval", result.FailureMessage);
}
/// <summary>Verifies that a zero reconciliation batch size is rejected.</summary>
[Fact]
public void ZeroReconciliationBatchSize_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { ReconciliationBatchSize = 0 });
Assert.True(result.Failed);
Assert.Contains("ReconciliationBatchSize", result.FailureMessage);
}
/// <summary>Verifies that a zero purge interval is rejected.</summary>
[Fact]
public void ZeroPurgeInterval_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { PurgeInterval = TimeSpan.Zero });
Assert.True(result.Failed);
Assert.Contains("PurgeInterval", result.FailureMessage);
}
/// <summary>Verifies that zero retention days is rejected.</summary>
[Fact]
public void ZeroRetentionDays_IsRejected()
{
var result = Validate(new SiteCallAuditOptions { RetentionDays = 0 });
Assert.True(result.Failed);
Assert.Contains("RetentionDays", result.FailureMessage);
}
}