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
@@ -3,7 +3,7 @@ using Microsoft.Data.Sqlite;
namespace ZB.MOM.WW.ScadaBridge.SiteEventLogging.Tests;
/// <summary>
/// LocalDb Phase 1 (Task 2) — the <c>site_events</c> DDL is extracted out of
/// The <c>site_events</c> DDL is extracted out of
/// <see cref="SiteEventLogger"/> so the Host's <c>AddZbLocalDb</c> onReady callback can
/// create it in the consolidated site database.
/// <para>
@@ -39,6 +39,7 @@ public class SiteEventLogSchemaTests
return cols;
}
/// <summary>Verifies that applying the schema creates the table with the expected columns.</summary>
[Fact]
public void Apply_CreatesTableWithExpectedColumns()
{
@@ -51,6 +52,7 @@ public class SiteEventLogSchemaTests
TableInfo(conn, "site_events").Select(c => c.Name));
}
/// <summary>Verifies that the id column is a text primary key rather than an autoincrement integer.</summary>
[Fact]
public void Apply_IdIsTextPrimaryKey_NotAutoincrement()
{
@@ -71,6 +73,7 @@ public class SiteEventLogSchemaTests
Assert.Equal(0L, Convert.ToInt64(cmd.ExecuteScalar()));
}
/// <summary>Verifies that inserts that omit the text id are rejected.</summary>
[Fact]
public void Apply_RejectsIntegerIdInserts()
{
@@ -79,7 +82,7 @@ public class SiteEventLogSchemaTests
SiteEventLogSchema.Apply(conn);
// A TEXT PK with no AUTOINCREMENT means an INSERT omitting id is an error,
// which is what forces the writer to mint one (Task 5a).
// which is what forces the writer to mint one.
using var cmd = conn.CreateCommand();
cmd.CommandText = """
INSERT INTO site_events (timestamp, event_type, severity, source, message)
@@ -88,6 +91,7 @@ public class SiteEventLogSchemaTests
Assert.Throws<SqliteException>(() => cmd.ExecuteNonQuery());
}
/// <summary>Verifies that the schema has no blob columns.</summary>
[Fact]
public void Apply_HasNoBlobColumns()
{
@@ -100,6 +104,7 @@ public class SiteEventLogSchemaTests
c => c.Type.Contains("BLOB", StringComparison.OrdinalIgnoreCase));
}
/// <summary>Verifies that applying the schema creates the expected indexes.</summary>
[Fact]
public void Apply_CreatesExpectedIndexes()
{
@@ -120,6 +125,7 @@ public class SiteEventLogSchemaTests
indexes);
}
/// <summary>Verifies that applying the schema repeatedly is safe.</summary>
[Fact]
public void Apply_IsIdempotent()
{