Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CLI.Tests/TemplateTableProjectionTests.cs
T
Joseph Doherty e0e4b24679 fix(deploy+cli): review findings — honest CLI timeouts, watermark-complete staleness, phase-2 staging, lock-safe cancellation
Six adversarial-review findings, each verified against the code first.

F1 (HIGH) CLI HttpClient capped every call at min(30s, caller timeout),
silently truncating deploy site's 5-minute BulkDeployTimeout and the
5-minute bundle export/preview/import calls — which printed a fake
"504 Request timed out" while the server kept working. HttpClient.Timeout
is now Timeout.InfiniteTimeSpan (the per-call CTS is the single overall
deadline, connect included) with the connect phase bounded separately on
SocketsHttpHandler.ConnectTimeout. The env override is renamed to
SCADABRIDGE_HTTP_CONNECT_TIMEOUT_SECONDS to match its new meaning.

F2 (HIGH) StaleInstanceProbe's process-static memo served stale hashes
because nothing bumped the watermark on three paths:
  (a) BundleImporter commits through the raw DbContext, so no import ever
      moved the watermark — a second import overwriting the same template
      could be OMITTED from ImportResult.StaleInstanceIds. It now bumps
      once per apply ATTEMPT: after the commit, and after the rollback too
      (the probe runs pre-commit, so a rolled-back attempt leaves memos for
      state that never landed; bumping on both paths is the simplest
      correct shape, versus threading transaction awareness through a
      process-static cache).
  (b) CollectWatermarkBumps' default: arm silently no-op'd, contradicting
      its own doc. It now sets unattributed=true — an over-broad bump costs
      extra work, a missed one produces stale work.
  (c) DataConnection edits route through SiteRepository.SaveChangesAsync,
      which had no watermark at all, yet Protocol/Primary+Backup config/
      FailoverRetryCount are revision-hash inputs. It now bumps (BumpAll —
      a connection has no owning template) after a commit that touched one.

F3 (MED) CLI TemplateTableProjection read child ARRAYS, but ListTemplates
now returns database-projected TemplateSummary rows, so template list
printed all zeros. It now prefers the *Count scalars and falls back to
array length (template get still returns full entities). --detail help
text and README corrected: a listing cannot yield definitions, so --detail
renders the raw summary payload and template get --id is the full dump.

F4 (MED) DeploySiteAsync staged every PendingDeployment in phase 1 against
a 5-min TTL while phase 2 reached them one batch at a time, so tail
instances' fetch tokens could expire before their command was sent.
Staging moved into phase 2, immediately before each send; prepare keeps
its flatten/validate/record work. The staging write is the phase's only
repository touch and is serialised behind a 1-permit semaphore, so the
non-thread-safe DbContext constraint holds and the sends stay concurrent.

F5 (MED, latent) DeploySiteAsync leaked every held operation lock if
cancelled — a wedged per-instance semaphore is permanent for the process.
Phase 2 no longer throws (cancellation is recorded as a per-instance
outcome so phase 3 still runs), and an escape from phase 1 or 3 now
unwinds every unfinalised entry: Failed status + lock release.

F6 (LOW) ScriptCompileVerdictCache's promotion wrote hot directly,
bypassing SegmentCapacity (true ceiling 3x against a documented 2x).
Promotion now goes through Store, keeping generational semantics; _hot
and _cold are volatile.

Tests: CLI 396, DeploymentManager 133, ManagementService 494,
TemplateEngine 478, ScriptAnalysis 60, Transport 157, Transport
integration 106, ConfigurationDatabase 366 — all green, 0 build warnings.
The F2/F4/F5 regression tests were each confirmed to FAIL with their fix
reverted.
2026-08-14 23:51:04 -04:00

198 lines
8.2 KiB
C#

using System.Text.Json;
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests;
/// <summary>
/// Tests for the compact <c>template list</c>/<c>get</c> table projection (followup #6):
/// the full per-template attribute/alarm/script dumps are collapsed to counts so table
/// output is usable in a terminal, while the array/object shape is preserved.
///
/// <para>
/// Two server shapes must both project correctly: <c>template get</c> still returns a
/// full <c>Template</c> entity with child ARRAYS, while <c>template list</c> returns
/// database-projected <see cref="TemplateSummary"/> rows carrying pre-computed COUNT
/// scalars and no arrays at all. Reading only the arrays made every listed template
/// render as zeros.
/// </para>
/// </summary>
public class TemplateTableProjectionTests
{
private const string ListJson = """
[
{
"id": 3,
"name": "MESReceiver",
"description": "base",
"parentTemplateId": null,
"isDerived": false,
"attributes": [ {"id":1},{"id":2},{"id":3} ],
"alarms": [ {"id":10} ],
"scripts": [ {"id":20},{"id":21} ],
"compositions": [],
"nativeAlarmSources": []
},
{
"id": 5,
"name": "LeftMESReceiver",
"description": null,
"parentTemplateId": 3,
"isDerived": false,
"attributes": [ {"id":1} ],
"alarms": [],
"scripts": [],
"compositions": [ {"id":99} ],
"nativeAlarmSources": [ {"id":7} ]
}
]
""";
[Fact]
public void ProjectSummary_Array_DropsMemberArraysAndKeepsCounts()
{
var compact = TemplateTableProjection.ProjectSummary(ListJson);
using var doc = JsonDocument.Parse(compact);
var root = doc.RootElement;
Assert.Equal(JsonValueKind.Array, root.ValueKind);
Assert.Equal(2, root.GetArrayLength());
var first = root[0];
Assert.Equal(3, first.GetProperty("id").GetInt32());
Assert.Equal("MESReceiver", first.GetProperty("name").GetString());
Assert.Equal("base", first.GetProperty("description").GetString());
Assert.Equal(JsonValueKind.Null, first.GetProperty("parentTemplateId").ValueKind);
Assert.Equal(3, first.GetProperty("#attrs").GetInt32());
Assert.Equal(1, first.GetProperty("#alarms").GetInt32());
Assert.Equal(2, first.GetProperty("#scripts").GetInt32());
Assert.Equal(0, first.GetProperty("#comps").GetInt32());
Assert.Equal(0, first.GetProperty("#nativeAlarms").GetInt32());
// The full member arrays must NOT survive — that is the whole point of the projection.
Assert.False(first.TryGetProperty("attributes", out _));
Assert.False(first.TryGetProperty("scripts", out _));
var second = root[1];
Assert.Equal(5, second.GetProperty("id").GetInt32());
Assert.Equal(3, second.GetProperty("parentTemplateId").GetInt32());
Assert.Equal(1, second.GetProperty("#comps").GetInt32());
Assert.Equal(1, second.GetProperty("#nativeAlarms").GetInt32());
// A null description stays null (it is not invented).
Assert.Equal(JsonValueKind.Null, second.GetProperty("description").ValueKind);
}
[Fact]
public void ProjectSummary_SingleObject_ProducesCompactObject()
{
const string getJson = """
{ "id": 7, "name": "ReactorSide", "description": "d", "parentTemplateId": null,
"isDerived": false, "attributes": [ {"id":1},{"id":2} ], "alarms": [], "scripts": [],
"compositions": [], "nativeAlarmSources": [] }
""";
var compact = TemplateTableProjection.ProjectSummary(getJson);
using var doc = JsonDocument.Parse(compact);
var root = doc.RootElement;
Assert.Equal(JsonValueKind.Object, root.ValueKind);
Assert.Equal(7, root.GetProperty("id").GetInt32());
Assert.Equal(2, root.GetProperty("#attrs").GetInt32());
Assert.False(root.TryGetProperty("attributes", out _));
}
/// <summary>
/// The <c>template list</c> shape. Serialised from the REAL
/// <see cref="TemplateSummary"/> record rather than hand-written JSON, so a
/// rename of one of its count properties fails this test instead of silently
/// putting zeros back on every row.
/// </summary>
[Fact]
public void ProjectSummary_SummaryRows_ReadsCountScalars()
{
var rows = new[]
{
new TemplateSummary(
Id: 3, Name: "MESReceiver", Description: "base", ParentTemplateId: null,
FolderId: null, IsDerived: false, OwnerCompositionId: null,
AttributeCount: 3, AlarmCount: 1, ScriptCount: 2,
CompositionCount: 0, NativeAlarmSourceCount: 0),
new TemplateSummary(
Id: 5, Name: "LeftMESReceiver", Description: null, ParentTemplateId: 3,
FolderId: 2, IsDerived: false, OwnerCompositionId: null,
AttributeCount: 1, AlarmCount: 0, ScriptCount: 0,
CompositionCount: 1, NativeAlarmSourceCount: 1),
};
var json = JsonSerializer.Serialize(rows,
new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
var compact = TemplateTableProjection.ProjectSummary(json);
using var doc = JsonDocument.Parse(compact);
var root = doc.RootElement;
Assert.Equal(2, root.GetArrayLength());
var first = root[0];
Assert.Equal(3, first.GetProperty("id").GetInt32());
Assert.Equal("MESReceiver", first.GetProperty("name").GetString());
Assert.Equal(3, first.GetProperty("#attrs").GetInt32());
Assert.Equal(1, first.GetProperty("#alarms").GetInt32());
Assert.Equal(2, first.GetProperty("#scripts").GetInt32());
Assert.Equal(0, first.GetProperty("#comps").GetInt32());
Assert.Equal(0, first.GetProperty("#nativeAlarms").GetInt32());
var second = root[1];
Assert.Equal(5, second.GetProperty("id").GetInt32());
Assert.Equal(3, second.GetProperty("parentTemplateId").GetInt32());
Assert.Equal(1, second.GetProperty("#attrs").GetInt32());
Assert.Equal(1, second.GetProperty("#comps").GetInt32());
Assert.Equal(1, second.GetProperty("#nativeAlarms").GetInt32());
}
/// <summary>
/// A count scalar wins over a child array when (hypothetically) both are
/// present, so a payload that gains summary fields never regresses to array
/// counting.
/// </summary>
[Fact]
public void ProjectSummary_PrefersCountScalarOverArray()
{
const string bothJson = """
{ "id": 1, "name": "T", "attributeCount": 42, "attributes": [ {"id":1} ] }
""";
var compact = TemplateTableProjection.ProjectSummary(bothJson);
using var doc = JsonDocument.Parse(compact);
Assert.Equal(42, doc.RootElement.GetProperty("#attrs").GetInt32());
}
[Fact]
public void ProjectSummary_NonJson_ReturnedVerbatim()
{
const string notJson = "<html>proxy error</html>";
Assert.Equal(notJson, TemplateTableProjection.ProjectSummary(notJson));
}
[Fact]
public void ProjectSummary_IsSubstantiallySmallerThanFullDump()
{
// Sanity check that the projection actually shrinks output (the reported symptom
// was ~171 KB table dumps). A template with a fat attribute array should collapse.
var fatAttributes = string.Join(",",
Enumerable.Range(0, 200).Select(i =>
$"{{\"id\":{i},\"name\":\"Attr{i}\",\"dataType\":\"String\",\"value\":\"some long-ish default value {i}\"}}"));
var fullJson = $$"""
[ { "id": 1, "name": "T", "description": "d", "parentTemplateId": null, "isDerived": false,
"attributes": [ {{fatAttributes}} ], "alarms": [], "scripts": [], "compositions": [], "nativeAlarmSources": [] } ]
""";
var compact = TemplateTableProjection.ProjectSummary(fullJson);
Assert.True(compact.Length * 4 < fullJson.Length,
$"Expected compact ({compact.Length}) to be far smaller than full ({fullJson.Length}).");
using var doc = JsonDocument.Parse(compact);
Assert.Equal(200, doc.RootElement[0].GetProperty("#attrs").GetInt32());
}
}