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.Commons.Tests/Messages/NotificationMessagesTests.cs
+25 -3
View File
@@ -9,8 +9,9 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
/// </summary>
public class NotificationMessagesTests
{
// ── Task 7: site/central notification message contracts ──
// ── Site/central notification message contracts ──
/// <summary>Verifies that positional construction of a notification submit sets all fields.</summary>
[Fact]
public void NotificationSubmit_PositionalConstruction_SetsAllFields()
{
@@ -29,6 +30,7 @@ public class NotificationMessagesTests
Assert.Equal(enqueuedAt, msg.SiteEnqueuedAt);
}
/// <summary>Verifies that a notification submit allows null optional source fields.</summary>
[Fact]
public void NotificationSubmit_AllowsNullOptionalSourceFields()
{
@@ -40,10 +42,11 @@ public class NotificationMessagesTests
Assert.Null(msg.SourceScript);
}
/// <summary>Verifies that the origin execution id of a notification submit defaults to null.</summary>
[Fact]
public void NotificationSubmit_OriginExecutionId_DefaultsToNull()
{
// Audit Log #23: OriginExecutionId is an additive trailing member — a
// OriginExecutionId is an additive trailing member — a
// submit built without it (old call sites / old serialized payloads)
// leaves the id null.
var msg = new NotificationSubmit(
@@ -53,6 +56,7 @@ public class NotificationMessagesTests
Assert.Null(msg.OriginExecutionId);
}
/// <summary>Verifies that the origin execution id round-trips when supplied.</summary>
[Fact]
public void NotificationSubmit_OriginExecutionId_RoundTripsWhenSupplied()
{
@@ -64,6 +68,7 @@ public class NotificationMessagesTests
Assert.Equal(executionId, msg.OriginExecutionId);
}
/// <summary>Verifies that the origin execution id survives a JSON round trip.</summary>
[Fact]
public void NotificationSubmit_OriginExecutionId_SurvivesJsonRoundTrip()
{
@@ -81,6 +86,7 @@ public class NotificationMessagesTests
Assert.Equal(executionId, roundTripped!.OriginExecutionId);
}
/// <summary>Verifies that the origin parent execution id defaults to null.</summary>
[Fact]
public void NotificationSubmit_OriginParentExecutionId_DefaultsToNull()
{
@@ -94,6 +100,7 @@ public class NotificationMessagesTests
Assert.Null(msg.OriginParentExecutionId);
}
/// <summary>Verifies that the origin parent execution id round-trips when supplied.</summary>
[Fact]
public void NotificationSubmit_OriginParentExecutionId_RoundTripsWhenSupplied()
{
@@ -107,6 +114,7 @@ public class NotificationMessagesTests
Assert.Equal(parentExecutionId, msg.OriginParentExecutionId);
}
/// <summary>Verifies that the origin parent execution id survives a JSON round trip.</summary>
[Fact]
public void NotificationSubmit_OriginParentExecutionId_SurvivesJsonRoundTrip()
{
@@ -126,6 +134,7 @@ public class NotificationMessagesTests
Assert.Equal(parentExecutionId, roundTripped!.OriginParentExecutionId);
}
/// <summary>Verifies that a notification submit carries the source node.</summary>
[Fact]
public void NotificationSubmit_carries_SourceNode()
{
@@ -152,6 +161,7 @@ public class NotificationMessagesTests
Assert.Equal("node-a", roundTripped!.SourceNode);
}
/// <summary>Verifies that two notification submits are equal when all fields match.</summary>
[Fact]
public void NotificationSubmit_ValueEquality_EqualWhenAllFieldsMatch()
{
@@ -163,6 +173,7 @@ public class NotificationMessagesTests
Assert.Equal(a.GetHashCode(), b.GetHashCode());
}
/// <summary>Verifies that a with-expression on a notification submit ack changes a single field.</summary>
[Fact]
public void NotificationSubmitAck_WithExpression_ChangesSingleField()
{
@@ -176,6 +187,7 @@ public class NotificationMessagesTests
Assert.NotEqual(ack, rejected);
}
/// <summary>Verifies that positional construction of a notification status query sets all fields.</summary>
[Fact]
public void NotificationStatusQuery_PositionalConstruction_SetsAllFields()
{
@@ -185,6 +197,7 @@ public class NotificationMessagesTests
Assert.Equal("notif-9", msg.NotificationId);
}
/// <summary>Verifies that positional construction of a notification status response sets all fields.</summary>
[Fact]
public void NotificationStatusResponse_PositionalConstruction_SetsAllFields()
{
@@ -200,8 +213,9 @@ public class NotificationMessagesTests
Assert.Equal(deliveredAt, msg.DeliveredAt);
}
// ── Task 8: outbox UI query/action contracts ──
// ── Outbox UI query/action contracts ──
/// <summary>Verifies that positional construction of a notification outbox query request sets all fields.</summary>
[Fact]
public void NotificationOutboxQueryRequest_PositionalConstruction_SetsAllFields()
{
@@ -224,6 +238,7 @@ public class NotificationMessagesTests
Assert.Equal(50, msg.PageSize);
}
/// <summary>Verifies that two notification summaries are equal when all fields match.</summary>
[Fact]
public void NotificationSummary_ValueEquality_EqualWhenAllFieldsMatch()
{
@@ -239,6 +254,7 @@ public class NotificationMessagesTests
Assert.Equal(a.GetHashCode(), b.GetHashCode());
}
/// <summary>Verifies that positional construction of a notification outbox query response sets all fields.</summary>
[Fact]
public void NotificationOutboxQueryResponse_PositionalConstruction_SetsAllFields()
{
@@ -255,6 +271,7 @@ public class NotificationMessagesTests
Assert.Equal(1, msg.TotalCount);
}
/// <summary>Verifies that the retry notification request and response round-trip their fields.</summary>
[Fact]
public void RetryNotificationRequestAndResponse_RoundTripFields()
{
@@ -267,6 +284,7 @@ public class NotificationMessagesTests
Assert.Null(response.ErrorMessage);
}
/// <summary>Verifies that the discard notification request and response round-trip their fields.</summary>
[Fact]
public void DiscardNotificationRequestAndResponse_RoundTripFields()
{
@@ -278,6 +296,7 @@ public class NotificationMessagesTests
Assert.Equal("not found", response.ErrorMessage);
}
/// <summary>Verifies that a with-expression on a notification KPI response changes a single field.</summary>
[Fact]
public void NotificationKpiResponse_WithExpression_ChangesSingleField()
{
@@ -294,6 +313,7 @@ public class NotificationMessagesTests
Assert.NotEqual(kpi, updated);
}
/// <summary>Verifies that positional construction of a notification KPI request sets the correlation id.</summary>
[Fact]
public void NotificationKpiRequest_PositionalConstruction_SetsCorrelationId()
{
@@ -301,6 +321,7 @@ public class NotificationMessagesTests
Assert.Equal("corr-1", msg.CorrelationId);
}
/// <summary>Verifies that the per-site notification KPI request carries the correlation id.</summary>
[Fact]
public void PerSiteNotificationKpiRequest_CarriesCorrelationId()
{
@@ -308,6 +329,7 @@ public class NotificationMessagesTests
Assert.Equal("corr-1", request.CorrelationId);
}
/// <summary>Verifies that the per-site notification KPI response carries the per-site snapshots.</summary>
[Fact]
public void PerSiteNotificationKpiResponse_CarriesPerSiteSnapshots()
{