fix(deploy): wire native-alarm-source capability validation into flattening pipeline (#22)

FlatteningPipeline loaded data connections but never passed the alarm-capable connection set to SemanticValidator, so the native-alarm-source capability check (built but inert) never ran — a source bound to a non-alarm-capable connection deployed silently. Compute the capable set (IAlarmSubscribableConnection: OPC UA + MxGateway) and thread it through ValidationService to SemanticValidator.
2026-06-15 13:20:20 -04:00
parent 2fb608f1b5
commit d6909207a8
4 changed files with 151 additions and 3 deletions
@@ -0,0 +1,96 @@
+using NSubstitute;
+using ZB.MOM.WW.ScadaBridge.Commons.Entities.Instances;
+using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
+using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
+using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
+using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
+using ZB.MOM.WW.ScadaBridge.DeploymentManager;
+using ZB.MOM.WW.ScadaBridge.TemplateEngine.Flattening;
+using ZB.MOM.WW.ScadaBridge.TemplateEngine.Validation;
+
+namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
+
+/// <summary>
+/// M2.1 (#22): proves the FlatteningPipeline actually computes the alarm-capable
+/// connection set from the loaded site data connections and threads it through
+/// ValidationService → SemanticValidator. Before the fix the pipeline loaded the
+/// connections but never passed the capable set, so the native-alarm-source
+/// capability check (built but inert) never ran in production — a source bound to
+/// a non-alarm-capable connection deployed silently.
+/// </summary>
+public class FlatteningPipelineNativeAlarmCapabilityTests
+{
+    private const int InstanceId = 1;
+    private const int TemplateId = 10;
+    private const int SiteId = 100;
+
+    private readonly ITemplateEngineRepository _templateRepo = Substitute.For<ITemplateEngineRepository>();
+    private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
+    private readonly FlatteningPipeline _sut;
+
+    public FlatteningPipelineNativeAlarmCapabilityTests()
+    {
+        _sut = new FlatteningPipeline(
+            _templateRepo,
+            _siteRepo,
+            new FlatteningService(),
+            new ValidationService(),
+            new RevisionHashService());
+    }
+
+    /// <summary>
+    /// Seeds a single-template chain whose only template carries one native alarm
+    /// source bound to <paramref name="connectionName"/>, and a site that owns a
+    /// single data connection of <paramref name="connectionProtocol"/>.
+    /// </summary>
+    private void Arrange(string connectionName, string connectionProtocol, string boundConnectionName)
+    {
+        var template = new Template("Tank") { Id = TemplateId };
+        template.NativeAlarmSources.Add(new TemplateNativeAlarmSource("BoilerAlarms")
+        {
+            ConnectionName = boundConnectionName,
+            SourceReference = "ns=2;s=Boiler",
+        });
+
+        var instance = new Instance("Tank-01") { Id = InstanceId, TemplateId = TemplateId, SiteId = SiteId };
+
+        _templateRepo.GetInstanceByIdAsync(InstanceId, Arg.Any<CancellationToken>()).Returns(instance);
+        _templateRepo.GetTemplateWithChildrenAsync(TemplateId, Arg.Any<CancellationToken>()).Returns(template);
+        _templateRepo.GetCompositionsByTemplateIdAsync(TemplateId, Arg.Any<CancellationToken>())
+            .Returns([]);
+        _templateRepo.GetAllSharedScriptsAsync(Arg.Any<CancellationToken>())
+            .Returns([]);
+
+        var connection = new DataConnection(connectionName, connectionProtocol, SiteId) { Id = 7 };
+        _siteRepo.GetDataConnectionsBySiteIdAsync(SiteId, Arg.Any<CancellationToken>())
+            .Returns([connection]);
+    }
+
+    [Fact]
+    public async Task FlattenAndValidate_NativeAlarmSourceOnNonAlarmCapableConnection_ReportsCapabilityError()
+    {
+        // A "Modbus" connection is NOT alarm-capable (no IAlarmSubscribableConnection adapter).
+        Arrange(connectionName: "PlantBus", connectionProtocol: "Modbus", boundConnectionName: "PlantBus");
+
+        var result = await _sut.FlattenAndValidateAsync(InstanceId);
+
+        Assert.True(result.IsSuccess);
+        Assert.Contains(result.Value.Validation.Errors,
+            e => e.Category == ValidationCategory.NativeAlarmSourceInvalid
+              && e.Message.Contains("alarm-capable"));
+    }
+
+    [Theory]
+    [InlineData("OpcUa")]
+    [InlineData("MxGateway")]
+    public async Task FlattenAndValidate_NativeAlarmSourceOnAlarmCapableConnection_NoCapabilityError(string protocol)
+    {
+        Arrange(connectionName: "Boiler", connectionProtocol: protocol, boundConnectionName: "Boiler");
+
+        var result = await _sut.FlattenAndValidateAsync(InstanceId);
+
+        Assert.True(result.IsSuccess);
+        Assert.DoesNotContain(result.Value.Validation.Errors,
+            e => e.Category == ValidationCategory.NativeAlarmSourceInvalid);
+    }
+}