Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/Streaming/SiteStreamAlarmDropReporterTests.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

61 lines
2.6 KiB
C#

using Akka.TestKit.Xunit2;
using Microsoft.Extensions.Logging.Abstractions;
using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Streaming;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Streaming;
/// <summary>
/// The hosted reporter must lift <see cref="SiteStreamManager.AlarmPublishDroppedCount"/>
/// onto the site health report via <see cref="ISiteHealthCollector"/>. Uses the real
/// collector (mirrors <c>ScriptSchedulerStatsReporterTests</c> — NSubstitute is not
/// referenced by this test project). The queue's own drop-counting mechanism is verified
/// deterministically and separately by
/// <see cref="Streaming.SiteStreamManagerTests.CreateAlarmPublishQueue_OverCapacity_DropsOldestAndInvokesCallback"/>;
/// this test proves the reporter's poll-and-push wiring runs correctly.
/// </summary>
public class SiteStreamAlarmDropReporterTests : TestKit, IDisposable
{
/// <inheritdoc />
void IDisposable.Dispose() => Shutdown();
/// <summary>Verifies that reporter pushes alarm drop count to collector.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Reporter_PushesAlarmDropCountToCollector()
{
var options = new SiteRuntimeOptions { StreamBufferSize = 100 };
var collector = new SiteHealthCollector();
var streamManager = new SiteStreamManager(options, NullLogger<SiteStreamManager>.Instance);
streamManager.Initialize(Sys);
using var reporter = new SiteStreamAlarmDropReporter(
collector, streamManager, NullLogger<SiteStreamAlarmDropReporter>.Instance,
pollInterval: TimeSpan.FromMilliseconds(50));
await reporter.StartAsync(CancellationToken.None);
try
{
// The immediate first probe (no drops yet) must reach the report as 0 —
// proving the reporter actually ran and pushed a value, not that the field
// simply defaulted.
await WaitUntilAsync(() =>
collector.CollectReport("site-1").SiteStreamAlarmDropCount == streamManager.AlarmPublishDroppedCount);
var report = collector.CollectReport("site-1");
Assert.Equal(streamManager.AlarmPublishDroppedCount, report.SiteStreamAlarmDropCount);
}
finally
{
await reporter.StopAsync(CancellationToken.None);
}
}
private static async Task WaitUntilAsync(Func<bool> condition)
{
for (var i = 0; i < 100 && !condition(); i++)
await Task.Delay(50);
Assert.True(condition(), "condition not met within timeout");
}
}