using Shouldly; using Xunit; using ZB.MOM.WW.OtOpcUa.Core.Scripting; namespace ZB.MOM.WW.OtOpcUa.Core.Scripting.Tests; /// /// Verifies the per-evaluation timeout wrapper. Fast scripts complete normally; /// CPU-bound or hung scripts throw instead of /// starving the engine. Caller-supplied cancellation tokens take precedence over the /// timeout so driver-shutdown paths see a clean cancel rather than a timeout. /// [Trait("Category", "Unit")] public sealed class TimedScriptEvaluatorTests { [Fact] public async Task Fast_script_completes_under_timeout_and_returns_value() { var inner = ScriptEvaluator.Compile( """return (double)ctx.GetTag("In").Value + 1.0;"""); var timed = new TimedScriptEvaluator( inner, TimeSpan.FromSeconds(1)); var ctx = new FakeScriptContext().Seed("In", 41.0); var result = await timed.RunAsync(ctx, TestContext.Current.CancellationToken); result.ShouldBe(42.0); } [Fact] public async Task Script_longer_than_timeout_throws_ScriptTimeoutException() { // Scripts can't easily do Thread.Sleep in the sandbox (System.Threading.Thread // is denied). But a tight CPU loop exceeds any short timeout. var inner = ScriptEvaluator.Compile( """ var end = Environment.TickCount64 + 5000; while (Environment.TickCount64 < end) { } return 1; """); var timed = new TimedScriptEvaluator( inner, TimeSpan.FromMilliseconds(50)); var ex = await Should.ThrowAsync(async () => await timed.RunAsync(new FakeScriptContext(), TestContext.Current.CancellationToken)); ex.Timeout.ShouldBe(TimeSpan.FromMilliseconds(50)); ex.Message.ShouldContain("50.0"); } [Fact] public async Task Caller_cancellation_takes_precedence_over_timeout() { // A CPU-bound script that would otherwise timeout; external ct fires first. // Expected: OperationCanceledException (not ScriptTimeoutException) so shutdown // paths aren't misclassified as timeouts. var inner = ScriptEvaluator.Compile( """ var end = Environment.TickCount64 + 10000; while (Environment.TickCount64 < end) { } return 1; """); var timed = new TimedScriptEvaluator( inner, TimeSpan.FromSeconds(5)); using var cts = new CancellationTokenSource(TimeSpan.FromMilliseconds(80)); await Should.ThrowAsync(async () => await timed.RunAsync(new FakeScriptContext(), cts.Token)); } [Fact] public void Default_timeout_is_250ms_per_plan() { TimedScriptEvaluator.DefaultTimeout .ShouldBe(TimeSpan.FromMilliseconds(250)); } [Fact] public void Zero_or_negative_timeout_is_rejected_at_construction() { var inner = ScriptEvaluator.Compile("""return 1;"""); Should.Throw(() => new TimedScriptEvaluator(inner, TimeSpan.Zero)); Should.Throw(() => new TimedScriptEvaluator(inner, TimeSpan.FromMilliseconds(-1))); } [Fact] public void Null_inner_is_rejected() { Should.Throw(() => new TimedScriptEvaluator(null!)); } [Fact] public void Null_context_is_rejected() { var inner = ScriptEvaluator.Compile("""return 1;"""); var timed = new TimedScriptEvaluator(inner); Should.ThrowAsync(async () => await timed.RunAsync(null!, TestContext.Current.CancellationToken)); } [Fact] public async Task Script_exception_propagates_unwrapped() { // User-thrown exceptions must come through as-is — NOT wrapped in // ScriptTimeoutException. The virtual-tag engine catches them per-tag and // maps to BadInternalError; conflating with timeout would lose that info. var inner = ScriptEvaluator.Compile( """throw new InvalidOperationException("script boom");"""); var timed = new TimedScriptEvaluator(inner, TimeSpan.FromSeconds(1)); var ex = await Should.ThrowAsync(async () => await timed.RunAsync(new FakeScriptContext(), TestContext.Current.CancellationToken)); ex.Message.ShouldBe("script boom"); } [Fact] public async Task ScriptTimeoutException_message_points_at_diagnostic_path() { var inner = ScriptEvaluator.Compile( """ var end = Environment.TickCount64 + 5000; while (Environment.TickCount64 < end) { } return 1; """); var timed = new TimedScriptEvaluator( inner, TimeSpan.FromMilliseconds(30)); var ex = await Should.ThrowAsync(async () => await timed.RunAsync(new FakeScriptContext(), TestContext.Current.CancellationToken)); ex.Message.ShouldContain("ctx.Logger"); ex.Message.ShouldContain("widening the timeout"); } }