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:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -4,13 +4,14 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Audit;
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
/// <summary>
/// Site Call Audit (#22): construction, value-equality and optionality tests
/// Site Call Audit: construction, value-equality and optionality tests
/// for the Site Calls UI query / KPI / detail message contracts. Mirrors the
/// Notification Outbox <c>NotificationMessagesTests</c> coverage of the read
/// side, scoped to the contracts the Site Calls page consumes.
/// </summary>
public class SiteCallQueriesTests
{
/// <summary>Verifies that positional construction of a site call query request sets all fields.</summary>
[Fact]
public void SiteCallQueryRequest_PositionalConstruction_SetsAllFields()
{
@@ -33,6 +34,7 @@ public class SiteCallQueriesTests
Assert.Equal(50, request.PageSize);
}
/// <summary>Verifies that a site call query request allows its optional filters to be null.</summary>
[Fact]
public void SiteCallQueryRequest_AllowsNullOptionalFilters()
{
@@ -48,6 +50,7 @@ public class SiteCallQueriesTests
Assert.Null(request.AfterId);
}
/// <summary>Verifies that two site call query responses are equal when all their fields match.</summary>
[Fact]
public void SiteCallQueryResponse_ValueEquality_EqualWhenAllFieldsMatch()
{
@@ -58,6 +61,7 @@ public class SiteCallQueriesTests
Assert.Equal(a.GetHashCode(), b.GetHashCode());
}
/// <summary>Verifies that a site call summary carries the entity columns and the stuck flag.</summary>
[Fact]
public void SiteCallSummary_CarriesEntityColumnsAndStuckFlag()
{
@@ -77,6 +81,7 @@ public class SiteCallQueriesTests
Assert.True(summary.IsStuck);
}
/// <summary>Verifies that a detail response for a missing row has a null detail.</summary>
[Fact]
public void SiteCallDetailResponse_MissingRow_HasNullDetail()
{
@@ -87,6 +92,7 @@ public class SiteCallQueriesTests
Assert.Equal("site call not found", response.ErrorMessage);
}
/// <summary>Verifies that a failed KPI response zeroes its KPI fields.</summary>
[Fact]
public void SiteCallKpiResponse_FailureShape_ZeroesKpiFields()
{
@@ -101,6 +107,7 @@ public class SiteCallQueriesTests
Assert.Null(response.OldestPendingAge);
}
/// <summary>Verifies that the per-site KPI response carries a snapshot for each site.</summary>
[Fact]
public void PerSiteSiteCallKpiResponse_CarriesPerSiteSnapshots()
{
@@ -119,6 +126,7 @@ public class SiteCallQueriesTests
Assert.Equal(TimeSpan.FromMinutes(15), site.OldestPendingAge);
}
/// <summary>Verifies that the oldest pending age of a KPI snapshot can be null for an empty table.</summary>
[Fact]
public void SiteCallKpiSnapshot_OldestPendingAge_IsNullableForEmptyTable()
{