bd6c0b4d3d
Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up misused inheritdoc across 481 files so the documented API surface is complete. Documentation-only (zero code lines changed). The 131 remaining findings are inheritdoc-style warnings deliberately left to preserve hand-written implementation rationale (plan-decision notes, race-condition explanations).
184 lines
7.5 KiB
C#
184 lines
7.5 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
|
|
{
|
|
/// <summary>Verifies that BrowseCommand rejects negative depth values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that BrowseCommand rejects zero depth values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that SubscribeCommand rejects zero interval values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that SubscribeCommand rejects negative interval values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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));
|
|
}
|
|
|
|
/// <summary>Verifies that SubscribeCommand in recursive mode rejects zero max depth with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that SubscribeCommand rejects negative duration values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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));
|
|
}
|
|
|
|
/// <summary>Verifies that AlarmsCommand rejects zero interval values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that HistoryReadCommand rejects negative max values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
|
|
/// <summary>Verifies that HistoryReadCommand rejects zero interval values with a command exception.</summary>
|
|
/// <returns>A task that represents the asynchronous test.</returns>
|
|
[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");
|
|
}
|
|
}
|