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,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
/// <summary>
/// Task 21 (PLAN-07): the additive optional <c>SiteIdentifier</c> trailing param on the
/// The additive optional <c>SiteIdentifier</c> trailing param on the
/// Browse/Verify/Cert-trust management commands. Verifies backward compatibility (legacy
/// JSON without the field deserializes to null) and round-trip survival when set.
/// </summary>
@@ -17,6 +17,7 @@ public class BrowseVerifyCertSiteIdentifierTests
// ── Backward compatibility: legacy JSON (no SiteIdentifier) → null ──
/// <summary>Verifies that browse node command legacy json site identifier null.</summary>
[Fact]
public void BrowseNodeCommand_LegacyJson_SiteIdentifierNull()
{
@@ -26,6 +27,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal("conn", cmd.ConnectionName);
}
/// <summary>Verifies that search address space command legacy json site identifier null.</summary>
[Fact]
public void SearchAddressSpaceCommand_LegacyJson_SiteIdentifierNull()
{
@@ -35,6 +37,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal("pump", cmd.Query);
}
/// <summary>Verifies that verify endpoint command legacy json site identifier null.</summary>
[Fact]
public void VerifyEndpointCommand_LegacyJson_SiteIdentifierNull()
{
@@ -44,6 +47,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal("OpcUa", cmd.Protocol);
}
/// <summary>Verifies that trust server cert command legacy json site identifier null.</summary>
[Fact]
public void TrustServerCertCommand_LegacyJson_SiteIdentifierNull()
{
@@ -53,6 +57,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal("ABCD", cmd.Thumbprint);
}
/// <summary>Verifies that remove server cert command legacy json site identifier null.</summary>
[Fact]
public void RemoveServerCertCommand_LegacyJson_SiteIdentifierNull()
{
@@ -62,6 +67,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal("ABCD", cmd.Thumbprint);
}
/// <summary>Verifies that list server certs command legacy json site identifier null.</summary>
[Fact]
public void ListServerCertsCommand_LegacyJson_SiteIdentifierNull()
{
@@ -72,6 +78,7 @@ public class BrowseVerifyCertSiteIdentifierTests
// ── Round-trip: SiteIdentifier set survives serialize → deserialize ──
/// <summary>Verifies that browse node command round trip site identifier survives.</summary>
[Fact]
public void BrowseNodeCommand_RoundTrip_SiteIdentifierSurvives()
{
@@ -82,6 +89,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal(original, round);
}
/// <summary>Verifies that search address space command round trip site identifier survives.</summary>
[Fact]
public void SearchAddressSpaceCommand_RoundTrip_SiteIdentifierSurvives()
{
@@ -92,6 +100,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal(original, round);
}
/// <summary>Verifies that verify endpoint command round trip site identifier survives.</summary>
[Fact]
public void VerifyEndpointCommand_RoundTrip_SiteIdentifierSurvives()
{
@@ -102,6 +111,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal(original, round);
}
/// <summary>Verifies that trust server cert command round trip site identifier survives.</summary>
[Fact]
public void TrustServerCertCommand_RoundTrip_SiteIdentifierSurvives()
{
@@ -112,6 +122,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal(original, round);
}
/// <summary>Verifies that remove server cert command round trip site identifier survives.</summary>
[Fact]
public void RemoveServerCertCommand_RoundTrip_SiteIdentifierSurvives()
{
@@ -122,6 +133,7 @@ public class BrowseVerifyCertSiteIdentifierTests
Assert.Equal(original, round);
}
/// <summary>Verifies that list server certs command round trip site identifier survives.</summary>
[Fact]
public void ListServerCertsCommand_RoundTrip_SiteIdentifierSurvives()
{