dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.KpiHistory.Tests/KpiHistoryOptionsValidatorTests.cs
+32 -1
View File
@@ -3,7 +3,7 @@ using ZB.MOM.WW.ScadaBridge.KpiHistory;
namespace ZB.MOM.WW.ScadaBridge.KpiHistory.Tests;
/// <summary>
/// K3 unit tests for <see cref="KpiHistoryOptionsValidator"/>: the default
/// Unit tests for <see cref="KpiHistoryOptionsValidator"/>: the default
/// options must validate, and each rule (SampleInterval / RetentionDays /
/// PurgeInterval / DefaultMaxSeriesPoints) must reject its out-of-range values.
/// </summary>
@@ -11,6 +11,7 @@ public class KpiHistoryOptionsValidatorTests
{
private static KpiHistoryOptionsValidator NewValidator() => new();
/// <summary>Verifies that a zero source timeout fails validation.</summary>
[Fact]
public void Validate_SourceTimeout_Zero_Fails()
{
@@ -19,6 +20,7 @@ public class KpiHistoryOptionsValidatorTests
Assert.Contains("SourceTimeout", result.FailureMessage);
}
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void Validate_Defaults_Pass()
{
@@ -30,6 +32,7 @@ public class KpiHistoryOptionsValidatorTests
// SampleInterval > TimeSpan.Zero
// ---------------------------------------------------------------------
/// <summary>Verifies that a zero sample interval fails validation.</summary>
[Fact]
public void Validate_SampleInterval_Zero_Fails()
{
@@ -42,6 +45,7 @@ public class KpiHistoryOptionsValidatorTests
f => f.Contains(nameof(KpiHistoryOptions.SampleInterval), StringComparison.Ordinal));
}
/// <summary>Verifies that a negative sample interval fails validation.</summary>
[Fact]
public void Validate_SampleInterval_Negative_Fails()
{
@@ -58,6 +62,8 @@ public class KpiHistoryOptionsValidatorTests
// RetentionDays in [1, 3650]
// ---------------------------------------------------------------------
/// <summary>Verifies that an in-range retention period passes validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(1)] // min
[InlineData(90)] // default
@@ -71,6 +77,8 @@ public class KpiHistoryOptionsValidatorTests
Assert.True(NewValidator().Validate(null, opts).Succeeded);
}
/// <summary>Verifies that an out-of-range retention period fails validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(0)]
[InlineData(3651)]
@@ -90,6 +98,7 @@ public class KpiHistoryOptionsValidatorTests
// PurgeInterval > TimeSpan.Zero
// ---------------------------------------------------------------------
/// <summary>Verifies that a zero purge interval fails validation.</summary>
[Fact]
public void Validate_PurgeInterval_Zero_Fails()
{
@@ -102,6 +111,7 @@ public class KpiHistoryOptionsValidatorTests
f => f.Contains(nameof(KpiHistoryOptions.PurgeInterval), StringComparison.Ordinal));
}
/// <summary>Verifies that a negative purge interval fails validation.</summary>
[Fact]
public void Validate_PurgeInterval_Negative_Fails()
{
@@ -118,6 +128,8 @@ public class KpiHistoryOptionsValidatorTests
// DefaultMaxSeriesPoints in [2, 5000]
// ---------------------------------------------------------------------
/// <summary>Verifies that an in-range default maximum series point count passes validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(2)] // min
[InlineData(200)] // default
@@ -128,6 +140,8 @@ public class KpiHistoryOptionsValidatorTests
Assert.True(NewValidator().Validate(null, opts).Succeeded);
}
/// <summary>Verifies that an out-of-range default maximum series point count fails validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(1)]
[InlineData(5001)]
@@ -147,6 +161,8 @@ public class KpiHistoryOptionsValidatorTests
// RollupInterval > TimeSpan.Zero
// ---------------------------------------------------------------------
/// <summary>Verifies that a non-positive rollup interval fails validation.</summary>
/// <param name="hours">The rollup interval in hours.</param>
[Theory]
[InlineData(0)]
[InlineData(-1)]
@@ -165,6 +181,8 @@ public class KpiHistoryOptionsValidatorTests
// RollupLookbackHours in [1, 168]
// ---------------------------------------------------------------------
/// <summary>Verifies that an in-range rollup lookback passes validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(1)] // min
[InlineData(3)] // default
@@ -175,6 +193,8 @@ public class KpiHistoryOptionsValidatorTests
Assert.True(NewValidator().Validate(null, opts).Succeeded);
}
/// <summary>Verifies that an out-of-range rollup lookback fails validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(0)]
[InlineData(169)]
@@ -194,6 +214,8 @@ public class KpiHistoryOptionsValidatorTests
// RollupRetentionDays in [1, 3650] AND >= RetentionDays
// ---------------------------------------------------------------------
/// <summary>Verifies that an in-range rollup retention period passes validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(90)] // == RetentionDays default
[InlineData(365)] // default
@@ -204,6 +226,8 @@ public class KpiHistoryOptionsValidatorTests
Assert.True(NewValidator().Validate(null, opts).Succeeded);
}
/// <summary>Verifies that an out-of-range rollup retention period fails validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(0)]
[InlineData(3651)]
@@ -219,6 +243,7 @@ public class KpiHistoryOptionsValidatorTests
f => f.Contains(nameof(KpiHistoryOptions.RollupRetentionDays), StringComparison.Ordinal));
}
/// <summary>Verifies that a rollup retention shorter than the raw retention fails validation.</summary>
[Fact]
public void Validate_RollupRetentionDays_LessThanRetentionDays_Fails()
{
@@ -237,6 +262,7 @@ public class KpiHistoryOptionsValidatorTests
&& f.Contains(nameof(KpiHistoryOptions.RetentionDays), StringComparison.Ordinal));
}
/// <summary>Verifies that a rollup retention equal to the raw retention passes validation.</summary>
[Fact]
public void Validate_RollupRetentionDays_EqualToRetentionDays_Passes()
{
@@ -249,6 +275,8 @@ public class KpiHistoryOptionsValidatorTests
// RollupThresholdHours >= 24
// ---------------------------------------------------------------------
/// <summary>Verifies that a rollup threshold at or above the minimum passes validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(24)] // min
[InlineData(168)] // default
@@ -259,6 +287,8 @@ public class KpiHistoryOptionsValidatorTests
Assert.True(NewValidator().Validate(null, opts).Succeeded);
}
/// <summary>Verifies that a rollup threshold below the minimum fails validation.</summary>
/// <param name="value">The option value under test.</param>
[Theory]
[InlineData(23)]
[InlineData(0)]
@@ -274,6 +304,7 @@ public class KpiHistoryOptionsValidatorTests
f => f.Contains(nameof(KpiHistoryOptions.RollupThresholdHours), StringComparison.Ordinal));
}
/// <summary>Verifies that violating every rule accumulates every failure message.</summary>
[Fact]
public void Validate_AllRulesViolated_AccumulatesEveryFailure()
{