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
@@ -21,7 +21,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.Transport.IntegrationTests.Import;
/// <summary>
/// #05-T3: a template script's <see cref="TemplateScript.MinTimeBetweenRuns"/> and
/// A template script's <see cref="TemplateScript.MinTimeBetweenRuns"/> and
/// <see cref="TemplateScript.ExecutionTimeoutSeconds"/> must survive an export→import
/// round-trip. The exporter serializes both fields (EntitySerializer) and the DTO
/// carries them; before this fix the importer's <c>BuildTemplate</c> (Add) and
@@ -33,6 +33,7 @@ public sealed class TemplateScriptFidelityTests : IDisposable
{
private readonly ServiceProvider _provider;
/// <summary>Initializes the test class with a fresh service provider and database.</summary>
public TemplateScriptFidelityTests()
{
var services = new ServiceCollection();
@@ -66,6 +67,7 @@ public sealed class TemplateScriptFidelityTests : IDisposable
_provider = services.BuildServiceProvider();
}
/// <summary>Disposes the service provider.</summary>
public void Dispose() => _provider.Dispose();
private async Task<Guid> ExportAndLoadAsync()
@@ -99,6 +101,8 @@ public sealed class TemplateScriptFidelityTests : IDisposable
return session.SessionId;
}
/// <summary>Verifies that adding a template script preserves its minimum time between runs and execution timeout.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Add_preserves_MinTimeBetweenRuns_and_ExecutionTimeoutSeconds()
{
@@ -147,6 +151,8 @@ public sealed class TemplateScriptFidelityTests : IDisposable
}
}
/// <summary>Verifies that overwriting updates the execution timeout, shows it as the only diff, and emits an audit entry.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Overwrite_updates_ExecutionTimeoutSeconds_only_diff_and_emits_audit()
{
@@ -200,10 +206,12 @@ public sealed class TemplateScriptFidelityTests : IDisposable
}
}
/// <summary>Verifies that adding preserves the locked-in-derived flag on attributes, alarms and scripts.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Add_preserves_LockedInDerived_on_attribute_alarm_script()
{
// #05-T4: LockedInDerived must survive export→import on all three child kinds.
// LockedInDerived must survive export→import on all three child kinds.
await using (var scope = _provider.CreateAsyncScope())
{
var ctx = scope.ServiceProvider.GetRequiredService<ScadaBridgeDbContext>();