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.
82 lines
2.8 KiB
C#
82 lines
2.8 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Kpi;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Kpi;
|
|
|
|
public class KpiSampleTests
|
|
{
|
|
/// <summary>Verifies that a KpiSample constructed with its required members round-trips the values.</summary>
|
|
[Fact]
|
|
public void KpiSample_ConstructedWithRequiredMembers_RoundTripsValues()
|
|
{
|
|
var capturedAt = new DateTime(2026, 6, 15, 12, 30, 0, DateTimeKind.Utc);
|
|
|
|
var sample = new KpiSample
|
|
{
|
|
Id = 42,
|
|
Source = KpiSources.NotificationOutbox,
|
|
Metric = "QueueDepth",
|
|
Scope = KpiScopes.Global,
|
|
ScopeKey = null,
|
|
Value = 17,
|
|
CapturedAtUtc = capturedAt,
|
|
};
|
|
|
|
Assert.Equal(42, sample.Id);
|
|
Assert.Equal("NotificationOutbox", sample.Source);
|
|
Assert.Equal("QueueDepth", sample.Metric);
|
|
Assert.Equal("Global", sample.Scope);
|
|
Assert.Null(sample.ScopeKey);
|
|
Assert.Equal(17, sample.Value);
|
|
Assert.Equal(capturedAt, sample.CapturedAtUtc);
|
|
Assert.Equal(DateTimeKind.Utc, sample.CapturedAtUtc.Kind);
|
|
}
|
|
|
|
/// <summary>Verifies that a scoped sample carries its scope key.</summary>
|
|
[Fact]
|
|
public void KpiSample_ScopedSample_CarriesScopeKey()
|
|
{
|
|
var sample = new KpiSample
|
|
{
|
|
Source = KpiSources.SiteHealth,
|
|
Metric = "OldestPendingAgeSeconds",
|
|
Scope = KpiScopes.Site,
|
|
ScopeKey = "site-a",
|
|
Value = 12.5,
|
|
CapturedAtUtc = DateTime.UtcNow,
|
|
};
|
|
|
|
Assert.Equal(KpiScopes.Site, sample.Scope);
|
|
Assert.Equal("site-a", sample.ScopeKey);
|
|
Assert.Equal(12.5, sample.Value);
|
|
}
|
|
|
|
/// <summary>Verifies that each KPI scope and source constant equals its own name.</summary>
|
|
[Fact]
|
|
public void KpiScopesAndSources_ConstantValues_EqualTheirNames()
|
|
{
|
|
Assert.Equal("NotificationOutbox", KpiSources.NotificationOutbox);
|
|
Assert.Equal("SiteCallAudit", KpiSources.SiteCallAudit);
|
|
Assert.Equal("AuditLog", KpiSources.AuditLog);
|
|
Assert.Equal("SiteHealth", KpiSources.SiteHealth);
|
|
|
|
Assert.Equal("Global", KpiScopes.Global);
|
|
Assert.Equal("Site", KpiScopes.Site);
|
|
Assert.Equal("Node", KpiScopes.Node);
|
|
}
|
|
|
|
/// <summary>Verifies that KpiSeriesPoint is a value record struct with component-wise equality.</summary>
|
|
[Fact]
|
|
public void KpiSeriesPoint_IsValueRecordStruct_WithComponentEquality()
|
|
{
|
|
var bucket = new DateTime(2026, 6, 15, 0, 0, 0, DateTimeKind.Utc);
|
|
|
|
var a = new KpiSeriesPoint(bucket, 3.0);
|
|
var b = new KpiSeriesPoint(bucket, 3.0);
|
|
|
|
Assert.Equal(bucket, a.BucketStartUtc);
|
|
Assert.Equal(3.0, a.Value);
|
|
Assert.Equal(a, b);
|
|
}
|
|
}
|