- Client.CLI-002: SubscribeCommand's neverWentBad list now requires the node to be present in lastStatus (i.e. received at least one update) so the 'suspect' bucket only contains observed nodes. - Client.CLI-003: every long-running command validates numeric option ranges (Interval / Depth / MaxDepth / Duration / Max) and throws CliFx CommandException on out-of-range values. - Client.CLI-004: SubscribeCommand carries XML summary docs on the type, ctor, every [CommandOption] property, and ExecuteAsync — matching the sibling commands' style. - Client.CLI-006: HistoryReadCommand parses --start / --end with InvariantCulture+UTC and surfaces FormatException as CommandException; every NodeIdParser.ParseRequired call wraps FormatException / ArgumentException as CommandException. - Client.CLI-007: CommandBase.ConfigureLogging calls Log.CloseAndFlush() before assigning a new Log.Logger so prior sinks are disposed. - Client.CLI-008: rewrote the subscribe and historyread sections of docs/Client.CLI.md (every flag documented, summary-bucket vocabulary, StandardDeviation aggregate, UTC --start/--end convention). - Client.CLI-009: SubscribeCommand / AlarmsCommand use named local handlers and detach them via -= after UnsubscribeAsync so no notification reaches the console after the command's output phase ends. - Client.CLI-010: added CommandRangeValidationTests, EventHandlerLifecycleTests, InputValidationErrorsTests, LoggerLifecycleTests, and SubscribeCommandSummaryTests pinning every Low fix; FakeOpcUaClientService gained AddDiscoveredVariable + RaiseDataChanged + BrowseResultsByParent helpers. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
166 lines
5.9 KiB
C#
166 lines
5.9 KiB
C#
using CliFx.Exceptions;
|
|
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Client.CLI.Commands;
|
|
using ZB.MOM.WW.OtOpcUa.Client.CLI.Tests.Fakes;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
|
|
|
|
/// <summary>
|
|
/// Regression tests for Client.CLI-003: numeric command options must validate their ranges
|
|
/// and report a clean operator-facing error instead of silently passing bad values to the SDK.
|
|
/// </summary>
|
|
public class CommandRangeValidationTests
|
|
{
|
|
[Fact]
|
|
public async Task BrowseCommand_NegativeDepth_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new BrowseCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
Depth = -1
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--depth");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task BrowseCommand_ZeroDepth_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new BrowseCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
Depth = 0
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--depth");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SubscribeCommand_ZeroInterval_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new SubscribeCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
Interval = 0
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--interval");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SubscribeCommand_NegativeInterval_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new SubscribeCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
Interval = -50
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SubscribeCommand_RecursiveZeroMaxDepth_ThrowsCommandException()
|
|
{
|
|
// --max-depth only matters when --recursive is set; validation is scoped to that combination.
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new SubscribeCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
Recursive = true,
|
|
MaxDepth = 0
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--max-depth");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SubscribeCommand_NegativeDuration_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new SubscribeCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
DurationSeconds = -5
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task AlarmsCommand_ZeroInterval_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new AlarmsCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
Interval = 0
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--interval");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task HistoryReadCommand_NegativeMax_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new HistoryReadCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
MaxValues = -10
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--max");
|
|
}
|
|
|
|
[Fact]
|
|
public async Task HistoryReadCommand_ZeroInterval_ThrowsCommandException()
|
|
{
|
|
var fakeService = new FakeOpcUaClientService();
|
|
var factory = new FakeOpcUaClientServiceFactory(fakeService);
|
|
var command = new HistoryReadCommand(factory)
|
|
{
|
|
Url = "opc.tcp://localhost:4840",
|
|
NodeId = "ns=2;s=N",
|
|
Aggregate = "Average",
|
|
IntervalMs = 0
|
|
};
|
|
|
|
using var console = TestConsoleHelper.CreateConsole();
|
|
var ex = await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
|
|
ex.Message.ShouldContain("--interval");
|
|
}
|
|
}
|