Refactor extract MigrationResource interface (that is now returned by checkState() methods)

This is effectively a breaking API change for code using the checkState()
methods, these now return the MigrationResource interface rather than the
abstract LocalMigrationResource (which we want to be internal)

Author: rob-bygrave

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

@@ -0,0 +1,83 @@
+package io.ebean.migration;
+
+/**
+ * A DB migration resource - typically a resource containing SQL.
+ */
+public interface MigrationResource extends Comparable<MigrationResource> {
+
+  /**
+   * Return the "key" that identifies the migration.
+   */
+  String key();
+
+  /**
+   * Return the migration comment.
+   */
+  String comment();
+
+  /**
+   * Deprecated migrate to comment().
+   */
+  @Deprecated
+  default String getComment() {
+    return comment();
+  }
+
+  /**
+   * Return the content of the migration.
+   */
+  String content();
+
+  /**
+   * Deprecated migrate to content().
+   */
+  @Deprecated
+  default String getContent() {
+    return content();
+  }
+
+  /**
+   * Default ordering by version.
+   */
+  @Override
+  int compareTo(MigrationResource other);
+
+  /**
+   * Return the underlying migration version.
+   */
+  MigrationVersion version();
+
+  /**
+   * Deprecated migrate to version().
+   */
+  @Deprecated
+  default MigrationVersion getVersion() {
+    return version();
+  }
+
+  /**
+   * Return the resource location.
+   */
+  String location();
+
+  /**
+   * Deprecated migrate to location().
+   */
+  @Deprecated
+  default String getLocation() {
+    return location();
+  }
+
+  /**
+   * Return the type code ("R" or "V") for this migration.
+   */
+  String type();
+
+  /**
+   * Deprecated migrate to type().
+   */
+  @Deprecated
+  default String getType() {
+    return type();
+  }
+}

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

@@ -19,7 +19,7 @@ public class MigrationRunner {
 
   protected final MigrationConfig migrationConfig;
 
-  protected List<LocalMigrationResource> checkMigrations;
+  protected List<MigrationResource> checkMigrations;
 
   public MigrationRunner(MigrationConfig migrationConfig) {
     this.migrationConfig = migrationConfig;
@@ -28,21 +28,21 @@ public MigrationRunner(MigrationConfig migrationConfig) {
   /**
    * Return the migrations that would be applied if the migration is run.
    */
-  public List<LocalMigrationResource> checkState() {
+  public List<MigrationResource> checkState() {
     return checkState(migrationConfig.createConnection());
   }
 
   /**
    * Return the migrations that would be applied if the migration is run.
    */
-  public List<LocalMigrationResource> checkState(DataSource dataSource) {
+  public List<MigrationResource> checkState(DataSource dataSource) {
     return checkState(getConnection(dataSource));
   }
 
   /**
    * Return the migrations that would be applied if the migration is run.
    */
-  public List<LocalMigrationResource> checkState(Connection connection) {
+  public List<MigrationResource> checkState(Connection connection) {
     run(connection, true);
     return checkMigrations;
   }

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

@@ -24,7 +24,7 @@ public LocalDdlMigrationResource(MigrationVersion version, String location, Reso
   /**
    * Return the content for the migration apply ddl script.
    */
-  public String getContent() {
+  public String content() {
     try {
       return resource.loadAsString(StandardCharsets.UTF_8);
     } catch (NullPointerException e) {

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

@@ -40,7 +40,7 @@ public int getChecksum() {
   }
 
   @Override
-  public String getContent() {
+  public String content() {
     return "location:" + location;
   }
 }

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

@@ -1,11 +1,12 @@
 package io.ebean.migration.runner;
 
+import io.ebean.migration.MigrationResource;
 import io.ebean.migration.MigrationVersion;
 
 /**
  * A DB migration resource (DDL or Jdbc)
  */
-public abstract class LocalMigrationResource implements Comparable<LocalMigrationResource> {
+public abstract class LocalMigrationResource implements MigrationResource {
 
   protected final MigrationVersion version;
 
@@ -47,9 +48,8 @@ public boolean isRepeatableLast() {
     return version.isRepeatableLast();
   }
 
-  /**
-   * Return the "key" that identifies the migration.
-   */
+
+  @Override
   public String key() {
     if (isRepeatable()) {
       return version.comment().toLowerCase();
@@ -58,45 +58,29 @@ public String key() {
     }
   }
 
-  /**
-   * Return the migration comment.
-   */
-  public String getComment() {
+  @Override
+  public String comment() {
     String comment = version.comment();
     return (comment == null || comment.isEmpty()) ? "-" : comment;
   }
 
-  /**
-   * Default ordering by version.
-   */
   @Override
-  public int compareTo(LocalMigrationResource o) {
-    return version.compareTo(o.version);
+  public int compareTo(MigrationResource other) {
+    return version.compareTo(other.version());
   }
 
-  /**
-   * Return the underlying migration version.
-   */
-  public MigrationVersion getVersion() {
+  @Override
+  public MigrationVersion version() {
     return version;
   }
 
-  /**
-   * Return the resource location.
-   */
-  public String getLocation() {
+  @Override
+  public String location() {
     return location;
   }
 
-  /**
-   * Return the content of the migration.
-   */
-  public abstract String getContent();
-
-  /**
-   * Return the type code ("R" or "V") for this migration.
-   */
-  public String getType() {
+  @Override
+  public String type() {
     return type;
   }
 

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

@@ -2,10 +2,7 @@
 
 import io.avaje.applog.AppLog;
 import io.ebean.ddlrunner.ScriptTransform;
-import io.ebean.migration.JdbcMigration;
-import io.ebean.migration.MigrationConfig;
-import io.ebean.migration.MigrationException;
-import io.ebean.migration.MigrationVersion;
+import io.ebean.migration.*;
 
 import java.io.IOException;
 import java.net.URL;
@@ -60,7 +57,7 @@ public final class MigrationTable {
   private MigrationMetaRow lastMigration;
   private LocalMigrationResource priorVersion;
 
-  private final List<LocalMigrationResource> checkMigrations = new ArrayList<>();
+  private final List<MigrationResource> checkMigrations = new ArrayList<>();
 
   /**
    * Version of a dbinit script. When set this means all migration version less than this are ignored.
@@ -274,7 +271,7 @@ private String trim(String s) {
   private boolean shouldRun(LocalMigrationResource localVersion, LocalMigrationResource prior) throws SQLException {
     if (prior != null && !localVersion.isRepeatable()) {
       if (!migrationExists(prior)) {
-        log.log(ERROR, "Migration {0} requires prior migration {1} which has not been run", localVersion.getVersion(), prior.getVersion());
+        log.log(ERROR, "Migration {0} requires prior migration {1} which has not been run", localVersion.version(), prior.version());
         return false;
       }
     }
@@ -300,7 +297,7 @@ private boolean runMigration(LocalMigrationResource local, MigrationMetaRow exis
     String script = null;
     int checksum;
     if (local instanceof LocalDdlMigrationResource) {
-      script = convertScript(local.getContent());
+      script = convertScript(local.content());
       checksum = Checksum.calculate(script);
     } else {
       checksum = ((LocalJdbcMigrationResource) local).getChecksum();
@@ -321,7 +318,7 @@ private boolean runMigration(LocalMigrationResource local, MigrationMetaRow exis
    */
   private boolean patchInsertMigration(LocalMigrationResource local, int checksum) throws SQLException {
     if (patchInsertVersions != null && patchInsertVersions.contains(local.key())) {
-      log.log(INFO, "Patch migration, insert into history {0}", local.getLocation());
+      log.log(INFO, "Patch migration, insert into history {0}", local.location());
       if (!checkStateOnly) {
         insertIntoHistory(local, checksum, 0);
       }
@@ -336,18 +333,18 @@ private boolean patchInsertMigration(LocalMigrationResource local, int checksum)
   boolean skipMigration(int checksum, LocalMigrationResource local, MigrationMetaRow existing) throws SQLException {
     boolean matchChecksum = (existing.getChecksum() == checksum);
     if (matchChecksum) {
-      log.log(TRACE, "skip unchanged migration {0}", local.getLocation());
+      log.log(TRACE, "skip unchanged migration {0}", local.location());
       return true;
 
     } else if (patchResetChecksum(existing, checksum)) {
-      log.log(INFO, "Patch migration, reset checksum on {0}", local.getLocation());
+      log.log(INFO, "Patch migration, reset checksum on {0}", local.location());
       return true;
 
     } else if (local.isRepeatable() || skipChecksum) {
       // re-run the migration
       return false;
     } else {
-      throw new MigrationException("Checksum mismatch on migration " + local.getLocation());
+      throw new MigrationException("Checksum mismatch on migration " + local.location());
     }
   }
 
@@ -383,7 +380,7 @@ private void executeMigration(LocalMigrationResource local, String script, int c
     long exeMillis = 0;
     try {
       if (skipMigrationRun) {
-        log.log(DEBUG, "skip migration {0}", local.getLocation());
+        log.log(DEBUG, "skip migration {0}", local.location());
       } else {
         exeMillis = executeMigration(local, script);
       }
@@ -396,7 +393,7 @@ private void executeMigration(LocalMigrationResource local, String script, int c
     } catch (SQLException e) {
       if (allowErrorInRepeatable && local.isRepeatableLast()) {
         // log the exception and continue on repeatable migration
-        log.log(ERROR, "Continue migration with error executing repeatable migration " + local.getVersion(), e);
+        log.log(ERROR, "Continue migration with error executing repeatable migration " + local.version(), e);
       } else {
         throw e;
       }
@@ -406,11 +403,11 @@ private void executeMigration(LocalMigrationResource local, String script, int c
   private long executeMigration(LocalMigrationResource local, String script) throws SQLException {
     long start = System.currentTimeMillis();
     if (local instanceof LocalDdlMigrationResource) {
-      log.log(DEBUG, "run migration {0}", local.getLocation());
-      scriptRunner.runScript(script, "run migration version: " + local.getVersion());
+      log.log(DEBUG, "run migration {0}", local.location());
+      scriptRunner.runScript(script, "run migration version: " + local.version());
     } else {
       JdbcMigration migration = ((LocalJdbcMigrationResource) local).getMigration();
-      log.log(INFO, "Executing jdbc migration version: {0} - {1}", local.getVersion(), migration);
+      log.log(INFO, "Executing jdbc migration version: {0} - {1}", local.version(), migration);
       migration.migrate(connection);
     }
     executionCount++;
@@ -437,9 +434,9 @@ private MigrationMetaRow createMetaRow(LocalMigrationResource migration, int che
       nextId = lastMigration.getId() + 1;
     }
 
-    String type = migration.getType();
+    String type = migration.type();
     String runVersion = migration.key();
-    String comment = migration.getComment();
+    String comment = migration.comment();
 
     return new MigrationMetaRow(nextId, type, runVersion, comment, checksum, envUserName, runOn, exeMillis);
   }
@@ -495,10 +492,10 @@ public boolean isEmpty() {
    *
    * @return the migrations that have been run (collected if checkState is true).
    */
-  public List<LocalMigrationResource> runAll(List<LocalMigrationResource> localVersions) throws SQLException {
+  public List<MigrationResource> runAll(List<LocalMigrationResource> localVersions) throws SQLException {
     checkMinVersion();
     for (LocalMigrationResource localVersion : localVersions) {
-      if (!localVersion.isRepeatable() && dbInitVersion != null && dbInitVersion.compareTo(localVersion.getVersion()) >= 0) {
+      if (!localVersion.isRepeatable() && dbInitVersion != null && dbInitVersion.compareTo(localVersion.version()) >= 0) {
         log.log(DEBUG, "migration skipped by dbInitVersion {0}", dbInitVersion);
       } else if (!shouldRun(localVersion, priorVersion)) {
         break;
@@ -523,7 +520,7 @@ private void checkMinVersion() {
    *
    * @return the migrations that have been run (collected if checkstate is true).
    */
-  public List<LocalMigrationResource> runInit(LocalMigrationResource initVersion, List<LocalMigrationResource> localVersions) throws SQLException {
+  public List<MigrationResource> runInit(LocalMigrationResource initVersion, List<LocalMigrationResource> localVersions) throws SQLException {
     runRepeatableInit(localVersions);
     initVersion.setInitType();
     if (!shouldRun(initVersion, null)) {

ebean-migration/src/test/java/io/ebean/migration/MigrationRunnerTest.java

@@ -3,7 +3,6 @@
 import io.ebean.datasource.DataSourceConfig;
 import io.ebean.datasource.DataSourceFactory;
 import io.ebean.datasource.DataSourcePool;
-import io.ebean.migration.runner.LocalMigrationResource;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
@@ -37,12 +36,12 @@ public void run_when_createConnection() {
     config.setMigrationPath("dbmig");
     MigrationRunner runner = new MigrationRunner(config);
 
-    List<LocalMigrationResource> check = runner.checkState();
+    List<MigrationResource> check = runner.checkState();
     assertThat(check).hasSize(5);
 
-    assertThat(check.get(0).getContent()).contains("-- do nothing");
-    assertThat(check.get(1).getContent()).contains("create table m1");
-    assertThat(check.get(2).getContent()).contains("create table m3");
+    assertThat(check.get(0).content()).contains("-- do nothing");
+    assertThat(check.get(1).content()).contains("create table m1");
+    assertThat(check.get(2).content()).contains("create table m3");
 
     runner.run();
   }
@@ -95,9 +94,9 @@ public void run_when_suppliedDataSource() {
     config.setMigrationPath("dbmig4");
 
     config.setPatchResetChecksumOn("m2_view,1.2");
-    List<LocalMigrationResource> checkState = runner.checkState(dataSource);
+    List<MigrationResource> checkState = runner.checkState(dataSource);
     assertThat(checkState).hasSize(1);
-    assertThat(checkState.get(0).getVersion().asString()).isEqualTo("1.3");
+    assertThat(checkState.get(0).version().asString()).isEqualTo("1.3");
 
     config.setPatchInsertOn("1.3");
     checkState = runner.checkState(dataSource);