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
@@ -18,8 +18,8 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.IntegrationTests;
/// <summary>
/// FU-B — integration coverage for the post-flush second-pass rewire in
/// <c>BundleImporter.ApplyAsync</c>: composition edges (<c>#39</c>) and
/// alarm-script FKs (remainder of <c>#37</c>). All three scenarios drive the
/// <c>BundleImporter.ApplyAsync</c>: composition edges and
/// alarm-script FKs. All three scenarios drive the
/// full export → load → apply pipeline so the wire-level DTO carries the
/// name-keyed references the importer is expected to resolve.
/// </summary>
@@ -27,6 +27,7 @@ public sealed class CompositionImportTests : IDisposable
{
private readonly ServiceProvider _provider;
/// <summary>Initializes the test class with an in-memory database and the Transport services.</summary>
public CompositionImportTests()
{
var services = new ServiceCollection();
@@ -43,7 +44,7 @@ public sealed class CompositionImportTests : IDisposable
services.AddScoped<IExternalSystemRepository, ExternalSystemRepository>();
services.AddScoped<INotificationRepository, NotificationRepository>();
services.AddScoped<IInboundApiRepository, InboundApiRepository>();
// M8: DependencyResolver now injects ISiteRepository to walk the
// DependencyResolver now injects ISiteRepository to walk the
// site/data-connection/instance closure; register it or activation fails.
services.AddScoped<ISiteRepository, SiteRepository>();
services.AddScoped<IAuditCorrelationContext, AuditCorrelationContext>();
@@ -53,6 +54,7 @@ public sealed class CompositionImportTests : IDisposable
_provider = services.BuildServiceProvider();
}
/// <summary>Releases the resources held by this test class.</summary>
public void Dispose() => _provider.Dispose();
/// <summary>
@@ -97,6 +99,8 @@ public sealed class CompositionImportTests : IDisposable
await ctx.SaveChangesAsync();
}
/// <summary>Verifies that composition edges are restored on import.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Composition_edges_are_restored_on_import()
{
@@ -163,6 +167,8 @@ public sealed class CompositionImportTests : IDisposable
}
}
/// <summary>Verifies that a composition referencing a skipped template emits an unresolved audit entry and skips the edge.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Composition_referencing_skipped_template_emits_unresolved_audit_and_skips_edge()
{
@@ -241,6 +247,8 @@ public sealed class CompositionImportTests : IDisposable
}
}
/// <summary>Verifies that the on-trigger script alarm link is restored on import.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task OnTriggerScript_alarm_link_is_restored_on_import()
{