6923be3aa2
- Driver.FOCAS.Cli-001: WriteCommand.ParseValue now wraps numeric FormatException / OverflowException as CliFx CommandException with the offending value. - Driver.FOCAS.Cli-002: SubscribeCommand's OnDataChange handler and the banner both take a writeLock so notification-callback and main-thread writes can't interleave; handler exceptions are warn-and-swallow. - Driver.FOCAS.Cli-003: FocasCommandBase.ValidateOptions rejects --cnc-port outside 1..65535, non-positive --timeout-ms, and non-positive --interval-ms; ExecuteAsync calls it first. - Driver.FOCAS.Cli-004: 'await using var driver' is the sole driver disposal path; dropped the redundant explicit await ShutdownAsync. - Driver.FOCAS.Cli-005 (Deferred): the fix lives in Driver.Cli.Common.SnapshotFormatter — explicitly naming the status-code shortlist there benefits every driver CLI. Left as a Driver.Cli.Common follow-up. - Registered the new tests/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli.Tests project in ZB.MOM.WW.OtOpcUa.slnx. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
62 lines
2.6 KiB
C#
62 lines
2.6 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli.Tests;
|
|
|
|
/// <summary>
|
|
/// Driver.FOCAS.Cli-004: every FOCAS CLI command must own one disposal mechanism for
|
|
/// the <c>FocasDriver</c>, not two. The chosen mechanism is <c>await using var driver
|
|
/// = ...</c> — <c>FocasDriver.DisposeAsync</c> already calls <c>ShutdownAsync</c>, so
|
|
/// an additional explicit <c>driver.ShutdownAsync(...)</c> in a <c>finally</c> block
|
|
/// runs shutdown twice. These tests guard against that regression by scanning the
|
|
/// command source files.
|
|
/// </summary>
|
|
[Trait("Category", "Unit")]
|
|
public sealed class CommandDisposalConventionsTests
|
|
{
|
|
private static readonly string CommandsDir = LocateCommandsDir();
|
|
|
|
[Theory]
|
|
[InlineData("ProbeCommand.cs")]
|
|
[InlineData("ReadCommand.cs")]
|
|
[InlineData("WriteCommand.cs")]
|
|
[InlineData("SubscribeCommand.cs")]
|
|
public void Command_does_not_call_ShutdownAsync_explicitly(string commandFile)
|
|
{
|
|
var path = Path.Combine(CommandsDir, commandFile);
|
|
File.Exists(path).ShouldBeTrue($"Expected {path} to exist.");
|
|
var source = File.ReadAllText(path);
|
|
|
|
// The await-using statement is the single disposal mechanism. An explicit
|
|
// driver.ShutdownAsync(...) call (typically inside a finally block) re-invokes
|
|
// a shutdown path that DisposeAsync already runs and is the smell -004 flags.
|
|
source.ShouldNotContain("driver.ShutdownAsync(");
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("ProbeCommand.cs")]
|
|
[InlineData("ReadCommand.cs")]
|
|
[InlineData("WriteCommand.cs")]
|
|
[InlineData("SubscribeCommand.cs")]
|
|
public void Command_uses_await_using_for_FocasDriver(string commandFile)
|
|
{
|
|
var path = Path.Combine(CommandsDir, commandFile);
|
|
var source = File.ReadAllText(path);
|
|
|
|
source.ShouldContain("await using var driver = new FocasDriver(");
|
|
}
|
|
|
|
private static string LocateCommandsDir()
|
|
{
|
|
// Walk up from the test assembly bin/ folder to the repo root, then into the
|
|
// source project's Commands/ directory. The test-host puts CWD somewhere under
|
|
// bin/Debug/net10.0 so we resolve relative to AppContext.BaseDirectory.
|
|
var dir = new DirectoryInfo(AppContext.BaseDirectory);
|
|
while (dir is not null && !File.Exists(Path.Combine(dir.FullName, "ZB.MOM.WW.OtOpcUa.slnx")))
|
|
dir = dir.Parent;
|
|
dir.ShouldNotBeNull("Could not find solution root (ZB.MOM.WW.OtOpcUa.slnx).");
|
|
return Path.Combine(
|
|
dir!.FullName, "src", "Drivers", "Cli", "ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli", "Commands");
|
|
}
|
|
}
|