Merge pull request #12 from TechnologyBrewery/group_feature

Added Group migration functionality to Baton plugin

Author: jacksondelametter

README.md

@@ -56,18 +56,22 @@ The following example configures the migration to only look in the `./src/main/r
 one file, `original-specification-example.foo` alone.
 ```json
 [
-  {
-    "name": "upgrade-foo-extension-files-migration",
-    "implementation": "org.technologybrewery.baton.example.FooToBarMigration",
-    "fileSets": [
-      {
-        "includes": ["**/legacy/*.foo"],
-        "excludes": ["original-specification-example.foo"]
-      }
-    ]
-  }
+    {
+        "group": "group-1",
+        "migrations": [
+            "name": "upgrade-foo-extension-files-migration",
+            "implementation": "org.technologybrewery.baton.example.FooToBarMigration",
+            "fileSets": [
+                {
+                    "includes": ["**/legacy/*.foo"],
+                    "excludes": ["original-specification-example.foo"]
+                }
+            ]
+        ]
+    }
 ]
 ```
+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. 
 
 ### 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,7 +210,25 @@ Default: `10`
 When specifying your configurations in `migrations.json` or your custom `migrationsConfigurationFile` file name, the 
 following options are available.
 
-### name
+### Group Configurations
+
+#### group
+The name of the group. Simply used to give a distinctive identifier to a group.
+
+Required? `true`
+
+Default: None
+
+#### migrations
+List of all the migrations in a group. This must be a non-zero list of migrations.
+
+Required? `true`
+
+Default: None
+
+### Migration Configurations
+
+#### name
 The name of the migration to perform.  As of 0.1.0, `name` is not particularly impactful.  However, in subsequent 
 releases it will gain importance as a means to order migration execution (convention-driven in the style of Flyway) as 
 well as inactivate specific migrations.
@@ -215,14 +237,14 @@ Required? `true`
 
 Default: None
 
-### description
+#### description
 The description of the migration.  This is intended to provide context on why the migration is needed.
 
 Required? `false`
 
 Default: None
 
-### implementation
+#### implementation
 The fully qualified Java class name that will perform the migration.  This **MUST** implement the 
 `org.technologybrewery.baton.Migration` interface, however it is recommended that it extend 
 `org.technologybrewery.baton.AbstractMigration` to allow implementations to be more consistent and focus on migration
@@ -232,7 +254,7 @@ Required? `true`
 
 Default: None
 
-### fileSet
+#### fileSet
 A Maven-inspired object that allows specification of common file sets.  **MUST** be added as a list item.
 
 Required? `false`

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

@@ -3,10 +3,8 @@
 import com.vlkan.rfos.RotatingFileOutputStream;
 import com.vlkan.rfos.RotationConfig;
 import com.vlkan.rfos.policy.SizeBasedRotationPolicy;
-import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.shared.model.fileset.FileSet;
 import org.apache.maven.shared.model.fileset.util.FileSetManager;

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

@@ -1,5 +1,7 @@
 package org.technologybrewery.baton;
 
+import java.util.ArrayList;
+import java.util.List;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -10,49 +12,49 @@ public class BatonExecutionSummary {
 
     private static final Logger logger = LoggerFactory.getLogger(BatonExecutionSummary.class);
 
-    private int filesSuccessfullyMigrated;
-
-    private int filesUnsuccessfullyMigrated;
-
-    private int numberOfTargetsExecuted;
+    private List<GroupSummary> groupSummaries = new ArrayList<>();
 
     /**
      * Adds a specific migration summary run to the cross-migration summary..
      *
      * @param summary summary to add
      */
-    public void addMigrationSummary(MigrationSummary summary) {
+    public void addGroupSummary(GroupSummary summary) {
         if (summary == null) {
             logger.warn("Mission migration summary details - file counts may be inaccurate!");
         } else {
-            filesSuccessfullyMigrated += summary.getFilesSuccessfullyMigrated();
-            filesUnsuccessfullyMigrated += summary.getFilesUnsuccessfullyMigrated();
+            groupSummaries.add(summary);
         }
-
-        numberOfTargetsExecuted++;
-
-    }
-
-    public int getFilesSuccessfullyMigrated() {
-        return filesSuccessfullyMigrated;
-    }
-
-    public int getFilesUnsuccessfullyMigrated() {
-        return filesUnsuccessfullyMigrated;
     }
 
     public int getNumberOfTargetsExecuted() {
+        int numberOfTargetsExecuted = 0;
+        for(GroupSummary groupSummary : groupSummaries) {
+            numberOfTargetsExecuted += groupSummary.getMigrationSummaries().size();
+        }
         return numberOfTargetsExecuted;
     }
 
+    public List<GroupSummary> getGroupSummaries() {
+        return this.groupSummaries;
+    }
+
     /**
      * Human-readable summary information.
      *
      * @return the summary as a readable string
      */
     public String getSummary() {
+        int filesSuccess = 0;
+        int filesUnsuccess = 0;
+        for(GroupSummary groupSummary : groupSummaries) {
+            for(MigrationSummary migrationSummary : groupSummary.getMigrationSummaries()) {
+                filesSuccess += migrationSummary.getFilesSuccessfullyMigrated();
+                filesUnsuccess += migrationSummary.getFilesUnsuccessfullyMigrated();
+            }
+        }
         return String.format("Migrations Processed: %d, Successfully Migrated Files: %d, Unsuccessfully Migrated Files: %d",
-                numberOfTargetsExecuted, filesSuccessfullyMigrated, filesUnsuccessfullyMigrated);
+                getNumberOfTargetsExecuted(), filesSuccess, filesUnsuccess);
     }
 
 }

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

@@ -12,6 +12,7 @@
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.shared.model.fileset.FileSet;
+import org.technologybrewery.baton.config.GroupTarget;
 import org.technologybrewery.baton.config.MigrationTarget;
 import org.technologybrewery.commons.json.AbstractValidatedElement;
 import org.technologybrewery.commons.json.ValidatedElement;
@@ -26,9 +27,7 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Enumeration;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.Set;
 
 /**
@@ -109,13 +108,13 @@ public class BatonMojo extends AbstractMojo {
 
     private final ObjectMapper objectMapper = initializeObjectMapper();
 
-    private Map<String, MigrationTarget> migrations = new HashMap<>();
+    private List<GroupTarget> groups = new ArrayList<>();
 
     protected ObjectMapper initializeObjectMapper() {
         ObjectMapper localObjectMapper = new ObjectMapper();
 
         SimpleModule module = new SimpleModule();
-        module.addAbstractTypeMapping(ValidatedElement.class, MigrationTarget.class);
+        module.addAbstractTypeMapping(ValidatedElement.class, GroupTarget.class);
 
         localObjectMapper.registerModule(module);
 
@@ -161,36 +160,39 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 
         defaultFileSets();
 
-        BatonExecutionSummary summary = performMigration(migrations.values());
+        BatonExecutionSummary summary = performMigration(groups);
         getLog().info(summary.getSummary());
 
     }
 
-    BatonExecutionSummary performMigration(Collection<MigrationTarget> targets) {
+    BatonExecutionSummary performMigration(Collection<GroupTarget> groupTargets) {
         BatonExecutionSummary executionSummary = new BatonExecutionSummary();
-        for (MigrationTarget target : targets) {
-            if (isActive(target)) {
-                try {
-                    getLog().debug(String.format("Executing Migration: %s (%s)", target.getName(), target.getImplementation()));
-                    Class<Migration> implementationClass = (Class<Migration>) Class.forName(target.getImplementation());
-                    Constructor<Migration> constructor = implementationClass.getConstructor();
-                    Migration migration = constructor.newInstance();
-                    migration.setName(target.getName());
-                    migration.setDescription(target.getDescription());
-                    migration.setMavenProject(project);
-                    migration.setBackupMigratedOriginalFiles(backupOriginalMigratedFiles);
-                    migration.setBackupCustomLocation(backupCustomLocation);
-                    migration.setNumberOfBacksUpsToKeep(numberOfBackupsToKeep);
-                    FileSet[] migrationSpecificFileSets = (CollectionUtils.isNotEmpty(target.getFileSets())) ? getFileSetsForTarget(target) : fileSets;
-                    MigrationSummary migrationSummary = migration.execute(migrationSpecificFileSets);
-                    executionSummary.addMigrationSummary(migrationSummary);
-
-                } catch (Exception e) {
-                    throw new BatonException("Could not complete migrations!", e);
+        for(GroupTarget groupTarget : groupTargets) {
+            GroupSummary groupSummary = new GroupSummary(groupTarget.getGroup());
+            for (MigrationTarget migrationTarget : groupTarget.getMigrations()) {
+                if (isActive(migrationTarget)) {
+                    try {
+                        getLog().debug(String.format("Executing Migration: %s (%s)", migrationTarget.getName(), migrationTarget.getImplementation()));
+                        Class<Migration> implementationClass = (Class<Migration>) Class.forName(migrationTarget.getImplementation());
+                        Constructor<Migration> constructor = implementationClass.getConstructor();
+                        Migration migration = constructor.newInstance();
+                        migration.setName(migrationTarget.getName());
+                        migration.setDescription(migrationTarget.getDescription());
+                        migration.setMavenProject(project);
+                        migration.setBackupMigratedOriginalFiles(backupOriginalMigratedFiles);
+                        migration.setBackupCustomLocation(backupCustomLocation);
+                        migration.setNumberOfBacksUpsToKeep(numberOfBackupsToKeep);
+                        FileSet[] migrationSpecificFileSets = (CollectionUtils.isNotEmpty(migrationTarget.getFileSets())) ? getFileSetsForTarget(migrationTarget) : fileSets;
+                        MigrationSummary migrationSummary = migration.execute(migrationSpecificFileSets);
+                        groupSummary.addMigrationSummary(migrationSummary);
+
+                    } catch (Exception e) {
+                        throw new BatonException("Could not complete migrations!", e);
+                    }
                 }
             }
+            executionSummary.addGroupSummary(groupSummary);
         }
-
         return executionSummary;
     }
 
@@ -230,37 +232,17 @@ protected void loadMigrations() {
                         migrationsStream,
                         tempMigrationsFile.toPath(),
                         StandardCopyOption.REPLACE_EXISTING);
-                migrations = loadMigrationsJson(tempMigrationsFile, migrations);
+                List<GroupTarget> groupTargets = AbstractValidatedElement.readAndValidateJsonList(tempMigrationsFile,objectMapper, GroupTarget.class);
+                groups.addAll(groupTargets);
 
-                getLog().info(String.format("Found %d migrations", migrations.size()));
+                getLog().info(String.format("Found %d migrations", groups.size()));
             } catch (IOException e) {
                 throw new BatonException("Unable to parse " + migrationsFileName, e);
             }
         }
 
     }
 
-    /**
-     * Loads all {@link MigrationTarget}s contained within the given {@link InputStream}, which is expected to
-     * reference the desired migrations.json file to load.
-     *
-     * @param migrationsFile   {@link File} referencing migrations.json file desired to load.
-     * @param migrationTargets the migration targets already loaded to this point
-     * @return {@link Map} containing all loaded {@link MigrationTarget}s with their corresponding name as the map key.
-     */
-    protected Map<String, MigrationTarget> loadMigrationsJson(File migrationsFile,
-                                                              Map<String, MigrationTarget> migrationTargets) {
-
-        List<MigrationTarget> loadedMigrations = AbstractValidatedElement.readAndValidateJsonList(migrationsFile,
-                objectMapper, MigrationTarget.class);
-
-        for (MigrationTarget migrationTarget : loadedMigrations) {
-            migrationTargets.put(migrationTarget.getName(), migrationTarget);
-        }
-
-        return migrationTargets;
-    }
-
     protected FileSet[] getFileSetsForTarget(MigrationTarget target) {
         List<FileSet> localFileSets = new ArrayList<>();
         for (org.technologybrewery.baton.config.FileSet targetFileSet : target.getFileSets()) {

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

@@ -0,0 +1,36 @@
+package org.technologybrewery.baton;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * High level summarization information for a specific Group. 
+ */
+public class GroupSummary {
+
+    private String groupName;
+
+    private List<MigrationSummary> migrationSummaries;
+
+    public GroupSummary(String groupName) {
+        this.groupName = groupName;
+        migrationSummaries = new ArrayList<>();
+    }
+
+    /**
+     * Adds a migration summary to the group summary
+     * @param migrationSummary
+     */
+    public void addMigrationSummary(MigrationSummary migrationSummary) {
+        migrationSummaries.add(migrationSummary);
+    }
+
+    public List<MigrationSummary> getMigrationSummaries() {
+        return this.migrationSummaries;
+    }
+
+    public String getGroupName() {
+        return this.groupName;
+    }
+    
+}

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

@@ -0,0 +1,48 @@
+package org.technologybrewery.baton.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.technologybrewery.commons.json.AbstractValidatedElement;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Holds target information to support group execution. 
+ */
+public class GroupTarget extends AbstractValidatedElement {
+
+    @JsonProperty(required = true)
+    private String group;
+
+    @JsonProperty(required = true)
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    private List<MigrationTarget> migrations = new ArrayList<>();
+
+    public GroupTarget(){}
+
+    public void setGroup(String group) {
+        this.group = group;
+    }
+
+    public String getGroup() {
+        return this.group;
+    }
+
+    @JsonIgnore
+    public void addMigration(MigrationTarget migration) {
+        this.migrations.add(migration);
+    }
+
+    public List<MigrationTarget> getMigrations() {
+        return this.migrations;
+    }
+
+    @Override
+    public String getSchemaFileName() {
+        return "migration-target-schema.json";
+    }
+    
+}