PropertiesTest.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.felix.utils.properties;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import junit.framework.TestCase;
/**
* <p>
* Unit tests on <code>Properties</code>.
* </p>
*
* @author jbonofre
*/
public class PropertiesTest extends TestCase {
private final static String TEST_PROPERTIES_FILE = "test.properties";
private final static String LINE_SEPARATOR = System.getProperty("line.separator");
private static final String COMMENT = "# comment";
private static final String KEY1 = "mvn:foo/bar";
private static final String KEY1A = "mvn\\:foo/bar";
private static final String KEY2 = "foo:bar:version:type:classifier";
private static final String KEY2A = "foo\\:bar\\:version\\:type\\:classifier";
private static final String VALUE1 = "value";
private Properties properties;
/*
* (non-Javadoc)
* @see junit.framework.TestCase#setUp()
*/
public void setUp() throws Exception {
properties = new Properties();
properties.load(this.getClass().getClassLoader().getResourceAsStream(TEST_PROPERTIES_FILE));
}
public void testSpaces() throws Exception {
String config = "\n" +
"\n" +
" \n" +
" \n" +
" \\ \\r \\n \\t \\f\n" +
" \n" +
" \n" +
"! dshfjklahfjkldashgjl;as\n" +
" #jdfagdfjagkdjfghksdajfd\n" +
" \n" +
"!!properties\n" +
"\n" +
"a=a\n" +
"b bb as,dn \n" +
"c\\r\\ \\t\\nu =:: cu\n" +
"bu= b\\\n" +
" u\n" +
"d=d\\r\\ne=e\n" +
"f :f\\\n" +
"f\\\n" +
" f\n" +
"g g\n" +
"h\\u0020h\n" +
"\\ i=i\n" +
"j=\\ j\n" +
"space=\\ c\n" +
"\n" +
"dblbackslash=\\\\\n" +
" \n";
java.util.Properties props1 = new java.util.Properties();
props1.load(new StringReader(config));
org.apache.felix.utils.properties.Properties props2 = new org.apache.felix.utils.properties.Properties();
props2.load(new StringReader(config));
assertEquals("1", "\n \t \f", props1.getProperty(" \r"));
assertEquals("2", "a", props1.getProperty("a"));
assertEquals("3", "bb as,dn ", props1.getProperty("b"));
assertEquals("4", ":: cu", props1.getProperty("c\r \t\nu"));
assertEquals("5", "bu", props1.getProperty("bu"));
assertEquals("6", "d\r\ne=e", props1.getProperty("d"));
assertEquals("7", "fff", props1.getProperty("f"));
assertEquals("8", "g", props1.getProperty("g"));
assertEquals("9", "", props1.getProperty("h h"));
assertEquals("10", "i=i", props1.getProperty(" "));
assertEquals("11", " j", props1.getProperty("j"));
assertEquals("12", " c", props1.getProperty("space"));
assertEquals("13", "\\", props1.getProperty("dblbackslash"));
assertEquals("1", "\n \t \f", props2.getProperty(" \r"));
assertEquals("2", "a", props2.getProperty("a"));
assertEquals("3", "bb as,dn ", props2.getProperty("b"));
assertEquals("4", ":: cu", props2.getProperty("c\r \t\nu"));
assertEquals("5", "bu", props2.getProperty("bu"));
assertEquals("6", "d\r\ne=e", props2.getProperty("d"));
assertEquals("7", "fff", props2.getProperty("f"));
assertEquals("8", "g", props2.getProperty("g"));
assertEquals("9", "", props2.getProperty("h h"));
assertEquals("10", "i=i", props2.getProperty(" "));
assertEquals("11", " j", props2.getProperty("j"));
assertEquals("12", " c", props2.getProperty("space"));
assertEquals("13", "\\", props2.getProperty("dblbackslash"));
assertEquals(props1, props2);
}
public void testConfigInterpolation() throws IOException
{
String config = "a=$\\\\\\\\{var}\n" +
"ab=${a}b\n" +
"abc=${ab}c";
java.util.Properties props1 = new java.util.Properties();
props1.load(new StringReader(config));
InterpolationHelper.performSubstitution((Map) props1);
org.apache.felix.utils.properties.Properties props2 = new org.apache.felix.utils.properties.Properties();
props2.load(new StringReader(config));
assertEquals(props1, props2);
}
/**
* <p>
* Test getting property.
* </p>
*
* @throws Exception
*/
public void testGettingProperty() throws Exception {
assertEquals("test", properties.get("test"));
}
public void testLoadSave() throws IOException {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
pw.println("# ");
pw.println("# The Main ");
pw.println("# ");
pw.println("# Comment ");
pw.println("# ");
pw.println("");
pw.println("# Another comment");
pw.println("");
pw.println("# A value comment");
pw.println("key1 = val1");
pw.println("");
pw.println("# Another value comment");
pw.println("key2 = ${key1}/foo");
pw.println("");
pw.println("# A third comment");
pw.println("key3 = val3");
pw.println("");
Properties props = new Properties();
props.load(new StringReader(sw.toString()));
props.save(System.err);
System.err.println("=====");
props.put("key2", props.get("key2"));
props.put("key3", "foo");
props.save(System.err);
System.err.println("=====");
}
public void testJavaUtilPropertiesCompatibility() throws Exception {
Properties properties = new Properties();
properties.load(this.getClass().getClassLoader().getResourceAsStream(TEST_PROPERTIES_FILE));
String test = properties.getProperty("test");
assertEquals(test, "test");
String defaultValue = properties.getProperty("notfound", "default");
assertEquals(defaultValue, "default");
properties.setProperty("another", "another");
assertEquals(properties.getProperty("another"), "another");
properties.store(System.err, null);
System.err.println("====");
}
private static final String RESULT1 = COMMENT + LINE_SEPARATOR + KEY1A + " = " + VALUE1 + LINE_SEPARATOR;
public void testSaveComment1() throws Exception {
properties.put(KEY1, COMMENT, VALUE1);
StringWriter sw = new StringWriter();
properties.save(sw);
assertTrue(sw.toString(), sw.toString().endsWith(RESULT1));
}
private static final String RESULT1A = COMMENT + LINE_SEPARATOR + KEY2A + " = " + VALUE1 + LINE_SEPARATOR;
public void testSaveComment1a() throws Exception {
properties.put(KEY2, COMMENT, VALUE1);
StringWriter sw = new StringWriter();
properties.save(sw);
assertTrue(sw.toString(), sw.toString().endsWith(RESULT1A));
}
private static final String RESULT2 = COMMENT + LINE_SEPARATOR + COMMENT + LINE_SEPARATOR + KEY1A + " = " + VALUE1 + LINE_SEPARATOR;
public void testSaveComment2() throws Exception {
properties.put(KEY1, Arrays.asList(new String[] {COMMENT, COMMENT}), VALUE1);
StringWriter sw = new StringWriter();
properties.save(sw);
assertTrue(sw.toString(), sw.toString().endsWith(RESULT2));
}
private static final String RESULT3 = COMMENT + LINE_SEPARATOR + COMMENT + LINE_SEPARATOR + KEY1A + " = " + VALUE1 + "\\" + LINE_SEPARATOR+ VALUE1 + LINE_SEPARATOR;
public void testSaveComment3() throws Exception {
properties.put(KEY1, Arrays.asList(new String[] {COMMENT, COMMENT}), Arrays.asList(new String[] {VALUE1, VALUE1}));
StringWriter sw = new StringWriter();
properties.save(sw);
assertTrue(sw.toString(), sw.toString().endsWith(RESULT3));
List<String> rawValue = properties.getRaw(KEY1);
assertEquals(2, rawValue.size());
assertEquals(KEY1A + " = " + VALUE1, rawValue.get(0));
assertEquals(VALUE1, rawValue.get(1));
}
public void testEntrySetValue() throws Exception {
properties.put(KEY1, VALUE1);
ByteArrayOutputStream baos = new ByteArrayOutputStream();
properties.save(baos);
properties = new Properties();
properties.load(new ByteArrayInputStream(baos.toByteArray()));
assertEquals(VALUE1, properties.get(KEY1));
for (Map.Entry<String, String> entry : properties.entrySet()) {
entry.setValue(entry.getValue() + "x");
}
assertEquals(VALUE1 + "x", properties.get(KEY1));
baos = new ByteArrayOutputStream();
properties.save(baos);
properties = new Properties();
properties.load(new ByteArrayInputStream(baos.toByteArray()));
assertEquals(VALUE1 + "x", properties.get(KEY1));
}
public void testMultiValueEscaping() throws IOException {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
pw.println("fruits apple, banana, pear, \\");
pw.println(" cantaloupe, watermelon, \\");
pw.println(" kiwi, mango");
java.util.Properties p = new java.util.Properties();
p.load(new StringReader(sw.toString()));
assertEquals("apple, banana, pear, cantaloupe, watermelon, kiwi, mango", p.getProperty("fruits"));
Properties props = new Properties();
props.load(new StringReader(sw.toString()));
assertEquals("apple, banana, pear, cantaloupe, watermelon, kiwi, mango", props.getProperty("fruits"));
List<String> raw = props.getRaw("fruits");
assertNotNull(raw);
assertEquals(3, raw.size());
assertEquals("fruits apple, banana, pear, ", raw.get(0));
props = new Properties();
props.put("fruits", props.getComments("fruits"), Arrays.asList(
"fruits apple, banana, pear, ",
" cantaloupe, watermelon, ",
" kiwi, mango"));
assertEquals("apple, banana, pear, cantaloupe, watermelon, kiwi, mango", props.getProperty("fruits"));
raw = props.getRaw("fruits");
assertNotNull(raw);
assertEquals(3, raw.size());
assertEquals("fruits apple, banana, pear, ", raw.get(0));
sw = new StringWriter();
props.save(sw);
props = new Properties();
props.load(new StringReader(sw.toString()));
assertEquals("apple, banana, pear, cantaloupe, watermelon, kiwi, mango", props.getProperty("fruits"));
raw = props.getRaw("fruits");
assertNotNull(raw);
assertEquals(3, raw.size());
assertEquals("fruits apple, banana, pear, ", raw.get(0));
props = new Properties();
props.put("fruits", props.getComments("fruits"), Arrays.asList(
" apple, banana, pear, ",
" cantaloupe, watermelon, ",
" kiwi, mango"));
assertEquals("apple, banana, pear, cantaloupe, watermelon, kiwi, mango", props.getProperty("fruits"));
raw = props.getRaw("fruits");
assertNotNull(raw);
assertEquals(3, raw.size());
assertEquals("fruits = apple, banana, pear, ", raw.get(0));
}
public void testUpdate() throws Exception {
Properties p1 = new Properties();
p1.put("fruits", Arrays.asList("#", "# List of fruits", "#"), Arrays.asList(
" apple, banana, pear, ",
" cantaloupe, watermelon, ",
" kiwi, mango"));
p1.put("trees", Arrays.asList("#", "# List of trees", "#"), Arrays.asList(
" fir, oak, maple"));
p1.put("vegetables", Arrays.asList("#", "# List of vegetables", "#"), Arrays.asList(
" potatoes"
));
Properties p2 = new Properties();
p2.put("fruits", Arrays.asList("#", "# List of good fruits", "#"), Arrays.asList(
" apple, banana, pear"));
p2.put("trees", "fir, oak, maple");
p1.update(p2);
assertEquals(2, p1.size());
assertEquals(Arrays.asList("#", "# List of trees", "#"), p1.getComments("trees"));
assertEquals("fir, oak, maple", p1.getProperty("trees"));
assertEquals(Arrays.asList("#", "# List of good fruits", "#"), p1.getComments("fruits"));
assertEquals("apple, banana, pear", p1.getProperty("fruits"));
}
public void testSubstitution() throws IOException
{
String str = "port = 4141" + LINE_SEPARATOR +
"host = localhost" + LINE_SEPARATOR +
"url = https://${host}:${port}/service" + LINE_SEPARATOR;
Properties properties = new Properties();
properties.load(new StringReader(str));
properties.put("url", "https://localhost:4141/service");
StringWriter sw = new StringWriter();
properties.save(sw);
assertEquals(str, sw.toString());
}
}