Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.Communication.Tests/MessageContractTests.cs
T
Joseph Doherty 513fa1aa16 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.
2026-10-07 15:05:49 -04:00

84 lines
3.4 KiB
C#

using ZB.MOM.WW.ScadaBridge.Commons.Messages.RemoteQuery;
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
/// <summary>
/// Tests that message contracts have correlation IDs and proper structure.
/// </summary>
public class MessageContractTests
{
/// <summary>Verifies that the event log query request has a correlation id.</summary>
[Fact]
public void EventLogQueryRequest_HasCorrelationId()
{
var msg = new EventLogQueryRequest(
"corr-456", "site1", null, null, null, null, null, null, null, 25, DateTimeOffset.UtcNow);
Assert.Equal("corr-456", msg.CorrelationId);
}
/// <summary>Verifies that the event log query response has a correlation id.</summary>
[Fact]
public void EventLogQueryResponse_HasCorrelationId()
{
var msg = new EventLogQueryResponse(
"corr-456", "site1", [], null, false, true, null, DateTimeOffset.UtcNow);
Assert.Equal("corr-456", msg.CorrelationId);
}
/// <summary>Verifies that the parked message query request has a correlation id.</summary>
[Fact]
public void ParkedMessageQueryRequest_HasCorrelationId()
{
var msg = new ParkedMessageQueryRequest(
"corr-789", "site1", 1, 25, DateTimeOffset.UtcNow);
Assert.Equal("corr-789", msg.CorrelationId);
}
/// <summary>Verifies that the parked message query response has a correlation id.</summary>
[Fact]
public void ParkedMessageQueryResponse_HasCorrelationId()
{
var msg = new ParkedMessageQueryResponse(
"corr-789", "site1", [], 0, 1, 25, true, null, DateTimeOffset.UtcNow);
Assert.Equal("corr-789", msg.CorrelationId);
}
/// <summary>Verifies that every message pattern exists as a record type.</summary>
[Fact]
public void AllMessagePatterns_ExistAsRecordTypes()
{
// Verify all 8 patterns have proper request/response types
// Pattern 1: Deployment
Assert.True(typeof(Commons.Messages.Deployment.DeployInstanceCommand).IsValueType == false);
Assert.True(typeof(Commons.Messages.Deployment.DeploymentStatusResponse).IsValueType == false);
// Pattern 2: Lifecycle
Assert.True(typeof(Commons.Messages.Lifecycle.DisableInstanceCommand).IsValueType == false);
Assert.True(typeof(Commons.Messages.Lifecycle.InstanceLifecycleResponse).IsValueType == false);
// Pattern 3: Artifacts
Assert.True(typeof(Commons.Messages.Artifacts.DeployArtifactsCommand).IsValueType == false);
Assert.True(typeof(Commons.Messages.Artifacts.ArtifactDeploymentResponse).IsValueType == false);
// Pattern 5: Debug View
Assert.True(typeof(Commons.Messages.DebugView.SubscribeDebugViewRequest).IsValueType == false);
Assert.True(typeof(Commons.Messages.DebugView.DebugViewSnapshot).IsValueType == false);
// Pattern 6: Health
Assert.True(typeof(Commons.Messages.Health.SiteHealthReport).IsValueType == false);
// Pattern 7: Remote Queries
Assert.True(typeof(EventLogQueryRequest).IsValueType == false);
Assert.True(typeof(EventLogQueryResponse).IsValueType == false);
Assert.True(typeof(ParkedMessageQueryRequest).IsValueType == false);
Assert.True(typeof(ParkedMessageQueryResponse).IsValueType == false);
// Pattern 8: Heartbeat
Assert.True(typeof(Commons.Messages.Health.HeartbeatMessage).IsValueType == false);
}
}