Merge pull request #237 from adrienlauer/full-config-dump

Configuration dump now displays inner properties

Author: adrienlauer

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 3.3.1 (2017-09-15)
+
+* [new] Configuration dump (config tool) now dumps inner properties for maps, collections, arrays and complex objects.
+* [new] Add `isRemembered()` on `SecuritySupport`.
+ 
 # Version 3.3.0 (2017-07-31)
 
 * [new] Print a default banner at startup in case of missing custom `banner.txt`.

core/src/main/java/org/seedstack/seed/core/internal/configuration/tool/ConfigTool.java

@@ -10,9 +10,11 @@
 import io.nuun.kernel.api.plugin.InitState;
 import io.nuun.kernel.api.plugin.context.InitContext;
 import io.nuun.kernel.api.plugin.request.ClasspathScanRequest;
+import org.seedstack.coffig.Coffig;
 import org.seedstack.coffig.Config;
 import org.seedstack.seed.SeedException;
 import org.seedstack.seed.cli.CliArgs;
+import org.seedstack.seed.core.SeedRuntime;
 import org.seedstack.seed.core.internal.AbstractSeedTool;
 import org.seedstack.seed.core.internal.CoreErrorCode;
 
@@ -26,12 +28,18 @@ public class ConfigTool extends AbstractSeedTool {
  private final Node root = new Node();
  @CliArgs
  private String[] args;
+ private Coffig configuration;
 
  @Override
  public String toolName() {
  return "config";
  }
 
+ @Override
+ protected void setup(SeedRuntime seedRuntime) {
+ configuration = seedRuntime.getConfiguration();
+ }
+
  @Override
  public Collection<ClasspathScanRequest> classpathScanRequests() {
  return classpathScanRequestBuilder()
@@ -42,7 +50,7 @@ public Collection<ClasspathScanRequest> classpathScanRequests() {
  @Override
  protected InitState initialize(InitContext initContext) {
  List<Node> nodes = new ArrayList<>();
- initContext.scannedClassesByAnnotationClass().get(Config.class).stream().map(Node::new).forEach(nodes::add);
+ initContext.scannedClassesByAnnotationClass().get(Config.class).stream().map(configClass -> new Node(configClass, configuration)).forEach(nodes::add);
  Collections.sort(nodes);
  nodes.forEach(this::buildTree);
  return InitState.INITIALIZED;
@@ -67,7 +75,7 @@ public Integer call() throws Exception {
  private void info(String[] path) {
  Node node = root.find(Arrays.copyOfRange(path, 0, path.length - 1));
  if (node == null) {
- throw SeedException.createNew(CoreErrorCode.INVALID_CONFIG_PATH).put("path", path);
+ throw SeedException.createNew(CoreErrorCode.INVALID_CONFIG_PATH).put("path", String.join(".", path));
  } else {
  PropertyInfo propertyInfo = node.getPropertyInfo(path[path.length - 1]);
  if (propertyInfo == null) {

core/src/main/java/org/seedstack/seed/core/internal/configuration/tool/Node.java

@@ -7,13 +7,19 @@
  */
 package org.seedstack.seed.core.internal.configuration.tool;
 
+import org.seedstack.coffig.Coffig;
 import org.seedstack.coffig.Config;
 import org.seedstack.coffig.SingleValue;
 import org.seedstack.shed.reflect.Annotations;
+import org.seedstack.shed.reflect.ReflectUtils;
+import org.seedstack.shed.reflect.Types;
 
+import javax.annotation.Nullable;
 import javax.validation.constraints.NotNull;
 import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -24,37 +30,40 @@
 import java.util.Map;
 import java.util.MissingResourceException;
 import java.util.ResourceBundle;
-import java.util.SortedMap;
 import java.util.TreeMap;
 
 import static org.seedstack.shed.reflect.Classes.instantiateDefault;
 import static org.seedstack.shed.reflect.ReflectUtils.makeAccessible;
 import static org.seedstack.shed.reflect.Types.simpleNameOf;
 
 class Node implements Comparable<Node> {
- private final String name;
  private final Class<?> configClass;
+ private final Coffig coffig;
+ private final String name;
  private final Class<?> outermostClass;
  private final int outermostLevel;
  private final String[] path;
+ private final ResourceBundle bundle;
  private final Map<String, PropertyInfo> propertyInfo;
- private final SortedMap<String, Node> children = new TreeMap<>();
+ private final Map<String, Node> children = new TreeMap<>();
 
  Node() {
- this.name = "";
  this.configClass = null;
+ this.coffig = null;
+ this.name = "";
  this.outermostClass = null;
  this.outermostLevel = 0;
  this.path = new String[0];
+ this.bundle = null;
  this.propertyInfo = new HashMap<>();
  }
 
- Node(Class<?> configClass) {
+ Node(Class<?> configClass, Coffig coffig) {
  this.configClass = configClass;
+ this.coffig = coffig;
 
  List<String> path = new ArrayList<>();
  Class<?> previousClass = configClass;
- int nestingLevel = -1;
  do {
  Config annotation = configClass.getAnnotation(Config.class);
  if (annotation == null) {
@@ -64,15 +73,15 @@ class Node implements Comparable<Node> {
  Collections.reverse(splitPath);
  path.addAll(splitPath);
  previousClass = configClass;
- nestingLevel++;
  } while ((configClass = configClass.getDeclaringClass()) != null);
 
  Collections.reverse(path);
  this.outermostClass = previousClass;
  this.outermostLevel = this.outermostClass.getAnnotation(Config.class).value().split("\\.").length;
  this.path = path.toArray(new String[path.size()]);
  this.name = this.path[this.path.length - 1];
- this.propertyInfo = buildPropertyInfo();
+ this.bundle = getResourceBundle();
+ this.propertyInfo = buildPropertyInfo(this.configClass, "", null);
  }
 
  String getName() {
@@ -149,68 +158,86 @@ public int compareTo(Node that) {
  return 0;
  }
 
- private Map<String, PropertyInfo> buildPropertyInfo() {
+ private Map<String, PropertyInfo> buildPropertyInfo(Class<?> configClass, String parentPropertyName, Object defaultInstance) {
  Map<String, PropertyInfo> result = new LinkedHashMap<>();
 
- ResourceBundle bundle = null;
- try {
- bundle = ResourceBundle.getBundle(outermostClass.getName());
- } catch (MissingResourceException e) {
- // ignore
- }
-
- Object defaultInstance;
- try {
- defaultInstance = instantiateDefault(configClass);
- } catch (Exception e) {
- defaultInstance = null;
+ if (defaultInstance == null) {
+ try {
+ defaultInstance = instantiateDefault(configClass);
+ } catch (Exception e) {
+ defaultInstance = null;
+ }
  }
 
  for (Field field : configClass.getDeclaredFields()) {
  if (Modifier.isStatic(field.getModifiers())) {
+ // Skip static fields (not used for configuration)
  continue;
  }
  if (field.getType().isAnnotationPresent(Config.class)) {
+ // Skip fields of type annotated with @Config as they are already detected
  continue;
  }
 
  makeAccessible(field);
 
- PropertyInfo propertyInfo = new PropertyInfo();
  Config configAnnotation = field.getAnnotation(Config.class);
+ Type genericType = field.getGenericType();
  String name;
  if (configAnnotation != null) {
  name = configAnnotation.value();
  } else {
  name = field.getName();
  }
 
+ PropertyInfo propertyInfo = new PropertyInfo();
  propertyInfo.setName(name);
- propertyInfo.setShortDescription(getMessage(bundle, "No description.", buildKey(name)));
- propertyInfo.setLongDescription(getMessage(bundle, null, buildKey(name, "long")));
- propertyInfo.setType(simpleNameOf(field.getGenericType()));
+ propertyInfo.setShortDescription(getMessage("", buildKey(parentPropertyName, name)));
+ propertyInfo.setLongDescription(getMessage(null, buildKey(parentPropertyName, name, "long")));
+ propertyInfo.setType(simpleNameOf(genericType));
  propertyInfo.setSingleValue(field.isAnnotationPresent(SingleValue.class));
+ propertyInfo.setMandatory(isNotNull(field));
  if (defaultInstance != null) {
- try {
- propertyInfo.setDefaultValue(field.get(defaultInstance));
- } catch (IllegalAccessException e) {
- // ignore
- }
+ propertyInfo.setDefaultValue(ReflectUtils.getValue(field, defaultInstance));
+ }
+
+ Class<?> rawClass = Types.rawClassOf(genericType);
+ Type itemType;
+ if (Collection.class.isAssignableFrom(rawClass) && genericType instanceof ParameterizedType) {
+ itemType = Types.rawClassOf(((ParameterizedType) genericType).getActualTypeArguments()[0]);
+ } else if (Map.class.isAssignableFrom(rawClass) && genericType instanceof ParameterizedType) {
+ itemType = Types.rawClassOf(((ParameterizedType) genericType).getActualTypeArguments()[1]);
+ } else if (genericType instanceof Class<?> && ((Class<?>) genericType).isArray()) {
+ itemType = ((Class<?>) genericType).getComponentType();
+ } else {
+ itemType = genericType;
+ }
+ if (!coffig.getMapper().canHandle(itemType)) {
+ propertyInfo.addInnerPropertyInfo(
+ buildPropertyInfo(
+ Types.rawClassOf(itemType),
+ parentPropertyName.isEmpty() ? name : parentPropertyName + "." + name,
+ itemType.equals(genericType) ? ReflectUtils.getValue(field, defaultInstance) : null
+ )
+ );
  }
- propertyInfo.setMandatory(propertyInfo.getDefaultValue() == null && Annotations.on(field).includingMetaAnnotations().find(NotNull.class).isPresent());
 
  result.put(name, propertyInfo);
  }
 
  return result;
  }
 
- private String getMessage(ResourceBundle resourceBundle, String defaultMessage, String key) {
- if (resourceBundle == null) {
+ private boolean isNotNull(Field field) {
+ return Annotations.on(field).includingMetaAnnotations().find(NotNull.class).isPresent();
+ }
+
+ private String getMessage(String defaultMessage, String key) {
+ if (bundle == null) {
  return defaultMessage;
  }
  try {
- return resourceBundle.getString(key);
+ return bundle.getString(key);
  } catch (MissingResourceException e) {
  return defaultMessage;
  }
@@ -227,11 +254,24 @@ private String buildKey(String... parts) {
  }
  }
  for (int i = 0; i < parts.length; i++) {
- sb.append(parts[i]);
- if (i < parts.length - 1) {
- sb.append(".");
+ if (!parts[i].isEmpty()) {
+ sb.append(parts[i]);
+ if (i < parts.length - 1) {
+ sb.append(".");
+ }
  }
  }
  return sb.toString();
  }
+
+ @Nullable
+ private ResourceBundle getResourceBundle() {
+ ResourceBundle bundle;
+ try {
+ bundle = ResourceBundle.getBundle(outermostClass.getName());
+ } catch (MissingResourceException e) {
+ bundle = null;
+ }
+ return bundle;
+ }
 }

core/src/main/java/org/seedstack/seed/core/internal/configuration/tool/PropertyInfo.java

@@ -7,6 +7,10 @@
  */
 package org.seedstack.seed.core.internal.configuration.tool;
 
+import java.util.Collections;
+import java.util.Map;
+import java.util.TreeMap;
+
 class PropertyInfo {
  private String name;
  private String type;
@@ -15,6 +19,7 @@ class PropertyInfo {
  private boolean singleValue;
  private boolean mandatory;
  private Object defaultValue;
+ private Map<String, PropertyInfo> innerPropertyInfo = new TreeMap<>();
 
  String getName() {
  return name;
@@ -71,4 +76,12 @@ Object getDefaultValue() {
  void setDefaultValue(Object defaultValue) {
  this.defaultValue = defaultValue;
  }
+
+ Map<String, PropertyInfo> getInnerPropertyInfo() {
+ return Collections.unmodifiableMap(innerPropertyInfo);
+ }
+
+ void addInnerPropertyInfo(Map<String, PropertyInfo> innerPropertyInfo) {
+ this.innerPropertyInfo.putAll(innerPropertyInfo);
+ }
 }

core/src/main/java/org/seedstack/seed/core/internal/configuration/tool/TreePrinter.java

@@ -8,6 +8,7 @@
 package org.seedstack.seed.core.internal.configuration.tool;
 
 import org.fusesource.jansi.Ansi;
+import org.fusesource.jansi.AnsiRenderer;
 
 import java.io.PrintStream;
 
@@ -65,13 +66,36 @@ private void printProperty(PropertyInfo propertyInfo, String leftPadding, Ansi a
  .a(propertyInfo.isSingleValue() ? "~" : "")
  .a(propertyInfo.isMandatory() ? "*" : "")
  .a(propertyInfo.getName())
- .reset()
- .a(": ")
+ .reset();
+
+ Object defaultValue = propertyInfo.getDefaultValue();
+ if (defaultValue != null) {
+ String stringDefaultValue = String.valueOf(defaultValue);
+ if (!defaultToString(defaultValue).equals(stringDefaultValue)) {
+ ansi
+ .a(" = ")
+ .fgBright(Ansi.Color.GREEN)
+ .a(defaultValue instanceof String ? String.format("\"%s\"", stringDefaultValue) : stringDefaultValue)
+ .reset();
+ }
+ }
+
+ ansi
  .fgBright(Ansi.Color.MAGENTA)
+ .a(" (")
  .a(propertyInfo.getType())
+ .a(")")
  .reset()
- .a(". ")
- .a(propertyInfo.getShortDescription())
+ .a(": ")
+ .a(AnsiRenderer.render(propertyInfo.getShortDescription()))
  .newline();
+
+ for (PropertyInfo child : propertyInfo.getInnerPropertyInfo().values()) {
+ printProperty(child, leftPadding + INDENTATION, ansi);
+ }
+ }
+
+ private static String defaultToString(Object o) {
+ return o.getClass().getName() + "@" + Integer.toHexString(o.hashCode());
  }
 }

security/specs/src/main/resources/org/seedstack/seed/security/SecurityConfig.properties

@@ -7,11 +7,20 @@
 #
 
 realms=The security realms used to authenticate and authorize users.
+realms.name=Name of the security realm.
+realms.permissionResolver=Name of the permission resolver used for this realm (optional).
+realms.roleMapper=Name of the role mapper used for this realm (optional).
 users=Users valid in the application (key: user id, value: user config).
+users.password=The password of the user.
+users.roles=Set of roles granted to the user.
 roles=Application roles (key: app role name, value: corresponding realm role(s)).
 permissions=Application permissions (key: app role name, value: permission(s) granted for this role).
 cache.authorization=Configuration of the authorization cache.
+cache.authorization.enabled=If true, authorization information is cached by the security subsystem.
+cache.authorization.name=The name of the authorization cache if any.
 cache.authentication=Configuration of the authorization cache.
+cache.authentication.enabled=If true, authentication information is cached by the security subsystem.
+cache.authentication.name=The name of the authentication cache if any.
 cache.enabled=If true, security caching is enabled, otherwise realms are queried for each security operation.
 sessions.enabled=If true, security sessions are enabled, otherwise security is session-less.
 sessions.timeout=Session inactivity timeout, in seconds.

specs/src/main/java/org/seedstack/seed/transaction/TransactionConfig.java

@@ -43,8 +43,7 @@ public JtaConfig jta() {
 
  @Config("jta")
  public static class JtaConfig {
- private static final String DEFAULT_USER_TRANSACTION_NAME = "java:comp/UserTransaction";
-
+ private static final String DEFAULT_USER_TRANSACTION_NAME = "java:comp/UserTransaction";
  @SingleValue
  private String txManagerName;
  private String userTxName = DEFAULT_USER_TRANSACTION_NAME;