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
@@ -13,7 +13,7 @@ using ZB.MOM.WW.ScadaBridge.Security;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components;
/// <summary>
/// Covers the M7-B8 (T17) "Verify endpoint" affordance added to
/// Covers the "Verify endpoint" affordance added to
/// <see cref="OpcUaEndpointEditor"/>: a button that calls the injected
/// <see cref="IEndpointVerificationService"/> with the current endpoint config and
/// renders the typed <see cref="VerifyEndpointResult"/> — green on success, a red
@@ -21,7 +21,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components;
/// <see cref="VerifyFailureKind.UntrustedCertificate"/> with a captured cert.
///
/// <para>
/// Also covers the M7-B10 (T17) "Trust certificate" affordance on the untrusted-cert
/// Also covers the "Trust certificate" affordance on the untrusted-cert
/// panel: an Administrator-gated button that calls
/// <see cref="ICertManagementService.TrustAsync"/> and re-runs Verify on success.
/// </para>
@@ -34,6 +34,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
private readonly ICertManagementService _certs =
Substitute.For<ICertManagementService>();
/// <summary>Registers the substitute verification and certificate-management services with the test container.</summary>
public OpcUaEndpointVerifyTests()
{
Services.AddSingleton(_verify);
@@ -86,6 +87,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
return host.FindComponent<OpcUaEndpointEditor>();
}
/// <summary>Verifies that a successful endpoint verification shows a success message.</summary>
[Fact]
public void Verify_Success_ShowsSuccessMessage()
{
@@ -102,6 +104,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
Assert.Empty(cut.FindAll("[data-test=verify-cert-panel]"));
}
/// <summary>Verifies that an untrusted server certificate shows the certificate panel with its thumbprint.</summary>
[Fact]
public void Verify_UntrustedCertificate_ShowsCertPanelWithThumbprint()
{
@@ -128,6 +131,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
Assert.NotEmpty(cut.FindAll("[data-test=verify-failure]"));
}
/// <summary>Verifies that a generic verification failure shows a failure message.</summary>
[Fact]
public void Verify_GenericFailure_ShowsFailureMessage()
{
@@ -161,6 +165,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
.Returns(new VerifyEndpointResult(
false, VerifyFailureKind.UntrustedCertificate, "Untrusted certificate.", cert));
/// <summary>Verifies that an administrator sees the trust button and that clicking it calls the trust operation.</summary>
[Fact]
public void TrustButton_Admin_SeesButton_AndClick_CallsTrustAsync()
{
@@ -183,6 +188,7 @@ public class OpcUaEndpointVerifyTests : BunitContext
"plant-a", "PLC-OPC", cert.DerBase64, cert.Thumbprint, Arg.Any<CancellationToken>());
}
/// <summary>Verifies that a user with only the Designer role does not see the trust button.</summary>
[Fact]
public void TrustButton_NonAdmin_DesignerOnly_DoesNotSeeButton()
{