Merge pull request #287 from adrienlauer/check-tool

Checktool

Author: adrienlauer

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Version 3.12.0 (2021-01-31)
 
 * [new] Java 15 support
+* [new] The `check` tool analyzes and show discrepancies between configuration files (actual config) and configuration objects (expected config).
 * [chg] Move main entrypoint logic from `SeedMain.main()` to `Seed.launch()`, allowing custom main methods in addition to the built-in `SeedMain`. 
 * [chg] Upgrade Shiro to 1.7.1 (fixes CVE-2020-11989, CVE-2020-17510, CVE-2020-1957, CVE-2020-13933 and CVE-2019-12422).
 * [chg] Upgrade Guice to 5.0.1

core/pom.xml

@@ -151,6 +151,12 @@
             <version>${glassfish-javax.el.version}</version>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.hibernate</groupId>
+            <artifactId>hibernate-validator</artifactId>
+            <version>${hibernate-validator.version}</version>
+            <optional>true</optional>
+        </dependency>
 
         <!-- Test dependencies -->
         <dependency>

core/src/main/java/org/seedstack/seed/core/Seed.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.core;
 
 import com.google.common.base.Strings;

core/src/main/java/org/seedstack/seed/core/SeedRuntime.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.core;
 
 import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;

core/src/main/java/org/seedstack/seed/core/internal/CoreErrorCode.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.core.internal;
 
 import org.seedstack.shed.exception.ErrorCode;

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

@@ -0,0 +1,65 @@
+/*
+ * Copyright © 2013-2021, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.seed.core.internal.configuration.tool;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import io.nuun.kernel.api.plugin.InitState;
+import io.nuun.kernel.api.plugin.context.InitContext;
+import io.nuun.kernel.api.plugin.request.ClasspathScanRequest;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import org.seedstack.coffig.Coffig;
+import org.seedstack.coffig.Config;
+import org.seedstack.seed.core.SeedRuntime;
+import org.seedstack.seed.core.internal.AbstractSeedTool;
+
+public abstract class AbstractConfigTool extends AbstractSeedTool {
+    final Node root = new Node();
+    @SuppressFBWarnings(value = "UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR", justification = "Field is initialized by a call to 'setup' method")
+    Coffig configuration;
+
+    @Override
+    protected void setup(SeedRuntime seedRuntime) {
+        configuration = seedRuntime.getConfiguration();
+    }
+
+    @Override
+    public Collection<ClasspathScanRequest> classpathScanRequests() {
+        return classpathScanRequestBuilder()
+                .annotationType(Config.class)
+                .build();
+    }
+
+    @Override
+    protected InitState initialize(InitContext initContext) {
+        List<Node> nodes = new ArrayList<>();
+        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;
+    }
+
+    private void buildTree(Node node) {
+        Node current = root;
+        String[] path = node.getPath();
+        for (String part : path) {
+            if (!part.isEmpty()) {
+                Node child = current.getChild(part);
+                if (child != null) {
+                    current = child;
+                } else {
+                    current.addChild(node);
+                    break;
+                }
+            }
+        }
+    }
+}