mirage-config/source/mirage/java.d
2022-10-11 21:07:21 +03:00

119 lines
3 KiB
D

/**
* Utilities for loading Java properties files.
*
* Authors:
* Mike Bierlee, m.bierlee@lostmoment.com
* Copyright: 2022 Mike Bierlee
* License:
* This software is licensed under the terms of the MIT license.
* The full terms of the license can be found in the LICENSE file.
*/
module mirage.java;
import mirage.config : ConfigDictionary;
import mirage.keyvalue : KeyValueConfigFactory, SupportHashtagComments, SupportSemicolonComments, SupportSections;
/**
* Creates configuration files from Java properties.
*/
class JavaPropertiesFactory : KeyValueConfigFactory!(
SupportHashtagComments.yes,
SupportSemicolonComments.no,
SupportSections.no
) {
}
/**
* Parse Java properties from the given Java properties string.
* Params:
* properties = Text contents of the config to be parsed.
* Returns: The parsed configuration.
*/
ConfigDictionary parseJavaProperties(const string properties) {
return new JavaPropertiesFactory().parseConfig(properties);
}
/**
* Load a Java properties file from disk.
*
* Params:
* filePath = Path to the Java properties file.
* Returns: The loaded configuration.
*/
ConfigDictionary loadJavaProperties(const string filePath) {
return new JavaPropertiesFactory().loadFile(filePath);
}
version (unittest) {
import std.exception : assertThrown;
import std.process : environment;
import mirage.config : ConfigCreationException;
@("Parse java properties")
unittest {
auto config = parseJavaProperties("
# I have a comment
bla=one
di.bla=two
");
assert(config.get("bla") == "one");
assert(config.get("di.bla") == "two");
}
@("Parse java properties file")
unittest {
auto config = loadJavaProperties("testfiles/java.properties");
assert(config.get("bla") == "one");
assert(config.get("di.bla") == "two");
}
@("Fail to parse when there are too many equals signs")
unittest {
assertThrown!ConfigCreationException(parseJavaProperties("one=two=three"));
}
@("Fail to parse when value assignment is missing")
unittest {
assertThrown!ConfigCreationException(parseJavaProperties("answertolife"));
}
@("Substitute env vars")
unittest {
environment["MIRAGE_TEST_ENVY"] = "Much";
auto config = parseJavaProperties("envy=$MIRAGE_TEST_ENVY");
assert(config.get("envy") == "Much");
}
@("Use value from other key")
unittest {
auto config = parseJavaProperties("
one=money
two=${one}
");
assert(config.get("two") == "money");
}
@("Values and keys are trimmed")
unittest {
auto config = parseJavaProperties("
one = money
");
assert(config.get("one") == "money");
}
@("Remove end-of-line comments")
unittest {
auto config = parseJavaProperties("
server=localhost #todo: change me. default=localhost when not set.
");
assert(config.get("server") == "localhost");
}
}