execute flyway migrations at start-up

pom.xml

@@ -32,6 +32,7 @@
         <java.version>11</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
+        <flyway.version>7.11.3</flyway.version>
         <jooq.version>3.15.1</jooq.version>
         <cxf.version>3.4.4</cxf.version>
         <spring.version>5.3.9</spring.version>
@@ -81,7 +82,7 @@
                     <plugin>
                         <groupId>org.flywaydb</groupId>
                         <artifactId>flyway-maven-plugin</artifactId>
-                        <version>7.11.3</version>
+                        <version>${flyway.version}</version>
 
                         <!-- Must be in the same phase as Jooq -->
                         <executions>
@@ -242,6 +243,7 @@
                 <includes>
                     <include>webapp/static/**</include>
                     <include>webapp/WEB-INF/web.xml</include>
+                    <include>db/**</include>
                 </includes>
             </resource>
         </resources>
@@ -671,6 +673,11 @@
             <artifactId>jooq</artifactId>
             <version>${jooq.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-core</artifactId>
+            <version>${flyway.version}</version>
+        </dependency>
 
         <!-- Test -->
         <dependency>

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

@@ -18,6 +18,7 @@
  */
 package de.rwth.idsg.steve;
 
+import de.rwth.idsg.steve.utils.FlywayMigrationRunner;
 import lombok.extern.slf4j.Slf4j;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
@@ -44,6 +45,8 @@ public Application() {
         DateTimeZone.setDefault(DateTimeZone.forID(sc.getTimeZoneId()));
         log.info("Date/time zone of the application is set to {}. Current date/time: {}", sc.getTimeZoneId(), DateTime.now());
 
+        FlywayMigrationRunner.run(sc);
+
         switch (sc.getProfile()) {
             case DEV:
                 delegate = new SteveDevStarter();

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

@@ -172,6 +172,10 @@ public static class DB {
         private final String userName;
         private final String password;
         private final boolean sqlLogging;
+
+        public String getJdbcUrl() {
+            return "jdbc:mysql://" + ip + ":" + port + "/" + schema;
+        }
     }
 
     // Credentials for Web interface access

src/main/java/de/rwth/idsg/steve/config/BeanConfiguration.java

@@ -84,7 +84,7 @@ private void initDataSource() {
         HikariConfig hc = new HikariConfig();
 
         // set standard params
-        hc.setJdbcUrl("jdbc:mysql://" + dbConfig.getIp() + ":" + dbConfig.getPort() + "/" + dbConfig.getSchema());
+        hc.setJdbcUrl(dbConfig.getJdbcUrl());
         hc.setUsername(dbConfig.getUserName());
         hc.setPassword(dbConfig.getPassword());
 

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

@@ -0,0 +1,43 @@
+package de.rwth.idsg.steve.utils;
+
+import de.rwth.idsg.steve.SteveConfiguration;
+import org.flywaydb.core.api.configuration.FluentConfiguration;
+
+/**
+ * @author Sevket Goekay <sevketgokay@gmail.com>
+ * @since 08.08.2021
+ */
+public class FlywayMigrationRunner {
+
+    private static final String INIT_SQL = "SET default_storage_engine=InnoDB;";
+    private static final String BOOKKEEPING_TABLE = "schema_version";
+    private static final String LOCATION_OF_MIGRATIONS = "db/migration";
+
+    public static void run(SteveConfiguration sc) {
+        try {
+            getConfig(sc.getDb()).load().migrate();
+        } catch (RuntimeException e) {
+            throw e;
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * This configuration should be kept in-sync with the one of the flyway-maven-plugin in pom.xml
+     */
+    private static FluentConfiguration getConfig(SteveConfiguration.DB dbConfig) {
+        FluentConfiguration c = new FluentConfiguration();
+
+        c.initSql(INIT_SQL);
+        c.outOfOrder(true);
+        c.table(BOOKKEEPING_TABLE);
+        c.cleanDisabled(true);
+        c.schemas(dbConfig.getSchema());
+        c.defaultSchema(dbConfig.getSchema());
+        c.locations(LOCATION_OF_MIGRATIONS);
+        c.dataSource(dbConfig.getJdbcUrl(), dbConfig.getUserName(), dbConfig.getPassword());
+
+        return c;
+    }
+}