Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.AuditLog.Tests/Site/SiteAuditTelemetryOptionsValidatorTests.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

67 lines
2.8 KiB
C#

using ZB.MOM.WW.ScadaBridge.AuditLog.Site.Telemetry;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Site;
/// <summary>
/// Eager startup validation for <see cref="SiteAuditTelemetryOptions"/>
/// (arch-review 08 round 2 NF4). The drain-loop cadences are used as raw
/// scheduling delays in <c>SiteAuditTelemetryActor</c>; a zero interval spins
/// the drain and a zero batch drains nothing. Idle must back off at least as
/// far as busy (idle &lt; busy inverts the actor's intent).
/// </summary>
public class SiteAuditTelemetryOptionsValidatorTests
{
/// <summary>Verifies that default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
var validator = new SiteAuditTelemetryOptionsValidator();
Assert.True(validator.Validate(null, new SiteAuditTelemetryOptions()).Succeeded);
}
/// <summary>Verifies that zero batch size fails.</summary>
[Fact]
public void ZeroBatchSize_Fails()
{
var validator = new SiteAuditTelemetryOptionsValidator();
var result = validator.Validate(null, new SiteAuditTelemetryOptions { BatchSize = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditTelemetryOptions.BatchSize), StringComparison.Ordinal));
}
/// <summary>Verifies that zero busy interval fails.</summary>
[Fact]
public void ZeroBusyInterval_Fails()
{
var validator = new SiteAuditTelemetryOptionsValidator();
var result = validator.Validate(null, new SiteAuditTelemetryOptions { BusyIntervalSeconds = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditTelemetryOptions.BusyIntervalSeconds), StringComparison.Ordinal));
}
/// <summary>Verifies that zero idle interval fails.</summary>
[Fact]
public void ZeroIdleInterval_Fails()
{
var validator = new SiteAuditTelemetryOptionsValidator();
var result = validator.Validate(null, new SiteAuditTelemetryOptions { IdleIntervalSeconds = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditTelemetryOptions.IdleIntervalSeconds), StringComparison.Ordinal));
}
/// <summary>Verifies that idle shorter than busy fails.</summary>
[Fact]
public void IdleShorterThanBusy_Fails()
{
var validator = new SiteAuditTelemetryOptionsValidator();
var result = validator.Validate(null,
new SiteAuditTelemetryOptions { BusyIntervalSeconds = 30, IdleIntervalSeconds = 5 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditTelemetryOptions.IdleIntervalSeconds), StringComparison.Ordinal));
}
}