Author: bleny Date: 2014-04-30 15:56:22 +0200 (Wed, 30 Apr 2014) New Revision: 3089 Url: http://forge.nuiton.org/projects/topia/repository/revisions/3089 Log: fixes #3181 introduce topia-service-flyway Added: trunk/topia-service-flyway/ trunk/topia-service-flyway/LICENSE.txt trunk/topia-service-flyway/README.txt trunk/topia-service-flyway/pom.xml trunk/topia-service-flyway/src/ trunk/topia-service-flyway/src/main/ trunk/topia-service-flyway/src/main/java/ trunk/topia-service-flyway/src/main/java/org/ trunk/topia-service-flyway/src/main/java/org/nuiton/ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayJdbcMigration.java trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayMigrationInfoProvider.java trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayService.java trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayServiceImpl.java Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2014-04-30 11:17:38 UTC (rev 3088) +++ trunk/pom.xml 2014-04-30 13:56:22 UTC (rev 3089) @@ -207,6 +207,7 @@ <module>topia-it</module> <module>topia-service-replication</module> <module>topia-service-migration</module> + <module>topia-service-flyway</module> <module>topia-service-csv</module> </modules> @@ -326,6 +327,12 @@ <scope>runtime</scope> </dependency> + <dependency> + <groupId>com.googlecode.flyway</groupId> + <artifactId>flyway-core</artifactId> + <version>2.3</version> + </dependency> + <!-- hibernate-core only include api, need implementation, binding with log4j will be used --> Property changes on: trunk/topia-service-flyway ___________________________________________________________________ Added: svn:ignore + *.ipr *.iws .classpath *.iml .project target .settings .idea atlassian-ide-plugin.xml Copied: trunk/topia-service-flyway/LICENSE.txt (from rev 3088, trunk/topia-service-migration/LICENSE.txt) =================================================================== --- trunk/topia-service-flyway/LICENSE.txt (rev 0) +++ trunk/topia-service-flyway/LICENSE.txt 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. Added: trunk/topia-service-flyway/README.txt =================================================================== Added: trunk/topia-service-flyway/pom.xml =================================================================== --- trunk/topia-service-flyway/pom.xml (rev 0) +++ trunk/topia-service-flyway/pom.xml 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.nuiton</groupId> + <artifactId>topia</artifactId> + <version>3.0-SNAPSHOT</version> + </parent> + + <groupId>org.nuiton.topia</groupId> + <artifactId>topia-service-flyway</artifactId> + <name>ToPIA :: Flyway integration service</name> + <description>Integration between topia and Flyway database migration framework</description> + + <dependencies> + + <!-- Sibling dependencies --> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>topia-persistence</artifactId> + <version>${project.version}</version> + <scope>compile</scope> + </dependency> + + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>topia-junit</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.nuiton</groupId> + <artifactId>nuiton-utils</artifactId> + </dependency> + + <dependency> + <groupId>org.apache.commons</groupId> + <artifactId>commons-lang3</artifactId> + </dependency> + + <dependency> + <groupId>com.google.guava</groupId> + <artifactId>guava</artifactId> + </dependency> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + </dependency> + + <dependency> + <groupId>com.googlecode.flyway</groupId> + <artifactId>flyway-core</artifactId> + </dependency> + + <!-- Depencies for test--> + <dependency> + <groupId>com.h2database</groupId> + <artifactId>h2</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + </dependency> + + </dependencies> + + <build> + <resources> + + <resource> + <directory>${maven.src.dir}/main/resources</directory> + <includes> + <include>**/*.hbm.xml</include> + <include>**/*.properties</include> + </includes> + </resource> + + </resources> + <plugins> + + </plugins> + </build> + +</project> + Property changes on: trunk/topia-service-flyway/pom.xml ___________________________________________________________________ Added: svn:mime-type + text/xml Added: trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayJdbcMigration.java =================================================================== --- trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayJdbcMigration.java (rev 0) +++ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayJdbcMigration.java 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,12 @@ +package org.nuiton.topia.flyway; + +import com.googlecode.flyway.core.api.migration.jdbc.JdbcMigration; + +/** + * Just an interface renaming so you don't need to add flyway as dependency and risk a version conflict. + * + * @since 3.0 + */ +public interface TopiaFlywayJdbcMigration extends JdbcMigration { + +} Added: trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayMigrationInfoProvider.java =================================================================== --- trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayMigrationInfoProvider.java (rev 0) +++ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayMigrationInfoProvider.java 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,12 @@ +package org.nuiton.topia.flyway; + +import com.googlecode.flyway.core.api.migration.MigrationInfoProvider; + +/** + * Just an interface renaming so you don't need to add flyway as dependency and risk a version conflict. + * + * @since 3.0 + */ +public interface TopiaFlywayMigrationInfoProvider extends MigrationInfoProvider { + +} Added: trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayService.java =================================================================== --- trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayService.java (rev 0) +++ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayService.java 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,19 @@ +package org.nuiton.topia.flyway; + +import org.nuiton.topia.persistence.TopiaService; + +/** + * Integrates Topia with <a href="http://flywaydb.org/">Flyway database migration framework</a>. + * + * @since 3.0 + */ +public interface TopiaFlywayService extends TopiaService { + + /** + * If you want flyway to init with an already existing DB, you must use + * this configuration and give, as value the version of the already + * existing schema. + */ + public static final String FLYWAY_INIT_VERSION = "flyway.initVersion"; + +} Added: trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayServiceImpl.java =================================================================== --- trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayServiceImpl.java (rev 0) +++ trunk/topia-service-flyway/src/main/java/org/nuiton/topia/flyway/TopiaFlywayServiceImpl.java 2014-04-30 13:56:22 UTC (rev 3089) @@ -0,0 +1,215 @@ +package org.nuiton.topia.flyway; + +import com.google.common.collect.ImmutableSet; +import com.googlecode.flyway.core.Flyway; +import com.googlecode.flyway.core.util.Location; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.topia.persistence.TopiaApplicationContext; +import org.nuiton.topia.persistence.TopiaException; + +import java.io.IOException; +import java.net.URL; +import java.util.Enumeration; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Set; + +/** + * Implementation for {@link org.nuiton.topia.flyway.TopiaFlywayService}. + * + * @since 3.0 + */ +public class TopiaFlywayServiceImpl implements TopiaFlywayService { + + private static final Log log = LogFactory.getLog(TopiaFlywayServiceImpl.class); + + /** + * Value for {@link #FLYWAY_INIT_VERSION} configuration parameter. + */ + protected String flywayInitVersion = null; + + @Override + public void setConfiguration(Map<String, String> serviceConfiguration) { + // set flywayInitVersion is provided + if (serviceConfiguration.containsKey(FLYWAY_INIT_VERSION)) { + flywayInitVersion = serviceConfiguration.get(FLYWAY_INIT_VERSION); + if (StringUtils.isBlank(flywayInitVersion)) { + throw new IllegalArgumentException("'" + flywayInitVersion + "' must not be empty"); + } + } + } + + @Override + public Class<?>[] getPersistenceClasses() { + return new Class<?>[0]; + } + + @Override + public void preInit(TopiaApplicationContext topiaApplicationContext) { + + if (log.isInfoEnabled()) { + log.info("init flyway service"); + } + + Flyway flyway = new Flyway(); + + setDataSource(flyway, topiaApplicationContext); + + setLocations(flyway, topiaApplicationContext); + + doExtraConfiguration(flyway, topiaApplicationContext); + + if (isSchemaEmpty(flyway, topiaApplicationContext)) { + + createSchema(flyway, topiaApplicationContext); + + } else { + + migrateSchema(flyway, topiaApplicationContext); + + } + + } + + /** + * Define flyway database credentials. + * + * This implementation search for parameters given in + * {@link org.nuiton.topia.persistence.TopiaApplicationContext#getConfiguration()}. We use + * the same credentials to migrate the database as the one used when we use it. + */ + protected void setDataSource(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + Map<String, String> configuration = topiaApplicationContext.getConfiguration(); + + String url = configuration.get("hibernate.connection.url"); + String user = configuration.get("hibernate.connection.username"); + String password = configuration.get("hibernate.connection.password"); + + flyway.setDataSource(url, user, password); + + } + + /** + * Define where Flyway should look for migrations. + * + * This implementation search for *.sql migration files in "db/migration" resources directory + * and for JDBC migrations in package.to.ApplicationContext<strong>.migration</strong> package. + */ + protected void setLocations(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + String classpathMigrationPackage = topiaApplicationContext.getClass().getPackage().getName() + ".migration"; + ImmutableSet<String> defaultLocations = ImmutableSet.of("db/migration", classpathMigrationPackage); + + // detects migrations and configure flyway locations + Set<String> locations = new LinkedHashSet<String>(); + for (String defaultLocation : defaultLocations) { + if (log.isInfoEnabled()) { + log.info("will search for migration in location " + defaultLocation); + } + try { + Location location = new Location(defaultLocation); + Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources(location.getPath()); + if (resources.hasMoreElements()) { + locations.add(defaultLocation); + if (log.isInfoEnabled()) { + log.info("migrations found in " + defaultLocation); + } + } else { + if (log.isInfoEnabled()) { + log.info("no migration found in " + defaultLocation); + } + } + } catch (IOException e) { + throw new TopiaException(e); + } + } + + String[] locationsArray = locations.toArray(new String[locations.size()]); + flyway.setLocations(locationsArray); + } + + /** + * Opened hook to override in a sub-class. + */ + protected void doExtraConfiguration(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + } + + /** + * Check if schema exists. If true is returned, we won't use any migrations and just create shema + * according to model. If false, a schema already exists and an migration should be tried. + */ + protected boolean isSchemaEmpty(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + boolean schemaEmpty = topiaApplicationContext.isSchemaEmpty(); + + return schemaEmpty; + + } + + protected void createSchema(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + String initVersion = topiaApplicationContext.getModelVersion(); + + if (log.isInfoEnabled()) { + log.info("schema is empty, ignore migrations and let topia create schema"); + } + + topiaApplicationContext.createSchema(); + + if (log.isInfoEnabled()) { + log.info("init flyway to version " + initVersion); + } + + flyway.setInitVersion(initVersion); + flyway.setInitDescription("schema creation called on application context by topia flyway service"); + flyway.init(); + + } + + protected void migrateSchema(Flyway flyway, TopiaApplicationContext topiaApplicationContext) { + + if (flywayInitVersion == null) { + if (log.isDebugEnabled()) { + log.debug("schema exists, no flywayInitVersion found, let suppose flyway is already initialized"); + } + // if flyway is not initialized, we will get +// Grave: Exception sending context initialized event to listener instance of class fr.ifremer.wao.web.WaoApplicationListener +// com.googlecode.flyway.core.api.FlywayException: Found non-empty schema "public" without metadata table! Use init() or set initOnMigrate to true to initialize the metadata table. +// at com.googlecode.flyway.core.Flyway$1.execute(Flyway.java:848) +// at com.googlecode.flyway.core.Flyway$1.execute(Flyway.java:819) +// at com.googlecode.flyway.core.Flyway.execute(Flyway.java:1200) +// at com.googlecode.flyway.core.Flyway.migrate(Flyway.java:819) + + } else { + if (log.isDebugEnabled()) { + log.debug("schema exists, will ask flyway to init if necessary to version " + flywayInitVersion); + } + flyway.setInitOnMigrate(true); + flyway.setInitVersion(flywayInitVersion); + } + + String targetVersion = topiaApplicationContext.getModelVersion(); + + if (log.isInfoEnabled()) { + log.info("schema exists, will run flyway migration up to target version " + targetVersion); + } + + flyway.setTarget(targetVersion); + + if (log.isInfoEnabled()) { + log.info("run flyway migration"); + } + + flyway.migrate(); + } + + @Override + public void postInit(TopiaApplicationContext applicationContext) { + // nothing to do + } + +}