using Microsoft.Extensions.Configuration; namespace ZB.MOM.WW.ScadaBridge.Host.Tests; /// /// WP-11: Tests for StartupValidator configuration validation. /// public class StartupValidatorTests { private static IConfiguration BuildConfig(Dictionary values) { return new ConfigurationBuilder() .AddInMemoryCollection(values) .Build(); } private static Dictionary ValidCentralConfig() => new() { ["ScadaBridge:Node:Role"] = "Central", ["ScadaBridge:Node:NodeHostname"] = "central-node1", ["ScadaBridge:Node:RemotingPort"] = "8081", ["ScadaBridge:Database:ConfigurationDb"] = "Server=localhost;Database=Config;", ["ScadaBridge:Security:Ldap:Server"] = "ldap.example.com", ["ScadaBridge:Security:JwtSigningKey"] = "test-signing-key-at-least-32-chars-long", ["ScadaBridge:Cluster:SeedNodes:0"] = "akka.tcp://scadabridge@central-node1:8081", ["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@central-node2:8081", // 1fcc4f5: Central requires a pepper (≥16 chars) for the inbound-API peppered-HMAC verifier. ["ScadaBridge:InboundApi:ApiKeyPepper"] = "test-pepper-01234567890", }; private static Dictionary ValidSiteConfig() => new() { ["ScadaBridge:Node:Role"] = "Site", ["ScadaBridge:Node:NodeHostname"] = "site-a-node1", ["ScadaBridge:Node:SiteId"] = "SiteA", ["ScadaBridge:Node:RemotingPort"] = "8082", ["ScadaBridge:Database:SiteDbPath"] = "./data/scadabridge.db", ["ScadaBridge:Cluster:SeedNodes:0"] = "akka.tcp://scadabridge@site-a-node1:8082", ["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@site-a-node2:8082", }; [Fact] public void ValidCentralConfig_PassesValidation() { var config = BuildConfig(ValidCentralConfig()); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void ValidSiteConfig_PassesValidation() { var config = BuildConfig(ValidSiteConfig()); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void MissingRole_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Node:Role"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("Role must be 'Central' or 'Site'", ex.Message); } [Fact] public void InvalidRole_FailsValidation() { var values = ValidCentralConfig(); values["ScadaBridge:Node:Role"] = "Unknown"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("Role must be 'Central' or 'Site'", ex.Message); } [Fact] public void EmptyHostname_FailsValidation() { var values = ValidCentralConfig(); values["ScadaBridge:Node:NodeHostname"] = ""; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("NodeHostname is required", ex.Message); } [Fact] public void MissingHostname_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Node:NodeHostname"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("NodeHostname is required", ex.Message); } [Theory] [InlineData("0")] [InlineData("-1")] [InlineData("65536")] [InlineData("abc")] [InlineData("")] public void InvalidPort_FailsValidation(string port) { var values = ValidCentralConfig(); values["ScadaBridge:Node:RemotingPort"] = port; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("RemotingPort must be 1-65535", ex.Message); } [Theory] [InlineData("1")] [InlineData("8081")] [InlineData("65535")] public void ValidPort_PassesValidation(string port) { var values = ValidCentralConfig(); values["ScadaBridge:Node:RemotingPort"] = port; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Site_MissingSiteId_FailsValidation() { var values = ValidSiteConfig(); values.Remove("ScadaBridge:Node:SiteId"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("SiteId is required for Site nodes", ex.Message); } [Fact] public void Central_MissingConfigurationDb_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Database:ConfigurationDb"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("ConfigurationDb connection string required for Central", ex.Message); } [Fact] public void Central_MissingMachineDataDb_PassesValidation() { // Host-008 regression: MachineDataDb is never consumed anywhere in the // system (only ConfigurationDb is wired into AddConfigurationDatabase). // It is no longer a required key, so its absence must not fail startup. var values = ValidCentralConfig(); values.Remove("ScadaBridge:Database:MachineDataDb"); var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Central_MissingLdapServer_FailsValidation() { // Task 1.4: the LDAP server key nests under Security:Ldap now. The pre-host // preflight validates the nested key and still fails fast for Central. var values = ValidCentralConfig(); values.Remove("ScadaBridge:Security:Ldap:Server"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("Ldap:Server required for Central", ex.Message); } [Fact] public void Central_MissingJwtSigningKey_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Security:JwtSigningKey"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("JwtSigningKey required for Central", ex.Message); } [Fact] public void Central_MissingApiKeyPepper_FailsValidation() { // Guard for 1fcc4f5: Central nodes require a pepper (≥16 chars) to back // the inbound-API peppered-HMAC verifier. A missing pepper must fail fast // so a misconfigured deployment is caught before the actor system starts. var values = ValidCentralConfig(); values.Remove("ScadaBridge:InboundApi:ApiKeyPepper"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("ApiKeyPepper", ex.Message); } [Fact] public void Central_ShortApiKeyPepper_FailsValidation() { // Guard for 1fcc4f5: a pepper shorter than 16 characters must also be rejected. var values = ValidCentralConfig(); values["ScadaBridge:InboundApi:ApiKeyPepper"] = "tooshort"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("ApiKeyPepper", ex.Message); } [Fact] public void Site_ApiKeyPepper_NotRequired() { // Site nodes do not host the inbound API, so the pepper must NOT be required // for them — absence must not fail validation. var values = ValidSiteConfig(); // Explicitly ensure no pepper is present values.Remove("ScadaBridge:InboundApi:ApiKeyPepper"); var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Site_MissingSiteDbPath_FailsValidation() { var values = ValidSiteConfig(); values.Remove("ScadaBridge:Database:SiteDbPath"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("SiteDbPath required for Site nodes", ex.Message); } [Fact] public void FewerThanTwoSeedNodes_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Cluster:SeedNodes:1"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("SeedNodes must have at least 2 entries", ex.Message); } [Fact] public void NoSeedNodes_FailsValidation() { var values = ValidCentralConfig(); values.Remove("ScadaBridge:Cluster:SeedNodes:0"); values.Remove("ScadaBridge:Cluster:SeedNodes:1"); var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("SeedNodes must have at least 2 entries", ex.Message); } [Theory] [InlineData("0")] [InlineData("-1")] [InlineData("65536")] [InlineData("abc")] public void Site_InvalidGrpcPort_FailsValidation(string grpcPort) { var values = ValidSiteConfig(); values["ScadaBridge:Node:GrpcPort"] = grpcPort; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("GrpcPort must be 1-65535", ex.Message); } [Fact] public void Site_ValidGrpcPort_PassesValidation() { var values = ValidSiteConfig(); values["ScadaBridge:Node:GrpcPort"] = "8083"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Central_InvalidGrpcPort_NotValidated() { var values = ValidCentralConfig(); values["ScadaBridge:Node:GrpcPort"] = "0"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Site_SeedNodeOnGrpcPort_FailsValidation() { // Host-004 regression: a site seed node must reference an Akka remoting // endpoint, never the Kestrel HTTP/2 gRPC port. A seed node whose port // equals this node's GrpcPort would make a joining node attempt an // Akka.Remote TCP association against the gRPC listener and fail. var values = ValidSiteConfig(); values["ScadaBridge:Node:GrpcPort"] = "8083"; values["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@site-a-node1:8083"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("must not target the gRPC port", ex.Message); } [Fact] public void Site_SeedNodeOnDefaultGrpcPort_FailsValidation() { // GrpcPort is absent here, so the NodeOptions default of 8083 applies. // A seed node on 8083 must still be rejected. var values = ValidSiteConfig(); values["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@site-a-node2:8083"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("must not target the gRPC port", ex.Message); } [Fact] public void Site_SeedNodesOnRemotingPort_PassesValidation() { // Two distinct site nodes, both seed entries on the remoting port (8082). var values = ValidSiteConfig(); values["ScadaBridge:Node:GrpcPort"] = "8083"; values["ScadaBridge:Cluster:SeedNodes:0"] = "akka.tcp://scadabridge@site-a-node1:8082"; values["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@site-a-node2:8082"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Central_SeedNodeOnPort8083_PassesValidation() { // The gRPC-port rule applies to Site nodes only. A Central node has no // GrpcPort, so a seed node on 8083 must not be rejected. var values = ValidCentralConfig(); values["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@central-node2:8083"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Site_GrpcPortEqualsRemotingPort_FailsValidation() { // Host-007 regression: REQ-HOST-4 requires GrpcPort to differ from // RemotingPort. Identical values cause Kestrel and Akka.Remote to // contend for the same port at runtime. var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8082"; values["ScadaBridge:Node:GrpcPort"] = "8082"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("GrpcPort must differ from RemotingPort", ex.Message); } [Fact] public void Site_DefaultGrpcPortEqualsRemotingPort_FailsValidation() { // GrpcPort absent => NodeOptions default 8083. A site whose RemotingPort // is also 8083 must still be rejected. var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8083"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("GrpcPort must differ from RemotingPort", ex.Message); } [Fact] public void Site_GrpcPortDiffersFromRemotingPort_PassesValidation() { var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8082"; values["ScadaBridge:Node:GrpcPort"] = "8083"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Theory] [InlineData("0")] [InlineData("-1")] [InlineData("65536")] [InlineData("abc")] public void Site_InvalidMetricsPort_FailsValidation(string metricsPort) { var values = ValidSiteConfig(); values["ScadaBridge:Node:MetricsPort"] = metricsPort; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("MetricsPort must be 1-65535", ex.Message); } [Fact] public void Site_ValidMetricsPort_PassesValidation() { var values = ValidSiteConfig(); values["ScadaBridge:Node:MetricsPort"] = "8084"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Site_MetricsPortEqualsRemotingPort_FailsValidation() { // Host-007 regression: the Kestrel metrics (HTTP/1.1) listener port must // differ from RemotingPort. Identical values cause the metrics listener // and Akka.Remote to contend for the same port at runtime. var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8082"; values["ScadaBridge:Node:MetricsPort"] = "8082"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("MetricsPort must differ from RemotingPort", ex.Message); } [Fact] public void Site_MetricsPortEqualsGrpcPort_FailsValidation() { // Host-007 regression: the metrics listener port must differ from GrpcPort. var values = ValidSiteConfig(); values["ScadaBridge:Node:GrpcPort"] = "8083"; values["ScadaBridge:Node:MetricsPort"] = "8083"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("MetricsPort must differ from GrpcPort", ex.Message); } [Fact] public void Site_DefaultMetricsPortEqualsRemotingPort_FailsValidation() { // MetricsPort absent => NodeOptions default 8084. A site whose RemotingPort // is also 8084 must still be rejected. var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8084"; // Keep GrpcPort distinct so only the metrics-vs-remoting rule fires. values["ScadaBridge:Node:GrpcPort"] = "8083"; // Seed nodes default to the remoting port (8082) in ValidSiteConfig; realign // them to 8084 so the seed-vs-grpc rule is not what trips here. values["ScadaBridge:Cluster:SeedNodes:0"] = "akka.tcp://scadabridge@site-a-node1:8084"; values["ScadaBridge:Cluster:SeedNodes:1"] = "akka.tcp://scadabridge@site-a-node2:8084"; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("MetricsPort must differ from RemotingPort", ex.Message); } [Fact] public void Site_MetricsPortDiffersFromRemotingAndGrpc_PassesValidation() { var values = ValidSiteConfig(); values["ScadaBridge:Node:RemotingPort"] = "8082"; values["ScadaBridge:Node:GrpcPort"] = "8083"; values["ScadaBridge:Node:MetricsPort"] = "8084"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void Central_InvalidMetricsPort_NotValidated() { // The metrics-port rules apply to Site nodes only; a Central node runs no // metrics listener, so an out-of-range MetricsPort must not fail startup. var values = ValidCentralConfig(); values["ScadaBridge:Node:MetricsPort"] = "0"; var config = BuildConfig(values); var ex = Record.Exception(() => StartupValidator.Validate(config)); Assert.Null(ex); } [Fact] public void MultipleErrors_AllReported() { var values = new Dictionary { // Role is missing, hostname is missing, port is missing }; var config = BuildConfig(values); var ex = Assert.Throws(() => StartupValidator.Validate(config)); Assert.Contains("Role must be 'Central' or 'Site'", ex.Message); Assert.Contains("NodeHostname is required", ex.Message); Assert.Contains("RemotingPort must be 1-65535", ex.Message); Assert.Contains("SeedNodes must have at least 2 entries", ex.Message); } }