Merge pull request #125 from harawata/123-skipped-migration

Print warnings when there is a skipped migration or a missing migration script.

Author: harawata

src/main/java/org/apache/ibatis/migration/operations/DatabaseOperation.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -46,11 +46,6 @@ protected void insertChangelog(Change change, ConnectionProvider connectionProvi
     }
   }
 
-  protected Change getLastAppliedChange(ConnectionProvider connectionProvider, DatabaseOperationOption option) {
-    List<Change> changelog = getChangelog(connectionProvider, option);
-    return changelog.isEmpty() ? null : changelog.get(changelog.size() - 1);
-  }
-
   protected List<Change> getChangelog(ConnectionProvider connectionProvider, DatabaseOperationOption option) {
     SqlRunner runner = getSqlRunner(connectionProvider);
     try {
@@ -83,6 +78,27 @@ protected boolean changelogExists(ConnectionProvider connectionProvider, Databas
     }
   }
 
+  protected void checkSkippedOrMissing(List<Change> changesInDb, List<Change> migrations, PrintStream printStream) {
+    int adjust = 0;
+    for (int i = 0; i < changesInDb.size(); i++) {
+      Change changeInDb = changesInDb.get(i);
+      int migrationIndex = migrations.indexOf(changeInDb);
+      if (migrationIndex == -1) {
+        // no corresponding migration script.
+        println(printStream, "WARNING: Missing migration script. id='" + changeInDb.getId() + "', description='"
+            + changeInDb.getDescription() + "'.");
+        adjust++;
+      } else if (migrationIndex != (i - adjust)) {
+        // Unapplied migration script(s).
+        for (int j = i - adjust; j < migrationIndex; j++) {
+          adjust--;
+          println(printStream,
+              "WARNING: Migration script '" + migrations.get(j).getFilename() + "' was not applied to the database.");
+        }
+      }
+    }
+  }
+
   protected SqlRunner getSqlRunner(ConnectionProvider connectionProvider) {
     try {
       return new SqlRunner(connectionProvider.getConnection());

src/main/java/org/apache/ibatis/migration/operations/DownOperation.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -56,12 +56,16 @@ public DownOperation operate(ConnectionProvider connectionProvider, MigrationLoa
       if (option == null) {
         option = new DatabaseOperationOption();
       }
-      Change lastChange = getLastAppliedChange(connectionProvider, option);
-      if (lastChange == null) {
+      List<Change> changesInDb = Collections.emptyList();
+      if (changelogExists(connectionProvider, option)) {
+        changesInDb = getChangelog(connectionProvider, option);
+      }
+      if (changesInDb.isEmpty()) {
         println(printStream, "Changelog exist, but no migration found.");
       } else {
         List<Change> migrations = migrationsLoader.getMigrations();
         Collections.sort(migrations);
+        checkSkippedOrMissing(changesInDb, migrations, printStream);
         Collections.reverse(migrations);
         int stepCount = 0;
         ScriptRunner runner = getScriptRunner(connectionProvider, option, printStream);
@@ -70,7 +74,7 @@ public DownOperation operate(ConnectionProvider connectionProvider, MigrationLoa
 
         try {
           for (Change change : migrations) {
-            if (change.getId().equals(lastChange.getId())) {
+            if (change.equals(changesInDb.get(changesInDb.size() - 1))) {
               if (stepCount == 0 && hook != null) {
                 hookBindings.put(MigrationHook.HOOK_CONTEXT, new HookContext(connectionProvider, runner, null));
                 hook.before(hookBindings);
@@ -99,7 +103,7 @@ public DownOperation operate(ConnectionProvider connectionProvider, MigrationLoa
               if (steps == null || stepCount >= steps) {
                 break;
               }
-              lastChange = getLastAppliedChange(connectionProvider, option);
+              changesInDb.remove(changesInDb.size() - 1);
             }
           }
           if (stepCount > 0 && hook != null) {

src/main/java/org/apache/ibatis/migration/operations/UpOperation.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -61,13 +61,14 @@ public UpOperation operate(ConnectionProvider connectionProvider, MigrationLoade
         option = new DatabaseOperationOption();
       }
 
-      Change lastChange = null;
+      List<Change> changesInDb = Collections.emptyList();
       if (changelogExists(connectionProvider, option)) {
-        lastChange = getLastAppliedChange(connectionProvider, option);
+        changesInDb = getChangelog(connectionProvider, option);
       }
 
       List<Change> migrations = migrationsLoader.getMigrations();
       Collections.sort(migrations);
+      checkSkippedOrMissing(changesInDb, migrations, printStream);
       int stepCount = 0;
       ScriptRunner runner = getScriptRunner(connectionProvider, option, printStream);
 
@@ -77,7 +78,7 @@ public UpOperation operate(ConnectionProvider connectionProvider, MigrationLoade
       Reader onAbortScriptReader = null;
       try {
         for (Change change : migrations) {
-          if (lastChange == null || change.getId().compareTo(lastChange.getId()) > 0) {
+          if (changesInDb.isEmpty() || change.compareTo(changesInDb.get(changesInDb.size() - 1)) > 0) {
             if (stepCount == 0 && hook != null) {
               hookBindings.put(MigrationHook.HOOK_CONTEXT, new HookContext(connectionProvider, runner, null));
               hook.before(hookBindings);

src/main/java/org/apache/ibatis/migration/operations/VersionOperation.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -47,33 +47,35 @@ public VersionOperation operate(ConnectionProvider connectionProvider, Migration
     if (option == null) {
       option = new DatabaseOperationOption();
     }
-    ensureVersionExists(migrationsLoader);
-    Change change = getLastAppliedChange(connectionProvider, option);
-    if (change == null || version.compareTo(change.getId()) > 0) {
+    List<Change> changesInDb = getChangelog(connectionProvider, option);
+    List<Change> migrations = migrationsLoader.getMigrations();
+    Change specified = new Change(version);
+    if (!migrations.contains(specified)) {
+      throw new MigrationException("A migration for the specified version number does not exist.");
+    }
+    Change lastChangeInDb = changesInDb.isEmpty() ? null : changesInDb.get(changesInDb.size() - 1);
+    if (lastChangeInDb == null || specified.compareTo(lastChangeInDb) > 0) {
       println(printStream, "Upgrading to: " + version);
-      UpOperation up = new UpOperation(1);
-      while (!version.equals(change.getId())) {
-        up.operate(connectionProvider, migrationsLoader, option, printStream, upHook);
-        change = getLastAppliedChange(connectionProvider, option);
+      int steps = 0;
+      for (Change change : migrations) {
+        if (change.compareTo(lastChangeInDb) > 0 && change.compareTo(specified) < 1) {
+          steps++;
+        }
       }
-    } else if (version.compareTo(change.getId()) < 0) {
+      new UpOperation(steps).operate(connectionProvider, migrationsLoader, option, printStream, upHook);
+    } else if (specified.compareTo(lastChangeInDb) < 0) {
       println(printStream, "Downgrading to: " + version);
-      DownOperation down = new DownOperation(1);
-      while (!version.equals(change.getId())) {
-        down.operate(connectionProvider, migrationsLoader, option, printStream, downHook);
-        change = getLastAppliedChange(connectionProvider, option);
+      int steps = 0;
+      for (Change change : migrations) {
+        if (change.compareTo(specified) > -1 && change.compareTo(lastChangeInDb) < 0) {
+          steps++;
+        }
       }
+      new DownOperation(steps).operate(connectionProvider, migrationsLoader, option, printStream, downHook);
     } else {
       println(printStream, "Already at version: " + version);
     }
     println(printStream);
     return this;
   }
-
-  private void ensureVersionExists(MigrationLoader migrationsLoader) {
-    List<Change> migrations = migrationsLoader.getMigrations();
-    if (!migrations.contains(new Change(version))) {
-      throw new MigrationException("A migration for the specified version number does not exist.");
-    }
-  }
 }

src/test/java/org/apache/ibatis/migration/MigratorTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -80,6 +80,8 @@ public void checkAssertion() {
 
     testVersionCommand();
     testStatusContainsNoPendingMigrations();
+    testSkippedScript();
+    testMissingScript();
     testDownCommand();
     testStatusContainsPendingMigrations();
     testPendingCommand();
@@ -153,11 +155,43 @@ private void testDoPendingScriptCommand() throws Exception {
 
   private void testVersionCommand() throws Exception {
     out.clearLog();
-    Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "version", "20080827200216"));
+    Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "version", "20080827200217"));
     String output = out.getLog();
     assertFalse(output.toString().contains("FAILURE"));
   }
 
+  private void testSkippedScript() throws Exception {
+    out.clearLog();
+    File skipped = new File(dir + File.separator + "scripts", "20080827200215_skipped_migration.sql");
+    assertTrue(skipped.createNewFile());
+    try {
+      Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "up"));
+      String output = out.getLog();
+      assertFalse(output.toString().contains("FAILURE"));
+      assertEquals(1, TestUtil.countStr(output, "WARNING"));
+      assertTrue(output.toString().contains(
+          "WARNING: Migration script '20080827200215_skipped_migration.sql' was not applied to the database."));
+    } finally {
+      skipped.delete();
+    }
+  }
+
+  private void testMissingScript() throws Exception {
+    out.clearLog();
+    File original = new File(dir + File.separator + "scripts", "20080827200216_create_procs.sql");
+    File renamed = new File(dir + File.separator + "scripts", "20080827200216_create_procs._sql");
+    assertTrue(original.renameTo(renamed));
+    try {
+      Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "up"));
+      String output = out.getLog();
+      assertFalse(output.toString().contains("FAILURE"));
+      assertTrue(output.toString()
+          .contains("WARNING: Missing migration script. id='20080827200216', description='create procs'."));
+    } finally {
+      assertTrue(renamed.renameTo(original));
+    }
+  }
+
   private void testDownCommand() throws Exception {
     out.clearLog();
     Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "down"));
@@ -206,7 +240,7 @@ private void testDoScriptCommand() throws Exception {
     assertFalse(output.toString().contains("20080827200212"));
     assertTrue(output.toString().contains("20080827200213"));
     assertTrue(output.toString().contains("20080827200214"));
-    assertFalse(output.toString().contains("20080827200215"));
+    assertFalse(output.toString().contains("20080827200216"));
     assertFalse(output.toString().contains("-- @UNDO"));
 
     out.clearLog();
@@ -218,21 +252,21 @@ private void testDoScriptCommand() throws Exception {
     assertFalse(output.toString().contains("20080827200212"));
     assertFalse(output.toString().contains("20080827200213"));
     assertFalse(output.toString().contains("20080827200214"));
-    assertFalse(output.toString().contains("20080827200215"));
+    assertFalse(output.toString().contains("20080827200216"));
     assertFalse(output.toString().contains("-- @UNDO"));
   }
 
   private void testUndoScriptCommand() throws Exception {
     out.clearLog();
-    Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "script", "20080827200215", "20080827200213"));
+    Migrator.main(TestUtil.args("--path=" + dir.getAbsolutePath(), "script", "20080827200216", "20080827200213"));
     String output = out.getLog();
     assertFalse(output.toString().contains("FAILURE"));
     assertFalse(output.toString().contains("20080827200210"));
     assertFalse(output.toString().contains("20080827200211"));
     assertFalse(output.toString().contains("20080827200212"));
     assertFalse(output.toString().contains("20080827200213"));
     assertTrue(output.toString().contains("20080827200214"));
-    assertTrue(output.toString().contains("20080827200215"));
+    assertTrue(output.toString().contains("20080827200216"));
     assertTrue(output.toString().contains("-- @UNDO"));
     out.clearLog();
 
@@ -244,7 +278,7 @@ private void testUndoScriptCommand() throws Exception {
     assertFalse(output.toString().contains("20080827200212"));
     assertFalse(output.toString().contains("20080827200213"));
     assertFalse(output.toString().contains("20080827200214"));
-    assertFalse(output.toString().contains("20080827200215"));
+    assertFalse(output.toString().contains("20080827200216"));
     assertTrue(output.toString().contains("-- @UNDO"));
   }
 

src/test/java/org/apache/ibatis/migration/example/scripts/20080827200215_create_procs.sql renamed to src/test/java/org/apache/ibatis/migration/example/scripts/20080827200216_create_procs.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2010-2016 the original author or authors.
+--    Copyright 2010-2018 the original author or authors.
 --
 --    Licensed under the Apache License, Version 2.0 (the "License");
 --    you may not use this file except in compliance with the License.

src/test/java/org/apache/ibatis/migration/example/scripts/20080827200216_parse_file_with_dot_._in_file_name.sql renamed to src/test/java/org/apache/ibatis/migration/example/scripts/20080827200217_parse_file_with_dot_._in_file_name.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2010-2016 the original author or authors.
+--    Copyright 2010-2018 the original author or authors.
 --
 --    Licensed under the Apache License, Version 2.0 (the "License");
 --    you may not use this file except in compliance with the License.