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:
+7
-2
@@ -6,12 +6,12 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages.Integration;
|
||||
|
||||
/// <summary>
|
||||
/// Audit Log (#23) telemetry handoff: envelope + pull request/response DTOs.
|
||||
/// Audit Log telemetry handoff: envelope + pull request/response DTOs.
|
||||
/// At-least-once from sites; idempotent at central on <see cref="AuditEvent.EventId"/>.
|
||||
/// </summary>
|
||||
public class AuditTelemetryMessagesTests
|
||||
{
|
||||
// C3 (Task 2.5): canonical ZB.MOM.WW.Audit.AuditEvent built via the shared
|
||||
// Canonical ZB.MOM.WW.Audit.AuditEvent built via the shared
|
||||
// factory (domain fields ride in DetailsJson). These tests assert only the
|
||||
// envelope/response DTO behaviour, so the audit row's contents are incidental.
|
||||
private static AuditEvent MakeEvent(Guid? id = null) =>
|
||||
@@ -21,6 +21,7 @@ public class AuditTelemetryMessagesTests
|
||||
status: AuditStatus.Delivered,
|
||||
eventId: id ?? Guid.NewGuid());
|
||||
|
||||
/// <summary>Verifies that a telemetry envelope constructed with three events can be enumerated.</summary>
|
||||
[Fact]
|
||||
public void AuditTelemetryEnvelope_ConstructsWithThreeEvents_AndIsEnumerable()
|
||||
{
|
||||
@@ -42,6 +43,7 @@ public class AuditTelemetryMessagesTests
|
||||
Assert.Equal(3, collected.Count);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the telemetry envelope is immutable and compares its event list by reference identity.</summary>
|
||||
[Fact]
|
||||
public void AuditTelemetryEnvelope_IsImmutable_RecordEqualityOnReferenceIdentityOfList()
|
||||
{
|
||||
@@ -62,6 +64,7 @@ public class AuditTelemetryMessagesTests
|
||||
Assert.Equal("site-01", a.SourceSiteId);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a pull request can be constructed and is immutable.</summary>
|
||||
[Fact]
|
||||
public void PullAuditEventsRequest_ConstructsAndIsImmutable()
|
||||
{
|
||||
@@ -77,6 +80,7 @@ public class AuditTelemetryMessagesTests
|
||||
Assert.Equal(500, bigger.BatchSize);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a pull response with more-available set can be constructed and enumerated.</summary>
|
||||
[Fact]
|
||||
public void PullAuditEventsResponse_ConstructsWithMoreAvailableTrue_AndIsEnumerable()
|
||||
{
|
||||
@@ -94,6 +98,7 @@ public class AuditTelemetryMessagesTests
|
||||
Assert.Equal(2, collected.Count);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a with-expression on a pull response changes only the targeted field.</summary>
|
||||
[Fact]
|
||||
public void PullAuditEventsResponse_WithExpression_ChangesSingleField()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user