Joseph Doherty
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.
87 lines
3.6 KiB
C#
87 lines
3.6 KiB
C#
using System.Text.Json;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Messages;
|
|
|
|
/// <summary>
|
|
/// Regression tests: <see cref="SetConnectionBindingsCommand"/>
|
|
/// previously declared its bindings as <c>IReadOnlyList<(string, int)></c>.
|
|
/// A <c>ValueTuple</c> serializes as <c>Item1</c>/<c>Item2</c> and cannot evolve
|
|
/// additively (REQ-COM-5a). It is now a named <see cref="ConnectionBinding"/> record.
|
|
/// </summary>
|
|
public class ConnectionBindingSerializationTests
|
|
{
|
|
/// <summary>Verifies that connection binding serializes with named properties.</summary>
|
|
[Fact]
|
|
public void ConnectionBinding_SerializesWithNamedProperties()
|
|
{
|
|
var json = JsonSerializer.Serialize(new ConnectionBinding("Temperature", 42));
|
|
|
|
using var doc = JsonDocument.Parse(json);
|
|
Assert.Equal(JsonValueKind.String, doc.RootElement.GetProperty("AttributeName").ValueKind);
|
|
Assert.Equal("Temperature", doc.RootElement.GetProperty("AttributeName").GetString());
|
|
Assert.Equal(42, doc.RootElement.GetProperty("DataConnectionId").GetInt32());
|
|
|
|
// The ValueTuple failure mode: Item1/Item2 must NOT appear.
|
|
Assert.False(doc.RootElement.TryGetProperty("Item1", out _));
|
|
Assert.False(doc.RootElement.TryGetProperty("Item2", out _));
|
|
}
|
|
|
|
/// <summary>Verifies that set connection bindings command round trips through json.</summary>
|
|
[Fact]
|
|
public void SetConnectionBindingsCommand_RoundTripsThroughJson()
|
|
{
|
|
var original = new SetConnectionBindingsCommand(
|
|
7,
|
|
new List<ConnectionBinding>
|
|
{
|
|
new("Speed", 5),
|
|
new("Mode", 11),
|
|
});
|
|
|
|
var json = JsonSerializer.Serialize(original);
|
|
var deserialized = JsonSerializer.Deserialize<SetConnectionBindingsCommand>(json);
|
|
|
|
Assert.NotNull(deserialized);
|
|
Assert.Equal(7, deserialized!.InstanceId);
|
|
Assert.Equal(2, deserialized.Bindings.Count);
|
|
Assert.Equal("Speed", deserialized.Bindings[0].AttributeName);
|
|
Assert.Equal(5, deserialized.Bindings[0].DataConnectionId);
|
|
Assert.Equal("Mode", deserialized.Bindings[1].AttributeName);
|
|
Assert.Equal(11, deserialized.Bindings[1].DataConnectionId);
|
|
|
|
// ConnectionBinding is a record: each element compares by value.
|
|
Assert.Equal(original.Bindings, deserialized.Bindings);
|
|
}
|
|
|
|
/// <summary>Verifies that roundtrip preserves override when set.</summary>
|
|
[Fact]
|
|
public void Roundtrip_preserves_override_when_set()
|
|
{
|
|
var original = new ConnectionBinding("Speed", 7, "ns=2;s=Pump1.Speed");
|
|
|
|
var json = JsonSerializer.Serialize(original);
|
|
var roundtripped = JsonSerializer.Deserialize<ConnectionBinding>(json);
|
|
|
|
Assert.NotNull(roundtripped);
|
|
Assert.Equal(original, roundtripped);
|
|
Assert.Equal("ns=2;s=Pump1.Speed", roundtripped!.DataSourceReferenceOverride);
|
|
}
|
|
|
|
/// <summary>Verifies that roundtrip defaults override to null when absent.</summary>
|
|
[Fact]
|
|
public void Roundtrip_defaults_override_to_null_when_absent()
|
|
{
|
|
// Older site builds will not emit the new field — deserialization
|
|
// must produce a null override and equal an explicit-null instance.
|
|
const string legacyJson = """{"AttributeName":"Speed","DataConnectionId":7}""";
|
|
|
|
var deserialized = JsonSerializer.Deserialize<ConnectionBinding>(legacyJson);
|
|
|
|
Assert.NotNull(deserialized);
|
|
Assert.Equal("Speed", deserialized!.AttributeName);
|
|
Assert.Equal(7, deserialized.DataConnectionId);
|
|
Assert.Null(deserialized.DataSourceReferenceOverride);
|
|
}
|
|
}
|