Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/SiteRuntimeOptionsValidatorTests.cs
T
Joseph Doherty b3021e7c5f feat(scripts): read-only, allow-listed Files global for site scripts; Delmia test receiver parses recipe files
Script file access (design docs/plans/2026-09-28-script-file-access-design.md): Files.ReadTextAsync /
ReadLinesAsync / ExistsAsync on site ScriptGlobals (+ Instance.Files), backed by the site-singleton
ScriptFileReader. The one host-mediated exception to the System.IO ban - scripts still never name a
System.IO type. OFF by default: ScadaBridge:SiteRuntime:ScriptFileAccess:AllowedRoots (empty = every call
throws Disabled) + MaxFileBytes (1 MiB, validated 1..64 MiB, roots must be absolute). Guard: fully
qualified, no device paths / ADS, canonical path strictly inside a root (directory-boundary match), no
reparse point on the file or any directory below the root, size cap before and during the read.
Errors are one Commons type, ScriptFileAccessException(+ScriptFileAccessFailure); Commons.Types.Scripts
joins the default script imports on every surface so it binds by short name. Mirrored on
ScriptCompileSurface (CompileFiles, parity-pinned) and the Test Run sandbox (binds, refuses Disabled).
Inbound (central) scripts do not get it.

Rig: docker/recipes (sample RecipeValueName,RecipeValue files incl. an invalid one) bind-mounted
read-only at /app/recipes on both site-a nodes with AllowedRoots [/app/recipes]. The TestMesMachine
SimDelmiaRecipe simulator now reads + parses the downloaded file, converts each value to its recipe tag's
type and loads it all-or-nothing (14 new TestDelmiaReceiver attributes); verify-mes-test-machine.sh
group A covers accept / re-download / invalid lines / NotFound / OutsideAllowedRoots, VERIFY_GROUPS
selects groups (rig: AD).
2026-09-28 10:36:42 -04:00

247 lines
8.2 KiB
C#

using Microsoft.Extensions.Options;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests;
/// <summary>
/// <see cref="SiteRuntimeOptions"/> values size the staggered Instance-Actor
/// startup batches, the dedicated script-execution thread scheduler, and the
/// site-wide stream buffer. A zero/negative count crashes actor construction with
/// an opaque <see cref="ArgumentOutOfRangeException"/>; these tests assert the
/// <see cref="SiteRuntimeOptionsValidator"/> rejects a bad
/// <c>ScadaBridge:SiteRuntime</c> section with a clear, key-naming message.
/// </summary>
public class SiteRuntimeOptionsValidatorTests
{
private static ValidateOptionsResult Validate(SiteRuntimeOptions options) =>
new SiteRuntimeOptionsValidator().Validate(Options.DefaultName, options);
[Fact]
public void DefaultOptions_AreValid()
{
var result = Validate(new SiteRuntimeOptions());
Assert.True(result.Succeeded, result.FailureMessage);
}
[Fact]
public void ZeroStartupBatchSize_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { StartupBatchSize = 0 });
Assert.True(result.Failed);
Assert.Contains("StartupBatchSize", result.FailureMessage);
}
[Fact]
public void ZeroScriptExecutionThreadCount_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { ScriptExecutionThreadCount = 0 });
Assert.True(result.Failed);
Assert.Contains("ScriptExecutionThreadCount", result.FailureMessage);
}
[Fact]
public void ZeroTagSubscribeRetryIntervalMs_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { TagSubscribeRetryIntervalMs = 0 });
Assert.True(result.Failed);
Assert.Contains("TagSubscribeRetryIntervalMs", result.FailureMessage);
}
[Fact]
public void NegativeStuckScriptGraceMs_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { StuckScriptGraceMs = -1 });
Assert.True(result.Failed);
Assert.Contains("StuckScriptGraceMs", result.FailureMessage);
}
[Fact]
public void ZeroStreamBufferSize_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { StreamBufferSize = 0 });
Assert.True(result.Failed);
Assert.Contains("StreamBufferSize", result.FailureMessage);
}
[Fact]
public void NegativeStartupBatchDelayMs_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { StartupBatchDelayMs = -1 });
Assert.True(result.Failed);
Assert.Contains("StartupBatchDelayMs", result.FailureMessage);
}
[Fact]
public void ZeroAlarmPublishQueueCapacity_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { AlarmPublishQueueCapacity = 0 });
Assert.True(result.Failed);
Assert.Contains("AlarmPublishQueueCapacity", result.FailureMessage);
}
// ── WP3.1 options ──────────────────────────────────────────────────────────────
/// <summary>
/// The ceiling is the upper bound of the instance-scaled pool; below the floor it would
/// silently shrink the configured pool instead of growing it.
/// </summary>
[Fact]
public void ScriptExecutionMaxThreadCountBelowThreadCount_IsRejected()
{
var result = Validate(new SiteRuntimeOptions
{
ScriptExecutionThreadCount = 8,
ScriptExecutionMaxThreadCount = 4
});
Assert.True(result.Failed);
Assert.Contains("ScriptExecutionMaxThreadCount", result.FailureMessage);
}
[Fact]
public void EqualScriptExecutionThreadCountAndMax_IsAccepted()
{
var result = Validate(new SiteRuntimeOptions
{
ScriptExecutionThreadCount = 8,
ScriptExecutionMaxThreadCount = 8
});
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>A zero gate would park every Expression trigger on the node forever.</summary>
[Fact]
public void ZeroTriggerEvalMaxConcurrency_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { TriggerEvalMaxConcurrency = 0 });
Assert.True(result.Failed);
Assert.Contains("TriggerEvalMaxConcurrency", result.FailureMessage);
}
[Fact]
public void ZeroTriggerEvalTimeoutSeconds_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { TriggerEvalTimeoutSeconds = 0 });
Assert.True(result.Failed);
Assert.Contains("TriggerEvalTimeoutSeconds", result.FailureMessage);
}
/// <summary>A zero cap would shed every trigger, silently disabling all scripts.</summary>
[Fact]
public void ZeroTraceArmWindowSeconds_IsRejected()
{
// Flow Debugger design 2026-09-05 §5.3: the arm window must be positive.
var result = Validate(new SiteRuntimeOptions { TraceArmWindowSeconds = 0 });
Assert.True(result.Failed);
Assert.Contains("TraceArmWindowSeconds", result.FailureMessage);
Assert.Equal(30, new SiteRuntimeOptions().TraceArmWindowSeconds);
}
/// <summary>A zero cap would drop every log line AND the closing row that reports the drops.</summary>
[Fact]
public void ZeroMaxLogLinesPerRun_IsRejected()
{
// Flow Debugger step logs (design 2026-09-09 D7): the per-run cap must be positive.
var result = Validate(new SiteRuntimeOptions { MaxLogLinesPerRun = 0 });
Assert.True(result.Failed);
Assert.Contains("MaxLogLinesPerRun", result.FailureMessage);
Assert.Equal(200, new SiteRuntimeOptions().MaxLogLinesPerRun);
}
[Fact]
public void ZeroMaxConcurrentRunsPerScript_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { MaxConcurrentRunsPerScript = 0 });
Assert.True(result.Failed);
Assert.Contains("MaxConcurrentRunsPerScript", result.FailureMessage);
}
// --- Lever 1 (2026-08-28): tag-subscribe backoff + in-flight ceiling ---
[Fact]
public void TagSubscribeRetryMaxIntervalMs_BelowFloor_IsRejected()
{
var result = Validate(new SiteRuntimeOptions
{
TagSubscribeRetryIntervalMs = 5000,
TagSubscribeRetryMaxIntervalMs = 4999,
});
Assert.True(result.Failed);
Assert.Contains("TagSubscribeRetryMaxIntervalMs", result.FailureMessage);
}
[Fact]
public void TagSubscribeRetryMaxIntervalMs_EqualToFloor_IsValid()
{
var result = Validate(new SiteRuntimeOptions
{
TagSubscribeRetryIntervalMs = 5000,
TagSubscribeRetryMaxIntervalMs = 5000,
});
Assert.True(result.Succeeded, result.FailureMessage);
}
[Fact]
public void ZeroTagSubscribeInFlightCeilingMs_IsRejected()
{
var result = Validate(new SiteRuntimeOptions { TagSubscribeInFlightCeilingMs = 0 });
Assert.True(result.Failed);
Assert.Contains("TagSubscribeInFlightCeilingMs", result.FailureMessage);
}
[Fact]
public void ScriptFileAccess_DefaultsToDisabled_AndIsValid()
{
var options = new SiteRuntimeOptions();
Assert.Empty(options.ScriptFileAccess.AllowedRoots);
Assert.True(Validate(options).Succeeded);
}
[Fact]
public void ScriptFileAccess_RelativeRoot_IsRejected()
{
var options = new SiteRuntimeOptions();
options.ScriptFileAccess.AllowedRoots.Add("recipes");
var result = Validate(options);
Assert.True(result.Failed);
Assert.Contains("ScriptFileAccess:AllowedRoots:0", result.FailureMessage);
}
[Fact]
public void ScriptFileAccess_AbsoluteRoot_IsAccepted()
{
var options = new SiteRuntimeOptions();
options.ScriptFileAccess.AllowedRoots.Add(Path.GetTempPath());
Assert.True(Validate(options).Succeeded);
}
[Theory]
[InlineData(0L)]
[InlineData(64L * 1024 * 1024 + 1)]
public void ScriptFileAccess_MaxFileBytesOutOfRange_IsRejected(long max)
{
var options = new SiteRuntimeOptions();
options.ScriptFileAccess.MaxFileBytes = max;
var result = Validate(options);
Assert.True(result.Failed);
Assert.Contains("ScriptFileAccess:MaxFileBytes", result.FailureMessage);
}
}