Extract tomcat specific configuration to specific module

cuioss · Sep 6, 2023 · fbbe527 · fbbe527
1 parent 662cee4
commit fbbe527
Show file tree

Hide file tree

Showing 29 changed files with 419 additions and 110 deletions.
diff --git a/bom/pom.xml b/bom/pom.xml
@@ -32,6 +32,12 @@
                 <version>${project.version}</version>
                 <scope>runtime</scope>
             </dependency>
+            <dependency>
+                <groupId>de.cuioss.portal.configuration</groupId>
+                <artifactId>portal-configuration-standalone</artifactId>
+                <version>${project.version}</version>
+                <scope>runtime</scope>
+            </dependency>
             <!-- Authentication-->
             <dependency>
                 <groupId>de.cuioss.portal.authentication</groupId>

diff --git a/modules/configuration/pom.xml b/modules/configuration/pom.xml
@@ -56,5 +56,6 @@
         <module>portal-configuration-api</module>
         <module>portal-configuration-impl</module>
         <module>portal-configuration-yaml</module>
+        <module>portal-configuration-standalone</module>
     </modules>
 </project>
diff --git a/modules/configuration/portal-configuration-impl/pom.xml b/modules/configuration/portal-configuration-impl/pom.xml
@@ -26,20 +26,20 @@
             </dependency>
         </dependencies>
     </dependencyManagement>
-  <dependencies>
-    <dependency>
-      <groupId>de.cuioss.portal.configuration</groupId>
-      <artifactId>portal-configuration-api</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>de.cuioss.portal.configuration</groupId>
-      <artifactId>portal-configuration-yaml</artifactId>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>jakarta.inject</groupId>
-      <artifactId>jakarta.inject-api</artifactId>
-    </dependency>
+    <dependencies>
+        <dependency>
+            <groupId>de.cuioss.portal.configuration</groupId>
+            <artifactId>portal-configuration-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>de.cuioss.portal.configuration</groupId>
+            <artifactId>portal-configuration-yaml</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.inject</groupId>
+            <artifactId>jakarta.inject-api</artifactId>
+        </dependency>
         <!-- Test -->
         <dependency>
             <groupId>org.awaitility</groupId>

diff --git a/...impl/src/main/java/de/cuioss/portal/configuration/impl/schedule/ConfigChangeObserver.java b/...impl/src/main/java/de/cuioss/portal/configuration/impl/schedule/ConfigChangeObserver.java
@@ -25,7 +25,6 @@
 import java.nio.file.Paths;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Predicate;
@@ -97,7 +96,7 @@ public class ConfigChangeObserver implements ApplicationInitializer {
     private Instance<FileWatcherService> fileWatcherServices;
 
     @Inject
-    private List<FileConfigurationSource> fileConfigurationSources;
+    private Instance<FileConfigurationSource> fileConfigurationSources;
 
     /** Fired, if the configuration of the changed file has changed */
     @Inject
@@ -172,7 +171,7 @@ private Map<String, String> getAffectedPropertiesAndIndirections(Map<String, Str
             LOGGER.debug("Adding affected properties to delta map: {}", affectedProperties);
             deltaMap.putAll(affectedProperties);
 
-            if (LOOP_LIMIT == i + 1) {
+            if (LOOP_LIMIT == (i + 1)) {
                 LOGGER.debug("Reached loop limit of {} iterations for finding config placeholder indirections",
                         LOOP_LIMIT);
             }
@@ -230,7 +229,7 @@ private Map<String, String> getFileChangeDeltaMap(Path changedFilePath) {
     }
 
     private boolean containsPlaceholder(final String haystack, final String needle) {
-        return null != haystack && null != needle
+        return (null != haystack) && (null != needle)
                 && (haystack.contains("${" + needle + "}") || haystack.contains("${" + needle + ":"));
     }
 

diff --git a/...mpl/src/main/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource b/...mpl/src/main/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource
diff --git a/...l/src/test/java/de/cuioss/portal/configuration/impl/source/FancyYamlFileConfigSource.java b/...l/src/test/java/de/cuioss/portal/configuration/impl/source/FancyYamlFileConfigSource.java
@@ -21,7 +21,7 @@
 public final class FancyYamlFileConfigSource extends YamlConfigSource {
 
     public FancyYamlFileConfigSource() {
-        super("classpath:/config/yml/application.yml");
+        super("classpath:/config/yml/application-user.yml");
     }
 
     @Override

diff --git a/...test/java/de/cuioss/portal/configuration/impl/support/EnablePortalConfigurationLocal.java b/...test/java/de/cuioss/portal/configuration/impl/support/EnablePortalConfigurationLocal.java
@@ -26,9 +26,6 @@
 
 import de.cuioss.portal.configuration.impl.producer.PortalConfigProducer;
 import de.cuioss.portal.configuration.impl.schedule.ConfigChangeObserver;
-import de.cuioss.portal.configuration.impl.source.InstallationConfigSourcePathInitializer;
-import de.cuioss.portal.configuration.impl.source.InstallationFileConfigSource;
-import de.cuioss.portal.configuration.impl.source.InstallationProductionFileConfigSource;
 import io.smallrye.config.inject.ConfigProducer;
 
 /**
@@ -39,8 +36,6 @@
  * <li>{@link ConfigProducer}</li>
  * <li>{@link PortalConfigProducer}</li>
  * <li>{@link PortalConfigurationMock}</li>
- * <li>{@link InstallationFileConfigSource}</li>
- * <li>{@link InstallationProductionFileConfigSource}</li>
  * </ul>
  *
  * @author Sven Haag
@@ -49,6 +44,6 @@
 @Retention(RUNTIME)
 @Target(TYPE)
 @AddBeanClasses({ ConfigProducer.class, PortalConfigProducer.class, PortalConfigurationMock.class,
-        InstallationConfigSourcePathInitializer.class, ConfigChangeObserver.class })
+        ConfigChangeObserver.class })
 public @interface EnablePortalConfigurationLocal {
 }
diff --git a/...mpl/src/test/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource b/...mpl/src/test/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource
@@ -1,8 +1,6 @@
 # Keep this test SPI content in sync with the pom.xml's antrun plugin!
 # Only this way the tests are running fine in your IDE and Maven.
 
-de.cuioss.portal.configuration.impl.source.InstallationFileConfigSource
-de.cuioss.portal.configuration.impl.source.InstallationProductionFileConfigSource
 de.cuioss.portal.configuration.impl.support.TestEnvConfigSource
 de.cuioss.portal.configuration.impl.support.PortalConfigurationMock
 de.cuioss.portal.configuration.impl.support.TestYamlFileConfigurationSource

diff --git a/...onfiguration/portal-configuration-impl/src/test/resources/config/yml/application-user.yml b/...onfiguration/portal-configuration-impl/src/test/resources/config/yml/application-user.yml
@@ -1,2 +1,24 @@
-my.user.key: user-value
-key-with-value: user-value
+key-bool: true
+key-with-value: stringvalue
+key-with-no-value: 
+key-master:
+  key-sub-number: 123456
+  key-sub-master:
+    key-sub-master-bool: yes
+    key-sub-master-string: stringvalue
+nested.key.replacement: ${key-with-value:default-nested-key-value}
+
+#SHOULD RESULT IN THE FOLLOWING PROPERTIES:
+#key-bool = true
+#key-with-value = stringvalue
+#key-with-no-value =
+#key-master.key-sub-number = 123456
+#key-master.key-sub-master.key-sub-master-bool = true
+#key-master.key-sub-master.key-sub-master-string = stringvalue
+
+array:
+  list:
+    - "a"
+    - "b"
+    - c
+string.list: "a,b,c"
diff --git a/modules/configuration/portal-configuration-standalone/README.adoc b/modules/configuration/portal-configuration-standalone/README.adoc
@@ -0,0 +1,15 @@
+= portal-configuration-standalone
+
+== What is it?
+
+Provides structure for configuration that can be used in a non quarkus context. It handle application.yml an so on
+
+=== Maven Coordinates
+
+[source,xml]
+----
+    <dependency>
+        <groupId>de.cuioss.portal.configuration</groupId>
+        <artifactId>portal-configuration-standalone</artifactId>
+    </dependency>
+----
diff --git a/modules/configuration/portal-configuration-standalone/pom.xml b/modules/configuration/portal-configuration-standalone/pom.xml
@@ -0,0 +1,37 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>de.cuioss.portal.configuration</groupId>
+        <artifactId>configuration</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>portal-configuration-standalone</artifactId>
+    <name>Portal Standalone Configuration</name>
+    <description>Provides structure for configuration that can be used in a non
+        quarkus context. It handle application.yml an so on</description>
+    <properties>
+        <maven.jar.plugin.automatic.module.name>
+            de.cuioss.portal.configuration.standalone</maven.jar.plugin.automatic.module.name>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>de.cuioss.portal.configuration</groupId>
+            <artifactId>portal-configuration-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>de.cuioss.portal.configuration</groupId>
+            <artifactId>portal-configuration-impl</artifactId>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>de.cuioss.portal.configuration</groupId>
+            <artifactId>portal-configuration-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.inject</groupId>
+            <artifactId>jakarta.inject-api</artifactId>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/...rce/AbstractInstallationConfigSource.java → ...rce/AbstractInstallationConfigSource.java b/...rce/AbstractInstallationConfigSource.java → ...rce/AbstractInstallationConfigSource.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.cuioss.portal.configuration.impl.source;
+package de.cuioss.portal.configuration.standalone.source;
 
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_DIR;
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_DIR_DEFAULT;
@@ -24,6 +24,7 @@
 
 import de.cuioss.portal.configuration.FileConfigurationSource;
 import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.configuration.impl.source.LoaderUtils;
 import de.cuioss.portal.configuration.source.AbstractPortalConfigSource;
 import de.cuioss.tools.collect.CollectionLiterals;
 import de.cuioss.tools.io.FileSystemLoader;

diff --git a/.../source/InstallationFileConfigSource.java → .../source/InstallationFileConfigSource.java b/.../source/InstallationFileConfigSource.java → .../source/InstallationFileConfigSource.java
@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.cuioss.portal.configuration.impl.source;
+package de.cuioss.portal.configuration.standalone.source;
 
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_FILENAME_DEFAULT;
 
 /**
  * Configuration source for the application.yml file.
  *
- * @author Sven Haag, Sven Haag
+ * @author Sven Haag
  */
 public class InstallationFileConfigSource extends AbstractInstallationConfigSource {
 

diff --git a/...stallationProductionFileConfigSource.java → ...stallationProductionFileConfigSource.java b/...stallationProductionFileConfigSource.java → ...stallationProductionFileConfigSource.java
@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.cuioss.portal.configuration.impl.source;
+package de.cuioss.portal.configuration.standalone.source;
 
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_PRODUCTION_FILENAME_DEFAULT;
 
 /**
  * Configuration source for the application-production.yml file.
  *
- * @author Sven Haag, Sven Haag
+ * @author Sven Haag
  */
 public class InstallationProductionFileConfigSource extends AbstractInstallationConfigSource {
 

diff --git a/...one/src/main/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource b/...one/src/main/resources/META-INF/services/org.eclipse.microprofile.config.spi.ConfigSource
@@ -0,0 +1,2 @@
+de.cuioss.portal.configuration.standalone.source.InstallationFileConfigSource
+de.cuioss.portal.configuration.standalone.source.InstallationProductionFileConfigSource
diff --git a/modules/configuration/portal-configuration-standalone/src/main/resources/beans.xml b/modules/configuration/portal-configuration-standalone/src/main/resources/beans.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_2_0.xsd"
+    bean-discovery-mode="annotated" version="2.0">
+</beans>
diff --git a/...tallationConfigSourcePathInitializer.java → ...tallationConfigSourcePathInitializer.java b/...tallationConfigSourcePathInitializer.java → ...tallationConfigSourcePathInitializer.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.cuioss.portal.configuration.impl.source;
+package de.cuioss.portal.configuration.standalone.source;
 
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_DIR;
 
@@ -26,6 +26,7 @@
 import org.eclipse.microprofile.config.spi.ConfigSource;
 
 import de.cuioss.portal.configuration.ConfigurationSourceChangeEvent;
+import de.cuioss.portal.configuration.standalone.source.AbstractInstallationConfigSource;
 import de.cuioss.tools.logging.CuiLogger;
 
 /**

diff --git a/...rce/InstallationFileConfigSourceTest.java → ...rce/InstallationFileConfigSourceTest.java b/...rce/InstallationFileConfigSourceTest.java → ...rce/InstallationFileConfigSourceTest.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.cuioss.portal.configuration.impl.source;
+package de.cuioss.portal.configuration.standalone.source;
 
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_DIR;
 import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CONFIG_DIR_DEFAULT;
@@ -30,6 +30,7 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 
+import de.cuioss.portal.configuration.standalone.source.InstallationFileConfigSource;
 import de.cuioss.test.juli.TestLogLevel;
 import de.cuioss.test.juli.junit5.EnableTestLogger;
 import de.cuioss.tools.string.Joiner;
@@ -51,7 +52,7 @@ void resolvesPath() {
         assertDoesNotThrow(() -> underTest.getPath());
         assertNotNull(underTest.getPath());
         assertTrue(underTest.getPath().endsWith(
-                Joiner.on(File.separatorChar).join("portal-configuration-impl", "config", "application.yml")));
+                Joiner.on(File.separatorChar).join("portal-configuration-standalone", "config", "application.yml")));
         assertSingleLogMessagePresentContaining(TestLogLevel.WARN, "Portal-121");
         assertSingleLogMessagePresentContaining(TestLogLevel.WARN, "Portal-158");
     }