[PORT #6167] Improve error/exception message for misconfigured cluste…

…r provider (#6169) * Improve error/exception message for misconfigured cluster provider (#6167) * Improve error/exception message for misconfigured cluster provider * Remove pattern matching * Improve validation to also catch other invalid configuration scenario * Simplify code * Update API Verify list (cherry picked from commit 5f8710d) * Update API Verify list
akkadotnet · Oct 12, 2022 · eba7bf5 · eba7bf5
1 parent d82cdc2
commit eba7bf5
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 9 deletions.
diff --git a/src/contrib/cluster/Akka.Cluster.Sharding.Tests/InvalidSettingsSpec.cs b/src/contrib/cluster/Akka.Cluster.Sharding.Tests/InvalidSettingsSpec.cs
@@ -0,0 +1,26 @@
+// -----------------------------------------------------------------------
+//  <copyright file="InvalidSettingsSpec.cs" company="Akka.NET Project">
+//      Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com>
+//      Copyright (C) 2013-2022 .NET Foundation <https://github.com/akkadotnet/akka.net>
+//  </copyright>
+// -----------------------------------------------------------------------
+
+using Akka.Configuration;
+using Akka.TestKit;
+using FluentAssertions;
+using Xunit;
+using static FluentAssertions.FluentActions;
+
+namespace Akka.Cluster.Sharding.Tests
+{
+    public class InvalidSettingsSpec: AkkaSpec
+    {
+        [Fact(DisplayName = "ClusterSharding started with invalid actor provider should raise a user friendly exception")]
+        public void InvalidActorProviderTest()
+        {
+            Invoking(() => ClusterSharding.Get(Sys)) // throws here
+                .Should().ThrowExactly<ConfigurationException>()
+                .WithMessage("*Did you forgot*");
+        }
+    }
+}
diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Core.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Core.verified.txt
@@ -2206,7 +2206,7 @@ namespace Akka.Configuration
         public ConfigurationException(string message) { }
         public ConfigurationException(string message, System.Exception exception) { }
         protected ConfigurationException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
-        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null) { }
+        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null, string reason = null) { }
     }
     public class ConfigurationFactory
     {

diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt
@@ -2208,7 +2208,7 @@ namespace Akka.Configuration
         public ConfigurationException(string message) { }
         public ConfigurationException(string message, System.Exception exception) { }
         protected ConfigurationException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
-        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null) { }
+        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null, string reason = null) { }
     }
     public class ConfigurationFactory
     {

diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt
@@ -2206,7 +2206,7 @@ namespace Akka.Configuration
         public ConfigurationException(string message) { }
         public ConfigurationException(string message, System.Exception exception) { }
         protected ConfigurationException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
-        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null) { }
+        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null, string reason = null) { }
     }
     public class ConfigurationFactory
     {

diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.verified.txt
@@ -2239,7 +2239,7 @@ namespace Akka.Configuration
         public ConfigurationException(string message) { }
         public ConfigurationException(string message, System.Exception exception) { }
         protected ConfigurationException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
-        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null) { }
+        public static Akka.Configuration.ConfigurationException NullOrEmptyConfig<T>(string path = null, string reason = null) { }
     }
     public class ConfigurationFactory
     {

diff --git a/src/core/Akka.Cluster.Tests/InvalidClusterSettingsSpec.cs b/src/core/Akka.Cluster.Tests/InvalidClusterSettingsSpec.cs
@@ -0,0 +1,31 @@
+// -----------------------------------------------------------------------
+//  <copyright file="InvalidClusterSettingsSpec.cs" company="Akka.NET Project">
+//      Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com>
+//      Copyright (C) 2013-2022 .NET Foundation <https://github.com/akkadotnet/akka.net>
+//  </copyright>
+// -----------------------------------------------------------------------
+
+using Akka.Configuration;
+using Akka.TestKit;
+using FluentAssertions;
+using Xunit;
+using Xunit.Abstractions;
+using static FluentAssertions.FluentActions;
+
+namespace Akka.Cluster.Tests
+{
+    public class InvalidClusterSettingsSpec : AkkaSpec
+    {
+        public InvalidClusterSettingsSpec(ITestOutputHelper output) : base(output)
+        {
+        }
+
+        [Fact(DisplayName = "Cluster started with invalid actor provider should raise a user friendly exception")]
+        public void InvalidActorProviderTest()
+        {
+            Invoking(() => Cluster.Get(Sys)) // throws here
+                .Should().ThrowExactly<ConfigurationException>()
+                .WithMessage("*Did you forgot*");
+        }
+    }
+}
diff --git a/src/core/Akka.Cluster/ClusterSettings.cs b/src/core/Akka.Cluster/ClusterSettings.cs
@@ -34,8 +34,8 @@ public ClusterSettings(Config config, string systemName)
         {
             //TODO: Requiring!
             var clusterConfig = config.GetConfig("akka.cluster");
-            if (clusterConfig.IsNullOrEmpty())
-                throw ConfigurationException.NullOrEmptyConfig<ClusterSettings>("akka.cluster");
+            if (clusterConfig?.GetConfig("failure-detector") == null)
+                throw ConfigurationException.NullOrEmptyConfig<ClusterSettings>("akka.cluster", "Did you forgot to set the 'akka.cluster.provider' HOCON property to 'cluster'?");
 
             LogInfoVerbose = clusterConfig.GetBoolean("log-info-verbose", false);
             LogInfo = LogInfoVerbose || clusterConfig.GetBoolean("log-info", false);

diff --git a/src/core/Akka/Configuration/ConfigurationException.cs b/src/core/Akka/Configuration/ConfigurationException.cs
@@ -16,11 +16,11 @@ namespace Akka.Configuration
     /// </summary>
     public class ConfigurationException : AkkaException
     {
-        public static ConfigurationException NullOrEmptyConfig<T>(string path = null)
+        public static ConfigurationException NullOrEmptyConfig<T>(string path = null, string reason = null)
         {
             if (!string.IsNullOrWhiteSpace(path))
-                return new ConfigurationException($"Failed to instantiate {typeof(T).Name}: Configuration does not contain `{path}` node");
-            return new ConfigurationException($"Failed to instantiate {typeof(T).Name}: Configuration is null or empty.");
+                return new ConfigurationException($"Failed to instantiate {typeof(T).Name}: Configuration does not contain `{path}` node{(reason != null ? $". {reason}" : "")}");
+            return new ConfigurationException($"Failed to instantiate {typeof(T).Name}: Configuration is null or empty{(reason != null ? $". {reason}" : "")}");
         }
 
         /// <summary>