incubator-kie-issues#1483: Create a common Kie Flyway initializer for Kie Modules

apps-integration-tests/integration-tests-jobs-service/integration-tests-jobs-service-common/src/main/java/org/kie/kogito/testcontainers/JobServiceContainer.java

@@ -32,6 +32,9 @@ public JobServiceContainer() {
         waitingFor(Wait.forHttp("/q/health/live").forStatusCode(200)).withStartupTimeout(Constants.CONTAINER_START_TIMEOUT);
         addEnv("QUARKUS_HTTP_PORT", Integer.toString(PORT));
         addEnv("QUARKUS_LOG_CATEGORY__ORG_KIE_KOGITO_JOBS_SERVICE__LEVEL", "DEBUG");
+        addEnv("QUARKUS_FLYWAY_MIGRATE_AT_START", "true");
+        addEnv("QUARKUS_FLYWAY_BASELINE_ON_MIGRATE", "true");
+        addEnv("QUARKUS_FLYWAY_CLEAN_AT_START", "false");
         withAccessToHost(true);
     }
 

apps-integration-tests/integration-tests-jobs-service/integration-tests-jobs-service-quarkus/integration-tests-jobs-service-common-quarkus/src/main/java/org/kie/kogito/test/resources/JobServiceCompositeQuarkusTestResource.java

@@ -66,6 +66,7 @@ public void init(JobServiceTestResource annotation) {
         if (annotation.dataIndexEnabled()) {
             DataIndexPostgreSqlContainer container = new DataIndexPostgreSqlContainer();
             container.addProtoFileFolder();
+            container.migrateDB();
             container.addEnv("QUARKUS_PROFILE", "kafka-events-support");
             KogitoPostgreSqlContainer postgresql = new KogitoPostgreSqlContainer();
             resource.withServiceContainer("data-index", container, postgresql);

data-audit/kogito-addons-data-audit-jpa/kogito-addons-data-audit-jpa-common/src/main/resources/META-INF/kie-flyway.properties

@@ -0,0 +1,23 @@
+#
+# 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 agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+module.name=data-audit
+
+module.locations.h2=classpath:kie-flyway/db/data-audit/h2
+module.locations.postgresql=classpath:kie-flyway/db/data-audit/postgresql

data-audit/kogito-addons-data-audit-jpa/kogito-addons-data-audit-jpa-common/src/main/resources/db/data-audit/postgresql/V1.0.0__CREATE DATA AUDIT SCHEMA.sql → data-audit/kogito-addons-data-audit-jpa/kogito-addons-data-audit-jpa-common/src/main/resources/kie-flyway/db/data-audit/h2/V1.0.0__CREATE DATA AUDIT SCHEMA.sql

@@ -30,8 +30,8 @@ create sequence TASK_INSTANCE_STATE_LOG_ID_SEQ start with 1 increment by 50;
 create sequence TASK_INSTANCE_VARIABLE_LOG_ID_SEQ start with 1 increment by 50;
 create table Job_Execution_Log (id bigint not null, event_date timestamp(6), execution_counter integer, expiration_time timestamp(6), job_id varchar(255), node_instance_id varchar(255), priority integer, process_instance_id varchar(255), repeat_interval bigint, repeat_limit integer, retries integer, scheduled_id varchar(255), status varchar(255), primary key (id));
 create table Process_Instance_Error_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), error_message varchar(255), node_definition_id varchar(255), node_instance_id varchar(255), primary key (id));
-create table Process_Instance_Node_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), connection varchar(255), event_data varchar(255), event_type varchar(255) check (event_type in ('ENTER','EXIT','ABORTED','ASYNC_ENTER','OBSOLETE','SKIPPED','ERROR','SLA_VIOLATION')), node_definition_id varchar(255), node_instance_id varchar(255), node_name varchar(255), node_type varchar(255), sla_due_date timestamp(6), work_item_id varchar(255), primary key (id));
-create table Process_Instance_State_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), event_type varchar(255) not null check (event_type in ('ACTIVE','STARTED','COMPLETED','ABORTED','SLA_VIOLATION','PENDING','SUSPENDING','ERROR')), outcome varchar(255), sla_due_date timestamp(6), state varchar(255), primary key (id));
+create table Process_Instance_Node_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), connection varchar(255), event_data varchar(255), event_type varchar(255), node_definition_id varchar(255), node_instance_id varchar(255), node_name varchar(255), node_type varchar(255), sla_due_date timestamp(6), work_item_id varchar(255), primary key (id));
+create table Process_Instance_State_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), event_type varchar(255) not null, outcome varchar(255), sla_due_date timestamp(6), state varchar(255), primary key (id));
 create table Process_Instance_State_Roles_Log (process_instance_state_log_id bigint not null, role varchar(255));
 create table Process_Instance_Variable_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), parent_process_instance_id varchar(255), process_id varchar(255), process_instance_id varchar(255), process_type varchar(255), process_version varchar(255), root_process_id varchar(255), root_process_instance_id varchar(255), variable_id varchar(255), variable_name varchar(255), variable_value varchar(255), primary key (id));
 create table Task_Instance_Assignment_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), assignment_type varchar(255), task_name varchar(255), primary key (id));
@@ -40,7 +40,7 @@ create table Task_Instance_Attachment_Log (id bigint not null, business_key varc
 create table Task_Instance_Comment_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), comment_content varchar(255), comment_id varchar(255), event_type integer, primary key (id));
 create table Task_Instance_Deadline_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), event_type varchar(255), primary key (id));
 create table Task_Instance_State_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), actual_user varchar(255), description varchar(255), event_type varchar(255), name varchar(255), state varchar(255), primary key (id));
-create table Task_Instance_Variable_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), variable_id varchar(255), variable_name varchar(255), variable_type varchar(255) check (variable_type in ('INPUT','OUTPUT')), variable_value varchar(255), primary key (id));
+create table Task_Instance_Variable_Log (id bigint not null, business_key varchar(255), event_date timestamp(6), event_id varchar(255), event_user varchar(255), process_instance_id varchar(255), user_task_definition_id varchar(255), user_task_instance_id varchar(255), variable_id varchar(255), variable_name varchar(255), variable_type varchar(255), variable_value varchar(255), primary key (id));
 create table Task_Instance_Deadline_Notification_Log (task_instance_deadline_log_id bigint not null, property_value varchar(255), property_name varchar(255) not null, primary key (task_instance_deadline_log_id, property_name));
 create index ix_jel_pid on Job_Execution_Log (process_instance_id);
 create index ix_jel_jid on Job_Execution_Log (job_id);
@@ -84,6 +84,9 @@ create index ix_tavl_utid on Task_Instance_Variable_Log (user_task_instance_id);
 create index ix_tavl_pid on Task_Instance_Variable_Log (process_instance_id);
 create index ix_tavl_key on Task_Instance_Variable_Log (business_key);
 create index ix_tavl_event_date on Task_Instance_Variable_Log (event_date);
+alter table if exists Process_Instance_Node_Log add constraint Process_Instance_Node_Log_event_type_check check (event_type in ('ENTER','EXIT','ABORTED','ASYNC_ENTER','OBSOLETE','SKIPPED','ERROR','SLA_VIOLATION'));
+alter table if exists Process_Instance_State_Log add constraint Process_Instance_State_Log_event_type_check check (event_type in ('ACTIVE','STARTED','COMPLETED','ABORTED','SLA_VIOLATION','PENDING','SUSPENDING','ERROR'));
+alter table if exists Task_Instance_Variable_Log add constraint Task_Instance_Variable_Log_variable_type_check check (variable_type in ('INPUT','OUTPUT'));
 alter table if exists Process_Instance_State_Roles_Log add constraint fk_process_instance_state_pid foreign key (process_instance_state_log_id) references Process_Instance_State_Log;
 alter table if exists Task_Instance_Assignment_Users_Log add constraint fk_task_instance_assignment_log_tid foreign key (task_instance_assignment_log_id) references Task_Instance_Assignment_Log;
 alter table if exists Task_Instance_Deadline_Notification_Log add constraint fk_task_instance_deadline_tid foreign key (task_instance_deadline_log_id) references Task_Instance_Deadline_Log;

data-audit/kogito-addons-data-audit-jpa/kogito-addons-data-audit-jpa-quarkus/pom.xml

@@ -56,6 +56,10 @@
             <groupId>org.kie.kogito</groupId>
             <artifactId>jobs-service-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.kie</groupId>
+            <artifactId>kie-addons-quarkus-flyway</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

data-audit/kogito-addons-data-audit-quarkus/pom.xml

@@ -51,6 +51,10 @@
             <groupId>org.kie.kogito</groupId>
             <artifactId>jobs-service-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.kie</groupId>
+            <artifactId>kie-addons-quarkus-flyway</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

data-audit/kogito-addons-data-audit-quarkus/src/test/resources/application.properties

@@ -24,5 +24,5 @@ quarkus.datasource.jdbc.url=jdbc:h2:mem:test
 
 quarkus.hibernate-orm.database.generation=create-drop
 
-
+kie.flyway.enabled=true
 

data-audit/kogito-addons-data-audit-springboot/pom.xml

@@ -48,6 +48,10 @@
             <groupId>org.kie.kogito</groupId>
             <artifactId>kogito-events-core</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.kie</groupId>
+            <artifactId>kie-addons-springboot-flyway</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

data-audit/kogito-addons-data-audit-springboot/src/test/resources/application.properties

@@ -5,6 +5,7 @@ spring.datasource.driver-class-name=org.h2.Driver
 
 spring.jpa.database=H2
 spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect
-spring.jpa.properties.hibernate.hbm2ddl.auto=create-drop
+kie.flyway.enabled=true
+spring.flyway.enabled=false
 
 

data-index/data-index-service/data-index-service-inmemory/pom.xml

@@ -45,6 +45,10 @@
       <groupId>org.kie.kogito</groupId>
       <artifactId>data-index-storage-postgresql</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-flyway</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-container-image-jib</artifactId>

data-index/data-index-service/data-index-service-inmemory/src/main/resources/application.properties

@@ -25,6 +25,11 @@ kogito.data-index.blocking=true
 #PostgreSql
 quarkus.datasource.db-kind=postgresql
 
+#Flyway - It's safe to enable Flyway by default for in-memory storage
+quarkus.flyway.migrate-at-start=true
+quarkus.flyway.baseline-on-migrate=true
+quarkus.flyway.locations=classpath:kie-flyway/db/data-index/postgresql
+
 #Hibernate
 quarkus.hibernate-orm.jdbc.timezone=UTC
 quarkus.hibernate-orm.database.generation=update

data-index/data-index-service/data-index-service-postgresql/src/main/resources/application.properties

@@ -25,9 +25,6 @@ kogito.data-index.blocking=true
 #Kafka
 quarkus.kafka.health.enabled=true
 
-#Flyway
-quarkus.flyway.baseline-on-migrate=true
-
 #PostgreSQL
 quarkus.datasource.db-kind=postgresql
 
@@ -39,3 +36,6 @@ quarkus.hibernate-orm.physical-naming-strategy=org.hibernate.boot.model.naming.C
 quarkus.container-image.build=${quarkus.build.image:true}
 quarkus.container-image.group=org.kie.kogito
 quarkus.jib.jvm-arguments=-Dquarkus.http.port=8080
+
+# Flyway Locations
+quarkus.flyway.locations=classpath:kie-flyway/db/data-index/postgresql

data-index/data-index-storage/data-index-storage-jpa/.gitignore

@@ -0,0 +1 @@
+/src/main/resources/kie-flyway/db/data-index/postgresql/*

data-index/data-index-storage/data-index-storage-jpa/pom.xml

@@ -33,6 +33,10 @@
   <name>Kogito Apps :: Data Index Storage JPA compatible DBs</name>
 
   <properties>
+    <path.to.postgresql.storage>../data-index-storage-postgresql</path.to.postgresql.storage>
+    <path.to.script.folder>src/main/resources/kie-flyway/db/</path.to.script.folder>
+    <path.to.migration.scripts.from>${path.to.postgresql.storage}/${path.to.script.folder}/data-index/postgresql</path.to.migration.scripts.from>
+    <path.to.migration.scripts.to>${path.to.script.folder}/data-index/postgresql</path.to.migration.scripts.to>
     <java.module.name>org.kie.kogito.index.jpa</java.module.name>
   </properties>
 
@@ -89,6 +93,11 @@
       <artifactId>kogito-quarkus-test-utils</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-flyway</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <build>
     <plugins>
@@ -110,6 +119,31 @@
           </execution>
         </executions>
       </plugin>
+      <!--  The cleanest way would be to use the maven-dependency-plugin to unpack and copy scripts from the built artifact `kie-addons-persistence-jdbc` but there's a limitation to using this only in the `package` phase whereas we need that into the `generate-sources` phase. See also https://issues.apache.org/jira/browse/MDEP-98 -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-resources-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>copy-resource-one</id>
+            <phase>generate-sources</phase>
+            <goals>
+              <goal>copy-resources</goal>
+            </goals>
+            <configuration>
+              <outputDirectory>${path.to.migration.scripts.to}</outputDirectory>
+              <resources>
+                <resource>
+                  <directory>${path.to.migration.scripts.from}</directory>
+                  <includes>
+                    <include>*.sql</include>
+                  </includes>
+                </resource>
+              </resources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

data-index/data-index-storage/data-index-storage-jpa/src/main/resources/META-INF/kie-flyway.properties

@@ -0,0 +1,23 @@
+#
+# 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 agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+module.name=data-index
+
+module.locations.postgresql=classpath:kie-flyway/db/data-index/postgresql,classpath:kie-flyway/db/persistence-common/postgresql
+module.locations.default=classpath:kie-flyway/db/data-index/ansi,classpath:kie-flyway/db/persistence-common/ansi

data-index/data-index-storage/data-index-storage-jpa/src/test/resources/application.properties

@@ -19,12 +19,12 @@
 
 # Kogito
 kogito.apps.persistence.type=jdbc
+kie.flyway.enabled=true
+
 # Data source
 quarkus.datasource.db-kind=h2
 quarkus.datasource.jdbc.url=jdbc:h2:tcp://localhost/mem:test;NON_KEYWORDS=VALUE,KEY
 # Hibernate
-quarkus.hibernate-orm.database.generation=create
-quarkus.hibernate-orm.database.generation.halt-on-error=true
 quarkus.hibernate-orm.physical-naming-strategy=org.hibernate.boot.model.naming.CamelCaseToUnderscoresNamingStrategy
 quarkus.hibernate-orm.jdbc.timezone=UTC
 quarkus.hibernate-orm.log.sql=true

data-index/data-index-storage/data-index-storage-postgresql-reporting/pom.xml

@@ -72,6 +72,11 @@
       <artifactId>kogito-quarkus-test-utils</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-flyway</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

data-index/data-index-storage/data-index-storage-postgresql/pom.xml

@@ -78,6 +78,11 @@
       <artifactId>kogito-quarkus-test-utils</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-flyway</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <build>
     <plugins>

data-index/data-index-storage/data-index-storage-postgresql/src/main/resources/META-INF/kie-flyway.properties

@@ -0,0 +1,22 @@
+#
+# 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 agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+module.name=data-index
+
+module.locations.postgresql=classpath:kie-flyway/db/data-index/postgresql,classpath:kie-flyway/db/persistence-common/postgresql

data-index/kogito-addons-quarkus-data-index-persistence/kogito-addons-quarkus-data-index-persistence-jpa/deployment/pom.xml

@@ -39,8 +39,8 @@
       <artifactId>kogito-addons-quarkus-data-index-persistence-jpa</artifactId>
     </dependency>
     <dependency>
-      <groupId>io.quarkus</groupId>
-      <artifactId>quarkus-flyway-deployment</artifactId>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-flyway-deployment</artifactId>
     </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>

data-index/kogito-addons-quarkus-data-index-persistence/kogito-addons-quarkus-data-index-persistence-jpa/integration-tests-process/src/main/resources/application.properties

@@ -19,7 +19,8 @@
 
 kogito.service.url=http://localhost:8080
 kogito.persistence.type=jdbc
-quarkus.flyway.migrate-at-start=true
+
+kie.flyway.enabled=true
 
 quarkus.datasource.db-kind=h2
 quarkus.datasource.username=kogito

data-index/kogito-addons-quarkus-data-index-persistence/kogito-addons-quarkus-data-index-persistence-jpa/integration-tests-sw/src/main/resources/application.properties

@@ -20,8 +20,7 @@
 kogito.persistence.type=jdbc
 kogito.service.url=http://localhost:8080
 
-quarkus.flyway.migrate-at-start=true
-quarkus.flyway.baseline-on-migrate=true
+kie.flyway.enabled=true
 
 quarkus.datasource.db-kind=h2
 quarkus.datasource.username=kogito

data-index/kogito-addons-quarkus-data-index-persistence/kogito-addons-quarkus-data-index-persistence-jpa/runtime/pom.xml

@@ -35,8 +35,8 @@
       <artifactId>kogito-addons-quarkus-data-index-persistence-common-runtime</artifactId>
     </dependency>
     <dependency>
-      <groupId>io.quarkus</groupId>
-      <artifactId>quarkus-flyway</artifactId>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-flyway</artifactId>
     </dependency>
     <dependency>
       <groupId>org.kie.kogito</groupId>