513fa1aa16
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.
165 lines
6.5 KiB
C#
165 lines
6.5 KiB
C#
using Google.Protobuf;
|
|
using Google.Protobuf.WellKnownTypes;
|
|
using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Grpc;
|
|
|
|
public class ProtoRoundtripTests
|
|
{
|
|
/// <summary>Verifies that an attribute value update survives a protobuf round trip.</summary>
|
|
/// <param name="quality">The test input.</param>
|
|
[Theory]
|
|
[InlineData(Quality.Good)]
|
|
[InlineData(Quality.Uncertain)]
|
|
[InlineData(Quality.Bad)]
|
|
[InlineData(Quality.Unspecified)]
|
|
public void AttributeValueUpdate_RoundTrip(Quality quality)
|
|
{
|
|
var timestamp = Timestamp.FromDateTimeOffset(
|
|
new DateTimeOffset(2026, 3, 21, 12, 0, 0, TimeSpan.Zero));
|
|
|
|
var original = new AttributeValueUpdate
|
|
{
|
|
InstanceUniqueName = "Site1.Pump01",
|
|
AttributePath = "Modules.PressureModule",
|
|
AttributeName = "CurrentPressure",
|
|
Value = "42.5",
|
|
Quality = quality,
|
|
Timestamp = timestamp
|
|
};
|
|
|
|
var bytes = original.ToByteArray();
|
|
var deserialized = AttributeValueUpdate.Parser.ParseFrom(bytes);
|
|
|
|
Assert.Equal(original.InstanceUniqueName, deserialized.InstanceUniqueName);
|
|
Assert.Equal(original.AttributePath, deserialized.AttributePath);
|
|
Assert.Equal(original.AttributeName, deserialized.AttributeName);
|
|
Assert.Equal(original.Value, deserialized.Value);
|
|
Assert.Equal(original.Quality, deserialized.Quality);
|
|
Assert.Equal(original.Timestamp, deserialized.Timestamp);
|
|
Assert.Equal(timestamp.Seconds, deserialized.Timestamp.Seconds);
|
|
Assert.Equal(timestamp.Nanos, deserialized.Timestamp.Nanos);
|
|
}
|
|
|
|
/// <summary>Verifies that an alarm state update survives a protobuf round trip.</summary>
|
|
/// <param name="state">The test input.</param>
|
|
[Theory]
|
|
[InlineData(AlarmStateEnum.AlarmStateNormal)]
|
|
[InlineData(AlarmStateEnum.AlarmStateActive)]
|
|
[InlineData(AlarmStateEnum.AlarmStateUnspecified)]
|
|
public void AlarmStateUpdate_RoundTrip(AlarmStateEnum state)
|
|
{
|
|
var timestamp = Timestamp.FromDateTimeOffset(
|
|
new DateTimeOffset(2026, 3, 21, 12, 30, 0, TimeSpan.Zero));
|
|
|
|
var original = new AlarmStateUpdate
|
|
{
|
|
InstanceUniqueName = "Site1.Pump01",
|
|
AlarmName = "HighPressure",
|
|
State = state,
|
|
Priority = 3,
|
|
Timestamp = timestamp
|
|
};
|
|
|
|
var bytes = original.ToByteArray();
|
|
var deserialized = AlarmStateUpdate.Parser.ParseFrom(bytes);
|
|
|
|
Assert.Equal(original.InstanceUniqueName, deserialized.InstanceUniqueName);
|
|
Assert.Equal(original.AlarmName, deserialized.AlarmName);
|
|
Assert.Equal(original.State, deserialized.State);
|
|
Assert.Equal(original.Priority, deserialized.Priority);
|
|
Assert.Equal(original.Timestamp, deserialized.Timestamp);
|
|
}
|
|
|
|
/// <summary>Verifies that a site stream event carrying an attribute change sets the matching oneof case.</summary>
|
|
[Fact]
|
|
public void SiteStreamEvent_OneOf_AttributeChanged()
|
|
{
|
|
var evt = new SiteStreamEvent
|
|
{
|
|
CorrelationId = "corr-123",
|
|
AttributeChanged = new AttributeValueUpdate
|
|
{
|
|
InstanceUniqueName = "Site1.Pump01",
|
|
AttributePath = "Modules.PressureModule",
|
|
AttributeName = "CurrentPressure",
|
|
Value = "42.5",
|
|
Quality = Quality.Good,
|
|
Timestamp = Timestamp.FromDateTimeOffset(DateTimeOffset.UtcNow)
|
|
}
|
|
};
|
|
|
|
Assert.Equal(SiteStreamEvent.EventOneofCase.AttributeChanged, evt.EventCase);
|
|
Assert.NotNull(evt.AttributeChanged);
|
|
Assert.Null(evt.AlarmChanged);
|
|
|
|
// Round-trip
|
|
var bytes = evt.ToByteArray();
|
|
var deserialized = SiteStreamEvent.Parser.ParseFrom(bytes);
|
|
|
|
Assert.Equal(SiteStreamEvent.EventOneofCase.AttributeChanged, deserialized.EventCase);
|
|
Assert.Equal("corr-123", deserialized.CorrelationId);
|
|
Assert.Equal("42.5", deserialized.AttributeChanged.Value);
|
|
}
|
|
|
|
/// <summary>Verifies that a site stream event carrying an alarm change sets the matching oneof case.</summary>
|
|
[Fact]
|
|
public void SiteStreamEvent_OneOf_AlarmChanged()
|
|
{
|
|
var evt = new SiteStreamEvent
|
|
{
|
|
CorrelationId = "corr-456",
|
|
AlarmChanged = new AlarmStateUpdate
|
|
{
|
|
InstanceUniqueName = "Site1.Pump01",
|
|
AlarmName = "HighPressure",
|
|
State = AlarmStateEnum.AlarmStateActive,
|
|
Priority = 1,
|
|
Timestamp = Timestamp.FromDateTimeOffset(DateTimeOffset.UtcNow)
|
|
}
|
|
};
|
|
|
|
Assert.Equal(SiteStreamEvent.EventOneofCase.AlarmChanged, evt.EventCase);
|
|
Assert.NotNull(evt.AlarmChanged);
|
|
Assert.Null(evt.AttributeChanged);
|
|
|
|
// Round-trip
|
|
var bytes = evt.ToByteArray();
|
|
var deserialized = SiteStreamEvent.Parser.ParseFrom(bytes);
|
|
|
|
Assert.Equal(SiteStreamEvent.EventOneofCase.AlarmChanged, deserialized.EventCase);
|
|
Assert.Equal("corr-456", deserialized.CorrelationId);
|
|
Assert.Equal(AlarmStateEnum.AlarmStateActive, deserialized.AlarmChanged.State);
|
|
Assert.Equal(1, deserialized.AlarmChanged.Priority);
|
|
}
|
|
|
|
/// <summary>Verifies that a DateTimeOffset timestamp survives a full protobuf round trip.</summary>
|
|
[Fact]
|
|
public void Timestamp_DateTimeOffset_FullRoundTrip()
|
|
{
|
|
var original = new DateTimeOffset(2026, 3, 21, 14, 30, 45, 123, TimeSpan.Zero);
|
|
var update = new AttributeValueUpdate
|
|
{
|
|
InstanceUniqueName = "Motor-1",
|
|
AttributePath = "Speed",
|
|
AttributeName = "Speed",
|
|
Value = "42.5",
|
|
Quality = Quality.Good,
|
|
Timestamp = Timestamp.FromDateTimeOffset(original)
|
|
};
|
|
|
|
var bytes = update.ToByteArray();
|
|
var deserialized = AttributeValueUpdate.Parser.ParseFrom(bytes);
|
|
|
|
var roundTripped = deserialized.Timestamp.ToDateTimeOffset();
|
|
Assert.Equal(original.Year, roundTripped.Year);
|
|
Assert.Equal(original.Month, roundTripped.Month);
|
|
Assert.Equal(original.Day, roundTripped.Day);
|
|
Assert.Equal(original.Hour, roundTripped.Hour);
|
|
Assert.Equal(original.Minute, roundTripped.Minute);
|
|
Assert.Equal(original.Second, roundTripped.Second);
|
|
Assert.Equal(original.Millisecond, roundTripped.Millisecond);
|
|
Assert.Equal(TimeSpan.Zero, roundTripped.Offset);
|
|
}
|
|
}
|