dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.CentralUI.Tests/Components/Audit/AuditDrilldownDrawerTests.cs
+23 -1
View File
@@ -9,7 +9,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components.Audit;
/// <summary>
/// bUnit tests for <see cref="AuditDrilldownDrawer"/> (#23 M7 Bundle C / M7-T4..T8).
/// bUnit tests for <see cref="AuditDrilldownDrawer"/>.
///
/// The drawer is a child component opened from the Audit Log page when a grid row
/// is clicked. It renders the offcanvas chrome (header, open/close) and delegates
@@ -24,6 +24,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Components.Audit;
/// </summary>
public class AuditDrilldownDrawerTests : BunitContext
{
/// <summary>Initializes the test context with loose JS interop and the services the drawer needs.</summary>
public AuditDrilldownDrawerTests()
{
// Default to Loose so the cURL clipboard call does not blow up tests
@@ -70,6 +71,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Extra = extra,
};
/// <summary>Verifies that the drawer renders the occurred-at UTC field.</summary>
[Fact]
public void Drawer_RendersField_OccurredAtUtc()
{
@@ -86,6 +88,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("2026-05-20T12:30:45", cut.Markup);
}
/// <summary>Verifies that a JSON request summary is pretty-printed with indentation.</summary>
[Fact]
public void Drawer_JsonRequestSummary_PrettyPrinted_Indented()
{
@@ -104,6 +107,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Matches(@"\n\s+""b"":\s*""two""", cut.Markup);
}
/// <summary>Verifies that a non-JSON request summary is rendered verbatim.</summary>
[Fact]
public void Drawer_NonJsonRequestSummary_RenderedVerbatim()
{
@@ -118,6 +122,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("not really json {{}", cut.Markup);
}
/// <summary>Verifies that a DbOutbound event renders its SQL block.</summary>
[Fact]
public void Drawer_DbOutboundChannel_RendersSqlBlock()
{
@@ -140,6 +145,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("abc", cut.Markup);
}
/// <summary>Verifies that an API outbound event shows the copy-as-cURL button.</summary>
[Fact]
public void Drawer_ApiOutbound_ShowsCopyAsCurlButton()
{
@@ -152,6 +158,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("data-test=\"copy-as-curl\"", cut.Markup);
}
/// <summary>Verifies that a non-API channel event hides the copy-as-cURL button.</summary>
[Fact]
public void Drawer_NotApiChannel_HidesCopyAsCurlButton()
{
@@ -165,6 +172,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"copy-as-curl\"", cut.Markup);
}
/// <summary>Verifies that a null correlation id hides the show-all button.</summary>
[Fact]
public void Drawer_NullCorrelationId_HidesShowAllButton()
{
@@ -177,6 +185,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"show-all-events\"", cut.Markup);
}
/// <summary>Verifies that a redacted body shows the redaction badge.</summary>
[Fact]
public void Drawer_RedactedBody_ShowsRedactionBadge()
{
@@ -191,6 +200,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("data-test=\"redaction-badge-request\"", cut.Markup);
}
/// <summary>Verifies that a non-redacted body hides the redaction badge.</summary>
[Fact]
public void Drawer_NonRedactedBody_HidesBadge()
{
@@ -203,6 +213,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"redaction-badge-request\"", cut.Markup);
}
/// <summary>Verifies that show-all-for-operation navigates with the correlation id in the query string.</summary>
[Fact]
public void ShowAllForOperation_Navigates_WithCorrelationIdQueryString()
{
@@ -220,6 +231,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains(corr.ToString(), nav.Uri);
}
/// <summary>Verifies that a null execution id hides the view-this-execution button.</summary>
[Fact]
public void Drawer_NullExecutionId_HidesViewThisExecutionButton()
{
@@ -232,6 +244,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"view-this-execution\"", cut.Markup);
}
/// <summary>Verifies that a non-null execution id shows the view-this-execution button.</summary>
[Fact]
public void Drawer_NonNullExecutionId_ShowsViewThisExecutionButton()
{
@@ -244,6 +257,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("data-test=\"view-this-execution\"", cut.Markup);
}
/// <summary>Verifies that view-this-execution navigates with the execution id in the query string.</summary>
[Fact]
public void ViewThisExecution_Navigates_WithExecutionIdQueryString()
{
@@ -260,6 +274,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains($"/audit/log?executionId={exec}", nav.Uri);
}
/// <summary>Verifies that a null parent execution id hides the view-parent-execution button.</summary>
[Fact]
public void Drawer_NullParentExecutionId_HidesViewParentExecutionButton()
{
@@ -272,6 +287,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"view-parent-execution\"", cut.Markup);
}
/// <summary>Verifies that a non-null parent execution id shows the view-parent-execution button.</summary>
[Fact]
public void Drawer_NonNullParentExecutionId_ShowsViewParentExecutionButton()
{
@@ -284,6 +300,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("data-test=\"view-parent-execution\"", cut.Markup);
}
/// <summary>Verifies that view-parent-execution navigates with the parent execution id in the query string.</summary>
[Fact]
public void ViewParentExecution_Navigates_WithExecutionIdQueryString()
{
@@ -303,6 +320,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains($"/audit/log?executionId={parent}", nav.Uri);
}
/// <summary>Verifies that a null execution id hides the view-execution-chain button.</summary>
[Fact]
public void Drawer_NullExecutionId_HidesViewExecutionChainButton()
{
@@ -315,6 +333,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.DoesNotContain("data-test=\"view-execution-chain\"", cut.Markup);
}
/// <summary>Verifies that a non-null execution id shows the view-execution-chain button.</summary>
[Fact]
public void Drawer_NonNullExecutionId_ShowsViewExecutionChainButton()
{
@@ -327,6 +346,7 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains("data-test=\"view-execution-chain\"", cut.Markup);
}
/// <summary>Verifies that view-execution-chain navigates to the execution tree page.</summary>
[Fact]
public void ViewExecutionChain_Navigates_ToExecutionTreePage()
{
@@ -345,6 +365,8 @@ public class AuditDrilldownDrawerTests : BunitContext
Assert.Contains($"/audit/execution-tree?executionId={exec}", nav.Uri);
}
/// <summary>Verifies that copy-as-cURL invokes the clipboard with the cURL command string.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CopyAsCurl_InvokesClipboard_WithCurlString()
{