DataDriven Config View

Simple tool for creating views over the typesafe config.

Usage

Lets take the following config as an example:

myapp {
  kafka {
    brokers = ["broker1:9092", "broker2:9092", "broker3.9092"]
    group-id = "my-group-id"
    shutdown-timeout = 1 second
  }
}

If you want this config in your app, you will meet a lot of obstacles along the way. The main problem is, that the config contract is not clearly defined and mocking configuration in yours tests will be painful.

To make the configuration less painful to use, let's define a clear contract for our application.

@ConfigView
interface MyConfigView {

  @ConfigView.StringList(path = "brokers")
  List<String> brokers();
  
  @ConfigView.String(path = "my-group-id")
  String groupId();
  
  @ConfigView.Duration(path = "shutdown-timeout")
  Duration shutdownTimeout();
}

Now we can simply create a view over our config and make the application great again ;)

final MyConfigView view = ConfigViewFactory.create(MyConfigView.class, config, "myapp.kafka");

Building

To build the Config View artifacts, the following dependencies are required:

• Git
• Java 8

Building the project itself is a matter of:

git clone https://github.com/datadrivencz/configview
cd configview
./gradlew publishToMavenLocal

Contact us

Feel free to open an issue in the issue tracker.

License

Config View is licensed under the terms of the Apache License 2.0.

Project information

• Config View is built on top of Byte Buddy
• Java code is formatted using google-format-java
• Code is built using gradle