Joseph Doherty
05b424788f
Gitea #551. 1. CSV import ran no driver-typed config gate. Its typed columns were always strictly parsed, but the free-form TagConfigJson column reached the database unread, so a CSV could author a tag the driver rejects — one that deploys green and reads BadNodeIdUnknown forever. RawTagCsvMapper.Parse now names the offending row in the staged review grid, and RawTreeService enforces the same gate on CreateTag/UpdateTag/ImportTags: a form cannot be the guarantee (the API and any future caller reach none of them, and this repo has no bUnit). A rejected import row is an ERROR — the batch inserts nothing and the row is named — never a skip. Note the brief's premise that manual entry rides ImportTagsAsync is wrong: RawManualTagEntryModal commits row-by-row via CreateTagAsync, which is why the gate had to land on all three write paths. 2/3. The seven pre-#549 Inspect methods ran a hand-list of DescribeInvalidEnum checks, so every rejection cause not on the list was invisible. They are now ACCEPT-GATE-FIRST (the MTConnect/Sql/OpcUaClient/Calculation shape): ask the driver's own reader for the verdict, then explain the refusal, with a catch-all so "the parse rejects but Inspect said nothing" is unreachable. That closes S7's absent dataType, AbCip members[], Modbus stringByteOrder and the type-dependent guards, plus causes the issue did not name (absent region/address/tagPath/symbolPath/topic, TwinCAT Structure, MQTT's Sparkplug tuple). FOCAS and MQTT keep advisories about ACCEPTED blobs, so they diagnose rather than return empty. Authoring half: ModbusTagConfigModel gains stringByteOrder; AbCipTagConfigModel asks the new AbCipTagDefinitionFactory.DescribeInvalidMember; S7TagConfigModel captures whether the SOURCE blob declared dataType and asks S7TagDefinitionFactory.DataTypeKey/DeclaresDataType. One authority per rule. 4. Doc sweep: the six factory Inspect summaries, EquipmentTagConfigInspector's class remarks and AdminOperationsActor's comment all claimed invalid enums are "silently defaulted by the lenient runtime" — false since R2-11 Phase C made the runtime reads strict. They describe rejections now.
89 lines
4.3 KiB
C#
89 lines
4.3 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.Mqtt.Tests;
|
|
|
|
/// <summary>
|
|
/// Gitea #551: <see cref="MqttTagDefinitionFactory.Inspect"/> gained an accept gate — see
|
|
/// <c>ModbusInspectAcceptGateTests</c>'s remarks for why both directions (never stricter, never silent)
|
|
/// are pinned.
|
|
/// <para>
|
|
/// MQTT's gate is the <b>UNION</b> of its two mappers, because <c>Inspect</c> is handed a blob with
|
|
/// no mode: the driver's <c>MqttMode</c> decides whether
|
|
/// <see cref="MqttTagDefinitionFactory.FromTagConfig"/> or
|
|
/// <see cref="MqttTagDefinitionFactory.FromSparkplugTagConfig"/> reads it, and nothing on a tag row
|
|
/// says which. Gating on the Plain mapper alone would warn that every correctly-authored Sparkplug
|
|
/// tag has no topic — the falsification control below is exactly that case.
|
|
/// </para>
|
|
/// </summary>
|
|
public sealed class MqttInspectAcceptGateTests
|
|
{
|
|
private const string RawPath = "cell/mqtt/dev1/T1";
|
|
|
|
private static bool EitherModeAccepts(string tagConfig)
|
|
=> MqttTagDefinitionFactory.FromTagConfig(tagConfig, RawPath, out _)
|
|
|| MqttTagDefinitionFactory.FromSparkplugTagConfig(tagConfig, RawPath, out _);
|
|
|
|
/// <summary>Blobs at least one mapper ACCEPTS, with no wildcard advisory — the gate must be silent.</summary>
|
|
public static TheoryData<string> Accepted() =>
|
|
[
|
|
"""{"topic":"plant/line1/temp"}""",
|
|
"""{"topic":"plant/line1/temp","payloadFormat":"Json","dataType":"Float64","qos":1}""",
|
|
// Sparkplug: no topic at all, and that is CORRECT — the control this whole union exists for.
|
|
"""{"groupId":"OtOpcUaSim","edgeNodeId":"EdgeA","metricName":"Temp"}""",
|
|
"""{"groupId":"OtOpcUaSim","edgeNodeId":"EdgeA","deviceId":"Filler1","metricName":"Node Control/Rebirth"}""",
|
|
];
|
|
|
|
/// <summary>Blobs NEITHER mapper accepts — the gate must produce at least one warning for each.</summary>
|
|
public static TheoryData<string> Rejected() =>
|
|
[
|
|
"{}", // no address of either shape
|
|
"""{"payloadFormat":"Json","dataType":"String"}""", // still no address
|
|
"""{"groupId":"G","edgeNodeId":"E"}""", // incomplete Sparkplug tuple
|
|
"""{"topic":"a/b","payloadFormat":"Jsonn"}""", // typo'd payloadFormat
|
|
"""{"topic":"a/b","dataType":"Flooat64"}""", // typo'd dataType
|
|
"""{"topic":"a/b","qos":5}""", // out-of-range qos
|
|
"""{"groupId":"G","edgeNodeId":"E","metricName":"M","qos":"high"}""", // non-numeric qos, both modes
|
|
];
|
|
|
|
[Theory]
|
|
[MemberData(nameof(Accepted))]
|
|
public void A_config_a_mapper_accepts_draws_no_warning(string tagConfig)
|
|
{
|
|
EitherModeAccepts(tagConfig).ShouldBeTrue("fixture must be accepted by at least one mode");
|
|
MqttTagDefinitionFactory.Inspect(tagConfig).ShouldBeEmpty();
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(Rejected))]
|
|
public void A_config_neither_mapper_accepts_is_never_passed_over_in_silence(string tagConfig)
|
|
{
|
|
EitherModeAccepts(tagConfig).ShouldBeFalse("fixture must be rejected by both modes");
|
|
MqttTagDefinitionFactory.Inspect(tagConfig).ShouldNotBeEmpty();
|
|
}
|
|
|
|
[Fact]
|
|
public void A_blob_with_no_address_of_either_shape_names_both()
|
|
{
|
|
var warnings = MqttTagDefinitionFactory.Inspect("{}");
|
|
warnings.ShouldContain(w => w.Contains("topic") && w.Contains("metricName"));
|
|
}
|
|
|
|
/// <summary>The wildcard advisory is about an ACCEPTED blob, so the accept gate must not swallow it.</summary>
|
|
[Fact]
|
|
public void A_wildcard_topic_still_warns_even_though_the_mapper_accepts_it()
|
|
{
|
|
const string Blob = """{"topic":"plant/+/temp"}""";
|
|
MqttTagDefinitionFactory.FromTagConfig(Blob, RawPath, out _).ShouldBeTrue("a wildcard topic is accepted on purpose");
|
|
MqttTagDefinitionFactory.Inspect(Blob).ShouldContain(w => w.Contains("wildcard"));
|
|
}
|
|
|
|
[Fact]
|
|
public void A_blank_reference_draws_nothing()
|
|
=> MqttTagDefinitionFactory.Inspect(" ").ShouldBeEmpty();
|
|
|
|
[Fact]
|
|
public void Unparseable_json_names_the_json()
|
|
=> MqttTagDefinitionFactory.Inspect("{oops").ShouldContain(w => w.Contains("not valid JSON"));
|
|
}
|