You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/01/20 17:59:42 UTC
[isis] 03/09: ISIS-2267: wip
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit e60bd982043b4bbccef25aa81a1ed31dd1883ea1
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 20 11:07:34 2020 +0000
ISIS-2267: wip
---
.../flyway/adoc/modules/flyway/pages/about.adoc | 35 ++++++++++-
.../flyway/impl/IsisModuleExtFlywayImpl.java | 53 ++--------------
...nfigurationCustomizerFromIsisConfiguration.java | 73 ++++++++++++++++++++++
extensions/pom.xml | 6 ++
4 files changed, 115 insertions(+), 52 deletions(-)
diff --git a/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc b/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
index 14b8bef..bb9a492 100644
--- a/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
+++ b/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
@@ -1,8 +1,37 @@
= Flyway (Extension)
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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 ag [...]
-TODO
-https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-execute-flyway-database-migrations-on-startup
+This module provides an very thin layer to use Spring Boot's integration with https://flywaydb.org[Flyway]
-https://www.baeldung.com/spring-boot-configure-data-source-programmatic
+== Dependencies
+
+Add the following dependency:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.isis.extensions</groupId>
+ <artifactId>isis-extensions-flyway-impl</artifactId>
+</dependency>
+----
+
+This will enable Spring Boot's integration with Flyway, and configure Flyway to pick up JDBC connection parameters from the `application.properties` (corresponding to `IsisConfiguration` class).
+
+Currently, only the form of persistence properties recognised are those of the JDO DataNucleus object store:
+
+isis.persistence.jdo-datanucleus.impl.javax.jdo.option.ConnectionURL = jdbc:h2:mem:test
+isis.persistence.jdo-datanucleus.impl.javax.jdo.option.ConnectionDriverName = org.h2.Driver
+isis.persistence.jdo-datanucleus.impl.javax.jdo.option.ConnectionUserName = sa
+isis.persistence.jdo-datanucleus.impl.javax.jdo.option.ConnectionPassword =
+
+
+
+
+
+== Reference
+
+See :
+
+* https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-execute-flyway-database-migrations-on-startup[Spring Boot docs] for Flyway integration
+* https://www.baeldung.com/spring-boot-configure-data-source-programmatic[www.baeldung.com] docs on how to programmatically build a `DataSource`
diff --git a/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/IsisModuleExtFlywayImpl.java b/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/IsisModuleExtFlywayImpl.java
index 90f3e76..ca11a61 100644
--- a/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/IsisModuleExtFlywayImpl.java
+++ b/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/IsisModuleExtFlywayImpl.java
@@ -18,10 +18,7 @@
*/
package org.apache.isis.extensions.flyway.impl;
-import javax.sql.DataSource;
-
-import org.springframework.boot.autoconfigure.flyway.FlywayDataSource;
-import org.springframework.boot.jdbc.DataSourceBuilder;
+import org.springframework.boot.autoconfigure.flyway.FlywayConfigurationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@@ -29,9 +26,7 @@ import org.springframework.context.annotation.Import;
import org.apache.isis.core.config.IsisConfiguration;
import org.apache.isis.core.config.IsisModuleCoreConfig;
-
-import lombok.Value;
-import lombok.val;
+import org.apache.isis.extensions.flyway.impl.config.FlywayConfigurationCustomizerFromIsisConfiguration;
@Configuration
@Import({
@@ -40,50 +35,10 @@ import lombok.val;
@ComponentScan
public class IsisModuleExtFlywayImpl {
- @Value
- static class JdbcConnectionParams {
- private final String connectionDriverName;
- private final String connectionUrl;
- private final String connectionUserName;
- private final String connectionPassword;
-
- public <T extends DataSource> DataSourceBuilder<T> configure(DataSourceBuilder<T> dataSourceBuilder) {
- dataSourceBuilder.driverClassName(connectionDriverName);
- dataSourceBuilder.url(connectionUrl);
- dataSourceBuilder.username(connectionUserName);
- dataSourceBuilder.password(connectionPassword);
- return dataSourceBuilder;
- }
- }
-
@Bean
- @FlywayDataSource
- public DataSource getDataSource(final IsisConfiguration isisConfiguration) {
-
- JdbcConnectionParams params = obtainParams(isisConfiguration);
-
- val dataSourceBuilder = DataSourceBuilder.create();
- params.configure(dataSourceBuilder);
- return dataSourceBuilder.build();
+ public FlywayConfigurationCustomizer flywayConfigurationCustomizer(final IsisConfiguration isisConfiguration) {
+ return new FlywayConfigurationCustomizerFromIsisConfiguration(isisConfiguration);
}
- /**
- * Searches for JDO connection params.
- *
- * <p>
- * In the future, could also search for JPA etc.
- * </p>
- */
- private static JdbcConnectionParams obtainParams(IsisConfiguration isisConfiguration) {
-
- val javaxJdoOption = isisConfiguration.getPersistence().getJdoDatanucleus().getImpl().getJavax().getJdo().getOption();
-
- val connectionDriverName = javaxJdoOption.getConnectionDriverName();
- val connectionUrl = javaxJdoOption.getConnectionUrl();
- val connectionUserName = javaxJdoOption.getConnectionUserName();
- val connectionPassword = javaxJdoOption.getConnectionPassword();
-
- return new JdbcConnectionParams(connectionDriverName, connectionUrl, connectionUserName, connectionPassword);
- }
}
diff --git a/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/config/FlywayConfigurationCustomizerFromIsisConfiguration.java b/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/config/FlywayConfigurationCustomizerFromIsisConfiguration.java
new file mode 100644
index 0000000..f3b80c3
--- /dev/null
+++ b/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flyway/impl/config/FlywayConfigurationCustomizerFromIsisConfiguration.java
@@ -0,0 +1,73 @@
+package org.apache.isis.extensions.flyway.impl.config;
+
+import javax.sql.DataSource;
+
+import org.flywaydb.core.api.configuration.FluentConfiguration;
+import org.springframework.boot.autoconfigure.flyway.FlywayConfigurationCustomizer;
+import org.springframework.boot.jdbc.DataSourceBuilder;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+import org.apache.isis.applib.annotation.OrderPrecedence;
+import org.apache.isis.core.config.IsisConfiguration;
+
+import lombok.Value;
+import lombok.val;
+
+@Component
+@Order(OrderPrecedence.HIGH)
+public class FlywayConfigurationCustomizerFromIsisConfiguration implements FlywayConfigurationCustomizer {
+
+ private final IsisConfiguration isisConfiguration;
+
+ public FlywayConfigurationCustomizerFromIsisConfiguration(
+ final IsisConfiguration isisConfiguration) {
+ this.isisConfiguration = isisConfiguration;
+ }
+
+ @Override
+ public void customize(final FluentConfiguration configuration) {
+ val params = obtainParams(isisConfiguration);
+ val datasource = params.createDatasource();
+
+ configuration.dataSource(datasource);
+ }
+
+ /**
+ * Searches for JDO connection params.
+ *
+ * <p>
+ * In the future, could also search for JPA etc.
+ * </p>
+ */
+ private static JdbcConnectionParams obtainParams(final IsisConfiguration isisConfiguration) {
+
+ val javaxJdoOption = isisConfiguration.getPersistence().getJdoDatanucleus().getImpl().getJavax().getJdo().getOption();
+
+ val connectionDriverName = javaxJdoOption.getConnectionDriverName();
+ val connectionUrl = javaxJdoOption.getConnectionUrl();
+ val connectionUserName = javaxJdoOption.getConnectionUserName();
+ val connectionPassword = javaxJdoOption.getConnectionPassword();
+
+ return new JdbcConnectionParams(connectionDriverName, connectionUrl, connectionUserName, connectionPassword);
+ }
+
+ @Value
+ static class JdbcConnectionParams {
+ private final String connectionDriverName;
+ private final String connectionUrl;
+ private final String connectionUserName;
+ private final String connectionPassword;
+
+ public DataSource createDatasource() {
+ val dataSourceBuilder = DataSourceBuilder.create();
+ dataSourceBuilder.driverClassName(connectionDriverName);
+ dataSourceBuilder.url(connectionUrl);
+ dataSourceBuilder.username(connectionUserName);
+ dataSourceBuilder.password(connectionPassword);
+ return dataSourceBuilder.build();
+ }
+ }
+
+
+}
diff --git a/extensions/pom.xml b/extensions/pom.xml
index 469be76..6aa9306 100644
--- a/extensions/pom.xml
+++ b/extensions/pom.xml
@@ -70,6 +70,12 @@
<dependency>
<groupId>org.apache.isis.extensions</groupId>
+ <artifactId>isis-extensions-flyway-impl</artifactId>
+ <version>2.0.0-M3-SNAPSHOT</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.isis.extensions</groupId>
<artifactId>isis-extensions-pdfjs-applib</artifactId>
<version>2.0.0-M3-SNAPSHOT</version>
</dependency>