Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.TemplateEngine.Tests/Validation/ValidationServiceTests.cs
T
Joseph Doherty 7c14a69091 feat(#23): elevate connection-binding completeness to a deploy-gating Error (M2.8)
Pre-deployment validation only WARNED when a data-sourced attribute had no
connection binding, so an instance with unresolved bindings still passed IsValid
and could deploy. There was also no check that a binding resolves to a connection
that actually exists at the target site.

- ValidationService.Validate gains an opt-in `enforceConnectionBindings` flag
  (default false) plus a `siteConnectionNames` set. Default-false keeps the
  template DESIGN-TIME path (ManagementActor.HandleValidateTemplate) non-blocking,
  since bindings are legitimately set later at instance/deploy time. The DEPLOY
  path (FlatteningPipeline) opts in (true) so:
    * a data-sourced attribute with no binding is now a deploy-gating Error;
    * a binding to a connection that does not exist on the target site is an Error.
  Static (non-data-sourced) attributes are never flagged.
- FlatteningPipeline computes the site-connection-names set from the loaded site
  data connections (mirroring M2.1's alarmCapableConnectionNames) and threads it in.
- Tests: TemplateEngine.Tests covers design-time warning / deploy-time error /
  static-ok / exists-at-site / non-existent-connection. New
  FlatteningPipelineConnectionBindingTests proves the deploy path enforces it.

Mark M2.7 + M2.8 completed in the plan task tracker.
2026-06-16 05:28:06 -04:00

310 lines
11 KiB
C#

using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
using ZB.MOM.WW.ScadaBridge.TemplateEngine.Validation;
namespace ZB.MOM.WW.ScadaBridge.TemplateEngine.Tests.Validation;
public class ValidationServiceTests
{
private readonly ValidationService _sut = new();
[Fact]
public void Validate_ValidConfig_ReturnsSuccess()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes = [new ResolvedAttribute { CanonicalName = "Temp", Value = "25", DataType = "Double" }],
Scripts = [new ResolvedScript { CanonicalName = "Monitor", Code = "var x = 1;" }]
};
var result = _sut.Validate(config);
Assert.True(result.IsValid);
}
[Fact]
public void Validate_EmptyInstanceName_ReturnsError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "",
Attributes = [new ResolvedAttribute { CanonicalName = "Temp", DataType = "Double" }]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.FlatteningFailure);
}
[Fact]
public void Validate_NamingCollision_ReturnsError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute { CanonicalName = "Temp", DataType = "Double" },
new ResolvedAttribute { CanonicalName = "Temp", DataType = "Int32" } // Duplicate!
]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.NamingCollision);
}
[Fact]
public void Validate_ForbiddenApi_ReturnsCompilationError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Scripts =
[
new ResolvedScript
{
CanonicalName = "BadScript",
Code = "System.IO.File.ReadAllText(\"secret.txt\");"
}
]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.ScriptCompilation);
}
[Fact]
public void Validate_MismatchedBraces_ReturnsCompilationError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Scripts =
[
new ResolvedScript { CanonicalName = "Bad", Code = "if (true) {" }
]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.ScriptCompilation);
}
[Fact]
public void Validate_AlarmReferencesMissingAttribute_ReturnsError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes = [new ResolvedAttribute { CanonicalName = "Temp", DataType = "Double" }],
Alarms =
[
new ResolvedAlarm
{
CanonicalName = "HighPressure",
TriggerType = "RangeViolation",
TriggerConfiguration = "{\"attributeName\":\"Pressure\"}" // Pressure doesn't exist
}
]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.AlarmTriggerReference);
}
[Fact]
public void Validate_AlarmReferencesExistingAttribute_NoError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes = [new ResolvedAttribute { CanonicalName = "Temp", DataType = "Double" }],
Alarms =
[
new ResolvedAlarm
{
CanonicalName = "HighTemp",
TriggerType = "RangeViolation",
TriggerConfiguration = "{\"attributeName\":\"Temp\"}"
}
]
};
var result = _sut.Validate(config);
// Should not have alarm trigger reference errors
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.AlarmTriggerReference);
}
[Fact]
public void Validate_ScriptTriggerReferencesMissingAttribute_ReturnsError()
{
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes = [new ResolvedAttribute { CanonicalName = "Temp", DataType = "Double" }],
Scripts =
[
new ResolvedScript
{
CanonicalName = "OnChange",
Code = "var x = 1;",
TriggerConfiguration = "{\"attributeName\":\"Missing\"}"
}
]
};
var result = _sut.Validate(config);
Assert.False(result.IsValid);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.ScriptTriggerReference);
}
[Fact]
public void Validate_UnboundDataSourceAttribute_DesignTime_ReturnsWarningNotError()
{
// M2.8 (#23): at template design time (the default, enforceConnectionBindings:false)
// a data-sourced attribute is legitimately unbound — bindings are set later at
// instance/deploy time. So this must stay a non-blocking WARNING and IsValid true.
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute
{
CanonicalName = "Temp",
DataType = "Double",
DataSourceReference = "ns=2;s=Temp",
BoundDataConnectionId = null // No binding!
}
]
};
var result = _sut.Validate(config);
Assert.Contains(result.Warnings, w => w.Category == ValidationCategory.ConnectionBinding);
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.ConnectionBinding);
Assert.True(result.IsValid);
}
[Fact]
public void Validate_UnboundDataSourceAttribute_DeployTime_ReturnsErrorAndBlocks()
{
// M2.8 (#23): the deploy path opts in (enforceConnectionBindings:true). A data-sourced
// attribute with no binding now gates the deployment as an ERROR (IsValid false).
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute
{
CanonicalName = "Temp",
DataType = "Double",
DataSourceReference = "ns=2;s=Temp",
BoundDataConnectionId = null // No binding!
}
]
};
var result = _sut.Validate(config, enforceConnectionBindings: true);
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.ConnectionBinding);
Assert.False(result.IsValid);
}
[Fact]
public void Validate_StaticAttributeWithoutBinding_DeployTime_NoBindingError()
{
// M2.8 (#23): only DATA-SOURCED attributes require a binding. A static attribute
// (DataSourceReference == null) must remain OK even under deploy-time enforcement.
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute
{
CanonicalName = "Setpoint",
DataType = "Double",
Value = "42",
DataSourceReference = null,
BoundDataConnectionId = null
}
]
};
var result = _sut.Validate(config, enforceConnectionBindings: true);
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.ConnectionBinding);
Assert.True(result.IsValid);
}
[Fact]
public void Validate_BoundToExistingSiteConnection_DeployTime_NoBindingError()
{
// M2.8 (#23): a data-sourced attribute bound to a connection that exists at the
// target site passes the binding gate.
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute
{
CanonicalName = "Temp",
DataType = "Double",
DataSourceReference = "ns=2;s=Temp",
BoundDataConnectionId = 7,
BoundDataConnectionName = "PlantBus"
}
]
};
var result = _sut.Validate(
config,
enforceConnectionBindings: true,
siteConnectionNames: new HashSet<string>(StringComparer.Ordinal) { "PlantBus" });
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.ConnectionBinding);
Assert.True(result.IsValid);
}
[Fact]
public void Validate_BoundToNonExistentSiteConnection_DeployTime_ReturnsError()
{
// M2.8 (#23): a binding pointing at a connection that does NOT exist on the
// target site is an ERROR that blocks deployment.
var config = new FlattenedConfiguration
{
InstanceUniqueName = "Instance1",
Attributes =
[
new ResolvedAttribute
{
CanonicalName = "Temp",
DataType = "Double",
DataSourceReference = "ns=2;s=Temp",
BoundDataConnectionId = 99,
BoundDataConnectionName = "GhostBus"
}
]
};
var result = _sut.Validate(
config,
enforceConnectionBindings: true,
siteConnectionNames: new HashSet<string>(StringComparer.Ordinal) { "PlantBus" });
Assert.Contains(result.Errors, e => e.Category == ValidationCategory.ConnectionBinding);
Assert.False(result.IsValid);
}
[Fact]
public void Validate_EmptyConfig_ReturnsWarning()
{
var config = new FlattenedConfiguration { InstanceUniqueName = "Instance1" };
var result = _sut.Validate(config);
Assert.Contains(result.Warnings, w => w.Category == ValidationCategory.FlatteningFailure);
}
}