using Shouldly;
using Xunit;
namespace ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Tests;
///
/// Gitea #551: gained an accept gate for its
/// rejection diagnosis — see ModbusInspectAcceptGateTests's remarks for why both
/// directions are pinned.
///
/// FOCAS is the one factory that deliberately does NOT return empty on accept: two of its warnings
/// are advisories about blobs the mapper ACCEPTS but the driver still cannot serve as
/// authored — an unparseable FOCAS address (#540, dropped at the driver's own init) and an authored
/// writable:true (the wire is read-only). Folding FOCAS into the plain "accept ⇒ empty"
/// shape would have silently deleted both, so they are pinned here alongside the new rejections.
///
///
public sealed class FocasInspectAcceptGateTests
{
private const string RawPath = "cell/focas/dev1/T1";
/// Blobs the mapper ACCEPTS and that carry no advisory — the gate must be silent.
public static TheoryData CleanAndAccepted() =>
[
"""{"address":"R100","dataType":"Int32"}""",
"""{"address":"X0.0","dataType":"Bit"}""",
"""{"address":"PARAM:1020"}""",
"""{"address":"FIXED:Identity/SeriesNumber","dataType":"String"}""",
];
/// Blobs the mapper REJECTS — the gate must produce at least one warning for each.
public static TheoryData Rejected() =>
[
"""{"dataType":"Int32"}""", // no address
"""{"address":"","dataType":"Int32"}""", // blank address
"""{"address":100}""", // address not a string
"""{"address":"R100","dataType":"Intt32"}""", // typo'd dataType
];
[Theory]
[MemberData(nameof(CleanAndAccepted))]
public void A_clean_config_the_mapper_accepts_draws_no_warning(string tagConfig)
{
FocasTagDefinitionFactory.FromTagConfig(tagConfig, RawPath, out _).ShouldBeTrue("fixture must be accepted");
FocasTagDefinitionFactory.Inspect(tagConfig).ShouldBeEmpty();
}
[Theory]
[MemberData(nameof(Rejected))]
public void A_config_the_mapper_rejects_is_never_passed_over_in_silence(string tagConfig)
{
FocasTagDefinitionFactory.FromTagConfig(tagConfig, RawPath, out _).ShouldBeFalse("fixture must be rejected");
FocasTagDefinitionFactory.Inspect(tagConfig).ShouldNotBeEmpty();
}
[Fact]
public void An_absent_address_is_named()
=> FocasTagDefinitionFactory.Inspect("""{"dataType":"Int32"}""")
.ShouldContain(w => w.Contains("'address'"));
// ---- The two advisories the accept gate must NOT swallow ----
[Fact]
public void An_unparseable_address_still_warns_even_though_the_mapper_accepts_it()
{
const string Blob = """{"address":"not-an-address","dataType":"Int32"}""";
FocasTagDefinitionFactory.FromTagConfig(Blob, RawPath, out _).ShouldBeTrue("the mapper accepts any non-blank address");
FocasTagDefinitionFactory.Inspect(Blob).ShouldContain(w => w.Contains("not parseable"));
}
[Fact]
public void An_authored_writable_still_warns_even_though_the_mapper_accepts_it()
{
const string Blob = """{"address":"R100","dataType":"Int32","writable":true}""";
FocasTagDefinitionFactory.FromTagConfig(Blob, RawPath, out _).ShouldBeTrue("the mapper accepts writable:true");
FocasTagDefinitionFactory.Inspect(Blob).ShouldContain(w => w.Contains("read-only"));
}
/// A rejected blob still gets its advisories — the two diagnoses are independent.
[Fact]
public void A_rejected_config_reports_the_rejection_and_the_advisory_together()
{
var warnings = FocasTagDefinitionFactory.Inspect(
"""{"address":"not-an-address","dataType":"Intt32","writable":true}""");
warnings.ShouldContain(w => w.Contains("dataType"));
warnings.ShouldContain(w => w.Contains("not parseable"));
warnings.ShouldContain(w => w.Contains("read-only"));
}
[Fact]
public void A_blank_reference_draws_nothing()
=> FocasTagDefinitionFactory.Inspect(" ").ShouldBeEmpty();
[Fact]
public void Unparseable_json_names_the_json()
=> FocasTagDefinitionFactory.Inspect("{oops").ShouldContain(w => w.Contains("not valid JSON"));
// ---- Gitea #556 item 2: an advisory can no longer swallow the catch-all rejection ----
///
/// The structural invariant the backstop exists to hold: a blob the mapper REFUSES always draws
/// strictly more than the advisories that same blob would draw if it were accepted. Before #556 the
/// backstop was gated on warnings.Count == 0 — and an advisory fires on an ACCEPTED blob
/// too, so it says nothing about the refusal while still satisfying that guard. Any refusal no
/// DescribeRejection branch can name was therefore dropped whenever an advisory was present.
/// Comparing the two counts states the property without string-matching a message to guess its
/// class, which is the whole point of keeping the two classes in separate lists.
///
/// ⚠️ FOCAS's own backstop is UNREACHABLE today (audited): every return false in
/// — absent / non-string / blank
/// address, invalid dataType — has a matching describe branch, and
/// TryReadEnumStrict and DescribeInvalidEnum share one classifier so they cannot
/// disagree. So the guard is protective here rather than a live fix; MQTT's is live (a padded
/// blob its own mappers refuse and every branch finds well-formed — see
/// MqttInspectAcceptGateTests). What this pins is the property that must survive the
/// next rejection cause someone adds without a describe branch.
///
///
[Fact]
public void A_rejected_config_always_draws_more_than_its_advisories_alone()
{
// Identical but for the dataType typo, so both carry the SAME two advisories.
const string Accepted = """{"address":"not-an-address","dataType":"Int32","writable":true}""";
const string Rejected = """{"address":"not-an-address","dataType":"Intt32","writable":true}""";
FocasTagDefinitionFactory.FromTagConfig(Accepted, RawPath, out _).ShouldBeTrue("control must be accepted");
FocasTagDefinitionFactory.FromTagConfig(Rejected, RawPath, out _).ShouldBeFalse("subject must be rejected");
var advisoriesOnly = FocasTagDefinitionFactory.Inspect(Accepted);
var withRejection = FocasTagDefinitionFactory.Inspect(Rejected);
advisoriesOnly.Count.ShouldBe(2, "the control's warnings are purely advisory");
withRejection.Count.ShouldBeGreaterThan(
advisoriesOnly.Count,
"a refusal must add a rejection-class warning — the backstop supplies one when nothing names it");
}
// ---- Gitea #556 item 1: leading whitespace no longer defeats the framing pre-filter ----
///
/// Padding a blob with leading whitespace. A driver is handed whatever authoring persisted, and
/// FromTagConfig passes it straight to JsonDocument.Parse, which skips leading
/// whitespace — so the MAPPER's verdict is identical padded or not, and the gate's must be too.
///
private const string Pad = " \t\r\n ";
///
/// Never stricter, under padding: a padded blob the mapper still accepts draws nothing. (This
/// direction already held before #556 — the pre-filter returned empty for everything padded — and
/// is kept so a future "just trim everywhere" change cannot start warning about a served tag.)
///
/// An accepted fixture, padded below.
[Theory]
[MemberData(nameof(CleanAndAccepted))]
public void Leading_whitespace_leaves_an_accepted_config_silent(string tagConfig)
{
var padded = Pad + tagConfig;
FocasTagDefinitionFactory.FromTagConfig(padded, RawPath, out _)
.ShouldBeTrue("the mapper's JsonDocument.Parse skips leading whitespace");
FocasTagDefinitionFactory.Inspect(padded).ShouldBeEmpty();
}
///
/// Never silent, under padding — the #556 item 1 defect itself. The pre-filter tested
/// reference[0] != '{', so EVERY padded blob returned empty and a padded config the driver
/// refuses deployed clean. Asserting equality with the untrimmed inspection (rather than merely
/// "not empty") also pins that padding changes no message.
///
/// A rejected fixture, padded below.
[Theory]
[MemberData(nameof(Rejected))]
public void Leading_whitespace_draws_exactly_the_warnings_the_untrimmed_blob_draws(string tagConfig)
{
var padded = Pad + tagConfig;
FocasTagDefinitionFactory.FromTagConfig(padded, RawPath, out _)
.ShouldBeFalse("the mapper's verdict is unchanged by padding");
FocasTagDefinitionFactory.Inspect(padded).ShouldBe(FocasTagDefinitionFactory.Inspect(tagConfig));
}
///
/// The other half of the same fix, and the one it would be easy to lose: trimming widens the gate
/// ONLY for JSON objects. A reference that is still not object-framed after the trim is not an
/// equipment-tag TagConfig at all — the pre-existing convention shared by all eleven inspectors —
/// so it keeps drawing nothing even though the mapper refuses it.
///
/// A padded, non-object reference.
[Theory]
[InlineData(" just a string")]
[InlineData(" [1,2,3]")]
[InlineData(" \t\r\n 42")]
[InlineData(" \"a\"")]
[InlineData(" ")]
public void A_non_object_reference_still_draws_nothing_after_trimming(string reference)
{
FocasTagDefinitionFactory.FromTagConfig(reference, RawPath, out _).ShouldBeFalse();
FocasTagDefinitionFactory.Inspect(reference).ShouldBeEmpty();
}
}