feat: flyway & liquibase produce init containers

quarkusio · Nov 17, 2022 · a46d6e6 · a46d6e6
1 parent 7015944
commit a46d6e6
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 5 deletions.
diff --git a/extensions/flyway/deployment/pom.xml b/extensions/flyway/deployment/pom.xml
@@ -29,6 +29,14 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-flyway</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-container-image-spi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-kubernetes-spi</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit5-internal</artifactId>

diff --git a/extensions/flyway/deployment/src/main/java/io/quarkus/flyway/FlywayProcessor.java b/extensions/flyway/deployment/src/main/java/io/quarkus/flyway/FlywayProcessor.java
@@ -38,6 +38,7 @@
 import io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem;
 import io.quarkus.arc.processor.DotNames;
 import io.quarkus.builder.item.SimpleBuildItem;
+import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.datasource.common.runtime.DataSourceUtil;
 import io.quarkus.deployment.Feature;
 import io.quarkus.deployment.annotations.BuildProducer;
@@ -60,6 +61,9 @@
 import io.quarkus.flyway.runtime.FlywayBuildTimeConfig;
 import io.quarkus.flyway.runtime.FlywayContainerProducer;
 import io.quarkus.flyway.runtime.FlywayRecorder;
+import io.quarkus.flyway.runtime.FlywayRuntimeConfig;
+import io.quarkus.kubernetes.spi.KubernetesEnvBuildItem;
+import io.quarkus.kubernetes.spi.KubernetesInitContainerBuildItem;
 import io.quarkus.runtime.util.ClassPathUtils;
 
 class FlywayProcessor {
@@ -204,9 +208,10 @@ void createBeans(FlywayRecorder recorder,
     @Consume(SyntheticBeansRuntimeInitBuildItem.class)
     @Record(ExecutionTime.RUNTIME_INIT)
     public ServiceStartBuildItem startActions(FlywayRecorder recorder,
+            FlywayRuntimeConfig config,
             BuildProducer<JdbcDataSourceSchemaReadyBuildItem> schemaReadyBuildItem,
             MigrationStateBuildItem migrationsBuildItem) {
-        // will actually run the actions at runtime
+
         recorder.doStartActions();
 
         // once we are done running the migrations, we produce a build item indicating that the
@@ -216,6 +221,18 @@ public ServiceStartBuildItem startActions(FlywayRecorder recorder,
         return new ServiceStartBuildItem("flyway");
     }
 
+    @BuildStep
+    void configureKubernetes(ContainerImageInfoBuildItem imageInfo,
+            BuildProducer<KubernetesInitContainerBuildItem> initContainers, BuildProducer<KubernetesEnvBuildItem> env) {
+        initContainers.produce(KubernetesInitContainerBuildItem.create("flyway")
+                .withImage(imageInfo.getImage())
+                .withEnvVars(Map.of("QUARKUS_FLYWAY_RUN_AND_EXIT", "true", "QUARKUS_FLYWAY_ENABLED", "true"))
+                .withInheritEnvVars(true)
+                .withInheritMounts(true));
+
+        env.produce(KubernetesEnvBuildItem.createSimpleVar("QUARKUS_FLYWAY_ENABLED", "false", null));
+    }
+
     private Set<String> getDataSourceNames(List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems) {
         Set<String> result = new HashSet<>(jdbcDataSourceBuildItems.size());
         for (JdbcDataSourceBuildItem item : jdbcDataSourceBuildItems) {

diff --git a/extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayRecorder.java b/extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayRecorder.java
@@ -27,6 +27,12 @@ public class FlywayRecorder {
 
     static final List<FlywayContainer> FLYWAY_CONTAINERS = new ArrayList<>(2);
 
+    private final FlywayRuntimeConfig config;
+
+    public FlywayRecorder(FlywayRuntimeConfig config) {
+        this.config = config;
+    }
+
     public void setApplicationMigrationFiles(Collection<String> migrationFiles) {
         log.debugv("Setting the following application migration files: {0}", migrationFiles);
         QuarkusPathLocationScanner.setApplicationMigrationFiles(migrationFiles);
@@ -69,6 +75,9 @@ public Flyway get() {
     }
 
     public void doStartActions() {
+        if (!config.enabled) {
+            return;
+        }
         for (FlywayContainer flywayContainer : FLYWAY_CONTAINERS) {
             if (flywayContainer.isCleanAtStart()) {
                 flywayContainer.getFlyway().clean();

diff --git a/extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayRuntimeConfig.java b/extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayRuntimeConfig.java
@@ -21,6 +21,13 @@ public FlywayDataSourceRuntimeConfig getConfigForDataSourceName(String dataSourc
         return namedDataSources.getOrDefault(dataSourceName, FlywayDataSourceRuntimeConfig.defaultConfig());
     }
 
+    /**
+     * Flag to enable / disable Liquibase.
+     *
+     */
+    @ConfigItem(defaultValue = "true")
+    public boolean enabled;
+
     /**
      * Flyway configuration for the default datasource.
      */
@@ -32,4 +39,4 @@ public FlywayDataSourceRuntimeConfig getConfigForDataSourceName(String dataSourc
      */
     @ConfigItem(name = ConfigItem.PARENT)
     public Map<String, FlywayDataSourceRuntimeConfig> namedDataSources = Collections.emptyMap();
-}
+}
diff --git a/extensions/liquibase/deployment/pom.xml b/extensions/liquibase/deployment/pom.xml
@@ -33,6 +33,14 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-liquibase</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-container-image-spi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-kubernetes-spi</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-junit5-internal</artifactId>

diff --git a/...iquibase/deployment/src/main/java/io/quarkus/liquibase/deployment/LiquibaseProcessor.java b/...iquibase/deployment/src/main/java/io/quarkus/liquibase/deployment/LiquibaseProcessor.java
@@ -11,6 +11,7 @@
 import java.util.HashSet;
 import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.BiConsumer;
@@ -31,6 +32,7 @@
 import io.quarkus.arc.deployment.SyntheticBeanBuildItem;
 import io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem;
 import io.quarkus.arc.processor.DotNames;
+import io.quarkus.container.spi.ContainerImageInfoBuildItem;
 import io.quarkus.datasource.common.runtime.DataSourceUtil;
 import io.quarkus.deployment.Feature;
 import io.quarkus.deployment.annotations.BuildProducer;
@@ -51,6 +53,8 @@
 import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
 import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild;
 import io.quarkus.deployment.util.ServiceUtil;
+import io.quarkus.kubernetes.spi.KubernetesEnvBuildItem;
+import io.quarkus.kubernetes.spi.KubernetesInitContainerBuildItem;
 import io.quarkus.liquibase.LiquibaseDataSource;
 import io.quarkus.liquibase.LiquibaseFactory;
 import io.quarkus.liquibase.runtime.LiquibaseBuildTimeConfig;
@@ -283,16 +287,27 @@ void createBeans(LiquibaseRecorder recorder,
     ServiceStartBuildItem startLiquibase(LiquibaseRecorder recorder,
             List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems,
             BuildProducer<JdbcDataSourceSchemaReadyBuildItem> schemaReadyBuildItem) {
-        // will actually run the actions at runtime
-        recorder.doStartActions();
 
+        recorder.doStartActions();
         // once we are done running the migrations, we produce a build item indicating that the
         // schema is "ready"
         schemaReadyBuildItem.produce(new JdbcDataSourceSchemaReadyBuildItem(getDataSourceNames(jdbcDataSourceBuildItems)));
 
         return new ServiceStartBuildItem("liquibase");
     }
 
+    @BuildStep
+    void configureKubernetes(ContainerImageInfoBuildItem imageInfo,
+            BuildProducer<KubernetesInitContainerBuildItem> initContainers, BuildProducer<KubernetesEnvBuildItem> env) {
+        initContainers.produce(KubernetesInitContainerBuildItem.create("liquibase")
+                .withImage(imageInfo.getImage())
+                .withEnvVars(Map.of("QUARKUS_LIQUIBASE_RUN_AND_EXIT", "true", "QUARKUS_LIQUIBASE_ENABLED", "true"))
+                .withInheritEnvVars(true)
+                .withInheritMounts(true));
+
+        env.produce(KubernetesEnvBuildItem.createSimpleVar("QUARKUS_LIQUIBASE_ENABLED", "false", null));
+    }
+
     private Set<String> getDataSourceNames(List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems) {
         Set<String> result = new HashSet<>(jdbcDataSourceBuildItems.size());
         for (JdbcDataSourceBuildItem item : jdbcDataSourceBuildItems) {

diff --git a/...sions/liquibase/runtime/src/main/java/io/quarkus/liquibase/runtime/LiquibaseRecorder.java b/...sions/liquibase/runtime/src/main/java/io/quarkus/liquibase/runtime/LiquibaseRecorder.java
@@ -6,6 +6,8 @@
 import javax.enterprise.inject.UnsatisfiedResolutionException;
 import javax.sql.DataSource;
 
+import org.jboss.logging.Logger;
+
 import io.quarkus.agroal.runtime.DataSources;
 import io.quarkus.agroal.runtime.UnconfiguredDataSource;
 import io.quarkus.arc.Arc;
@@ -20,6 +22,14 @@
 @Recorder
 public class LiquibaseRecorder {
 
+    private static final Logger log = Logger.getLogger(LiquibaseRecorder.class);
+
+    private final LiquibaseRuntimeConfig config;
+
+    public LiquibaseRecorder(LiquibaseRuntimeConfig config) {
+        this.config = config;
+    }
+
     public Supplier<LiquibaseFactory> liquibaseSupplier(String dataSourceName) {
         DataSource dataSource = DataSources.fromName(dataSourceName);
         if (dataSource instanceof UnconfiguredDataSource) {
@@ -41,6 +51,10 @@ public LiquibaseFactory get() {
     }
 
     public void doStartActions() {
+        if (!config.enabled) {
+            return;
+        }
+
         try {
             InjectableInstance<LiquibaseFactory> liquibaseFactoryInstance = Arc.container()
                     .select(LiquibaseFactory.class, Any.Literal.INSTANCE);

diff --git a/.../liquibase/runtime/src/main/java/io/quarkus/liquibase/runtime/LiquibaseRuntimeConfig.java b/.../liquibase/runtime/src/main/java/io/quarkus/liquibase/runtime/LiquibaseRuntimeConfig.java
@@ -29,6 +29,13 @@ public LiquibaseDataSourceRuntimeConfig getConfigForDataSourceName(String dataSo
         return namedDataSources.getOrDefault(dataSourceName, LiquibaseDataSourceRuntimeConfig.defaultConfig());
     }
 
+    /**
+     * Flag to enable / disable Liquibase.
+     *
+     */
+    @ConfigItem(defaultValue = "true")
+    public boolean enabled;
+
     /**
      * Liquibase configuration for the default datasource.
      */
@@ -40,4 +47,4 @@ public LiquibaseDataSourceRuntimeConfig getConfigForDataSourceName(String dataSo
      */
     @ConfigItem(name = ConfigItem.PARENT)
     public Map<String, LiquibaseDataSourceRuntimeConfig> namedDataSources = Collections.emptyMap();
-}
+}