(ratis) branch master updated: RATIS-1957. Preconditions incorrectly sets an exception message (#981)

[szetszwo]

This is an automated email from the ASF dual-hosted git repository.

szetszwo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git


The following commit(s) were added to refs/heads/master by this push:
     new 0d963e2ce RATIS-1957. Preconditions incorrectly sets an exception 
message (#981)
0d963e2ce is described below

commit 0d963e2ceec9045497bea1e4e2a939e84f36242a
Author: Tsz-Wo Nicholas Sze <szets...@apache.org>
AuthorDate: Thu Dec 7 14:19:58 2023 -0800

    RATIS-1957. Preconditions incorrectly sets an exception message (#981)
---
 .../java/org/apache/ratis/util/Preconditions.java     | 11 +++++++----
 .../java/org/apache/ratis/util/TestPreconditions.java | 19 +++++++++++++++++++
 2 files changed, 26 insertions(+), 4 deletions(-)

diff --git 
a/ratis-common/src/main/java/org/apache/ratis/util/Preconditions.java 
b/ratis-common/src/main/java/org/apache/ratis/util/Preconditions.java
index 902c1f5e6..36e647f0f 100644
--- a/ratis-common/src/main/java/org/apache/ratis/util/Preconditions.java
+++ b/ratis-common/src/main/java/org/apache/ratis/util/Preconditions.java
@@ -43,6 +43,9 @@ public interface Preconditions {
    */
   static void assertTrue(boolean value, Object message) {
     if (!value) {
+      if (message instanceof Supplier) {
+        message = ((Supplier<?>) message).get();
+      }
       throw new IllegalStateException(String.valueOf(message));
     }
   }
@@ -84,7 +87,7 @@ public interface Preconditions {
         () -> name + ": expected == " + expected + " but computed == " + 
computed);
   }
 
-  static void assertNull(Object object, Supplier<String> message) {
+  static void assertNull(Object object, Supplier<Object> message) {
     assertTrue(object == null, message);
   }
 
@@ -93,14 +96,14 @@ public interface Preconditions {
         + name + " = " + object + " != null, class = " + object.getClass());
   }
 
-  static <T> T assertNotNull(T object, Supplier<String> message) {
+  static <T> T assertNotNull(T object, Supplier<Object> message) {
     assertTrue(object != null, message);
     return object;
   }
 
   static <T> T assertNotNull(T object, String name) {
-    return assertNotNull(object, () -> name + " is expected to not be null but 
"
-        + name + " = " + object + " == null, class = " + object.getClass());
+    Preconditions.assertTrue(object != null, () -> name + " == null");
+    return object;
   }
 
   static <T> T assertNotNull(T object, String format, Object... args) {
diff --git 
a/ratis-test/src/test/java/org/apache/ratis/util/TestPreconditions.java 
b/ratis-test/src/test/java/org/apache/ratis/util/TestPreconditions.java
index 7ea3cf7b6..884c1e5d5 100644
--- a/ratis-test/src/test/java/org/apache/ratis/util/TestPreconditions.java
+++ b/ratis-test/src/test/java/org/apache/ratis/util/TestPreconditions.java
@@ -22,7 +22,9 @@ import org.junit.Test;
 
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 public class TestPreconditions extends BaseTest {
@@ -50,4 +52,21 @@ public class TestPreconditions extends BaseTest {
 
     Preconditions.assertUnique(three, Arrays.asList(4, 5, 6));
   }
+
+  @Test(timeout = 1000)
+  public void testAssertNull() {
+    final Map<String, String> map = new HashMap<>();
+    final String key = "abc1234";
+    // putNew will call Preconditions.assertNull(..) to assert the entry does 
not exist in the map
+    // putNew the first time should work
+    CollectionUtils.putNew(key, key, map, () -> "m");
+    Preconditions.assertTrue(map.containsKey(key));
+
+    // putNew the second time should fail
+    final Throwable e = testFailureCase("put " + key + " again",
+        () -> CollectionUtils.putNew(key, key, map, () -> "m"),
+        IllegalStateException.class);
+    // The message should contain the key name
+    Preconditions.assertTrue(e.getMessage().contains(key));
+  }
 }