View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.configuration2;
19  
20  import static org.junit.jupiter.api.Assertions.assertEquals;
21  import static org.junit.jupiter.api.Assertions.assertFalse;
22  import static org.junit.jupiter.api.Assertions.assertNull;
23  import static org.junit.jupiter.api.Assertions.assertSame;
24  import static org.junit.jupiter.api.Assertions.assertThrows;
25  import static org.junit.jupiter.api.Assertions.assertTrue;
26  import static org.mockito.Mockito.mock;
27  
28  import java.lang.reflect.Constructor;
29  import java.util.ArrayList;
30  import java.util.HashSet;
31  import java.util.Iterator;
32  import java.util.List;
33  import java.util.NoSuchElementException;
34  import java.util.Set;
35  
36  import org.apache.commons.configuration2.builder.FileBasedBuilderParametersImpl;
37  import org.apache.commons.configuration2.builder.combined.CombinedConfigurationBuilder;
38  import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler;
39  import org.apache.commons.configuration2.convert.ListDelimiterHandler;
40  import org.apache.commons.configuration2.interpol.ConfigurationInterpolator;
41  import org.junit.jupiter.api.Test;
42  
43  /**
44   * Test case for the {@link SubsetConfiguration} class.
45   */
46  public class TestSubsetConfiguration {
47  
48      static final String TEST_DIR = ConfigurationAssert.TEST_DIR_NAME;
49      static final String TEST_FILE = "testDigesterConfiguration2.xml";
50  
51      @Test
52      public void testClear() {
53          final Configuration config = new BaseConfiguration();
54          config.setProperty("test.key1", "value1");
55          config.setProperty("testing.key2", "value1");
56  
57          final Configuration subset = config.subset("test");
58          subset.clear();
59  
60          assertTrue(subset.isEmpty());
61          assertFalse(config.isEmpty());
62      }
63  
64      /**
65       * Tries to create an instance without a parent configuration.
66       */
67      @Test
68      public void testConstructNullParent() {
69          assertThrows(NullPointerException.class, () -> new SubsetConfiguration(null, ""));
70      }
71  
72      @Test
73      public void testGetChildKey() {
74          final Configuration conf = new BaseConfiguration();
75          // subset with delimiter
76          SubsetConfiguration subset = new SubsetConfiguration(conf, "prefix", ".");
77          assertEquals("key", subset.getChildKey("prefix.key"));
78          assertEquals("", subset.getChildKey("prefix"));
79  
80          // subset without delimiter
81          subset = new SubsetConfiguration(conf, "prefix", null);
82          assertEquals("key", subset.getChildKey("prefixkey"));
83          assertEquals("", subset.getChildKey("prefix"));
84      }
85  
86      @Test
87      public void testGetKeys() {
88          final Configuration conf = new BaseConfiguration();
89          conf.setProperty("test", "value0");
90          conf.setProperty("test.key1", "value1");
91          conf.setProperty("testing.key2", "value1");
92  
93          final Configuration subset = new SubsetConfiguration(conf, "test", ".");
94  
95          final Iterator<String> it = subset.getKeys();
96          assertEquals("", it.next());
97          assertEquals("key1", it.next());
98          assertFalse(it.hasNext());
99      }
100 
101     @Test
102     public void testGetKeysWithPrefix() {
103         final Configuration conf = new BaseConfiguration();
104         conf.setProperty("test.abc", "value0");
105         conf.setProperty("test.abc.key1", "value1");
106         conf.setProperty("test.abcdef.key2", "value1");
107 
108         final Configuration subset = new SubsetConfiguration(conf, "test", ".");
109 
110         final Iterator<String> it = subset.getKeys("abc");
111         assertEquals("abc", it.next());
112         assertEquals("abc.key1", it.next());
113         assertFalse(it.hasNext());
114     }
115 
116     @Test
117     public void testGetList() {
118         final BaseConfiguration conf = new BaseConfiguration();
119         conf.setListDelimiterHandler(new DefaultListDelimiterHandler(','));
120         conf.setProperty("test.abc", "value0,value1");
121         conf.addProperty("test.abc", "value3");
122 
123         final Configuration subset = new SubsetConfiguration(conf, "test", ".");
124         final List<Object> list = subset.getList("abc", new ArrayList<>());
125         assertEquals(3, list.size());
126     }
127 
128     /**
129      * Tests whether the list delimiter handler from the parent configuration is used.
130      */
131     @Test
132     public void testGetListDelimiterHandlerFromParent() {
133         final BaseConfiguration config = new BaseConfiguration();
134         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("prefix");
135         final ListDelimiterHandler listHandler = new DefaultListDelimiterHandler(',');
136         config.setListDelimiterHandler(listHandler);
137         assertSame(listHandler, subset.getListDelimiterHandler());
138     }
139 
140     @Test
141     public void testGetParent() {
142         final Configuration conf = new BaseConfiguration();
143         final SubsetConfiguration subset = new SubsetConfiguration(conf, "prefix", ".");
144 
145         assertEquals(conf, subset.getParent());
146     }
147 
148     @Test
149     public void testGetParentKey() {
150         final Configuration conf = new BaseConfiguration();
151         // subset with delimiter
152         SubsetConfiguration subset = new SubsetConfiguration(conf, "prefix", ".");
153         assertEquals("prefix.key", subset.getParentKey("key"));
154         assertEquals("prefix", subset.getParentKey(""));
155 
156         // subset without delimiter
157         subset = new SubsetConfiguration(conf, "prefix", null);
158         assertEquals("prefixkey", subset.getParentKey("key"));
159         assertEquals("prefix", subset.getParentKey(""));
160     }
161 
162     @Test
163     public void testGetPrefix() {
164         final Configuration conf = new BaseConfiguration();
165         final SubsetConfiguration subset = new SubsetConfiguration(conf, "prefix", ".");
166 
167         assertEquals("prefix", subset.getPrefix());
168     }
169 
170     @Test
171     public void testGetProperty() {
172         final Configuration conf = new BaseConfiguration();
173         conf.setProperty("test.key1", "value1");
174         conf.setProperty("testing.key2", "value1");
175 
176         final Configuration subset = new SubsetConfiguration(conf, "test", ".");
177         assertFalse(subset.isEmpty());
178         assertTrue(subset.containsKey("key1"));
179         assertFalse(subset.containsKey("ng.key2"));
180     }
181 
182     @Test
183     public void testInterpolationForKeysOfTheParent() {
184         final BaseConfiguration config = new BaseConfiguration();
185         config.setProperty("test", "junit");
186         config.setProperty("prefix.key", "${test}");
187         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("prefix");
188         assertEquals("junit", subset.getString("key", ""));
189     }
190 
191     /**
192      * Tests manipulating the interpolator.
193      */
194     @Test
195     public void testInterpolator() {
196         final BaseConfiguration config = new BaseConfiguration();
197         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("prefix");
198         InterpolationTestHelper.testGetInterpolator(subset);
199     }
200 
201     /**
202      * Tests whether a list delimiter handler is used correctly.
203      */
204     @Test
205     public void testListDelimiterHandling() {
206         final BaseConfiguration config = new BaseConfiguration();
207         final Configuration subset = config.subset("prefix");
208         config.setListDelimiterHandler(new DefaultListDelimiterHandler('/'));
209         subset.addProperty("list", "a/b/c");
210         assertEquals(3, config.getList("prefix.list").size());
211 
212         ((AbstractConfiguration) subset).setListDelimiterHandler(new DefaultListDelimiterHandler(';'));
213         subset.addProperty("list2", "a;b;c");
214         assertEquals(3, config.getList("prefix.list2").size());
215     }
216 
217     @Test
218     public void testLocalLookupsInInterpolatorAreInherited() {
219         final BaseConfiguration config = new BaseConfiguration();
220         final ConfigurationInterpolator interpolator = config.getInterpolator();
221         interpolator.registerLookup("brackets", key -> "(" + key + ")");
222         config.setProperty("prefix.var", "${brackets:x}");
223         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("prefix");
224         assertEquals("(x)", subset.getString("var", ""));
225     }
226 
227     @Test
228     public void testNested() throws Exception {
229         final CombinedConfigurationBuilder builder = new CombinedConfigurationBuilder();
230         builder.configure(new FileBasedBuilderParametersImpl().setFile(ConfigurationAssert.getTestFile(TEST_FILE)));
231         final Configuration config = builder.getConfiguration();
232         final Configuration subConf = config.subset("tables.table(0)");
233         assertTrue(subConf.getKeys().hasNext());
234         final Configuration subSubConf = subConf.subset("fields.field(1)");
235         final Iterator<String> itKeys = subSubConf.getKeys();
236         final Set<String> keys = new HashSet<>();
237         keys.add("name");
238         keys.add("type");
239         while (itKeys.hasNext()) {
240             final String k = itKeys.next();
241             assertTrue(keys.contains(k));
242             keys.remove(k);
243         }
244         assertTrue(keys.isEmpty());
245     }
246 
247     @Test
248     public void testPrefixDelimiter() {
249         final BaseConfiguration config = new BaseConfiguration();
250         config.setProperty("part1.part2@test.key1", "value1");
251         config.setProperty("part1.part2", "value2");
252         config.setProperty("part3.part4@testing.key2", "value3");
253 
254         final SubsetConfiguration subset = new SubsetConfiguration(config, "part1.part2", "@");
255         // Check subset properties
256         assertEquals("value1", subset.getString("test.key1"));
257         assertEquals("value2", subset.getString(""));
258         assertNull(subset.getString("testing.key2"));
259 
260         // Check for empty subset configuration and iterator
261         assertEquals(2, subset.size());
262         assertFalse(subset.isEmpty());
263         assertTrue(subset.getKeys().hasNext());
264     }
265 
266     @Test
267     public void testPrefixDelimiterNegativeTest() {
268         final BaseConfiguration config = new BaseConfiguration();
269         config.setProperty("part1.part2@test.key1", "value1");
270         config.setProperty("part3.part4@testing.key2", "value2");
271 
272         final SubsetConfiguration subset = new SubsetConfiguration(config, "part1.part2", "@") {
273             // Anonymous inner class declaration to override SubsetConfiguration.getKeysInternal() - Call
274             // ImutableConfiguration.getKeys(String) on the parent configuration of the SubsetConfiguration in order to
275             // not consequently pass the prefix delimiter
276             @Override
277             protected Iterator<String> getKeysInternal() {
278                 Class<?> subsetIteratorClass;
279                 try {
280                     subsetIteratorClass = Class.forName("org.apache.commons.configuration2.SubsetConfiguration$SubsetIterator");
281                     final Constructor<?> ctor = subsetIteratorClass.getDeclaredConstructor(SubsetConfiguration.class, Iterator.class);
282                     ctor.setAccessible(true);
283 
284                     return (Iterator<String>) ctor.newInstance(this, parent.getKeys("part1.part2"));
285                 } catch (final Exception ex) {
286                     throw new IllegalArgumentException(ex);
287                 }
288             }
289         };
290 
291         // Check subset properties - contains one property
292         assertEquals("value1", subset.getString("test.key1"));
293         assertNull(subset.getString("testing.key2"));
294 
295         // Check for empty subset configuration and iterator - even if the SubsetConfiguration contains properties, like
296         // checked previously its states that it is empty
297         assertEquals(0, subset.size());
298         assertTrue(subset.isEmpty());
299         assertFalse(subset.getKeys().hasNext());
300     }
301 
302     /**
303      * Tests whether the list delimiter handler is also set for the parent configuration.
304      */
305     @Test
306     public void testSetListDelimiterHandlerInParent() {
307         final BaseConfiguration config = new BaseConfiguration();
308         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("prefix");
309         final ListDelimiterHandler listHandler = new DefaultListDelimiterHandler(',');
310         subset.setListDelimiterHandler(listHandler);
311         assertSame(listHandler, config.getListDelimiterHandler());
312     }
313 
314     /**
315      * Tests the case that the parent configuration is not derived from AbstractConfiguration and thus does not support a
316      * list delimiter handler.
317      */
318     @Test
319     public void testSetListDelimiterHandlerParentNotSupported() {
320         final Configuration config = mock(Configuration.class);
321         final SubsetConfiguration subset = new SubsetConfiguration(config, "prefix");
322         final ListDelimiterHandler listHandler = new DefaultListDelimiterHandler(',');
323         subset.setListDelimiterHandler(listHandler);
324         assertSame(listHandler, subset.getListDelimiterHandler());
325     }
326 
327     @Test
328     public void testSetPrefix() {
329         final Configuration conf = new BaseConfiguration();
330         final SubsetConfiguration subset = new SubsetConfiguration(conf, null, ".");
331         subset.setPrefix("prefix");
332 
333         assertEquals("prefix", subset.getPrefix());
334     }
335 
336     @Test
337     public void testSetProperty() {
338         final Configuration conf = new BaseConfiguration();
339         final Configuration subset = new SubsetConfiguration(conf, "test", ".");
340 
341         // set a property in the subset and check the parent
342         subset.setProperty("key1", "value1");
343         assertEquals("value1", subset.getProperty("key1"));
344         assertEquals("value1", conf.getProperty("test.key1"));
345 
346         // set a property in the parent and check in the subset
347         conf.setProperty("test.key2", "value2");
348         assertEquals("value2", conf.getProperty("test.key2"));
349         assertEquals("value2", subset.getProperty("key2"));
350     }
351 
352     @Test
353     public void testThrowExceptionOnMissing() {
354         final BaseConfiguration config = new BaseConfiguration();
355         config.setThrowExceptionOnMissing(true);
356 
357         final SubsetConfiguration subset = new SubsetConfiguration(config, "prefix");
358 
359         assertThrows(NoSuchElementException.class, () -> subset.getString("foo"));
360 
361         config.setThrowExceptionOnMissing(false);
362         assertNull(subset.getString("foo"));
363 
364         subset.setThrowExceptionOnMissing(true);
365         assertThrows(NoSuchElementException.class, () -> config.getString("foo"));
366     }
367 }