Joseph Doherty
513fa1aa16
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.
78 lines
3.6 KiB
C#
78 lines
3.6 KiB
C#
using ZB.MOM.WW.ScadaBridge.AuditLog.Site;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Site;
|
|
|
|
/// <summary>
|
|
/// Eager startup validation for <see cref="SqliteAuditWriterOptions"/>
|
|
/// (arch-review 08 round 2 NF4). The site hot-path writer's channel/batch/flush
|
|
/// knobs must be positive or the background writer task cannot make progress.
|
|
/// <c>BacklogPollIntervalSeconds</c> is deliberately NOT validated — a
|
|
/// non-positive value has a documented fall-back-to-30s contract.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <c>DatabasePath</c> is intentionally NOT covered here (arch-review remediation): it defaults to <c>""</c> (no CWD-relative default — mirrors
|
|
/// <c>LocalDb:Path</c>), but this validator runs on both Central and Site
|
|
/// composition roots via <c>ValidateOnStart</c>, and only Site nodes ever resolve
|
|
/// the writer. The Site-only requirement is enforced pre-host by
|
|
/// <c>StartupValidator</c> in ZB.MOM.WW.ScadaBridge.Host — see
|
|
/// <c>StartupValidatorTests.SiteWithoutAuditLogDatabasePath_FailsValidation</c>.
|
|
/// </remarks>
|
|
public class SqliteAuditWriterOptionsValidatorTests
|
|
{
|
|
/// <summary>Verifies that the default options pass validation.</summary>
|
|
[Fact]
|
|
public void DefaultOptions_AreValid()
|
|
{
|
|
// Includes the empty DatabasePath default — this validator does not check
|
|
// it (see class remarks); only StartupValidator does, and only for Site nodes.
|
|
var validator = new SqliteAuditWriterOptionsValidator();
|
|
Assert.True(validator.Validate(null, new SqliteAuditWriterOptions()).Succeeded);
|
|
}
|
|
|
|
/// <summary>Verifies that a channel capacity of zero fails validation.</summary>
|
|
[Fact]
|
|
public void ZeroChannelCapacity_Fails()
|
|
{
|
|
var validator = new SqliteAuditWriterOptionsValidator();
|
|
var result = validator.Validate(null, new SqliteAuditWriterOptions { ChannelCapacity = 0 });
|
|
Assert.False(result.Succeeded);
|
|
Assert.Contains(result.Failures!,
|
|
f => f.Contains(nameof(SqliteAuditWriterOptions.ChannelCapacity), StringComparison.Ordinal));
|
|
}
|
|
|
|
/// <summary>Verifies that a batch size of zero fails validation.</summary>
|
|
[Fact]
|
|
public void ZeroBatchSize_Fails()
|
|
{
|
|
var validator = new SqliteAuditWriterOptionsValidator();
|
|
var result = validator.Validate(null, new SqliteAuditWriterOptions { BatchSize = 0 });
|
|
Assert.False(result.Succeeded);
|
|
Assert.Contains(result.Failures!,
|
|
f => f.Contains(nameof(SqliteAuditWriterOptions.BatchSize), StringComparison.Ordinal));
|
|
}
|
|
|
|
/// <summary>Verifies that a flush interval of zero fails validation.</summary>
|
|
[Fact]
|
|
public void ZeroFlushInterval_Fails()
|
|
{
|
|
var validator = new SqliteAuditWriterOptionsValidator();
|
|
var result = validator.Validate(null, new SqliteAuditWriterOptions { FlushIntervalMs = 0 });
|
|
Assert.False(result.Succeeded);
|
|
Assert.Contains(result.Failures!,
|
|
f => f.Contains(nameof(SqliteAuditWriterOptions.FlushIntervalMs), StringComparison.Ordinal));
|
|
}
|
|
|
|
/// <summary>Verifies that a non-positive backlog poll interval still passes validation.</summary>
|
|
/// <param name="value">The non-positive poll interval, in milliseconds, to validate.</param>
|
|
[Theory]
|
|
[InlineData(0)]
|
|
[InlineData(-1)]
|
|
public void NonPositiveBacklogPollInterval_StillValid(int value)
|
|
{
|
|
// Documented fall-back-to-30s contract — must NOT be rejected.
|
|
var validator = new SqliteAuditWriterOptionsValidator();
|
|
Assert.True(validator.Validate(null,
|
|
new SqliteAuditWriterOptions { BacklogPollIntervalSeconds = value }).Succeeded);
|
|
}
|
|
}
|