org.kualigan.maven.plugins.liquibase

Class LiquibaseTestMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.liquibase.maven.plugins.AbstractLiquibaseMojo

org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

org.kualigan.maven.plugins.liquibase.LiquibaseTestMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class LiquibaseTestMojo
extends org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

Tests Liquibase changelogs against various databases

Author:

Leo Przybylski

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeLogFile Deprecated.
protected File	changeLogSavePath
protected boolean	clearCheckSums Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.
protected String	contexts The Liquibase contexts to execute, which can be "," separated if multiple contexts are required.
protected String	databaseClass The class to use as the database object.
static String	DEFAULT_CHANGELOG_PATH
static String	DEFAULT_LBPROP_PATH
static String	DEFAULT_UPDATE_FILE
static String	DEFAULT_UPDATE_PATH
protected String	defaultSchemaName The default schema name to use the for database connection.
protected String	driver The fully qualified name of the driver class to use to connect to the database.
protected boolean	includeArtifact Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
protected boolean	includeTestOutputDirectory Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
protected String	logging Controls the level of logging from Liquibase when executing.
protected String	password The database password to use to connect to the specified database.
protected org.apache.maven.project.MavenProject	project The Maven project that plugin is running under.
protected boolean	promptOnNonLocalDatabase Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.
protected String	propertyFile The Liquibase properties file used to configure the Liquibase Liquibase.
protected boolean	propertyFileWillOverride Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration.
protected String	rollbackTag The tag to roll the database back to.
protected Properties	systemProperties List of system properties to pass to the database.
static String	TEST_ROLLBACK_TAG
protected File	updatePath Location of an update.xml
protected String	url The Database URL to connect to for executing Liquibase.
protected String	username The database username to use to connect to the specified database.
protected boolean	verbose Controls the verbosity of the output from invoking the plugin.
protected org.apache.maven.artifact.manager.WagonManager	wagonManager The Maven Wagon manager to use when obtaining server authentication details.

Fields inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

changelogCatalogName, changelogSchemaName, defaultCatalogName, emptyPassword, outputDefaultCatalog, outputDefaultSchema, outputFileEncoding, skip

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
LiquibaseTestMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doFieldHack()
void	execute()
protected void	generateUpdateLog(File changeLogFile, Collection<File> changelogs)
protected File	getBasedir()
protected Field	getDeclaredField(Class clazz, String fieldName) Recursively searches for the field specified by the fieldName in the class and all the super classes until it either finds it, or runs out of parents.
protected File[]	getLiquibasePropertiesFiles()
protected Element	includeNode(Document parentChangeLog, File changelog)
protected void	parsePropertiesFile(InputStream propertiesInputStream) Parses a properties file and sets the assocaited fields in the plugin.
protected void	performLiquibaseTask(liquibase.Liquibase liquibase)
protected Collection<File>	scanForChangelogs(File searchPath)

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

checkRequiredParametersAreSpecified, createLiquibase, getFileOpener, printSettings

Methods inherited from class org.liquibase.maven.plugins.AbstractLiquibaseMojo

cleanup, configureFieldsAndValues, getClassLoaderIncludingProjectClasspath, getLiquibase, getMavenArtifactClassLoader, getOutputWriter, isPromptOnNonLocalDatabase

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHANGELOG_PATH

public static final String DEFAULT_CHANGELOG_PATH

See Also:

Constant Field Values

DEFAULT_UPDATE_FILE

public static final String DEFAULT_UPDATE_FILE

See Also:

Constant Field Values

DEFAULT_UPDATE_PATH

public static final String DEFAULT_UPDATE_PATH

See Also:

Constant Field Values

DEFAULT_LBPROP_PATH

public static final String DEFAULT_LBPROP_PATH

See Also:

Constant Field Values

TEST_ROLLBACK_TAG

public static final String TEST_ROLLBACK_TAG

See Also:

Constant Field Values

driver

@Parameter(property="liquibase.driver",
           required=true)
protected String driver

The fully qualified name of the driver class to use to connect to the database.

url

@Parameter(property="liquibase.url",
           required=true)
protected String url

The Database URL to connect to for executing Liquibase.

wagonManager

@Component(role=org.apache.maven.artifact.manager.WagonManager.class)
protected org.apache.maven.artifact.manager.WagonManager wagonManager

The Maven Wagon manager to use when obtaining server authentication details.

username

@Parameter(property="liquibase.username",
           required=true)
protected String username

The database username to use to connect to the specified database.

password

@Parameter(property="liquibase.password",
           required=true)
protected String password

The database password to use to connect to the specified database.

defaultSchemaName

@Parameter(property="liquibase.defaultSchemaName")
protected String defaultSchemaName

The default schema name to use the for database connection.

databaseClass

@Parameter(property="liquibase.databaseClass",
           required=true)
protected String databaseClass

The class to use as the database object.

promptOnNonLocalDatabase

protected boolean promptOnNonLocalDatabase

Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.

includeArtifact

protected boolean includeArtifact

Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

includeTestOutputDirectory

protected boolean includeTestOutputDirectory

Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.

verbose

protected boolean verbose

Controls the verbosity of the output from invoking the plugin.

logging

protected String logging

Controls the level of logging from Liquibase when executing. The value can be "all", "finest", "finer", "fine", "info", "warning", "severe" or "off". The value is case insensitive.

propertyFile

protected String propertyFile

The Liquibase properties file used to configure the Liquibase Liquibase.

propertyFileWillOverride

protected boolean propertyFileWillOverride

Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.

clearCheckSums

protected boolean clearCheckSums

Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.

systemProperties

protected Properties systemProperties

List of system properties to pass to the database.

changeLogFile

protected String changeLogFile

Deprecated.

Specifies the change log file to use for Liquibase. No longer needed with updatePath.

changeLogSavePath

protected File changeLogSavePath

updatePath

@Parameter(property="lb.updatePath",
           defaultValue="${project.basedir}/src/main/scripts/changelogs")
protected File updatePath

Location of an update.xml

rollbackTag

@Parameter(property="liquibase.rollbackTag")
protected String rollbackTag

The tag to roll the database back to.

project

@Parameter(property="project",
           required=true)
protected org.apache.maven.project.MavenProject project

The Maven project that plugin is running under.

contexts

protected String contexts

The Liquibase contexts to execute, which can be "," separated if multiple contexts are required. If no context is specified then ALL contexts will be executed.

Constructor Detail

LiquibaseTestMojo

public LiquibaseTestMojo()

Method Detail

getBasedir

protected File getBasedir()

doFieldHack

protected void doFieldHack()

getLiquibasePropertiesFiles

protected File[] getLiquibasePropertiesFiles()
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class org.liquibase.maven.plugins.AbstractLiquibaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

performLiquibaseTask

protected void performLiquibaseTask(liquibase.Liquibase liquibase)
                             throws liquibase.exception.LiquibaseException

Overrides:

performLiquibaseTask in class org.liquibase.maven.plugins.AbstractLiquibaseChangeLogMojo

Throws:

liquibase.exception.LiquibaseException

parsePropertiesFile

protected void parsePropertiesFile(InputStream propertiesInputStream)
                            throws org.apache.maven.plugin.MojoExecutionException

Parses a properties file and sets the assocaited fields in the plugin.

Overrides:

parsePropertiesFile in class org.liquibase.maven.plugins.AbstractLiquibaseMojo

Parameters:

propertiesInputStream - The input stream which is the Liquibase properties that needs to be parsed.

Throws:

org.apache.maven.plugin.MojoExecutionException - If there is a problem parsing the file.

getDeclaredField

protected Field getDeclaredField(Class clazz,
                     String fieldName)
                          throws NoSuchFieldException

Recursively searches for the field specified by the fieldName in the class and all the super classes until it either finds it, or runs out of parents.

Parameters:

clazz - The Class to start searching from.

fieldName - The name of the field to retrieve.

Returns:

The Field identified by the field name.

Throws:

NoSuchFieldException - If the field was not found in the class or any of its super classes.

scanForChangelogs

protected Collection<File> scanForChangelogs(File searchPath)

generateUpdateLog

protected void generateUpdateLog(File changeLogFile,
                     Collection<File> changelogs)
                          throws FileNotFoundException,
                                 IOException

Throws:

FileNotFoundException

IOException

includeNode

protected Element includeNode(Document parentChangeLog,
                  File changelog)
                       throws IOException

Throws:

IOException