Joseph Doherty
cdd65beb6c
Closes the four remaining items in the 2026-06-24 template-inheritance/CLI follow-up tracker. #4 — CLI `instance set-bindings` can now set DataSourceReferenceOverride. `--bindings` accepts an optional 3rd element per entry: [attributeName, dataConnectionId, dataSourceReferenceOverride]. A string sets the override; a JSON null or an omitted 3rd element leaves it unset (template default). TryParseBindings accepts 2- or 3-element entries and rejects a non-string/non-null 3rd element or 4+ elements with a clean error. Previously the CLI sent the override as null and silently wiped any existing one (only a raw POST /management could set it). #5 — `template update` is partial, not full-replace (fixed server-side so all clients benefit). UpdateTemplateAsync now uses leave-unchanged semantics: a null description keeps the stored value (pass "" to clear); a null parentTemplateId keeps the existing parent. Parent stays immutable — a non-null differing value is still rejected — but omitting --parent-id is now a no-op instead of failing every derived-template update. #6 — compact `template list`/`get` table output + `--detail`. Table output is now id/name/description/parent/derived + member counts (#attrs/#alarms/ #scripts/#comps/#nativeAlarms) via TemplateTableProjection, fed through a new optional tableProjector seam on CommandHelpers. `--detail` restores the full dump. JSON output is left untouched (always full) so machine consumers are unaffected — the projector only runs on the table path. #8 — structured deploy-time validation error. New ValidationResult.SummarizeErrors() (Commons) returns a grouped, capped summary: leading total count, one line per ValidationCategory, and a per-module rollup (canonical name up to its last dot) with counts + "... and N more module(s)" caps. DeploymentService uses it for the "Pre-deployment validation failed" message and logs the full per-entry list via LogWarning. Replaces the flat semicolon-joined dump that became a wall of text for instances with 50-194 unbound attributes. Tests: +8 Commons (SummarizeErrors), +8 CLI (4 binding 3-element / 4 table projection), +2 net TemplateEngine (partial-update). Affected suites green: Commons 587, CLI 341, TemplateEngine 447, DeploymentManager 101, ManagementService 230, CentralUI 866; full solution builds 0/0. Docs: Component-DeploymentManager.md "Validation Error Reporting"; CLI README (set-bindings 3-element form, template update leave-unchanged, list/get --detail); UpdateTemplateCommand doc; known-issues tracker #4/#5/#6/#8 resolved (all 8 items now closed).
123 lines
4.9 KiB
C#
123 lines
4.9 KiB
C#
using System.Text.Json;
|
|
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
|
|
|
|
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.
|
|
/// </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 _));
|
|
}
|
|
|
|
[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());
|
|
}
|
|
}
|