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.
This commit is contained in:
@@ -2,6 +2,7 @@ namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit.Tests;
|
||||
|
||||
public class SiteCallAuditOptionsTests
|
||||
{
|
||||
/// <summary>Verifies that the defaults are the expected values.</summary>
|
||||
[Fact]
|
||||
public void Defaults_AreExpectedValues()
|
||||
{
|
||||
@@ -12,7 +13,7 @@ public class SiteCallAuditOptionsTests
|
||||
// KPI interval mirrors NotificationOutboxOptions.DeliveredKpiWindow.
|
||||
Assert.Equal(TimeSpan.FromMinutes(1), options.KpiInterval);
|
||||
|
||||
// Reconciliation tick cadence mirrors SiteAuditReconciliationOptions (#23).
|
||||
// Reconciliation tick cadence mirrors SiteAuditReconciliationOptions.
|
||||
Assert.Equal(TimeSpan.FromMinutes(5), options.ReconciliationInterval);
|
||||
// Purge tick cadence mirrors AuditLogPurgeOptions.
|
||||
Assert.Equal(TimeSpan.FromHours(24), options.PurgeInterval);
|
||||
@@ -20,6 +21,7 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(365, options.RetentionDays);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the resolved reconciliation interval defaults to the configured value.</summary>
|
||||
[Fact]
|
||||
public void ResolvedReconciliationInterval_DefaultsToConfiguredValue()
|
||||
{
|
||||
@@ -28,6 +30,8 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(options.ReconciliationInterval, options.ResolvedReconciliationInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the resolved reconciliation interval clamps a zero or negative value to the minimum.</summary>
|
||||
/// <param name="configuredSeconds">The configured interval in seconds.</param>
|
||||
[Theory]
|
||||
[InlineData(0)]
|
||||
[InlineData(-5)]
|
||||
@@ -47,6 +51,7 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(TimeSpan.FromSeconds(1), options.ResolvedReconciliationInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an override of the reconciliation interval bypasses the clamp.</summary>
|
||||
[Fact]
|
||||
public void ResolvedReconciliationInterval_OverrideBypassesClamp()
|
||||
{
|
||||
@@ -62,6 +67,7 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(sub1Second, options.ResolvedReconciliationInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the resolved purge interval defaults to the configured value.</summary>
|
||||
[Fact]
|
||||
public void ResolvedPurgeInterval_DefaultsToConfiguredValue()
|
||||
{
|
||||
@@ -70,6 +76,8 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(options.PurgeInterval, options.ResolvedPurgeInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the resolved purge interval clamps a zero or negative value to the minimum.</summary>
|
||||
/// <param name="configuredSeconds">The configured interval in seconds.</param>
|
||||
[Theory]
|
||||
[InlineData(0)]
|
||||
[InlineData(-30)]
|
||||
@@ -89,6 +97,7 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(TimeSpan.FromMinutes(1), options.ResolvedPurgeInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a purge interval below the one-minute floor is clamped to the minimum.</summary>
|
||||
[Fact]
|
||||
public void ResolvedPurgeInterval_BelowMinuteFloorClampsToMinimum()
|
||||
{
|
||||
@@ -101,6 +110,7 @@ public class SiteCallAuditOptionsTests
|
||||
Assert.Equal(TimeSpan.FromMinutes(1), options.ResolvedPurgeInterval);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an override of the purge interval bypasses the clamp.</summary>
|
||||
[Fact]
|
||||
public void ResolvedPurgeInterval_OverrideBypassesClamp()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user