Merge pull request #9390 from Sanne/multitenancy-ci

gsmet · web-flow · commit a84849805de1 · 2020-05-20T20:17:25.000+02:00
Enable Hibernate ORM multitenancy IT on CI
diff --git a/.github/workflows/ci-actions.yml b/.github/workflows/ci-actions.yml
@@ -34,8 +34,8 @@ on:
 env:
   # Workaround testsuite locale issue
   LANG: en_US.UTF-8
-  NATIVE_TEST_MAVEN_OPTS: "-B --settings .github/mvn-settings.xml --fail-at-end -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-native-image:19.3.1-java11 -Dtest-postgresql -Dtest-elasticsearch -Dtest-keycloak -Dtest-amazon-services -Dtest-mysql -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dnative-image.xmx=5g -Dnative -Dformat.skip install"
-  JVM_TEST_MAVEN_OPTS: "-e -B --settings .github/mvn-settings.xml -Dtest-postgresql -Dtest-elasticsearch -Dtest-mysql -Dtest-mariadb -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-amazon-services -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dtest-keycloak -Dformat.skip"
+  NATIVE_TEST_MAVEN_OPTS: "-B --settings .github/mvn-settings.xml --fail-at-end -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-native-image:19.3.1-java11 -Dtest-postgresql -Dtest-elasticsearch -Dtest-keycloak -Dtest-amazon-services -Dtest-mysql -Dtest-mariadb -Dmariadb.base_url='jdbc:mariadb://localhost:3308' -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dnative-image.xmx=5g -Dnative -Dformat.skip install"
+  JVM_TEST_MAVEN_OPTS: "-e -B --settings .github/mvn-settings.xml -Dtest-postgresql -Dtest-elasticsearch -Dtest-mysql -Dtest-mariadb -Dmariadb.base_url='jdbc:mariadb://localhost:3308' -Dmariadb.url='jdbc:mariadb://localhost:3308/hibernate_orm_test'  -Dtest-mssql -Dtest-amazon-services -Dtest-vault -Dtest-neo4j -Dtest-kafka -Dtest-keycloak -Dformat.skip"
   DB_USER: hibernate_orm_test
   DB_PASSWORD: hibernate_orm_test
   DB_NAME: hibernate_orm_test
@@ -144,7 +144,7 @@ jobs:
           MYSQL_USER: hibernate_orm_test
           MYSQL_PASSWORD: hibernate_orm_test
           MYSQL_DATABASE: hibernate_orm_test
-          MYSQL_RANDOM_ROOT_PASSWORD: true
+          MYSQL_ROOT_PASSWORD: secret
         ports:
           - 127.0.0.1:3308:3306
       mssql:
@@ -320,6 +320,7 @@ jobs:
               jpa-mssql
               jpa-derby
               jpa-without-entity
+              hibernate-tenancy
           - category: Data2
             mysql: "true"
             postgres: "true"
@@ -476,7 +477,7 @@ jobs:
       - name: Maria DB Service
         run: |
           docker run --rm --publish 3308:3306 --name build-mariadb \
-            -e MYSQL_USER=$DB_USER -e MYSQL_PASSWORD=$DB_PASSWORD -e MYSQL_DATABASE=$DB_NAME -e MYSQL_RANDOM_ROOT_PASSWORD=true \
+            -e MYSQL_USER=$DB_USER -e MYSQL_PASSWORD=$DB_PASSWORD -e MYSQL_DATABASE=$DB_NAME -e MYSQL_ROOT_PASSWORD=secret \
             -d mariadb:10.4
         if: matrix.mariadb
       - name: MS-SQL Service
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/DataSourceTenantConnectionResolver.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/DataSourceTenantConnectionResolver.java
@@ -89,8 +89,6 @@ private static AgroalDataSource tenantDataSource(JPAConfig jpaConfig, String ten
 
     private static class TenantConnectionProvider extends QuarkusConnectionProvider {
 
-        private static final long serialVersionUID = 1L;
-
         private final String tenantId;
 
         public TenantConnectionProvider(String tenantId, AgroalDataSource dataSource) {
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/HibernateCurrentTenantIdentifierResolver.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/HibernateCurrentTenantIdentifierResolver.java
@@ -12,7 +12,7 @@
  * @author Michael Schnell
  *
  */
-public class HibernateCurrentTenantIdentifierResolver implements CurrentTenantIdentifierResolver {
+public final class HibernateCurrentTenantIdentifierResolver implements CurrentTenantIdentifierResolver {
 
     private static final Logger LOG = Logger.getLogger(HibernateCurrentTenantIdentifierResolver.class);
 
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/HibernateMultiTenantConnectionProvider.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/tenant/HibernateMultiTenantConnectionProvider.java
@@ -16,7 +16,7 @@
  * @author Michael Schnell
  *
  */
-public class HibernateMultiTenantConnectionProvider extends AbstractMultiTenantConnectionProvider {
+public final class HibernateMultiTenantConnectionProvider extends AbstractMultiTenantConnectionProvider {
 
     private static final Logger LOG = Logger.getLogger(HibernateMultiTenantConnectionProvider.class);
 
@@ -33,12 +33,14 @@ protected ConnectionProvider getAnyConnectionProvider() {
     }
 
     @Override
-    protected ConnectionProvider selectConnectionProvider(String tenantIdentifier) {
+    protected ConnectionProvider selectConnectionProvider(final String tenantIdentifier) {
         LOG.debugv("selectConnectionProvider({0})", tenantIdentifier);
 
         ConnectionProvider provider = providerMap.get(tenantIdentifier);
         if (provider == null) {
-            return providerMap.computeIfAbsent(tenantIdentifier, tid -> resolveConnectionProvider(tid));
+            final ConnectionProvider connectionProvider = resolveConnectionProvider(tenantIdentifier);
+            providerMap.put(tenantIdentifier, connectionProvider);
+            return connectionProvider;
         }
         return provider;
 
diff --git a/integration-tests/hibernate-tenancy/README.md b/integration-tests/hibernate-tenancy/README.md
@@ -27,14 +27,22 @@ You can then run the tests as follows (either with `-Dnative` or not):
 mvn clean install -Dtest-mariadb
 ```
 
-If you have specific requirements, you can define a specific connection URL with `-Djdbc:mariadb://localhost:3306/hibernate_orm_test`.
+If you have specific requirements, you can define a specific connection URL with `-Dmariadb.base_url=jdbc:mariadb://...`.
+Note that this specific integration test module module requires permissions to create additional users and databases, hence the `mariadb.base_url` variable
+should not include the database name: check the `application.properties` to see how it's used.
 
 To run the MariaDB server "manually" via command line for testing, the following command line could be useful:
 
 ```
 docker run --ulimit memlock=-1:-1 -it --rm=true --memory-swappiness=0 --name quarkus_test_mariadb -e MYSQL_DATABASE=hibernate_orm_test -e MYSQL_ROOT_PASSWORD=secret -p 3306:3306 mariadb:10.4
 ```
 
+or if you prefer podman, this won't need root permissions:
+
+```
+podman run --rm=true --net=host --memory-swappiness=0 --tmpfs /var/lib/mysql:rw --tmpfs /var/log:rw --name mariadb_demo -e MYSQL_USER=hibernate_orm_test -e MYSQL_PASSWORD=hibernate_orm_test -e MYSQL_DATABASE=hibernate_orm_test -e MYSQL_ROOT_PASSWORD=secret -p 3306:3306 mariadb:10.4
+```
+
 N.B. it takes a while for MariaDB to be actually booted and accepting connections.
 
 After it's fully booted, you can run all integration tests via
diff --git a/integration-tests/hibernate-tenancy/pom.xml b/integration-tests/hibernate-tenancy/pom.xml
@@ -16,7 +16,7 @@
 	<description>Module that contains Hibernate Multitenancy related tests running with the MariaDB database</description>
 
 	<properties>
-		<mariadb.url>jdbc:mariadb://localhost:3306</mariadb.url>
+		<mariadb.base_url>jdbc:mariadb://localhost:3306</mariadb.base_url>
 		<mariadb.image>mariadb:10.4</mariadb.image>
 	</properties>
 
diff --git a/integration-tests/hibernate-tenancy/src/main/resources/application.properties b/integration-tests/hibernate-tenancy/src/main/resources/application.properties
@@ -1,38 +1,38 @@
 # Hibernate ORM settings 
 quarkus.hibernate-orm.database.generation=none
 quarkus.hibernate-orm.multitenant=DATABASE
-quarkus.hibernate-orm.validate-tenant-in-current-sessions=false
-
-# Maria DB URL
-mariadb.url=jdbc:mariadb://localhost:3306
 
 # Default DB Configuration
 quarkus.datasource.db-kind=mariadb
 quarkus.datasource.username=root
 quarkus.datasource.password=secret
-quarkus.datasource.jdbc.url=${mariadb.url}/hibernate_orm_test
+quarkus.datasource.jdbc.url=${mariadb.base_url}/hibernate_orm_test
 quarkus.datasource.jdbc.max-size=1
 quarkus.datasource.jdbc.min-size=1
 quarkus.flyway.migrate-at-start=true
+#Reset Flyway metadata at boot, as the database might have been tainted by previous integration tests:
+quarkus.flyway.clean-at-start=true
 quarkus.flyway.locations=classpath:database/default
 
 # DATABASE Tenant 'base' Configuration
 quarkus.datasource.base.db-kind=mariadb
 quarkus.datasource.base.username=jane
 quarkus.datasource.base.password=abc
-quarkus.datasource.base.jdbc.url=${mariadb.url}/base
+quarkus.datasource.base.jdbc.url=${mariadb.base_url}/base
 quarkus.datasource.base.jdbc.max-size=1
 quarkus.datasource.base.jdbc.min-size=1
 quarkus.flyway.base.migrate-at-start=true
+quarkus.flyway.base.clean-at-start=true
 quarkus.flyway.base.locations=classpath:database/base
 
 # DATABASE Tenant 'mycompany' Configuration
 quarkus.datasource.mycompany.db-kind=mariadb
 quarkus.datasource.mycompany.username=john
 quarkus.datasource.mycompany.password=def
-quarkus.datasource.mycompany.jdbc.url=${mariadb.url}/mycompany
+quarkus.datasource.mycompany.jdbc.url=${mariadb.base_url}/mycompany
 quarkus.datasource.mycompany.jdbc.max-size=1
 quarkus.datasource.mycompany.jdbc.min-size=1
 quarkus.flyway.mycompany.migrate-at-start=true
+quarkus.flyway.mycompany.clean-at-start=true
 quarkus.flyway.mycompany.locations=classpath:database/mycompany
 
diff --git a/integration-tests/hibernate-tenancy/src/main/resources/database/default/V1.0.0__init_databases.sql b/integration-tests/hibernate-tenancy/src/main/resources/database/default/V1.0.0__init_databases.sql
@@ -1,9 +1,9 @@
-CREATE DATABASE base;
-CREATE USER 'jane'@'%' IDENTIFIED BY 'abc';
+CREATE DATABASE IF NOT EXISTS base;
+CREATE USER IF NOT EXISTS 'jane'@'%' IDENTIFIED BY 'abc';
 GRANT ALL privileges ON base.* TO 'jane'@'%';
 
-CREATE DATABASE mycompany;
-CREATE USER 'john'@'%' IDENTIFIED BY 'def';
+CREATE DATABASE IF NOT EXISTS mycompany;
+CREATE USER IF NOT EXISTS 'john'@'%' IDENTIFIED BY 'def';
 GRANT ALL privileges ON mycompany.* TO 'john'@'%';
 
 FLUSH PRIVILEGES;
diff --git a/integration-tests/jpa-mariadb/README.md b/integration-tests/jpa-mariadb/README.md
@@ -35,6 +35,12 @@ To run the MariaDB server "manually" via command line for testing, the following
 docker run --ulimit memlock=-1:-1 -it --rm=true --memory-swappiness=0 --name quarkus_test_mariadb -e MYSQL_USER=hibernate_orm_test -e MYSQL_PASSWORD=hibernate_orm_test -e MYSQL_DATABASE=hibernate_orm_test -e MYSQL_RANDOM_ROOT_PASSWORD=true -p 3306:3306 mariadb:10.4
 ```
 
+or if you prefer podman, this won't need root permissions:
+
+```
+podman run --rm=true --net=host --memory-swappiness=0 --tmpfs /var/lib/mysql:rw --tmpfs /var/log:rw --name mariadb_demo -e MYSQL_USER=hibernate_orm_test -e MYSQL_PASSWORD=hibernate_orm_test -e MYSQL_DATABASE=hibernate_orm_test -e MYSQL_ROOT_PASSWORD=secret -p 3306:3306 mariadb:10.4
+```
+
 N.B. it takes a while for MariaDB to be actually booted and accepting connections.
 
 After it's fully booted, you can run all integration tests via

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`* @author Michael Schnell`
`13`	`13`	`*`
`14`	`14`	`*/`
`15`		`-public class HibernateCurrentTenantIdentifierResolver implements CurrentTenantIdentifierResolver {`
	`15`	`+public final class HibernateCurrentTenantIdentifierResolver implements CurrentTenantIdentifierResolver {`
`16`	`16`
`17`	`17`	`private static final Logger LOG = Logger.getLogger(HibernateCurrentTenantIdentifierResolver.class);`
`18`	`18`