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

58 lines
2.5 KiB
C#

using ZB.MOM.WW.ScadaBridge.AuditLog.Site;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Site;
/// <summary>
/// Eager startup validation for <see cref="SiteAuditRetentionOptions"/>
/// (arch-review 08 round 2 NF4). Although the option class self-clamps at
/// resolve time, the validator still fails a boot with a plainly-wrong config
/// (zero retention window, zero/negative purge period, negative initial delay)
/// so the operator learns at startup rather than trusting a silent clamp.
/// <c>PurgeIntervalOverride</c> is test-only and left unvalidated.
/// </summary>
public class SiteAuditRetentionOptionsValidatorTests
{
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
var validator = new SiteAuditRetentionOptionsValidator();
Assert.True(validator.Validate(null, new SiteAuditRetentionOptions()).Succeeded);
}
/// <summary>Verifies that a retention period of zero days fails validation.</summary>
[Fact]
public void ZeroRetentionDays_Fails()
{
var validator = new SiteAuditRetentionOptionsValidator();
var result = validator.Validate(null, new SiteAuditRetentionOptions { RetentionDays = 0 });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditRetentionOptions.RetentionDays), StringComparison.Ordinal));
}
/// <summary>Verifies that a purge interval of zero fails validation.</summary>
[Fact]
public void ZeroPurgeInterval_Fails()
{
var validator = new SiteAuditRetentionOptionsValidator();
var result = validator.Validate(null,
new SiteAuditRetentionOptions { PurgeInterval = TimeSpan.Zero });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditRetentionOptions.PurgeInterval), StringComparison.Ordinal));
}
/// <summary>Verifies that a negative initial delay fails validation.</summary>
[Fact]
public void NegativeInitialDelay_Fails()
{
var validator = new SiteAuditRetentionOptionsValidator();
var result = validator.Validate(null,
new SiteAuditRetentionOptions { InitialDelay = TimeSpan.FromSeconds(-1) });
Assert.False(result.Succeeded);
Assert.Contains(result.Failures!,
f => f.Contains(nameof(SiteAuditRetentionOptions.InitialDelay), StringComparison.Ordinal));
}
}