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
@@ -7,7 +7,7 @@ using ZB.MOM.WW.ScadaBridge.InboundAPI;
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
/// <summary>
/// WP-14: End-to-end integration tests for Phase 7 integration surfaces.
/// End-to-end integration tests for Phase 7 integration surfaces.
/// </summary>
public class IntegrationSurfaceTests
{
@@ -17,6 +17,7 @@ public class IntegrationSurfaceTests
// ZB.MOM.WW.Auth.ApiKeys verifier (Bearer sbk_<keyId>_<secret>); its coverage
// lives in the InboundAPI endpoint + Auth-library tests.
/// <summary>Verifies that inbound API parameter validation handles the extended types and reports the right error codes.</summary>
[Fact]
public void InboundAPI_ParameterValidation_ExtendedTypes()
{
@@ -46,10 +47,11 @@ public class IntegrationSurfaceTests
// ── External System: error classification ──
/// <summary>Verifies that external system HTTP errors are classified as transient or permanent.</summary>
[Fact]
public void ExternalSystem_ErrorClassification_TransientVsPermanent()
{
// WP-8: Verify the full classification spectrum
// Verify the full classification spectrum
Assert.True(ExternalSystemGateway.ErrorClassifier.IsTransient(HttpStatusCode.InternalServerError));
Assert.True(ExternalSystemGateway.ErrorClassifier.IsTransient(HttpStatusCode.ServiceUnavailable));
Assert.True(ExternalSystemGateway.ErrorClassifier.IsTransient(HttpStatusCode.RequestTimeout));
@@ -62,7 +64,7 @@ public class IntegrationSurfaceTests
}
// ── Notification: mock SMTP delivery ──
// NS-019: the site-shaped NotificationDeliveryService that this case exercised
// The site-shaped NotificationDeliveryService that this case exercised
// was removed when sites stopped delivering notifications. The central SMTP
// delivery path is now covered end-to-end by
// ZB.MOM.WW.ScadaBridge.NotificationOutbox.Tests.Delivery.EmailNotificationDeliveryAdapterTests;
@@ -70,6 +72,8 @@ public class IntegrationSurfaceTests
// ── Script Context: integration API wiring ──
/// <summary>Verifies that the script context routes external system calls to the configured client.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptContext_ExternalSystem_Call_Wired()
{
@@ -86,6 +90,8 @@ public class IntegrationSurfaceTests
Assert.Equal("{\"value\":1}", result.ResponseJson);
}
/// <summary>Verifies that the script context routes notification sends to the configured service.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptContext_Notify_Send_Wired()
{
@@ -111,6 +117,8 @@ public class IntegrationSurfaceTests
Assert.NotNull(buffered);
}
/// <summary>Verifies that an external system call throws when no client is configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptContext_ExternalSystem_NoClient_Throws()
{
@@ -120,6 +128,8 @@ public class IntegrationSurfaceTests
() => context.ExternalSystem.Call("api", "method"));
}
/// <summary>Verifies that a database call throws when no gateway is configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptContext_Database_NoGateway_Throws()
{
@@ -129,6 +139,8 @@ public class IntegrationSurfaceTests
() => context.Database.Connection("db"));
}
/// <summary>Verifies that a notification send throws when no service is configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptContext_Notify_NoService_Throws()
{