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
@@ -8,7 +8,7 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.Tests.Serialization;
public sealed class BundleSerializerTests
{
// Commons-015 sets the documented PBKDF2 floor to 100_000 (OWASP minimum).
// The documented PBKDF2 floor is 100_000 (OWASP minimum).
// Using the floor keeps the suite fast while passing EncryptionMetadata
// validation.
private const int TestIterations = EncryptionMetadata.MinPbkdf2Iterations;
@@ -33,6 +33,7 @@ public sealed class BundleSerializerTests
contents: Array.Empty<ManifestContentEntry>(),
contentBytes: contentBytes);
/// <summary>Verifies that packing without a passphrase emits a manifest and plain JSON content.</summary>
[Fact]
public void Pack_emits_manifest_and_content_json_when_no_passphrase()
{
@@ -49,6 +50,7 @@ public sealed class BundleSerializerTests
Assert.Null(archive.GetEntry("content.enc"));
}
/// <summary>Verifies that packing with a passphrase emits a manifest and encrypted content.</summary>
[Fact]
public void Pack_emits_manifest_and_content_enc_when_passphrase_supplied()
{
@@ -67,6 +69,7 @@ public sealed class BundleSerializerTests
Assert.NotNull(archive.GetEntry("content.enc"));
}
/// <summary>Verifies that a round trip through a temporary stream recovers identical content.</summary>
[Fact]
public void Roundtrip_through_temp_stream_recovers_identical_content()
{
@@ -91,6 +94,7 @@ public sealed class BundleSerializerTests
Assert.Equal("return 42;", shared.Code);
}
/// <summary>Verifies that reading the manifest throws when the archive has no manifest file.</summary>
[Fact]
public void ReadManifest_throws_when_zip_missing_manifest_json()
{
@@ -107,6 +111,7 @@ public sealed class BundleSerializerTests
Assert.Throws<InvalidDataException>(() => sut.ReadManifest(ms));
}
/// <summary>Verifies that unpacking throws a CryptographicException when the passphrase is wrong.</summary>
[Fact]
public void UnpackContent_throws_CryptographicException_on_wrong_passphrase()
{