Add the InitialScriptLoader class to load a import.sql file on startup

Author: nakamura-to

README.md

@@ -7,6 +7,7 @@ Quarkus Extension for Doma provides the following features:
 
 - Hot reload
 - Automatic bean register
+- Automatic SQL execution on startup
 - Configuration
 - Support for native images
 
@@ -18,6 +19,10 @@ In development mode, SQL and Script files are hot reloaded.
 
 Our extension registers all DAO beans to the Quarkus CDI container automatically.
 
+### Automatic SQL import on startup
+
+Our extension executes ``import.sql`` automatically when Doma starts.
+
 ### Configuration
 
 You can write the following configurations in your application.properties file: 
@@ -32,6 +37,7 @@ quarkus.doma.batch-size=0
 quarkus.doma.fetch-size=0
 quarkus.doma.max-rows=0
 quarkus.doma.query-timeout=0
+quarkus-doma_quarkus.doma.sql-load-script=import.sql
 
 quarkus.doma.log.sql=false
 quarkus.doma.log.dao=false

deployment/src/main/java/org/seasar/doma/quarkus/deployment/DomaConfigurationMerger.java

@@ -1,27 +1,46 @@
 package org.seasar.doma.quarkus.deployment;
 
 import io.quarkus.agroal.deployment.JdbcDataSourceBuildItem;
+import io.quarkus.deployment.builditem.ApplicationArchivesBuildItem;
+import io.quarkus.deployment.builditem.LaunchModeBuildItem;
+import io.quarkus.runtime.LaunchMode;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Stream;
 import org.jboss.logging.Logger;
 import org.seasar.doma.quarkus.runtime.DomaConfiguration;
+import org.seasar.doma.quarkus.runtime.InitialScript;
 
 public class DomaConfigurationMerger {
 
   private static final Logger LOGGER = Logger.getLogger(DomaConfigurationMerger.class);
 
   private final DomaConfiguration configuration;
   private final List<JdbcDataSourceBuildItem> dataSources;
+  private final ApplicationArchivesBuildItem applicationArchives;
+  private final LaunchModeBuildItem launchMode;
 
   DomaConfigurationMerger(
-      DomaConfiguration configuration, List<JdbcDataSourceBuildItem> dataSources) {
+      DomaConfiguration configuration,
+      List<JdbcDataSourceBuildItem> dataSources,
+      ApplicationArchivesBuildItem applicationArchives,
+      LaunchModeBuildItem launchMode) {
     this.configuration = Objects.requireNonNull(configuration);
     this.dataSources = Objects.requireNonNull(dataSources);
+    this.applicationArchives = Objects.requireNonNull(applicationArchives);
+    this.launchMode = Objects.requireNonNull(launchMode);
   }
 
   void merge() {
+    mergeDataSourceDependentItems();
+    mergeSqlLoadScript();
+    LOGGER.debugf("configuration: %s", configuration);
+  }
+
+  private void mergeDataSourceDependentItems() {
     Optional<String> dataSourceName = configuration.datasourceName;
     Optional<DomaConfiguration.DialectType> dialect = configuration.dialect;
 
@@ -38,11 +57,10 @@ void merge() {
           configuration.dialect = Optional.of(inferDialectType(dbKind));
         } else {
           throw new IllegalStateException(
-              "The quarkus.doma.datasource-name \""
-                  + dataSourceName.get()
-                  + "\" is found, but quarkus.datasource named \""
-                  + dataSourceName.get()
-                  + "\" is not found.");
+              String.format(
+                  "'quarkus.doma.datasource-name=%s' is found, "
+                      + "but 'quarkus.datasource.\"datasource-name\"' is not found.",
+                  dataSourceName.get()));
         }
       }
     } else {
@@ -65,8 +83,6 @@ void merge() {
                 + "Specify the configuration in your application.properties.");
       }
     }
-
-    LOGGER.debugf("configuration: %s", configuration);
   }
 
   private DomaConfiguration.DialectType inferDialectType(String dbKind) {
@@ -89,4 +105,34 @@ private DomaConfiguration.DialectType inferDialectType(String dbKind) {
                 + "\". The dbKind is illegal or not supported.");
     }
   }
+
+  private void mergeSqlLoadScript() {
+    Optional<String> sqlLoadScript = configuration.sqlLoadScript;
+    if (sqlLoadScript.isPresent()) {
+      if (sqlLoadScript.get().equals(InitialScript.NO_FILE)) {
+        configuration.sqlLoadScript = Optional.empty();
+      } else {
+        Path path = applicationArchives.getRootArchive().getChildPath(sqlLoadScript.get());
+        if (path == null || Files.isDirectory(path)) {
+          throw new IllegalStateException(
+              String.format(
+                  "Can't find the file referenced in 'quarkus.doma.sql-load-script=%s'. "
+                      + "Remove property or add file to your path.",
+                  sqlLoadScript.get()));
+        }
+      }
+    } else {
+      LaunchMode mode = launchMode.getLaunchMode();
+      if (mode == LaunchMode.DEVELOPMENT || mode == LaunchMode.TEST) {
+        Path path = applicationArchives.getRootArchive().getChildPath(InitialScript.DEFAULT);
+        if (path == null || Files.isDirectory(path)) {
+          configuration.sqlLoadScript = Optional.empty();
+        } else {
+          configuration.sqlLoadScript = Optional.of(InitialScript.DEFAULT);
+        }
+      } else {
+        configuration.sqlLoadScript = Optional.empty();
+      }
+    }
+  }
 }

deployment/src/main/java/org/seasar/doma/quarkus/deployment/DomaProcessor.java

@@ -10,18 +10,24 @@
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.Record;
+import io.quarkus.deployment.builditem.ApplicationArchivesBuildItem;
 import io.quarkus.deployment.builditem.FeatureBuildItem;
+import io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem;
 import io.quarkus.deployment.builditem.LaunchModeBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 import io.quarkus.runtime.LaunchMode;
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
 import org.jboss.jandex.DotName;
 import org.jboss.jandex.IndexView;
 import org.seasar.doma.DaoImplementation;
 import org.seasar.doma.quarkus.runtime.DomaConfiguration;
 import org.seasar.doma.quarkus.runtime.DomaProducer;
 import org.seasar.doma.quarkus.runtime.DomaRecorder;
+import org.seasar.doma.quarkus.runtime.InitialScriptLoader;
 
 class DomaProcessor {
 
@@ -33,41 +39,69 @@ FeatureBuildItem feature() {
   }
 
   @BuildStep
-  NativeImageResourceBuildItem resources() {
-    DomaResourceScanner scanner = new DomaResourceScanner();
-    List<String> resources = scanner.scan();
-    return new NativeImageResourceBuildItem(resources);
+  AdditionalBeanBuildItem additionalBeans() {
+    return new AdditionalBeanBuildItem(DomaProducer.class);
   }
 
   @BuildStep
-  ReflectiveClassBuildItem classes(BeanArchiveIndexBuildItem beanArchiveIndex) {
-    IndexView indexView = beanArchiveIndex.getIndex();
-    DomaClassScanner scanner = new DomaClassScanner(indexView);
-    List<String> classes = scanner.scan();
-    return new ReflectiveClassBuildItem(true, true, classes.toArray(new String[0]));
+  BeanDefiningAnnotationBuildItem beanDefiningAnnotation() {
+    return new BeanDefiningAnnotationBuildItem(
+        DotName.createSimple(DaoImplementation.class.getName()));
   }
 
   @BuildStep
-  AdditionalBeanBuildItem additionalBeans() {
-    return new AdditionalBeanBuildItem(DomaProducer.class);
+  MergedConfigurationBuildItem mergedConfiguration(
+      DomaConfiguration configuration,
+      List<JdbcDataSourceBuildItem> dataSources,
+      ApplicationArchivesBuildItem applicationArchives,
+      LaunchModeBuildItem launchMode) {
+    DomaConfigurationMerger merger =
+        new DomaConfigurationMerger(configuration, dataSources, applicationArchives, launchMode);
+    merger.merge();
+    return new MergedConfigurationBuildItem(configuration);
   }
 
   @BuildStep
-  BeanDefiningAnnotationBuildItem beanDefiningAnnotation() {
-    return new BeanDefiningAnnotationBuildItem(
-        DotName.createSimple(DaoImplementation.class.getName()));
+  List<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFile(
+      MergedConfigurationBuildItem mergedConfiguration) {
+    DomaConfiguration configuration = mergedConfiguration.getConfiguration();
+    Optional<String> sqlLoadScript = configuration.sqlLoadScript;
+    return sqlLoadScript
+        .map(it -> Collections.singletonList(new HotDeploymentWatchedFileBuildItem(it)))
+        .orElse(Collections.emptyList());
+  }
+
+  @BuildStep
+  NativeImageResourceBuildItem resources(MergedConfigurationBuildItem mergedConfiguration) {
+    List<String> resources = new ArrayList<>();
+    DomaConfiguration configuration = mergedConfiguration.getConfiguration();
+    Optional<String> sqlLoadScript = configuration.sqlLoadScript;
+    sqlLoadScript.ifPresent(resources::add);
+    DomaResourceScanner scanner = new DomaResourceScanner();
+    List<String> scannedResources = scanner.scan();
+    resources.addAll(scannedResources);
+    return new NativeImageResourceBuildItem(resources);
+  }
+
+  @BuildStep
+  ReflectiveClassBuildItem classes(BeanArchiveIndexBuildItem beanArchiveIndex) {
+    List<String> classes = new ArrayList<>();
+    IndexView indexView = beanArchiveIndex.getIndex();
+    DomaClassScanner scanner = new DomaClassScanner(indexView);
+    List<String> scannedClasses = scanner.scan();
+    classes.add(InitialScriptLoader.class.getName());
+    classes.addAll(scannedClasses);
+    return new ReflectiveClassBuildItem(true, true, classes.toArray(new String[0]));
   }
 
   @BuildStep
   @Record(STATIC_INIT)
   void configure(
       DomaRecorder recorder,
-      DomaConfiguration configuration,
-      List<JdbcDataSourceBuildItem> dataSources,
+      MergedConfigurationBuildItem mergedConfiguration,
       LaunchModeBuildItem launchMode,
       BuildProducer<BeanContainerListenerBuildItem> beanContainerListeners) {
-    DomaConfigurationMerger merger = new DomaConfigurationMerger(configuration, dataSources);
-    merger.merge();
+    DomaConfiguration configuration = mergedConfiguration.getConfiguration();
     beanContainerListeners.produce(
         new BeanContainerListenerBuildItem(recorder.configure(configuration)));
     if (launchMode.getLaunchMode() == LaunchMode.DEVELOPMENT) {

deployment/src/main/java/org/seasar/doma/quarkus/deployment/MergedConfigurationBuildItem.java

@@ -0,0 +1,18 @@
+package org.seasar.doma.quarkus.deployment;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+import java.util.Objects;
+import org.seasar.doma.quarkus.runtime.DomaConfiguration;
+
+public final class MergedConfigurationBuildItem extends SimpleBuildItem {
+
+  private final DomaConfiguration configuration;
+
+  public MergedConfigurationBuildItem(DomaConfiguration configuration) {
+    this.configuration = Objects.requireNonNull(configuration);
+  }
+
+  public DomaConfiguration getConfiguration() {
+    return configuration;
+  }
+}

deployment/src/test/java/org/seasar/doma/quarkus/deployment/InitialScriptLoaderCustomTest.java

@@ -0,0 +1,52 @@
+package org.seasar.doma.quarkus.deployment;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import io.quarkus.test.QuarkusUnitTest;
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.Statement;
+import javax.inject.Inject;
+import javax.sql.DataSource;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+public class InitialScriptLoaderCustomTest {
+
+  @RegisterExtension
+  static QuarkusUnitTest runner =
+      new QuarkusUnitTest()
+          .setArchiveProducer(
+              () ->
+                  ShrinkWrap.create(JavaArchive.class)
+                      .add(
+                          new StringAsset(
+                              "quarkus.datasource.db-kind=h2\n"
+                                  + "quarkus.datasource.username=USERNAME-NAMED\n"
+                                  + "quarkus.datasource.jdbc.url=jdbc:h2:tcp://localhost/mem:testing\n"
+                                  + "quarkus.datasource.jdbc.driver=org.h2.Driver\n"
+                                  + "quarkus.doma.sql-load-script=import2.sql\n"
+                                  + "quarkus.doma.log.sql=true\n"),
+                          "application.properties")
+                      .addAsResource("import2.sql"));
+
+  @Inject DataSource dataSource;
+
+  @Test
+  public void test() throws Exception {
+    int count = 0;
+    try (Connection connection = dataSource.getConnection()) {
+      try (Statement statement = connection.createStatement()) {
+        try (ResultSet resultSet = statement.executeQuery("select id from department")) {
+          while (resultSet.next()) {
+            count++;
+          }
+        }
+      }
+    }
+    assertEquals(2, count);
+  }
+}

deployment/src/test/java/org/seasar/doma/quarkus/deployment/InitialScriptLoaderTest.java

@@ -0,0 +1,51 @@
+package org.seasar.doma.quarkus.deployment;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import io.quarkus.test.QuarkusUnitTest;
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.Statement;
+import javax.inject.Inject;
+import javax.sql.DataSource;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+public class InitialScriptLoaderTest {
+
+  @RegisterExtension
+  static QuarkusUnitTest runner =
+      new QuarkusUnitTest()
+          .setArchiveProducer(
+              () ->
+                  ShrinkWrap.create(JavaArchive.class)
+                      .add(
+                          new StringAsset(
+                              "quarkus.datasource.db-kind=h2\n"
+                                  + "quarkus.datasource.username=USERNAME-NAMED\n"
+                                  + "quarkus.datasource.jdbc.url=jdbc:h2:tcp://localhost/mem:testing\n"
+                                  + "quarkus.datasource.jdbc.driver=org.h2.Driver\n"
+                                  + "quarkus.doma.log.sql=true\n"),
+                          "application.properties")
+                      .addAsResource("import.sql"));
+
+  @Inject DataSource dataSource;
+
+  @Test
+  public void test() throws Exception {
+    int count = 0;
+    try (Connection connection = dataSource.getConnection()) {
+      try (Statement statement = connection.createStatement()) {
+        try (ResultSet resultSet = statement.executeQuery("select id from employee")) {
+          while (resultSet.next()) {
+            count++;
+          }
+        }
+      }
+    }
+    assertEquals(2, count);
+  }
+}