com.googlecode.flyway.maven.AbstractMigrationLoadingMojo Maven / Gradle / Ivy
/**
* Copyright (C) 2010-2012 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.googlecode.flyway.maven;
import com.googlecode.flyway.core.Flyway;
import com.googlecode.flyway.core.api.MigrationVersion;
import com.googlecode.flyway.core.util.StringUtils;
import com.googlecode.flyway.core.validation.ValidationErrorMode;
/**
* Base class for mojos that rely on loading migrations from the classpath.
*
* @phase pre-integration-test
*/
@SuppressWarnings({"UnusedDeclaration", "JavaDoc"})
abstract class AbstractMigrationLoadingMojo extends AbstractFlywayMojo {
/**
* Locations on the classpath to scan recursively for migrations. Locations may contain both sql
* and java-based migrations. (default: db/migration)
* Also configurable with Maven or System Property: ${flyway.locations} (Comma-separated list)
*
* @parameter
*/
private String[] locations;
/**
* The base package where the Java migrations are located. (default: db.migration)
* Also configurable with Maven or System Property: ${flyway.basePackage}
*
* @parameter expression="${flyway.basePackage}"
* @deprecated Uses locations instead. Will be removed in Flyway 3.0.
*/
private String basePackage;
/**
* The base directory on the classpath where the Sql migrations are located. (default: db/migration)
Also
* configurable with Maven or System Property: ${flyway.baseDir}
*
* @parameter expression="${flyway.baseDir}"
* @deprecated Uses locations instead. Will be removed in Flyway 3.0.
*/
private String baseDir;
/**
* The encoding of Sql migrations. (default: UTF-8)
Also configurable with Maven or System Property:
* ${flyway.encoding}
*
* @parameter expression="${flyway.encoding}"
*/
private String encoding;
/**
* The file name prefix for Sql migrations (default: V) Also configurable with Maven or System Property:
* ${flyway.sqlMigrationPrefix}
*
* @parameter expression="${flyway.sqlMigrationPrefix}"
*/
private String sqlMigrationPrefix;
/**
* The file name suffix for Sql migrations (default: .sql) Also configurable with Maven or System Property:
* ${flyway.sqlMigrationSuffix}
*
* @parameter expression="${flyway.sqlMigrationSuffix}"
*/
private String sqlMigrationSuffix;
/**
* The action to take when validation fails.
Possible values are:
FAIL (default)
* Throw an exception and fail.
CLEAN (Warning ! Do not use in production !)
Cleans the
* database.
This is exclusively intended as a convenience for development. Even tough we strongly
* recommend not to change migration scripts once they have been checked into SCM and run, this provides a way of
* dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that the next
* migration will bring you back to the state checked into SCM.
This property has no effect when
* validationMode is set to NONE.
Also configurable with Maven or System Property:
* ${flyway.validationErrorMode}
*
* @parameter expression="${flyway.validationErrorMode}"
* @deprecated Use cleanOnValidationError instead. Will be removed in Flyway 3.0.
*/
@Deprecated
private String validationErrorMode;
/**
* Whether to automatically call clean or not when a validation error occurs. (default: {@code false})
* This is exclusively intended as a convenience for development. Even tough we
* strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a
* way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that
* the next migration will bring you back to the state checked into SCM.
* Warning ! Do not enable in production !
* Also configurable with Maven or System Property: ${flyway.cleanOnValidationError}
*
* @parameter expression="${flyway.cleanOnValidationError}"
*/
private boolean cleanOnValidationError;
/**
* The target version up to which Flyway should run migrations. Migrations with a higher version number will not be
* applied. (default: the latest version)
* Also configurable with Maven or System Property: ${flyway.target}
*
* @parameter expression="${flyway.target}"
*/
private String target;
/**
* Allows migrations to be run "out of order" (default: {@code false}).
* If you already have versions 1 and 3 applied, and now a version 2 is found,
* it will be applied too instead of being ignored.
* Also configurable with Maven or System Property: ${flyway.outOfOrder}
*
* @parameter expression="${flyway.outOfOrder}"
*/
private boolean outOfOrder;
@Override
protected final void doExecute(Flyway flyway) throws Exception {
String locationsProperty = mavenProject.getProperties().getProperty("flyway.locations");
if (locationsProperty != null) {
flyway.setLocations(StringUtils.tokenizeToStringArray(locationsProperty, ","));
} else if (locations != null) {
flyway.setLocations(locations);
}
if (basePackage != null) {
flyway.setBasePackage(basePackage);
}
if (baseDir != null) {
flyway.setBaseDir(baseDir);
}
if (encoding != null) {
flyway.setEncoding(encoding);
}
if (sqlMigrationPrefix != null) {
flyway.setSqlMigrationPrefix(sqlMigrationPrefix);
}
if (sqlMigrationSuffix != null) {
flyway.setSqlMigrationSuffix(sqlMigrationSuffix);
}
if (validationErrorMode != null) {
flyway.setValidationErrorMode(ValidationErrorMode.valueOf(validationErrorMode.toUpperCase()));
}
flyway.setCleanOnValidationError(cleanOnValidationError);
flyway.setOutOfOrder(outOfOrder);
if (target != null) {
flyway.setTarget(new MigrationVersion(target));
}
doExecuteWithMigrationConfig(flyway);
}
/**
* Executes Flyway fully configured for loading migrations.
*
* @param flyway The instance of Flyway to launch.
* @throws Exception when the execution failed.
*/
protected abstract void doExecuteWithMigrationConfig(Flyway flyway) throws Exception;
}