Merge pull request #13 from TechnologyBrewery/migration_ordering_feature

Added migration manual versioned ordering

Author: jacksondelametter

README.md

@@ -71,8 +71,94 @@ one file, `original-specification-example.foo` alone.
     }
 ]
 ```
+
+### Group and Migration Ordering
+
+#### Groups
 Migration files contain groups of migrations. Each group is executed in its entirety before moving on to the next. Groups are executed in the order in which they appear in the migration file. 
 
+Example of ordered groups
+```json
+[ 
+    {
+        "group": "foo",
+        "type": "ordered",
+        "migrations": [
+            {
+                "name": "migration_1"        
+            }
+        ]
+    }, 
+    {
+        "group": "bar",
+        "type": "ordered",
+        "migrations": [
+            {
+                "name": "migration_2"        
+            }
+        ]
+    }
+ ]
+```
+If Baton is executed with this migrations.json, groups would be processed in the order in which they were specified (foo, bar)
+
+#### Migrations
+Migrations within a group can be ordered manually or by version. 
+
+Example of manually ordered migrations
+```json
+[ 
+      {
+         "group": "foo",
+         "type": "ordered",
+         "migrations": [
+            {
+                  "name": "migration_1"        
+            },
+            {
+                  "name": "migration_2" 
+           },
+           {
+                 "name": "migration_3" 
+           },
+           {
+                 "name": "migration_4"
+           }
+        ]
+    }
+ ]
+```
+If Baton is executed with this migration.json, migrations would be processed in the order in which they were specified (migration_1, migration_2, migration_3, migration_4)
+
+Example of version ordered migrations
+```json
+[ 
+      {
+         "group": "bar",
+         "type": "versioned",
+         "migrations": [
+            {
+                  "name": "migration_1", 
+                  "version": "3.0.0"     
+            },
+            {
+                  "name": "migration_2", 
+                  "version": "2.0.0" 
+           },
+           {
+                 "name": "migration_3",
+                 "version": "1.0.0" 
+           },
+           {
+                 "name": "migration_4", 
+                 "version": "5.0.0" 
+           }
+        ]
+    }
+ ]
+```
+If Baton is executed with this migration.json, migrations would be processed by the version number in ascending order (migration_3, migration_2, migration_1, migration_4)
+
 ### Add `baton-maven-plugin` to your Maven build
 The last step is to add `baton-maven-plugin` to your Maven build process just like any other plugin.
 
@@ -206,6 +292,14 @@ works.
 
 Default: `10`
 
+### minimumVersion
+Used to filter out version ordered migrations. All migrations with versions less 
+than the minimum version will be skipped. 
+
+Default: `0.0.0`
+
+Format: `[Number].[Number].[Number]`
+
 ## Migrations JSON File Configuration
 When specifying your configurations in `migrations.json` or your custom `migrationsConfigurationFile` file name, the 
 following options are available.
@@ -219,6 +313,15 @@ Required? `true`
 
 Default: None
 
+#### type
+The migration ordering type. 
+
+Required? `true`
+
+Default: None
+
+Values: `ordered | versioned`
+
 #### migrations
 List of all the migrations in a group. This must be a non-zero list of migrations.
 
@@ -237,6 +340,15 @@ Required? `true`
 
 Default: None
 
+#### version
+The version of the migration
+
+Required? Only if type is set to `versioned` in the parent group configuration
+
+Default: None
+
+Format: `[Number].[Number].[Number]`
+
 #### description
 The description of the migration.  This is intended to provide context on why the migration is needed.
 

baton-maven-plugin/src/main/java/org/technologybrewery/baton/AbstractMigration.java

@@ -56,7 +56,7 @@ public abstract class AbstractMigration implements Migration {
     public MigrationSummary execute(FileSet[] fileSets) {
         if (!active) {
             logger.info("Migration {}' is marked inactive - skipping", getName());
-            return new MigrationSummary(0, 0);
+            return new MigrationSummary(this.name, 0, 0);
         }
 
         FileSetManager fileSetManager = new FileSetManager();
@@ -90,7 +90,7 @@ public MigrationSummary execute(FileSet[] fileSets) {
             }
         }
 
-        return new MigrationSummary(successfulMigrations, unsuccessfulMigrations);
+        return new MigrationSummary(this.name, successfulMigrations, unsuccessfulMigrations);
     }
 
     /**

baton-maven-plugin/src/main/java/org/technologybrewery/baton/BatonMojo.java

@@ -26,9 +26,13 @@
 import java.nio.file.StandardCopyOption;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.Enumeration;
 import java.util.List;
 import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
  * A Maven plugin that allows migration logic to be executed against a Maven module based on a classpath-provided
@@ -64,6 +68,12 @@ public class BatonMojo extends AbstractMojo {
     @Parameter(property = "baton.testDirectory", required = false)
     protected File testDirectory;
 
+    /**
+     * Used to filter out migrations that are less than the value
+     */
+    @Parameter(property = "baton.minimumVersion", required = false, defaultValue = "0.0.0")
+    protected String minimumVersion;
+
     /**
      * A list of fileSet rules to select files and directories.  Will be defaulted based on project information
      * if not specified.
@@ -110,6 +120,12 @@ public class BatonMojo extends AbstractMojo {
 
     private List<GroupTarget> groups = new ArrayList<>();
 
+    protected static final String VERSIONED = "versioned";
+    
+    protected static final String ORDERED = "ordered";
+
+    private static final String minVersionPattern = "\\d+\\.\\d+\\.\\d+";
+
     protected ObjectMapper initializeObjectMapper() {
         ObjectMapper localObjectMapper = new ObjectMapper();
 
@@ -156,21 +172,45 @@ protected void defaultFileSets() {
 
     @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
+        validateMinimumVersion();
         loadMigrations();
-
+        sortMigrationsInGroups(groups);
         defaultFileSets();
 
         BatonExecutionSummary summary = performMigration(groups);
         getLog().info(summary.getSummary());
 
     }
 
+    private void validateMinimumVersion() {
+        Pattern pattern = Pattern.compile(minVersionPattern);
+        Matcher matcher = pattern.matcher(this.minimumVersion);
+        if(!matcher.find()) {
+            this.minimumVersion = "0.0.0";
+            getLog().warn(String.format("Invalid format for minimum version %s, " + 
+                    "setting to 0.0.0. Must be of the format [Number].[Number].[Number]", this.minimumVersion));
+        }
+    }
+
+    protected void sortMigrationsInGroups(List<GroupTarget> groupTargets) {
+        for(GroupTarget groupTarget : groupTargets) {
+            if(groupTarget.getType().equals(VERSIONED)) {
+                Collections.sort(groupTarget.getMigrations(), new Comparator<MigrationTarget>() {
+                    @Override
+                    public int compare(MigrationTarget o1, MigrationTarget o2) {
+                        return o1.getVersion().compareTo(o2.getVersion());
+                    }
+                });
+            }
+        }
+    }
+    
     BatonExecutionSummary performMigration(Collection<GroupTarget> groupTargets) {
         BatonExecutionSummary executionSummary = new BatonExecutionSummary();
         for(GroupTarget groupTarget : groupTargets) {
             GroupSummary groupSummary = new GroupSummary(groupTarget.getGroup());
             for (MigrationTarget migrationTarget : groupTarget.getMigrations()) {
-                if (isActive(migrationTarget)) {
+                if (isActive(migrationTarget) && isMinimumVersion(migrationTarget, groupTarget.getType())) {
                     try {
                         getLog().debug(String.format("Executing Migration: %s (%s)", migrationTarget.getName(), migrationTarget.getImplementation()));
                         Class<Migration> implementationClass = (Class<Migration>) Class.forName(migrationTarget.getImplementation());
@@ -209,24 +249,36 @@ protected boolean isActive(MigrationTarget migrationTarget) {
         return isActive;
     }
 
+    protected boolean isMinimumVersion(MigrationTarget migrationTarget, String groupType) {
+        boolean isMinimumVersion = true;
+        if(groupType.equals(VERSIONED)) {
+            isMinimumVersion = migrationTarget.getVersion().compareTo(this.minimumVersion) >= 0;
+        }
+        if(!isMinimumVersion) {
+            getLog().info(String.format("Skipping, migration %s with version %s does not meet minimum version of %s", 
+                migrationTarget.getName(), migrationTarget.getVersion(), this.minimumVersion));
+        }
+        return isMinimumVersion;
+    }
+
     /**
      * Scans the classpath for any migrations.json files and loads all defined {@link MigrationTarget} configurations.
      */
     protected void loadMigrations() {
-        Enumeration<URL> migrationsEnumeration = null;
+        Enumeration<URL> groupsEnumeration = null;
         try {
-            migrationsEnumeration = getClass().getClassLoader().getResources(migrationsFileName);
+            groupsEnumeration = getClass().getClassLoader().getResources(migrationsFileName);
 
         } catch (IOException ioe) {
             throw new BatonException("Unable to find migrations!", ioe);
         }
 
-        URL migrationsResource;
-        while (migrationsEnumeration.hasMoreElements()) {
-            migrationsResource = migrationsEnumeration.nextElement();
-            getLog().info(String.format("Loading migrations from: %s", migrationsResource.toString()));
+        URL groupsResource;
+        while (groupsEnumeration.hasMoreElements()) {
+            groupsResource = groupsEnumeration.nextElement();
+            getLog().info(String.format("Loading migrations from: %s", groupsResource.toString()));
 
-            try (InputStream migrationsStream = migrationsResource.openStream()) {
+            try (InputStream migrationsStream = groupsResource.openStream()) {
                 File tempMigrationsFile = File.createTempFile("migrations", ".json");
                 Files.copy(
                         migrationsStream,

baton-maven-plugin/src/main/java/org/technologybrewery/baton/MigrationSummary.java

@@ -5,11 +5,14 @@
  */
 public class MigrationSummary {
 
-    private int filesSuccessfullyMigrated;
+    private final String name;
 
-    private int filesUnsuccessfullyMigrated;
+    private final int filesSuccessfullyMigrated;
 
-    public MigrationSummary(int filesSuccessfullyMigrated, int fileUnsuccessfullyMigrated) {
+    private final int filesUnsuccessfullyMigrated;
+
+    public MigrationSummary(String name, int filesSuccessfullyMigrated, int fileUnsuccessfullyMigrated) {
+        this.name = name;
         this.filesSuccessfullyMigrated = filesSuccessfullyMigrated;
         this.filesUnsuccessfullyMigrated = fileUnsuccessfullyMigrated;
     }
@@ -21,4 +24,8 @@ public int getFilesSuccessfullyMigrated() {
     public int getFilesUnsuccessfullyMigrated() {
         return filesUnsuccessfullyMigrated;
     }
+
+    public String getName() {
+        return this.name;
+    }
 }

baton-maven-plugin/src/main/java/org/technologybrewery/baton/config/GroupTarget.java

@@ -17,6 +17,9 @@ public class GroupTarget extends AbstractValidatedElement {
     @JsonProperty(required = true)
     private String group;
 
+    @JsonProperty(required = true)
+    private String type;
+
     @JsonProperty(required = true)
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     private List<MigrationTarget> migrations = new ArrayList<>();
@@ -31,6 +34,14 @@ public String getGroup() {
         return this.group;
     }
 
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    public String getType() {
+        return this.type;
+    }
+
     @JsonIgnore
     public void addMigration(MigrationTarget migration) {
         this.migrations.add(migration);

baton-maven-plugin/src/main/java/org/technologybrewery/baton/config/MigrationTarget.java

@@ -27,6 +27,9 @@ public class MigrationTarget {
     @JsonProperty(required = true)
     private String implementation;
 
+    @JsonProperty
+    private String version;
+
     @JsonProperty
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     private List<FileSet> fileSets = new ArrayList<>();
@@ -58,6 +61,14 @@ public void setImplementation(String implementation) {
         this.implementation = implementation;
     }
 
+    public void setVersion(String version) {
+        this.version = version;
+    }
+
+    public String getVersion() {
+        return this.version;
+    }
+
     public List<FileSet> getFileSets() {
         return fileSets;
     }