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.CLI.Tests/Commands/AuditBackfillCommandTests.cs
+25 -3
View File
@@ -8,9 +8,8 @@ using ZB.MOM.WW.ScadaBridge.CLI.Commands;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// Tests for the <c>scadabridge audit backfill-source-node</c> subcommand
/// (Audit Log #23 M5.6 T5): argument parsing, request-body construction,
/// HTTP wiring, and CLI scaffold.
/// Tests for the <c>scadabridge audit backfill-source-node</c> subcommand:
/// argument parsing, request-body construction, HTTP wiring, and CLI scaffold.
/// </summary>
[Collection("Console")]
public class AuditBackfillCommandTests
@@ -19,6 +18,7 @@ public class AuditBackfillCommandTests
// BuildRequestBody
// ─────────────────────────────────────────────────────────────────────
/// <summary>Verifies that building a request body from default arguments contains the expected sentinel, before and batch size fields.</summary>
[Fact]
public void BuildRequestBody_DefaultArgs_ContainsExpectedFields()
{
@@ -38,6 +38,7 @@ public class AuditBackfillCommandTests
Assert.Equal(5000, root.GetProperty("batchSize").GetInt32());
}
/// <summary>Verifies that a custom sentinel and batch size are reflected in the request body JSON.</summary>
[Fact]
public void BuildRequestBody_CustomSentinelAndBatch_ReflectedInJson()
{
@@ -66,16 +67,23 @@ public class AuditBackfillCommandTests
private readonly HttpStatusCode _status;
private readonly string _responseBody;
/// <summary>Initializes a new handler that returns the given status and body for every request.</summary>
/// <param name="status">The HTTP status code to return.</param>
/// <param name="responseBody">The response body to return.</param>
public CapturingHandler(HttpStatusCode status, string responseBody)
{
_status = status;
_responseBody = responseBody;
}
/// <summary>Gets the path and query of the last request received.</summary>
public string? LastRequestUri { get; private set; }
/// <summary>Gets the body of the last request received.</summary>
public string? LastRequestBody { get; private set; }
/// <summary>Gets the HTTP method of the last request received.</summary>
public string? LastMethod { get; private set; }
/// <inheritdoc />
protected override async Task<HttpResponseMessage> SendAsync(
HttpRequestMessage request, CancellationToken cancellationToken)
{
@@ -95,6 +103,8 @@ public class AuditBackfillCommandTests
private static string SuccessBody(long rowsUpdated = 42, string sentinel = "unknown", string before = "2026-01-01T00:00:00.0000000Z")
=> JsonSerializer.Serialize(new { rowsUpdated, sentinel, before });
/// <summary>Verifies that a successful backfill returns exit code zero and writes the response to the output.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RunBackfill_Success_ReturnsZeroAndWritesOutput()
{
@@ -117,6 +127,8 @@ public class AuditBackfillCommandTests
Assert.Contains("backfill complete", text, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that the backfill request is sent to the backfill endpoint path.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RunBackfill_RequestUri_ContainsBackfillPath()
{
@@ -133,6 +145,8 @@ public class AuditBackfillCommandTests
Assert.Equal("POST", handler.LastMethod);
}
/// <summary>Verifies that the backfill request body contains the sentinel and the before timestamp.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RunBackfill_RequestBody_ContainsSentinelAndBefore()
{
@@ -157,6 +171,8 @@ public class AuditBackfillCommandTests
Assert.Equal(2000, doc.RootElement.GetProperty("batchSize").GetInt32());
}
/// <summary>Verifies that an HTTP 403 response yields exit code 2.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RunBackfill_Http403_ReturnsExitCode2()
{
@@ -173,6 +189,8 @@ public class AuditBackfillCommandTests
Assert.Equal(2, exit);
}
/// <summary>Verifies that an HTTP 500 response yields exit code 1.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RunBackfill_Http500_ReturnsExitCode1()
{
@@ -193,6 +211,7 @@ public class AuditBackfillCommandTests
// CLI parsing
// ─────────────────────────────────────────────────────────────────────
/// <summary>Verifies that the backfill-source-node subcommand exists in the audit command group.</summary>
[Fact]
public void BackfillSourceNode_Subcommand_ExistsInAuditCommandGroup()
{
@@ -201,6 +220,7 @@ public class AuditBackfillCommandTests
Assert.Empty(parse.Errors);
}
/// <summary>Verifies that the before option is required on the backfill-source-node subcommand.</summary>
[Fact]
public void BackfillSourceNode_BeforeOption_IsRequired()
{
@@ -209,6 +229,7 @@ public class AuditBackfillCommandTests
Assert.NotEqual(0, exit);
}
/// <summary>Verifies that the help text describes the sentinel and before options.</summary>
[Fact]
public void BackfillSourceNode_HelpText_DescribesSentinelAndBefore()
{
@@ -223,6 +244,7 @@ public class AuditBackfillCommandTests
Assert.Contains("before", text, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that the default sentinel value is unknown.</summary>
[Fact]
public void BackfillSourceNode_DefaultSentinel_IsUnknown()
{