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,6 +21,7 @@ public class CertStoreActorTests : TestKit, IDisposable
private readonly string _rejectedDir;
private readonly OpcUaGlobalOptions _options;
/// <summary>Initializes a new instance of the <see cref="CertStoreActorTests"/> class.</summary>
public CertStoreActorTests()
{
var root = Path.Combine(Path.GetTempPath(), "ScadaBridge-CertStoreTests", Guid.NewGuid().ToString("N"));
@@ -33,6 +34,7 @@ public class CertStoreActorTests : TestKit, IDisposable
};
}
/// <inheritdoc />
void IDisposable.Dispose()
{
Shutdown();
@@ -69,6 +71,7 @@ public class CertStoreActorTests : TestKit, IDisposable
return (Convert.ToBase64String(der), cert.Thumbprint);
}
/// <summary>Verifies the case: write, then List, then Remove, round Trips.</summary>
[Fact]
public void Write_ThenList_ThenRemove_RoundTrips()
{
@@ -106,6 +109,7 @@ public class CertStoreActorTests : TestKit, IDisposable
emptyAck.Certs!.Should().NotContain(c => c.Thumbprint == thumbprint);
}
/// <summary>Verifies the case: export Local Trusted Certs, returns Thumbprint And Der Bytes.</summary>
[Fact]
public void ExportLocalTrustedCerts_ReturnsThumbprintAndDerBytes()
{
@@ -127,6 +131,7 @@ public class CertStoreActorTests : TestKit, IDisposable
entry.DerBytes.Should().Equal(expectedDer);
}
/// <summary>Verifies the case: write, invalid Base64, returns Failure Ack.</summary>
[Fact]
public void Write_InvalidBase64_ReturnsFailureAck()
{
@@ -138,6 +143,7 @@ public class CertStoreActorTests : TestKit, IDisposable
ack.Error.Should().NotBeNullOrEmpty();
}
/// <summary>Verifies the case: remove, missing Cert, is No Op Success.</summary>
[Fact]
public void Remove_MissingCert_IsNoOpSuccess()
{
@@ -148,6 +154,7 @@ public class CertStoreActorTests : TestKit, IDisposable
ack.Success.Should().BeTrue("removing an absent cert is an idempotent no-op");
}
/// <summary>Verifies the case: write, path Traversal Thumbprint, rejected Without Touching Filesystem.</summary>
[Fact]
public void Write_PathTraversalThumbprint_RejectedWithoutTouchingFilesystem()
{
@@ -167,6 +174,7 @@ public class CertStoreActorTests : TestKit, IDisposable
"the actor must not write outside the trusted-store directory");
}
/// <summary>Verifies the case: remove, path Traversal Thumbprint, rejected Without Touching Filesystem.</summary>
[Fact]
public void Remove_PathTraversalThumbprint_RejectedWithoutTouchingFilesystem()
{