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:
+25
-1
@@ -21,7 +21,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Tracking;
|
||||
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Integration.Infrastructure;
|
||||
|
||||
/// <summary>
|
||||
/// Shared end-to-end harness for the M3 cached-call combined telemetry tests
|
||||
/// Shared end-to-end harness for the cached-call combined telemetry tests
|
||||
/// (G2/G3/G4). Composes the full pipeline:
|
||||
/// <list type="bullet">
|
||||
/// <item><description>Site-local SQLite <see cref="SqliteAuditWriter"/> (in-memory) +
|
||||
@@ -48,15 +48,25 @@ namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Integration.Infrastructure;
|
||||
/// </remarks>
|
||||
public sealed class CombinedTelemetryHarness : IAsyncDisposable
|
||||
{
|
||||
/// <summary>The site SQLite audit writer under test.</summary>
|
||||
public SqliteAuditWriter SqliteWriter { get; }
|
||||
/// <summary>The in-memory ring buffer fallback for audit events.</summary>
|
||||
public RingBufferFallback Ring { get; }
|
||||
/// <summary>The fallback audit writer that wraps the SQLite writer and the ring buffer.</summary>
|
||||
public FallbackAuditWriter FallbackWriter { get; }
|
||||
/// <summary>The site-local operation tracking store.</summary>
|
||||
public OperationTrackingStore TrackingStore { get; }
|
||||
/// <summary>The inner cached-call telemetry forwarder.</summary>
|
||||
public CachedCallTelemetryForwarder InnerForwarder { get; }
|
||||
/// <summary>The combined telemetry dispatcher that sends audit and operational state together.</summary>
|
||||
public CombinedTelemetryDispatcher Dispatcher { get; }
|
||||
/// <summary>The cached-call lifecycle bridge wired to the forwarder.</summary>
|
||||
public CachedCallLifecycleBridge Bridge { get; }
|
||||
/// <summary>The stub site-stream audit client that delivers packets directly to the ingest actor.</summary>
|
||||
public DirectActorSiteStreamAuditClient StubClient { get; }
|
||||
/// <summary>The central audit ingest actor.</summary>
|
||||
public IActorRef IngestActor { get; }
|
||||
/// <summary>The service provider backing the central repositories.</summary>
|
||||
public IServiceProvider ServiceProvider { get; }
|
||||
|
||||
private readonly MsSqlMigrationFixture _fixture;
|
||||
@@ -64,6 +74,10 @@ public sealed class CombinedTelemetryHarness : IAsyncDisposable
|
||||
private readonly ServiceProvider _trackingLocalDbProvider;
|
||||
private bool _disposed;
|
||||
|
||||
/// <summary>Builds the harness, wiring the site writer chain, dispatcher and central ingest actor against the shared fixture.</summary>
|
||||
/// <param name="fixture">The MS SQL migration fixture providing the central database.</param>
|
||||
/// <param name="testKit">The Akka test kit that hosts the ingest actor.</param>
|
||||
/// <param name="siteCallRepoOverride">Optional factory that replaces the default site-call audit repository.</param>
|
||||
public CombinedTelemetryHarness(
|
||||
MsSqlMigrationFixture fixture,
|
||||
Akka.TestKit.Xunit2.TestKit testKit,
|
||||
@@ -133,15 +147,23 @@ public sealed class CombinedTelemetryHarness : IAsyncDisposable
|
||||
/// dispatcher (the bridge's hooks fire only for S&F retry-loop
|
||||
/// attempts; submit-row emission happens at the script call site).
|
||||
/// </summary>
|
||||
/// <param name="submit">The submit packet to forward.</param>
|
||||
/// <param name="ct">A token to cancel the forward.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public Task EmitSubmitAsync(CachedCallTelemetry submit, CancellationToken ct = default) =>
|
||||
Dispatcher.ForwardAsync(submit, ct);
|
||||
|
||||
/// <summary>
|
||||
/// Convenience: route a per-attempt or terminal outcome through the bridge.
|
||||
/// </summary>
|
||||
/// <param name="context">The attempt or terminal-outcome context to route.</param>
|
||||
/// <param name="ct">A token to cancel the emit.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public Task EmitAttemptAsync(CachedCallAttemptContext context, CancellationToken ct = default) =>
|
||||
Bridge.OnAttemptCompletedAsync(context, ct);
|
||||
|
||||
/// <summary>Creates a fresh central database context for reading back persisted rows.</summary>
|
||||
/// <returns>A new <see cref="ScadaBridgeDbContext"/>.</returns>
|
||||
public ScadaBridgeDbContext CreateReadContext()
|
||||
{
|
||||
var options = new DbContextOptionsBuilder<ScadaBridgeDbContext>()
|
||||
@@ -173,6 +195,8 @@ public sealed class CombinedTelemetryHarness : IAsyncDisposable
|
||||
return services.BuildServiceProvider();
|
||||
}
|
||||
|
||||
/// <summary>Releases the resources held by this test class asynchronously.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
if (_disposed) return;
|
||||
|
||||
Reference in New Issue
Block a user