feat(cli): add --execution-timeout-seconds + --min-time-between-runs to template script (#54)

Expose TemplateScript.ExecutionTimeoutSeconds and MinTimeBetweenRuns (previously
settable only via Transport bundle import) on the CLI and Central UI authoring surfaces.

- Commons: add additive trailing optionals MinTimeBetweenRuns (TimeSpan?) and
  ExecutionTimeoutSeconds (int?) to Add/UpdateTemplateScriptCommand.
- ManagementActor: thread both new fields into the built TemplateScript on add/update.
- CLI template script add/update: new --min-time-between-runs (duration: ms/s/min,
  bare number = seconds, 0 = unset, mirroring DurationInput) and
  --execution-timeout-seconds (int) flags, with client-side duration validation.
- Central UI TemplateEdit: add an Execution timeout input (seconds) on the script
  trigger tab, mirroring the existing Min-time-between-runs control; null/0 = site default.
- Tests: TemplateScriptTimingTests pins the option surface + duration parsing; updated
  the stale 'no UI control' comment on the TemplateService round-trip test.
This commit is contained in:
Joseph Doherty
2026-06-19 03:14:10 -04:00
parent 5185486a3c
commit ae25b5a8d6
5 changed files with 162 additions and 18 deletions
@@ -0,0 +1,120 @@
using System.CommandLine;
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// #54: <c>template script add/update</c> must expose <c>--min-time-between-runs</c>
/// (a duration with ms/s/min units) and <c>--execution-timeout-seconds</c> (an int)
/// so the per-script throttle/re-fire interval and the execution-timeout override —
/// previously settable only via Transport bundle import — are CLI-authorable. These
/// tests pin the option surface and the duration-parsing semantics of
/// <see cref="TemplateCommands.TryParseMinTimeBetweenRuns"/>.
/// </summary>
public class TemplateScriptTimingTests
{
private static readonly Option<string> Url = new("--url") { Recursive = true };
private static readonly Option<string> Username = new("--username") { Recursive = true };
private static readonly Option<string> Password = new("--password") { Recursive = true };
private static readonly Option<string> Format = CliOptions.CreateFormatOption();
private static Command ScriptGroup()
=> TemplateCommands.Build(Url, Format, Username, Password)
.Subcommands.Single(c => c.Name == "script");
// ---- option surface ----
[Fact]
public void ScriptAdd_HasTimingOptions()
{
var add = ScriptGroup().Subcommands.Single(c => c.Name == "add");
var names = add.Options.Select(o => o.Name).ToArray();
Assert.Contains("--min-time-between-runs", names);
Assert.Contains("--execution-timeout-seconds", names);
}
[Fact]
public void ScriptUpdate_HasTimingOptions()
{
var update = ScriptGroup().Subcommands.Single(c => c.Name == "update");
var names = update.Options.Select(o => o.Name).ToArray();
Assert.Contains("--min-time-between-runs", names);
Assert.Contains("--execution-timeout-seconds", names);
}
// ---- --min-time-between-runs parsing ----
[Fact]
public void MinTime_Absent_IsUnsetNoError()
{
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(null, out var d, out var err));
Assert.Null(d);
Assert.Null(err);
}
[Fact]
public void MinTime_Blank_IsUnsetNoError()
{
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(" ", out var d, out var err));
Assert.Null(d);
Assert.Null(err);
}
[Theory]
[InlineData("500ms", 500)]
[InlineData("250MS", 250)]
public void MinTime_Milliseconds_Parsed(string value, int expectedMs)
{
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(value, out var d, out var err));
Assert.Null(err);
Assert.Equal(TimeSpan.FromMilliseconds(expectedMs), d);
}
[Theory]
[InlineData("5")] // bare number → seconds
[InlineData("5s")]
[InlineData("5sec")]
[InlineData("5SEC")]
public void MinTime_Seconds_BareDefaultsToSeconds(string value)
{
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(value, out var d, out var err));
Assert.Null(err);
Assert.Equal(TimeSpan.FromSeconds(5), d);
}
[Theory]
[InlineData("2m")]
[InlineData("2min")]
[InlineData("2MIN")]
public void MinTime_Minutes_Parsed(string value)
{
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(value, out var d, out var err));
Assert.Null(err);
Assert.Equal(TimeSpan.FromMinutes(2), d);
}
[Theory]
[InlineData("0")]
[InlineData("0s")]
[InlineData("0min")]
public void MinTime_Zero_IsUnset(string value)
{
// 0 means "no throttle" → null, mirroring DurationInput.Compose's non-positive handling.
Assert.True(TemplateCommands.TryParseMinTimeBetweenRuns(value, out var d, out var err));
Assert.Null(err);
Assert.Null(d);
}
[Theory]
[InlineData("abc")]
[InlineData("5h")] // hours not supported
[InlineData("5days")]
[InlineData("-3")]
[InlineData("1.5s")] // non-integer
public void MinTime_Invalid_ReturnsError(string value)
{
Assert.False(TemplateCommands.TryParseMinTimeBetweenRuns(value, out var d, out var err));
Assert.Null(d);
Assert.NotNull(err);
}
}
@@ -505,14 +505,11 @@ public class TemplateServiceTests
[Fact]
public async Task UpdateScript_UiEditPath_PreservesExistingExecutionTimeoutSeconds()
{
// M2.5 (#9): ExecutionTimeoutSeconds has no authoring control in the UI.
// A UI-style update (proposed.ExecutionTimeoutSeconds == null) must NOT
// overwrite a timeout previously set via Transport import.
//
// The fix is in TemplateEdit.razor: it round-trips the loaded value, so
// proposed.ExecutionTimeoutSeconds will equal the existing value, not null.
// This test proves that when the round-trip is working, the service
// preserves the timeout end-to-end.
// #54: the UI now has an ExecutionTimeoutSeconds input, but it still loads
// (round-trips) the existing value into that input on edit, so leaving it
// untouched re-sends the same value rather than null. This test proves the
// service preserves the timeout end-to-end when the loaded value is re-sent
// — guarding the UI edit path against silently blanking a configured timeout.
var existing = new TemplateScript("OnStart", "return true;")
{
Id = 1,