org.liquibase.maven.plugins.LiquibaseRollback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of liquibase-maven-plugin Show documentation
A Maven plugin wraps up some of the functionality of Liquibase
There is a newer version: 4.30.0
Show newest version
// Version:   $Id: $
// Copyright: Copyright(c) 2007 Trace Financial Limited
package org.liquibase.maven.plugins;

import liquibase.Contexts;
import liquibase.LabelExpression;
import liquibase.Liquibase;
import liquibase.exception.LiquibaseException;
import liquibase.util.ISODateFormat;
import org.apache.maven.plugin.MojoFailureException;

import java.text.DateFormat;
import java.text.ParseException;
import java.util.Date;

/**
 * Invokes Liquibase to rollback the database (and mark changesets as unapplied). The
 * changesets to be rolled back are specified using attributes 'rollbackCount',
 * 'rollbackTag' and/or 'rollbackDate'
 * @author Peter Murray
 * @goal rollback
 */
public class LiquibaseRollback extends AbstractLiquibaseChangeLogMojo {

    protected enum RollbackType {

      TAG, DATE, COUNT
    }

    /**
     * The tag to roll the database back to.
     * @parameter property="liquibase.rollbackTag"
     */
    protected String rollbackTag;

    /**
     * The number of changesets to rollback.
     * @parameter property="liquibase.rollbackCount" default-value="-1"
     */
    protected int rollbackCount;

    /**
     * The date to rollback the database to. The format of the date must match either an ISO date format, or that of the
     * DateFormat.getDateInstance() for the platform the plugin is executing
     * on.
     * @parameter property="liquibase.rollbackDate"
     */
    protected String rollbackDate;

    /** The type of the rollback that is being performed. */
    protected RollbackType type;

    /** External script containing rollback logic. Set to override the rollback logic contained in the changelog*/
    protected String rollbackScript;

    @Override
    protected void checkRequiredParametersAreSpecified() throws MojoFailureException {
        super.checkRequiredParametersAreSpecified();

        checkRequiredRollbackParameters();
    }

    protected void checkRequiredRollbackParameters() throws MojoFailureException {
        if ((rollbackCount == -1) && (rollbackDate == null) && (rollbackTag == null)) {
            throw new MojoFailureException("One of the rollback options must be specified, "
                                     + "please specify one of rollbackTag, rollbackCount "
                                     + "or rollbackDate");
        }

        if ((rollbackCount != -1) && (rollbackCount <= 0)) {
            throw new MojoFailureException("A rollback count of " + rollbackCount + " is meaningless, please "
                                     + "select a value greater than 0");
        }

        String message = "Cannot specify multiple rollbackXXX options, please select only"
                     + " one of rollbackTag, rollbackCount, rollbackDate.";

        if (rollbackCount > 0) {
            if ((rollbackDate != null) || (rollbackTag != null)) {
                throw new MojoFailureException(message);
            }
            type = RollbackType.COUNT;
        } else if (rollbackDate != null) {
            if ((rollbackTag != null) || (rollbackCount > 0)) {
                throw new MojoFailureException(message);
            }
            type = RollbackType.DATE;
        } else if (rollbackTag != null) {
            if ((rollbackCount > 0) || (rollbackDate != null)) {
                throw new MojoFailureException(message);
            }
            type = RollbackType.TAG;
        }
    }

    @Override
    protected void printSettings(String indent) {
        super.printSettings(indent);
        getLog().info(indent + "rollback Count: " + rollbackCount);
        getLog().info(indent + "rollback Date: " + rollbackDate);
        getLog().info(indent + "rollback Tag: " + rollbackTag);
    }

    @Override
    protected void performLiquibaseTask(Liquibase liquibase) throws LiquibaseException {
        super.performLiquibaseTask(liquibase);
        switch (type) {
            case COUNT: {
                liquibase.rollback(rollbackCount, rollbackScript, new Contexts(contexts), new LabelExpression(getLabelFilter()));
                break;
            }
            case DATE: {
                try {
                    liquibase.rollback(parseDate(rollbackDate), rollbackScript,new Contexts(contexts), new LabelExpression(getLabelFilter()));
                }
                catch (ParseException e) {
                    String message = "Error parsing rollbackDate: " + e.getMessage();
                    throw new LiquibaseException(message, e);
                }
                break;
            }
            case TAG: {
                liquibase.rollback(rollbackTag, rollbackScript,new Contexts(contexts), new LabelExpression(getLabelFilter()));
                break;
            }
            default: {
                throw new IllegalStateException("Unexpected rollback type, " + type);
            }
        }
    }

    protected Date parseDate(String date) throws ParseException {
        ISODateFormat isoFormat = new ISODateFormat();
        try {
            return isoFormat.parse(date);
        } catch (ParseException e) {
            DateFormat format = DateFormat.getDateInstance();
            try {
                return format.parse(date);
            } catch (ParseException e1) {
                throw new ParseException("Date must match ISODateFormat or STANDARD platform format.\n"+e.getMessage(), 0);
            }
        }
    }
}