fix(adminui): Heidenhain authoring UX — CSV preview runs the save-path row rule, dictated data type is locked, credential error shown once (#830)
- RawTagRowRules: the ONE driver-dispatched authority on Tag-ROW rules (access level / Tag.DataType). RawTreeService's save path, the CSV import's staged review grid (RawTagCsvMapper) and the manual-entry grid all call it; no call site names a driver. A ReadWrite or mistyped Heidenhain row is now invalid IN THE PREVIEW instead of only at Commit. - Manual-entry grid + tag modal: when the driver dictates the data type for the row's address (RawTagRowDefaults.DictatedDataType), the field is a locked read-only value instead of a select that commit silently replaced; the grid runs the row rule client-side and no longer rewrites the row at commit. - Driver/device modals: the credential refusal is shown once (the modal's save-gate notice); HeidenhainDriverFormModel / HeidenhainDeviceModel.Validate report only ranges / endpoint. - docs/drivers/Heidenhain.md: #831 alarm conditions + rediscovery, #830 authoring behaviour. Tests: HeidenhainAuthoringUxTests (CSV preview == ImportTagsAsync row-for-row, dictated type is what the save path accepts, single credential surface, ALARM: seeding, CSV alarm rows, AlarmMs round-trip); HeidenhainAuthoringTests updated for the single-notice rule.
This commit is contained in:
@@ -53,7 +53,10 @@ public sealed class HeidenhainAuthoringTests
|
||||
{
|
||||
var m = HeidenhainDriverFormModel.FromJson("{}");
|
||||
m.DncPassword = "hunter2";
|
||||
m.Validate()!.ShouldNotContain("hunter2");
|
||||
// #830: the credential refusal is the hosting modal's (the save gate), reported once — not the form's too.
|
||||
var refusal = DriverConfigSaveGate.Validate(DriverTypeNames.Heidenhain, m.ToJson());
|
||||
refusal.ShouldNotBeNull();
|
||||
refusal.ShouldNotContain("hunter2");
|
||||
m.DncPassword = null;
|
||||
m.StatusMs = 10;
|
||||
m.Validate().ShouldNotBeNull();
|
||||
@@ -66,7 +69,7 @@ public sealed class HeidenhainAuthoringTests
|
||||
d.Port.ShouldBe(19000);
|
||||
d.Validate().ShouldBeNull();
|
||||
d.DataPassword = "plain";
|
||||
d.Validate().ShouldNotBeNull();
|
||||
DriverConfigSaveGate.Validate(DriverTypeNames.Heidenhain, d.ToJson()).ShouldNotBeNull(); // #830: the modal's gate
|
||||
d.DataPassword = "env:OTOPCUA_HEIDENHAIN_DATA";
|
||||
var json = d.ToJson();
|
||||
JsonNode.Parse(json)!["Note"]!.GetValue<string>().ShouldBe("keep");
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
using Shouldly;
|
||||
using Xunit;
|
||||
using ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.DeviceForms;
|
||||
using ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Forms;
|
||||
using ZB.MOM.WW.OtOpcUa.AdminUI.Uns;
|
||||
using ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
|
||||
using ZB.MOM.WW.OtOpcUa.Configuration.Enums;
|
||||
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
||||
using ZB.MOM.WW.OtOpcUa.Driver.Heidenhain;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Uns;
|
||||
|
||||
/// <summary>
|
||||
/// lmxopcua#830 authoring UX: (a) the CSV review grid previews the SAME row rule the commit applies, (b) the
|
||||
/// driver-dictated data type is a lock, never a silent rewrite, (c) a credential refusal is reported once.
|
||||
/// Plus the #831 ALARM: authoring seams (editor seeding, native-alarm editor visibility).
|
||||
/// </summary>
|
||||
[Trait("Category", "Unit")]
|
||||
public sealed class HeidenhainAuthoringUxTests
|
||||
{
|
||||
private static CancellationToken Ct => TestContext.Current.CancellationToken;
|
||||
|
||||
private const string Header = "Name,DataType,AccessLevel,TagConfigJson";
|
||||
|
||||
private static string Csv(params string[] rows) => Header + "\n" + string.Join("\n", rows);
|
||||
|
||||
private static string Json(string json) => "\"" + json.Replace("\"", "\"\"") + "\"";
|
||||
|
||||
// ---- (a) CSV preview == commit ----
|
||||
|
||||
[Fact]
|
||||
public void Csv_preview_flags_ReadWrite_and_data_type_mismatch_rows_like_the_commit()
|
||||
{
|
||||
var exec = Json("""{"address":"Status/ExecutionState"}""");
|
||||
var result = RawTagCsvMapper.Parse(DriverTypeNames.Heidenhain, Csv(
|
||||
$"ok,Int32,Read,{exec}",
|
||||
$"rw,Int32,ReadWrite,{exec}",
|
||||
$"dt,Double,Read,{exec}",
|
||||
$"feed,Int32,Read,{Json("""{"address":"Overrides/Feed"}""")}"));
|
||||
|
||||
result.FatalError.ShouldBeNull();
|
||||
var rows = result.Rows;
|
||||
rows[0].Ok.ShouldBeTrue(rows[0].Error);
|
||||
rows[1].Error!.ShouldContain("read-only");
|
||||
rows[2].Error!.ShouldContain("Int32");
|
||||
rows[3].Error!.ShouldContain("Double"); // a Float64 leaf publishes Double — picked as Int32 it used to preview OK
|
||||
result.CanCommit.ShouldBeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Csv_preview_and_ImportTags_agree_row_for_row()
|
||||
{
|
||||
var exec = Json("""{"address":"Status/ExecutionState"}""");
|
||||
var csv = Csv($"ok,Int32,Read,{exec}", $"rw,Int32,ReadWrite,{exec}", $"dt,String,Read,{exec}",
|
||||
$"plc,Int64,Read,{Json("""{"address":"PLC:DWORD:0","dataType":"Int64"}""")}");
|
||||
var preview = RawTagCsvMapper.Parse(DriverTypeNames.Heidenhain, csv);
|
||||
|
||||
var name = RawTreeTestDb.SeedFresh();
|
||||
var svc = new RawTreeService(RawTreeTestDb.Factory(name));
|
||||
var created = await svc.CreateDriverAsync(RawTreeTestDb.ClusterId, null, "hh1", DriverTypeNames.Heidenhain, "{}", Ct);
|
||||
string deviceId;
|
||||
using (var db = RawTreeTestDb.CreateNamed(name)) deviceId = db.Devices.Single(d => d.DriverInstanceId == created.CreatedId).DeviceId;
|
||||
|
||||
// Feed EVERY parsed row (the invalid ones too, rebuilt from their cells) to the commit and compare verdicts.
|
||||
foreach (var row in preview.Rows)
|
||||
{
|
||||
var dataType = row.Cells[1];
|
||||
var access = Enum.Parse<TagAccessLevel>(row.Cells[2]);
|
||||
var input = new RawTagInput(row.Cells[0], dataType, access, false, null, row.Cells[3]);
|
||||
var outcome = await svc.ImportTagsAsync(deviceId, [new RawTagImportRow(null, input)], Ct);
|
||||
(outcome.Errors.Count == 0).ShouldBe(row.Ok, $"{row.Name}: preview {row.Error ?? "OK"} vs commit {string.Join("; ", outcome.Errors)}");
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Row_rules_are_driver_dispatched_not_named_at_call_sites()
|
||||
{
|
||||
RawTagRowRules.DriverTypesWithRules.ShouldContain(DriverTypeNames.Heidenhain);
|
||||
RawTagRowRules.Problem(DriverTypeNames.Modbus, TagAccessLevel.ReadWrite, "Float", "{}").ShouldBeNull();
|
||||
RawTagRowRules.Problem(DriverTypeNames.Heidenhain, TagAccessLevel.ReadWrite, "Int32", """{"address":"Status/ExecutionState"}""")
|
||||
.ShouldBe(HeidenhainTagRules.DescribeRowProblem(true, "Int32", """{"address":"Status/ExecutionState"}"""));
|
||||
RawTagRowRules.IsReadOnlyDriver(DriverTypeNames.Heidenhain).ShouldBeTrue();
|
||||
RawTagRowRules.IsReadOnlyDriver(DriverTypeNames.S7).ShouldBeFalse();
|
||||
}
|
||||
|
||||
// ---- (b) dictated data type is a lock ----
|
||||
|
||||
[Theory]
|
||||
[InlineData("""{"address":"Axes/Positions","isArray":true}""", "Double")]
|
||||
[InlineData("""{"address":"PLC:WORD:3","dataType":"Int16"}""", "Int16")]
|
||||
[InlineData("""{"address":"ALARM:*","alarm":{}}""", "Boolean")]
|
||||
public void The_dictated_data_type_is_what_the_grid_and_modal_lock_to(string config, string expected)
|
||||
{
|
||||
RawTagRowDefaults.DictatedDataType(DriverTypeNames.Heidenhain, config).ShouldBe(expected);
|
||||
// ...and the locked value is exactly what the save path accepts — nothing to rewrite on commit.
|
||||
RawTagRowRules.Problem(DriverTypeNames.Heidenhain, TagAccessLevel.Read, expected, config).ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void An_unresolved_config_or_another_driver_leaves_the_data_type_to_the_operator()
|
||||
{
|
||||
RawTagRowDefaults.DictatedDataType(DriverTypeNames.Heidenhain, "{}").ShouldBeNull();
|
||||
RawTagRowDefaults.DictatedDataType(DriverTypeNames.Modbus, """{"address":"Axes/Positions","isArray":true}""").ShouldBeNull();
|
||||
}
|
||||
|
||||
// ---- (c) credential error shown once ----
|
||||
|
||||
[Fact]
|
||||
public void A_literal_password_is_reported_by_the_modal_save_gate_only_not_also_by_the_form()
|
||||
{
|
||||
var driver = HeidenhainDriverFormModel.FromJson("{}");
|
||||
driver.InspectPassword = "hunter2";
|
||||
var json = driver.ToJson();
|
||||
DriverConfigSaveGate.Validate(DriverTypeNames.Heidenhain, json).ShouldNotBeNull(); // the modal's one notice + Save disabled
|
||||
driver.Validate().ShouldBeNull(); // the form no longer repeats it
|
||||
driver.StatusMs = 10;
|
||||
driver.Validate()!.ShouldContain("StatusMs"); // non-credential problems still show in the form
|
||||
|
||||
var device = HeidenhainDeviceModel.FromJson("""{"Host":"cnc-7"}""");
|
||||
device.DncPassword = "hunter2";
|
||||
DriverConfigSaveGate.Validate(DriverTypeNames.Heidenhain, device.ToJson()).ShouldNotBeNull();
|
||||
device.Validate().ShouldBeNull();
|
||||
HeidenhainDeviceModel.FromJson("{}").Validate().ShouldNotBeNull(); // host still required in the form
|
||||
}
|
||||
|
||||
// ---- #831 authoring seams ----
|
||||
|
||||
[Fact]
|
||||
public void Picking_an_alarm_selector_seeds_the_alarm_object_and_leaving_it_drops_it()
|
||||
{
|
||||
var m = HeidenhainTagConfigModel.FromJson("{}");
|
||||
m.Address = "ALARM:CLASS=7";
|
||||
var json = m.ToJson();
|
||||
m.Validate().ShouldBeNull();
|
||||
TagConfigValidator.Validate(DriverTypeNames.Heidenhain, json).ShouldBeNull();
|
||||
NativeAlarmModel.FromJson(json).IsAlarm.ShouldBeTrue();
|
||||
HeidenhainTagDefinitionFactory.TryFromTagConfig("p", "d", json, out var def, out _).ShouldBeTrue();
|
||||
def!.Alarm!.Severity.ShouldBe(HeidenhainTagConfigModel.DefaultAlarmSeverity);
|
||||
|
||||
// An authored severity is never overwritten by a later edit.
|
||||
var edited = NativeAlarmModel.Edit(json, a => a.Severity = 950);
|
||||
var again = HeidenhainTagConfigModel.FromJson(edited);
|
||||
again.Address = "ALARM:*";
|
||||
HeidenhainTagDefinitionFactory.TryFromTagConfig("p", "d", again.ToJson(), out def, out _).ShouldBeTrue();
|
||||
def!.Alarm!.Severity.ShouldBe(950);
|
||||
|
||||
again.Address = "Status/ExecutionState";
|
||||
var plain = again.ToJson();
|
||||
NativeAlarmModel.FromJson(plain).IsAlarm.ShouldBeFalse();
|
||||
TagConfigValidator.Validate(DriverTypeNames.Heidenhain, plain).ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Heidenhain_offers_the_native_alarm_editor_and_a_csv_alarm_row_imports()
|
||||
{
|
||||
NativeAlarmModel.SupportsNativeAlarms(DriverTypeNames.Heidenhain).ShouldBeTrue();
|
||||
var result = RawTagCsvMapper.Parse(DriverTypeNames.Heidenhain,
|
||||
"Name,DataType,AccessLevel,TagConfigJson,Alarm.AlarmType,Alarm.Severity\n" +
|
||||
$"Any,Boolean,Read,{Json("""{"address":"ALARM:*"}""")},AlarmCondition,800\n" +
|
||||
$"NoAlarm,Boolean,Read,{Json("""{"address":"ALARM:*"}""")},,\n");
|
||||
result.Rows[0].Ok.ShouldBeTrue(result.Rows[0].Error);
|
||||
result.Rows[1].Ok.ShouldBeFalse(); // a selector without the alarm object is refused in the preview
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void The_driver_form_round_trips_the_alarm_cadence()
|
||||
{
|
||||
var m = HeidenhainDriverFormModel.FromJson("{}");
|
||||
m.AlarmMs.ShouldBe(2000);
|
||||
m.AlarmMs = 500;
|
||||
var o = HeidenhainOptionsParser.Parse(m.ToJson());
|
||||
o.Polling.AlarmMs.ShouldBe(500);
|
||||
m.AlarmMs = 50;
|
||||
m.Validate()!.ShouldContain("AlarmMs");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user