Make runner package internal

- Do not export runner package
- Move logic in MigrationRunner into MigrationEngine
- Make most types in runner package final and package protected

Author: rob-bygrave

ebean-migration/src/main/java/io/ebean/migration/MigrationRunner.java

@@ -1,7 +1,7 @@
 package io.ebean.migration;
 
 import io.avaje.applog.AppLog;
-import io.ebean.migration.runner.*;
+import io.ebean.migration.runner.MigrationEngine;
 
 import javax.sql.DataSource;
 import java.sql.Connection;
@@ -19,8 +19,6 @@ public class MigrationRunner {
 
   protected final MigrationConfig migrationConfig;
 
-  protected List<MigrationResource> checkMigrations;
-
   public MigrationRunner(MigrationConfig migrationConfig) {
     this.migrationConfig = migrationConfig;
   }
@@ -43,8 +41,7 @@ public List<MigrationResource> checkState(DataSource dataSource) {
    * Return the migrations that would be applied if the migration is run.
    */
   public List<MigrationResource> checkState(Connection connection) {
-    run(connection, true);
-    return checkMigrations;
+    return run(connection, true);
   }
 
   /**
@@ -85,118 +82,8 @@ private Connection getConnection(DataSource dataSource) {
   /**
    * Run the migrations if there are any that need running.
    */
-  protected void run(Connection connection, boolean checkStateOnly) {
-    try {
-      LocalMigrationResources resources = new LocalMigrationResources(migrationConfig);
-      if (!resources.readResources() && !resources.readInitResources()) {
-        log.log(DEBUG, "no migrations to check");
-        return;
-      }
-
-      long startMs = System.currentTimeMillis();
-      connection.setAutoCommit(false);
-      MigrationPlatform platform = derivePlatformName(migrationConfig, connection);
-      new MigrationSchema(migrationConfig, connection).createAndSetIfNeeded();
-
-      MigrationTable table = new MigrationTable(migrationConfig, connection, checkStateOnly, platform);
-      table.createIfNeededAndLock();
-      try {
-        List<LocalMigrationResource> migrations = resources.versions();
-        runMigrations(migrations, table, checkStateOnly);
-        connection.commit();
-        if (!checkStateOnly) {
-          long commitMs = System.currentTimeMillis();
-          log.log(INFO, "DB migrations completed in {0}ms - executed:{1} totalMigrations:{2}", (commitMs - startMs), table.count(), migrations.size());
-          int countNonTransactional = table.runNonTransactional();
-          if (countNonTransactional > 0) {
-            log.log(INFO, "Non-transactional DB migrations completed in {0}ms - executed:{1}", (System.currentTimeMillis() - commitMs), countNonTransactional);
-          }
-        }
-      } finally {
-        table.unlockMigrationTable();
-      }
-
-    } catch (MigrationException e) {
-      rollback(connection);
-      throw e;
-
-    } catch (Exception e) {
-      rollback(connection);
-      throw new RuntimeException(e);
-
-    } finally {
-      close(connection);
-    }
-  }
-
-  /**
-   * Run all the migrations as needed.
-   */
-  private void runMigrations(List<LocalMigrationResource> localVersions, MigrationTable table, boolean checkStateMode) throws SQLException {
-    // get the migrations in version order
-    if (table.isEmpty()) {
-      LocalMigrationResource initVersion = getInitVersion();
-      if (initVersion != null) {
-        // run using a dbinit script
-        log.log(INFO, "dbinit migration version:{0}  local migrations:{1}  checkState:{2}", initVersion, localVersions.size(), checkStateMode);
-        checkMigrations = table.runInit(initVersion, localVersions);
-        return;
-      }
-    }
-    checkMigrations = table.runAll(localVersions);
-  }
-
-  /**
-   * Return the last init migration.
-   */
-  private LocalMigrationResource getInitVersion() {
-    LocalMigrationResources initResources = new LocalMigrationResources(migrationConfig);
-    if (initResources.readInitResources()) {
-      List<LocalMigrationResource> initVersions = initResources.versions();
-      if (!initVersions.isEmpty()) {
-        return initVersions.get(initVersions.size() - 1);
-      }
-    }
-    return null;
+  private List<MigrationResource> run(Connection connection, boolean checkStateOnly) {
+    return new MigrationEngine(migrationConfig).run(connection, checkStateOnly);
   }
 
-  /**
-   * Return the platform deriving from connection if required.
-   */
-  private MigrationPlatform derivePlatformName(MigrationConfig migrationConfig, Connection connection) {
-    final String platform = migrationConfig.getPlatform();
-    if (platform != null) {
-      return DbNameUtil.platform(platform);
-    }
-    // determine the platform from the db connection
-    String derivedPlatformName = DbNameUtil.normalise(connection);
-    migrationConfig.setPlatform(derivedPlatformName);
-    return DbNameUtil.platform(derivedPlatformName);
-  }
-
-  /**
-   * Close the connection logging if an error occurs.
-   */
-  private void close(Connection connection) {
-    try {
-      if (connection != null) {
-        connection.close();
-      }
-    } catch (SQLException e) {
-      log.log(WARNING, "Error closing connection", e);
-    }
-  }
-
-  /**
-   * Rollback the connection logging if an error occurs.
-   */
-  private void rollback(Connection connection) {
-    try {
-      if (connection != null) {
-        connection.rollback();
-      }
-    } catch (SQLException e) {
-      log.log(WARNING, "Error on connection rollback", e);
-    }
-  }
 }

ebean-migration/src/main/java/io/ebean/migration/runner/Checksum.java

@@ -9,7 +9,7 @@
 /**
  * Calculates the checksum for the given string content.
  */
-class Checksum {
+final class Checksum {
 
   /**
    * Returns the checksum of the string content.

…/java/io/ebean/migration/DbNameUtil.java …o/ebean/migration/runner/DbNameUtil.javaebean-migration/src/main/java/io/ebean/migration/DbNameUtil.java renamed to ebean-migration/src/main/java/io/ebean/migration/runner/DbNameUtil.java ebean-migration/src/main/java/io/ebean/migration/DbNameUtil.java renamed to ebean-migration/src/main/java/io/ebean/migration/runner/DbNameUtil.java

@@ -1,6 +1,4 @@
-package io.ebean.migration;
-
-import io.ebean.migration.runner.MigrationPlatform;
+package io.ebean.migration.runner;
 
 import java.sql.*;
 
@@ -61,7 +59,7 @@ private static String readPostgres(Connection connection) {
         }
       }
     } catch (SQLException e) {
-      MigrationRunner.log.log(WARNING, "Error running detection query on Postgres", e);
+      MigrationEngine.log.log(WARNING, "Error running detection query on Postgres", e);
     }
     return POSTGRES;
   }

…/io/ebean/migration/DbPlatformNames.java …an/migration/runner/DbPlatformNames.javaebean-migration/src/main/java/io/ebean/migration/DbPlatformNames.java renamed to ebean-migration/src/main/java/io/ebean/migration/runner/DbPlatformNames.java ebean-migration/src/main/java/io/ebean/migration/DbPlatformNames.java renamed to ebean-migration/src/main/java/io/ebean/migration/runner/DbPlatformNames.java

@@ -1,4 +1,4 @@
-package io.ebean.migration;
+package io.ebean.migration.runner;
 
 /**
  * Known database platform names.

ebean-migration/src/main/java/io/ebean/migration/runner/LocalMigrationResource.java

@@ -6,7 +6,7 @@
 /**
  * A DB migration resource (DDL or Jdbc)
  */
-public abstract class LocalMigrationResource implements MigrationResource {
+abstract class LocalMigrationResource implements MigrationResource {
 
   protected final MigrationVersion version;
 
@@ -17,34 +17,35 @@ public abstract class LocalMigrationResource implements MigrationResource {
   /**
    * Construct with version and resource.
    */
-  public LocalMigrationResource(MigrationVersion version, String location) {
+  LocalMigrationResource(MigrationVersion version, String location) {
     this.version = version;
     this.location = location;
     this.type = version.type();
   }
 
+  @Override
   public String toString() {
     return version.toString();
   }
 
   /**
    * Return true if the underlying version is "repeatable".
    */
-  public boolean isRepeatable() {
+  boolean isRepeatable() {
     return version.isRepeatable();
   }
 
   /**
    * Return true if the underlying version is "repeatable init".
    */
-  public boolean isRepeatableInit() {
+  boolean isRepeatableInit() {
     return version.isRepeatableInit();
   }
 
   /**
    * Return true if the underlying version is "repeatable last".
    */
-  public boolean isRepeatableLast() {
+  boolean isRepeatableLast() {
     return version.isRepeatableLast();
   }
 
@@ -87,7 +88,7 @@ public String type() {
   /**
    * Set the migration to be an Init migration.
    */
-  public void setInitType() {
+  void setInitType() {
     this.type = MigrationVersion.BOOTINIT_TYPE;
   }
 }

ebean-migration/src/main/java/io/ebean/migration/runner/LocalMigrationResources.java

@@ -16,7 +16,7 @@
 /**
  * Loads the DB migration resources and sorts them into execution order.
  */
-public final class LocalMigrationResources {
+final class LocalMigrationResources {
 
   private static final System.Logger log = MigrationSchema.log;
 
@@ -28,7 +28,7 @@ public final class LocalMigrationResources {
   /**
    * Construct with configuration options.
    */
-  public LocalMigrationResources(MigrationConfig migrationConfig) {
+  LocalMigrationResources(MigrationConfig migrationConfig) {
     this.migrationConfig = migrationConfig;
     this.classLoader = migrationConfig.getClassLoader();
     this.searchForJdbcMigrations = migrationConfig.getJdbcMigrationFactory() != null;
@@ -37,14 +37,14 @@ public LocalMigrationResources(MigrationConfig migrationConfig) {
   /**
    * Read the init migration resources (usually only 1) returning true if there are versions.
    */
-  public boolean readInitResources() {
+  boolean readInitResources() {
     return readResourcesForPath(migrationConfig.getMigrationInitPath());
   }
 
   /**
    * Read all the migration resources (SQL scripts) returning true if there are versions.
    */
-  public boolean readResources() {
+  boolean readResources() {
     return readResourcesForPath(migrationConfig.getMigrationPath());
   }
 
@@ -134,14 +134,14 @@ private LocalMigrationResource createScriptMigration(Resource resource, String f
   /**
    * Return the list of migration resources in version order.
    */
-  public List<LocalMigrationResource> versions() {
+  List<LocalMigrationResource> versions() {
     return versions;
   }
 
   /**
    * Filter used to find the migration scripts.
    */
-  private static class Match implements Predicate<String> {
+  private static final class Match implements Predicate<String> {
 
     private final boolean searchJdbc;
 
@@ -158,7 +158,7 @@ public boolean test(String name) {
   /**
    * Filter to find JDBC migrations only.
    */
-  private static class JdbcOnly implements Predicate<String> {
+  private static final class JdbcOnly implements Predicate<String> {
     @Override
     public boolean test(String name) {
       return name.endsWith(".class") && !name.contains("$");