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/Pages/AuditLogPageScaffoldTests.cs
+21 -8
View File
@@ -16,9 +16,8 @@ using NavMenu = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Layout.NavMenu;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Pages;
/// <summary>
/// Scaffold tests for the new Audit Log page (#23 M7-T1) and the Audit
/// nav group that hosts both it and the renamed Configuration Audit Log
/// (#23 M7 Bundle A).
/// Scaffold tests for the new Audit Log page and the Audit
/// nav group that hosts both it and the renamed Configuration Audit Log.
///
/// These are render-only smoke tests — the filter bar and results grid
/// are intentional placeholders that Bundle B fills in. The tests pin
@@ -27,6 +26,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Pages;
/// </summary>
public class AuditLogPageScaffoldTests : BunitContext
{
/// <summary>Configures bUnit's JS interop in loose mode so unconfigured grid interop calls are no-ops.</summary>
public AuditLogPageScaffoldTests()
{
// The page hosts AuditResultsGrid, whose OnAfterRenderAsync wires the
@@ -63,7 +63,7 @@ public class AuditLogPageScaffoldTests : BunitContext
// Provide stand-ins so the scaffold smoke tests still render the page.
Services.AddSingleton(Substitute.For<ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories.ISiteRepository>());
Services.AddSingleton(_queryService);
// M6 (K15): the page now injects IKpiHistoryQueryService for the Trends
// The page now injects IKpiHistoryQueryService for the Trends
// panel. Provide a stand-in so the scaffold/drill-in renders still work.
Services.AddSingleton(Substitute.For<IKpiHistoryQueryService>());
@@ -73,7 +73,7 @@ public class AuditLogPageScaffoldTests : BunitContext
nav.NavigateTo($"/audit/log?{query}");
}
// Bundle G (#23 M7-T15): the page now hosts an in-component
// The page now hosts an in-component
// AuthorizeView around the Export-CSV button, so the page MUST
// render inside a CascadingAuthenticationState. The router supplies
// this in production; bUnit hosts the page directly so we wrap it
@@ -109,7 +109,7 @@ public class AuditLogPageScaffoldTests : BunitContext
/// <summary>
/// Asserts the named rail section is present. After the ZB.MOM.WW.Theme
/// adoption (Task 2.4) nav sections are the kit's <c>NavRailSection</c> —
/// adoption nav sections are the kit's <c>NavRailSection</c> —
/// native <c>&lt;details class="rail-section"&gt;</c> disclosures that are
/// open by default, so a section's items are already in the DOM (no click
/// needed, no JS). This helper just confirms the section's
@@ -122,6 +122,7 @@ public class AuditLogPageScaffoldTests : BunitContext
s => s.TextContent.Contains(title, StringComparison.Ordinal));
}
/// <summary>Verifies that the Audit Log page renders its page heading.</summary>
[Fact]
public void AuditLogPage_Renders_PageHeading()
{
@@ -136,6 +137,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that the nav menu contains an Audit group with a link to the Audit Log page.</summary>
[Fact]
public void NavMenu_Contains_AuditGroup_With_AuditLog_Link()
{
@@ -149,6 +151,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that the nav menu lists the Configuration Audit Log link under the Audit group.</summary>
[Fact]
public void NavMenu_Contains_ConfigurationAuditLog_Link_UnderAuditGroup()
{
@@ -174,9 +177,10 @@ public class AuditLogPageScaffoldTests : BunitContext
}
// ─────────────────────────────────────────────────────────────────────────
// Bundle D — query-string drill-in parsing (#23 M7-T10..T12)
// Query-string drill-in parsing
// ─────────────────────────────────────────────────────────────────────────
/// <summary>Verifies that navigating with a correlation id applies the filter and loads results automatically.</summary>
[Fact]
public void NavigateWithCorrelationId_AppliesFilter_AndAutoLoads()
{
@@ -197,6 +201,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that navigating with an execution id applies the filter and loads results automatically.</summary>
[Fact]
public void NavigateWithExecutionIdParam_AppliesFilter_AndAutoLoads()
{
@@ -219,6 +224,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that an unparseable execution id is silently dropped and nothing loads automatically.</summary>
[Fact]
public void NavigateWithUnparseableExecutionIdParam_IsSilentlyDropped_NoAutoLoad()
{
@@ -235,6 +241,7 @@ public class AuditLogPageScaffoldTests : BunitContext
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that navigating with a parent execution id applies the filter and loads results automatically.</summary>
[Fact]
public void NavigateWithParentExecutionIdParam_AppliesFilter_AndAutoLoads()
{
@@ -257,6 +264,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that an unparseable parent execution id is silently dropped and nothing loads automatically.</summary>
[Fact]
public void NavigateWithUnparseableParentExecutionIdParam_IsSilentlyDropped_NoAutoLoad()
{
@@ -274,6 +282,7 @@ public class AuditLogPageScaffoldTests : BunitContext
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that navigating with a target parameter applies the target filter.</summary>
[Fact]
public void NavigateWithTargetParam_AppliesTargetFilter()
{
@@ -292,6 +301,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that navigating with a site parameter applies the site filter.</summary>
[Fact]
public void NavigateWithSiteParam_AppliesSiteFilter()
{
@@ -311,10 +321,11 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that navigating with a status parameter applies the status filter.</summary>
[Fact]
public void NavigateWithStatusParam_AppliesStatusFilter()
{
// Bundle E (M7-T13): the Health-dashboard Audit error-rate tile drills
// The Health-dashboard Audit error-rate tile drills
// in with ?status=Failed. The page parses the enum (case-insensitive),
// builds an AuditLogQueryFilter with Status set, and auto-loads.
_queryService = Substitute.For<IAuditLogQueryService>();
@@ -333,6 +344,7 @@ public class AuditLogPageScaffoldTests : BunitContext
});
}
/// <summary>Verifies that an unknown status value is silently dropped and nothing loads automatically.</summary>
[Fact]
public void NavigateWithUnknownStatusParam_IsSilentlyDropped_NoAutoLoad()
{
@@ -350,6 +362,7 @@ public class AuditLogPageScaffoldTests : BunitContext
Arg.Any<CancellationToken>());
}
/// <summary>Verifies that navigating without parameters leaves the filter empty and does not load automatically.</summary>
[Fact]
public void NavigateWithNoParams_LeavesFilterEmpty_NoAutoLoad()
{