Merge branch 'master' into 1819-migrate-to-spring-boot-refactor-as-preparation

Author: goekay

README.md

@@ -72,11 +72,11 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
 
 3. Configure SteVe **before** building:
 
-    The basic configuration is defined in [main.properties](src/main/resources/config/prod/main.properties):
-      - You _must_ change [database configuration](src/main/resources/config/prod/main.properties#L9-L13)
-      - You _must_ change [the host](src/main/resources/config/prod/main.properties#L22) to the correct IP address of your server
-      - You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L17-L18)
-      - You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L32-L35)
+    The basic configuration is defined in [application-prod.properties](src/main/resources/application-prod.properties):
+      - You _must_ change [database configuration](src/main/resources/application-prod.properties)
+      - You _must_ change [the host](src/main/resources/application-prod.properties) to the correct IP address of your server
+      - You _must_ change [web interface credentials](src/main/resources/application-prod.properties)
+      - You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/application-prod.properties)
      
     For advanced configuration please see the [Configuration wiki](https://github.com/steve-community/steve/wiki/Configuration)
 
@@ -101,7 +101,7 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
 If you prefer to build and start this project via docker (you can skip the steps 1, 4 and 5 from above), this can be done as follows: `docker compose up -d`
 
 Because the docker compose file is written to build the project for you, you still have to change the project configuration settings from step 3.
-Instead of changing the [main.properties in the prod directory](src/main/resources/config/prod/main.properties), you have to change the [main.properties in the docker directory](src/main/resources/config/docker/main.properties). There you have to change all configurations which are described in step 3.
+Instead of changing the [application-prod.properties](src/main/resources/application-prod.properties), you have to change the [application-docker.properties](src/main/resources/application-docker.properties). There you have to change all configurations which are described in step 3.
 The database password for the user "steve" has to be the same as you have configured it in the docker compose file.
 
 With the default docker compose configuration, the web interface will be accessible at: `http://localhost:8180`

pom.xml

@@ -96,8 +96,12 @@
         <finalName>${project.artifactId}</finalName>
         <resources>
             <resource>
-                <directory>src/main/resources/config/${envName}</directory>
+                <directory>src/main/resources</directory>
                 <filtering>true</filtering>
+                <includes>
+                    <include>application**.properties</include>
+                    <include>logback-spring**.xml</include>
+                </includes>
             </resource>
             <resource>
                 <directory>src/main/resources</directory>
@@ -266,7 +270,8 @@
                         </goals>
                         <configuration>
                             <files>
-                                <file>src/main/resources/config/${envName}/main.properties</file>
+                                <file>src/main/resources/application.properties</file>
+                                <file>src/main/resources/application-${envName}.properties</file>
                             </files>
                         </configuration>
                     </execution>

src/main/java/de/rwth/idsg/steve/ApplicationProfile.java

@@ -24,8 +24,10 @@
  */
 public enum ApplicationProfile {
     DEV,
-    TEST,
-    PROD;
+    DOCKER,
+    KUBERNETES,
+    PROD,
+    TEST;
 
     public static ApplicationProfile fromName(String v) {
         for (ApplicationProfile ap : ApplicationProfile.values()) {
@@ -35,8 +37,4 @@ public static ApplicationProfile fromName(String v) {
         }
         throw new IllegalArgumentException(v);
     }
-
-    public boolean isProd() {
-        return this == PROD;
-    }
 }

src/main/java/de/rwth/idsg/steve/SteveConfiguration.java

@@ -48,7 +48,7 @@ public enum SteveConfiguration {
     private final String timeZoneId = "UTC";  // or ZoneId.systemDefault().getId();
 
     // -------------------------------------------------------------------------
-    // main.properties
+    // application.properties
     // -------------------------------------------------------------------------
 
     private final String contextPath;
@@ -62,7 +62,10 @@ public enum SteveConfiguration {
     private final Jetty jetty;
 
     SteveConfiguration() {
-        PropertiesFileLoader p = new PropertiesFileLoader("main.properties");
+        // Load the profile in order to load the correct application-<profile>.properties file
+        String profileTemp = new PropertiesFileLoader("application.properties").getString("profile");
+
+        PropertiesFileLoader p = new PropertiesFileLoader("application-" + profileTemp.toLowerCase() + ".properties");
 
         contextPath = sanitizeContextPath(p.getOptionalString("context.path"));
         steveVersion = p.getString("steve.version");

src/main/java/de/rwth/idsg/steve/utils/PropertiesFileLoader.java

@@ -18,16 +18,13 @@
  */
 package de.rwth.idsg.steve.utils;
 
-import com.google.common.base.Splitter;
 import com.google.common.base.Strings;
 import lombok.extern.slf4j.Slf4j;
 
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.Collections;
-import java.util.List;
 import java.util.Properties;
 
 /**
@@ -96,18 +93,6 @@ public String getOptionalString(String key) {
         return trim(key, s);
     }
 
-    public List<String> getStringList(String key) {
-        String s = prop.getProperty(key);
-        if (Strings.isNullOrEmpty(s)) {
-            return Collections.emptyList();
-        }
-        s = resolveIfSystemEnv(s);
-        return Splitter.on(",")
-                       .trimResults()
-                       .omitEmptyStrings()
-                       .splitToList(s);
-    }
-
     public boolean getOptionalBoolean(String key) {
         String s = getOptionalString(key);
         if (s == null) {
@@ -119,15 +104,6 @@ public boolean getOptionalBoolean(String key) {
         }
     }
 
-    public Integer getOptionalInt(String key) {
-        String s = getOptionalString(key);
-        if (s == null) {
-            return null;
-        } else {
-            return Integer.parseInt(s);
-        }
-    }
-
     // -------------------------------------------------------------------------
     // Private helpers
     // -------------------------------------------------------------------------

src/main/resources/config/dev/main.properties renamed to src/main/resources/application-dev.properties

@@ -52,7 +52,7 @@ ws.session.select.strategy = ALWAYS_LAST
 # stations into database and accept their requests.
 #
 # CAUTION: setting this property to true is very dangerous, because we will accept EVERY BootNotification or WebSocket
-# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message. 
+# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message.
 #
 auto.register.unknown.stations = false
 

src/main/resources/config/docker/main.properties renamed to src/main/resources/application-docker.properties

@@ -52,7 +52,7 @@ ws.session.select.strategy = ALWAYS_LAST
 # stations into database and accept their requests.
 #
 # CAUTION: setting this property to true is very dangerous, because we will accept EVERY BootNotification or WebSocket
-# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message. 
+# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message.
 #
 auto.register.unknown.stations = false
 

src/main/resources/config/kubernetes/main.properties renamed to src/main/resources/application-kubernetes.properties

@@ -52,7 +52,7 @@ ws.session.select.strategy = ALWAYS_LAST
 # stations into database and accept their requests.
 #
 # CAUTION: setting this property to true is very dangerous, because we will accept EVERY BootNotification or WebSocket
-# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message. 
+# connection attempt from ANY sender as long as the sender knows the URL and sends a valid message.
 #
 auto.register.unknown.stations = false