Fix dbmigration (#1277)

ENH: Support adding a '-- Generated by' comment to DDL including version and timestamp

src/main/java/io/ebean/Ebean.java

@@ -113,7 +113,10 @@ import java.util.concurrent.ConcurrentHashMap;
  */
 public final class Ebean {
   private static final Logger logger = LoggerFactory.getLogger(Ebean.class);
-
+  static {
+    EbeanVersion.getVersion(); // initalizes the version class and logs the version.
+  }
+ 
   /**
    * Manages creation and cache of EbeanServers.
    */

src/main/java/io/ebean/EbeanServerFactory.java

@@ -33,6 +33,10 @@ public class EbeanServerFactory {
 
   private static SpiContainer container;
 
+  static {
+    EbeanVersion.getVersion(); // initalizes the version class and logs the version.
+  }
+
   /**
    * Initialise the container with clustering configuration.
    * <p>

src/main/java/io/ebean/EbeanVersion.java

@@ -0,0 +1,43 @@
+package io.ebean;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+/**
+ * Class to determine the ebean version. (
+ * @author Roland Praml, FOCONIS AG
+ *
+ */
+public class EbeanVersion {
+  private EbeanVersion() {
+    
+  }
+  private static final Logger logger = LoggerFactory.getLogger(EbeanVersion.class);
+  
+  private static String version = "unknown";
+  static {
+    try {
+      Properties prop = new Properties();
+      InputStream in = Ebean.class.getResourceAsStream("/META-INF/maven/io.ebean/ebean/pom.properties");
+      if (in != null) {
+        prop.load(in);
+        in.close();
+        version = prop.getProperty("version");
+      }
+      logger.info("ebean version: {}", version);
+    } catch (IOException e) {
+      logger.warn("Could not determine ebean version: {}", e.getMessage());
+    }
+  }
+  
+  /**
+   * Returns the ebean version (read from /META-INF/maven/io.ebean/ebean/pom.properties)
+   */
+  public static String getVersion() {
+    return version;
+  }
+  
+}

src/main/java/io/ebean/config/DbMigrationConfig.java

@@ -1,11 +1,16 @@
 package io.ebean.config;
 
+import io.ebean.EbeanVersion;
 import io.ebean.annotation.Platform;
 import io.ebean.migration.MigrationConfig;
 import io.ebean.migration.MigrationRunner;
+import io.ebean.util.StringHelper;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.Map;
 import java.util.Properties;
 
@@ -116,6 +121,11 @@ public class DbMigrationConfig {
    */
   protected boolean strictMode = true;
 
+  /**
+   * Contains the DDL-header information.
+   */
+  protected String ddlHeader;
+
   /**
    * Return the DB platform to generate migration DDL for.
    * <p>
@@ -387,6 +397,14 @@ public class DbMigrationConfig {
     return patchResetChecksumOn;
   }
 
+  /**
+   * Returns a DDL header prepend for each DDL. E.g. for copyright headers
+   * You can use placeholders like ${version} or ${timestamp} in properties file.
+   */
+  public String getDdlHeader() {
+    return ddlHeader;
+  }
+
   /**
    * Set migration versions that should have their checksum reset and not run.
    * <p>
@@ -454,6 +472,11 @@ public class DbMigrationConfig {
     String adminPwd = properties.get("datasource." + serverName + ".password", dbPassword);
     adminPwd = properties.get("datasource." + serverName + ".adminpassword", adminPwd);
     dbPassword = properties.get("migration.dbpassword", adminPwd);
+    ddlHeader = properties.get("ddl.header", ddlHeader);
+    if (ddlHeader != null && !ddlHeader.isEmpty()) {
+      ddlHeader = StringHelper.replaceString(ddlHeader, "${version}", EbeanVersion.getVersion());
+      ddlHeader = StringHelper.replaceString(ddlHeader, "${timestamp}", ZonedDateTime.now().format( DateTimeFormatter.ISO_INSTANT ));
+    }
   }
 
   /**

src/main/java/io/ebeaninternal/dbmigration/ddlgeneration/BaseDdlHandler.java

@@ -66,8 +66,13 @@ public class BaseDdlHandler implements DdlHandler {
   }
 
   @Override
-  public void generateExtra(DdlWrite write) throws IOException {
-    tableDdl.generateExtra(write);
+  public void generateProlog(DdlWrite write) throws IOException {
+    tableDdl.generateProlog(write);
+  }
+
+  @Override
+  public void generateEpilog(DdlWrite write) throws IOException {
+    tableDdl.generateEpilog(write);
   }
 
   @Override

src/main/java/io/ebeaninternal/dbmigration/ddlgeneration/DdlHandler.java

@@ -41,5 +41,7 @@ public interface DdlHandler {
 
   void generate(DdlWrite writer, DropIndex dropIndex) throws IOException;
 
-  void generateExtra(DdlWrite write) throws IOException;
+  void generateProlog(DdlWrite write) throws IOException;
+
+  void generateEpilog(DdlWrite write) throws IOException;
 }

src/main/java/io/ebeaninternal/dbmigration/ddlgeneration/TableDdl.java

@@ -68,8 +68,14 @@ public interface TableDdl {
    */
   void generate(DdlWrite writer, DropIndex dropIndex) throws IOException;
 
+  /**
+  /**
+   * Generate any extra DDL such as stored procedures or TableValueParameters.
+   */
+  void generateProlog(DdlWrite write) throws IOException;
+
   /**
    * Generate any extra DDL such as regeneration of history triggers.
    */
-  void generateExtra(DdlWrite write) throws IOException;
+  void generateEpilog(DdlWrite write) throws IOException;
 }

src/main/java/io/ebeaninternal/dbmigration/ddlgeneration/platform/BaseTableDdl.java

@@ -656,14 +656,20 @@ public class BaseTableDdl implements TableDdl {
     platformDdl.dropHistoryTable(writer, dropHistoryTable);
   }
 
+  @Override
+  public void generateProlog(DdlWrite write) throws IOException {
+    platformDdl.generateProlog(write);
+  }
+
   /**
    * Called at the end to generate additional ddl such as regenerate history triggers.
    */
   @Override
-  public void generateExtra(DdlWrite write) throws IOException {
+  public void generateEpilog(DdlWrite write) throws IOException {
     for (HistoryTableUpdate update : this.regenerateHistoryTriggers.values()) {
       platformDdl.regenerateHistoryTriggers(write, update);
     }
+    platformDdl.generateEpilog(write);
   }
 
   @Override

src/main/java/io/ebeaninternal/dbmigration/ddlgeneration/platform/PlatformDdl.java

@@ -617,4 +617,19 @@ public class PlatformDdl {
     }
     apply.append(String.format("comment on column %s.%s is '%s'", table, column, comment)).endOfStatement();
   }
+
+  /**
+   * Use this to generate a prolog for each script (stored procedures)
+   */
+  public void generateProlog(DdlWrite write) throws IOException {
+
+  }
+
+  /**
+   * Use this to generate an epilog. Will be added at the end of script
+   */
+  public void generateEpilog(DdlWrite write) throws IOException {
+
+  }
+
 }

src/main/java/io/ebeaninternal/dbmigration/model/CurrentModel.java

@@ -107,6 +107,10 @@ public class CurrentModel {
     createDdl();
 
     StringBuilder ddl = new StringBuilder(2000);
+    String header = server.getServerConfig().getMigrationConfig().getDdlHeader();
+    if (header != null && !header.isEmpty()) {
+      ddl.append(header).append('\n');
+    }
     ddl.append(write.apply().getBuffer());
     ddl.append(write.applyForeignKeys().getBuffer());
     ddl.append(write.applyHistory().getBuffer());
@@ -122,6 +126,10 @@ public class CurrentModel {
     createDdl();
 
     StringBuilder ddl = new StringBuilder(2000);
+    String header = server.getServerConfig().getMigrationConfig().getDdlHeader();
+    if (header != null && !header.isEmpty()) {
+      ddl.append(header).append('\n');
+    }
     ddl.append(write.dropAllForeignKeys().getBuffer());
     ddl.append(write.dropAll().getBuffer());
 
@@ -139,7 +147,9 @@ public class CurrentModel {
       write = new DdlWrite(new MConfiguration(), model);
 
       DdlHandler handler = handler();
+      handler.generateProlog(write);
       handler.generate(write, createChangeSet);
+      handler.generateEpilog(write);
     }
   }
 

src/main/java/io/ebeaninternal/dbmigration/model/PlatformDdlWriter.java

@@ -45,14 +45,14 @@ public class PlatformDdlWriter {
   public void processMigration(Migration dbMigration, DdlWrite write, File writePath, String fullVersion) throws IOException {
 
     DdlHandler handler = handler();
-
+    handler.generateProlog(write);
     List<ChangeSet> changeSets = dbMigration.getChangeSet();
     for (ChangeSet changeSet : changeSets) {
       if (isApply(changeSet)) {
         handler.generate(write, changeSet);
       }
     }
-    handler.generateExtra(write);
+    handler.generateEpilog(write);
 
     writePlatformDdl(write, writePath, fullVersion);
   }
@@ -88,6 +88,10 @@ public class PlatformDdlWriter {
    */
   protected void writeApplyDdl(Writer writer, DdlWrite write) throws IOException {
 
+    String header = config.getDdlHeader();
+    if (header != null) {
+      writer.append(header).append('\n');
+    }
     // merge the apply buffers in the appropriate order
     prependDropDependencies(writer, write.applyDropDependencies());
     writer.append("-- apply changes\n");

src/main/java/io/ebeaninternal/dbmigration/model/build/ModelBuildBeanVisitor.java

@@ -90,7 +90,9 @@ public class ModelBuildBeanVisitor implements BeanVisitor {
     if (!descriptor.isIdTypePlatformDefault() || initialValue > 0 || allocationSize > 0) {
       // explicitly set to use sequence or identity (generally not recommended practice)
       if (IdType.IDENTITY == descriptor.getIdType()) {
-        table.setIdentityType(IdentityType.IDENTITY);
+        if (!descriptor.isIdTypePlatformDefault()) {
+          table.setIdentityType(IdentityType.IDENTITY);
+        }
       } else {
         // explicit sequence defined
         table.setIdentityType(IdentityType.SEQUENCE);