commit 3453e9879de212af13b4317305969fc3ad5aa4d4
author Heewon Lee <94441510+pingpingy1@users.noreply.github.com> Wed Apr 24 07:05:45 2024 +0900
committer GitHub <noreply@github.com> Tue Apr 23 18:05:45 2024 -0400
tree ad9f19ee7c4a5878ae27e538e5c5dbe28496d148
parent 7ed1c5f4035d64816756e9855023feb6d8604814

Guard MapConfiguration against null maps (#381)

MapConfiguration has a `protected` property `map`, which is provided
upon instantiation and cannot be changed later. The lack of `null`
guards for this property leads to inevitable NPEs at an undetermined
later time. This PR implements a fail-fast guard.

src/main/java/org/apache/commons/configuration2/MapConfiguration.java

diff --git a/src/main/java/org/apache/commons/configuration2/MapConfiguration.java b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
index 4319bdf..aff3b20 100644
--- a/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
@@ -22,6 +22,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Properties;
 
 import org.apache.commons.configuration2.ex.ConfigurationRuntimeException;
@@ -87,7 +88,7 @@
      * @param map the map
      */
     public MapConfiguration(final Map<String, ?> map) {
-        this.map = (Map<String, Object>) map;
+        this.map = (Map<String, Object>) Objects.requireNonNull(map, "map");
     }
 
     /**
@@ -100,7 +101,7 @@
      * @since 1.8
      */
     public MapConfiguration(final Properties props) {
-        map = toMap(props);
+        map = toMap(Objects.requireNonNull(props));
     }
 
     /**

src/test/java/org/apache/commons/configuration2/TestMapConfiguration.java

diff --git a/src/test/java/org/apache/commons/configuration2/TestMapConfiguration.java b/src/test/java/org/apache/commons/configuration2/TestMapConfiguration.java
index c447e65..d0f22d5 100644
--- a/src/test/java/org/apache/commons/configuration2/TestMapConfiguration.java
+++ b/src/test/java/org/apache/commons/configuration2/TestMapConfiguration.java
@@ -19,11 +19,13 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Properties;
 
 import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler;
 import org.apache.commons.configuration2.convert.DisabledListDelimiterHandler;
@@ -154,4 +156,10 @@
         config.setListDelimiterHandler(new DisabledListDelimiterHandler());
         assertEquals(SPACE_VALUE, config.getProperty(KEY));
     }
+
+    @Test
+    public void testNullMap() {
+        assertThrows(NullPointerException.class, () -> new MapConfiguration((Map) null));
+        assertThrows(NullPointerException.class, () -> new MapConfiguration((Properties) null));
+    }
 }