feat(mtconnect): warn at Test Connect and deploy when SampleCount >= the Agent bufferSize (#825)
Parse the /probe Header bufferSize; MTConnectDriverProbe reads sampleCount (default 1000) and answers Ok with a WARNING message (amber chip in the Test Connect button); InitializeAsync logs the same Warning and exposes agentBufferSize on the diagnostics bag. Live-checked against the shared cppagent fixture (bufferSize 16384).
This commit is contained in:
+29
@@ -947,6 +947,35 @@ public sealed class MTConnectAgentIntegrationTests(MTConnectAgentFixture agent)
|
||||
seen.Skip(before).ShouldContain(e => e.Snapshot.StatusCode == Good);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// #825 — Test Connect reads the live Agent's <c>/probe</c> <c>bufferSize</c> and warns (still Ok) when the
|
||||
/// configured <c>SampleCount</c> would be refused; one below the buffer is the falsifiability control.
|
||||
/// </summary>
|
||||
[Fact(Timeout = TestTimeoutMs)]
|
||||
public async Task Test_Connect_warns_when_SampleCount_reaches_the_live_agents_buffer_size()
|
||||
{
|
||||
SkipIfDown();
|
||||
|
||||
var bufferSize = (int?)agent.ProbeDocument?.Root?.Elements().FirstOrDefault(e => e.Name.LocalName == "Header")
|
||||
?.Attribute("bufferSize");
|
||||
if (bufferSize is not > 1)
|
||||
{
|
||||
Assert.Skip($"The Agent at {agent.AgentUri} declares no usable bufferSize in its /probe header.");
|
||||
}
|
||||
|
||||
var refused = await new MTConnectDriverProbe().ProbeAsync(
|
||||
JsonSerializer.Serialize(new { agentUri = agent.AgentUri, sampleCount = bufferSize.Value }),
|
||||
TimeSpan.FromSeconds(15), Ct);
|
||||
refused.Ok.ShouldBeTrue(refused.Message);
|
||||
refused.Message!.ShouldContain($"WARNING: SampleCount {bufferSize.Value} is at or above the Agent's bufferSize {bufferSize.Value}");
|
||||
|
||||
var fits = await new MTConnectDriverProbe().ProbeAsync(
|
||||
JsonSerializer.Serialize(new { agentUri = agent.AgentUri, sampleCount = bufferSize.Value - 1 }),
|
||||
TimeSpan.FromSeconds(15), Ct);
|
||||
fits.Ok.ShouldBeTrue(fits.Message);
|
||||
fits.Message!.ShouldNotContain("WARNING");
|
||||
}
|
||||
|
||||
private static bool Is(string? value, string expected) =>
|
||||
string.Equals(value?.Trim(), expected, StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
|
||||
+128
@@ -0,0 +1,128 @@
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using Shouldly;
|
||||
using Xunit;
|
||||
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Driver.MTConnect.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// lmxopcua#825 — a <c>SampleCount</c> at or above the Agent's <c>bufferSize</c> is refused <c>OUT_OF_RANGE</c> on
|
||||
/// every <c>/sample</c> stream. The <c>/probe</c> header carries <c>bufferSize</c>, so Test Connect and the
|
||||
/// driver's initialize (deploy) both warn instead of leaving it to surface as a Degraded stream.
|
||||
/// </summary>
|
||||
[Trait("Category", "Unit")]
|
||||
public sealed class MTConnectBufferSizeWarningTests
|
||||
{
|
||||
private static string ProbeXml(string? bufferSizeAttribute) =>
|
||||
$"""
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<MTConnectDevices xmlns="urn:mtconnect.org:MTConnectDevices:2.0">
|
||||
<Header instanceId="1"{(bufferSizeAttribute is null ? "" : $" bufferSize=\"{bufferSizeAttribute}\"")}/>
|
||||
<Devices>
|
||||
<Device id="d" name="D">
|
||||
<DataItems><DataItem id="d_avail" category="EVENT" type="AVAILABILITY"/></DataItems>
|
||||
</Device>
|
||||
</Devices>
|
||||
</MTConnectDevices>
|
||||
""";
|
||||
|
||||
[Theory]
|
||||
[InlineData("16384", 16384L)]
|
||||
[InlineData(null, null)]
|
||||
[InlineData("0", null)]
|
||||
[InlineData("-5", null)]
|
||||
[InlineData("lots", null)]
|
||||
public void The_probe_parser_reads_the_header_buffer_size_and_never_fails_on_it(string? attribute, long? expected) =>
|
||||
MTConnectProbeParser.Parse(ProbeXml(attribute)).BufferSize.ShouldBe(expected);
|
||||
|
||||
[Theory]
|
||||
[InlineData(16383, 16384L, false)]
|
||||
[InlineData(16384, 16384L, true)]
|
||||
[InlineData(20000, 16384L, true)]
|
||||
[InlineData(1_000_000, null, false)]
|
||||
public void The_warning_fires_exactly_at_and_above_the_buffer_size(int sampleCount, long? bufferSize, bool warns)
|
||||
{
|
||||
var warning = MTConnectDriver.SampleCountBufferWarning(sampleCount, bufferSize);
|
||||
(warning is not null).ShouldBe(warns);
|
||||
if (warns) warning!.ShouldContain($"below {bufferSize}");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Test_Connect_stays_ok_but_carries_the_warning_when_SampleCount_does_not_fit()
|
||||
{
|
||||
var probe = new MTConnectDriverProbe(new StubHandler(ProbeXml("16384")));
|
||||
var r = await probe.ProbeAsync(
|
||||
"{\"agentUri\":\"http://stub-agent:5000\",\"sampleCount\":16384}", TimeSpan.FromSeconds(3),
|
||||
TestContext.Current.CancellationToken);
|
||||
|
||||
r.Ok.ShouldBeTrue("the Agent answered — reachability is not the problem");
|
||||
r.Message!.ShouldContain("WARNING:");
|
||||
r.Message!.ShouldContain("bufferSize 16384");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Test_Connect_checks_the_driver_default_when_SampleCount_is_absent()
|
||||
{
|
||||
// The default SampleCount is 1000 — an Agent with a tiny buffer refuses it too.
|
||||
var probe = new MTConnectDriverProbe(new StubHandler(ProbeXml("512")));
|
||||
var r = await probe.ProbeAsync(
|
||||
"{\"agentUri\":\"http://stub-agent:5000\"}", TimeSpan.FromSeconds(3), TestContext.Current.CancellationToken);
|
||||
|
||||
r.Ok.ShouldBeTrue();
|
||||
r.Message!.ShouldContain("SampleCount 1000 is at or above the Agent's bufferSize 512");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Test_Connect_message_is_unchanged_when_SampleCount_fits()
|
||||
{
|
||||
var probe = new MTConnectDriverProbe(new StubHandler(ProbeXml("16384")));
|
||||
var r = await probe.ProbeAsync(
|
||||
"{\"agentUri\":\"http://stub-agent:5000\",\"sampleCount\":1000}", TimeSpan.FromSeconds(3),
|
||||
TestContext.Current.CancellationToken);
|
||||
|
||||
r.Ok.ShouldBeTrue();
|
||||
r.Message!.ShouldNotContain("WARNING");
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData(131072, true)]
|
||||
[InlineData(1000, false)]
|
||||
public async Task Initialize_warns_and_surfaces_the_buffer_size_on_the_diagnostics_bag(int sampleCount, bool warns)
|
||||
{
|
||||
var client = CannedAgentClient.FromFixtures(); // Fixtures/probe.xml: bufferSize="131072"
|
||||
client.Probe.BufferSize.ShouldBe(131072L);
|
||||
var logger = new RecordingDriverLogger();
|
||||
var driver = new MTConnectDriver(
|
||||
new MTConnectDriverOptions
|
||||
{
|
||||
AgentUri = "http://fixture-agent:5000",
|
||||
RequestTimeoutMs = 5000,
|
||||
SampleCount = sampleCount,
|
||||
Tags = [new MTConnectTagDefinition("dev1_pos", DriverDataType.Float64)],
|
||||
},
|
||||
"mt-825",
|
||||
_ => client,
|
||||
logger);
|
||||
try
|
||||
{
|
||||
await driver.InitializeAsync("{}", TestContext.Current.CancellationToken);
|
||||
|
||||
logger.Warnings.Any(w => w.Contains("bufferSize", StringComparison.Ordinal)).ShouldBe(warns);
|
||||
driver.GetDiagnostics()["agentBufferSize"].ShouldBe("131072");
|
||||
}
|
||||
finally
|
||||
{
|
||||
await driver.ShutdownAsync(TestContext.Current.CancellationToken);
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class StubHandler(string probeXml) : HttpMessageHandler
|
||||
{
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken ct) =>
|
||||
Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)
|
||||
{
|
||||
Content = new StringContent(probeXml, System.Text.Encoding.UTF8, "application/xml"),
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user