From 07fcb419b2739af5772bcf190372f22bb06a7f96 Mon Sep 17 00:00:00 2001 From: blafond Date: Fri, 25 Mar 2022 11:25:42 -0500 Subject: [PATCH] [#929] initial hibernate-reactive-h2 module --- hibernate-reactive-h2/LICENSE | 202 ++++++++++++++++++ hibernate-reactive-h2/build.gradle | 129 +++++++++++ .../org/hibernate/reactive/package-info.java | 8 + .../pool/impl/H2ModuleSqlClientPool.java | 126 +++++++++++ settings.gradle | 1 + 5 files changed, 466 insertions(+) create mode 100644 hibernate-reactive-h2/LICENSE create mode 100644 hibernate-reactive-h2/build.gradle create mode 100644 hibernate-reactive-h2/src/main/java/org/hibernate/reactive/package-info.java create mode 100644 hibernate-reactive-h2/src/main/java/org/hibernate/reactive/pool/impl/H2ModuleSqlClientPool.java diff --git a/hibernate-reactive-h2/LICENSE b/hibernate-reactive-h2/LICENSE new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/hibernate-reactive-h2/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/hibernate-reactive-h2/build.gradle b/hibernate-reactive-h2/build.gradle new file mode 100644 index 0000000000..c061fd5e39 --- /dev/null +++ b/hibernate-reactive-h2/build.gradle @@ -0,0 +1,129 @@ +ext { + mavenPomName = 'Hibernate Reactive H2' +} + +description = 'The H2 module of Hibernate Reactive' + +apply from: publishScript + +dependencies { + implementation project(':hibernate-reactive-core') + + api ("org.hibernate:hibernate-core:${hibernateOrmVersion}") { + //We don't need any of these: + exclude group: 'org.javassist', module: 'javassist' + exclude group: 'javax.activation', module: 'javax.activation-api' + } + + api 'io.smallrye.reactive:mutiny:1.4.0' + + //Logging + implementation 'org.jboss.logging:jboss-logging:3.4.3.Final' + compileOnly 'org.jboss.logging:jboss-logging-annotations:2.2.1.Final' + + annotationProcessor 'org.jboss.logging:jboss-logging:3.4.3.Final' + annotationProcessor 'org.jboss.logging:jboss-logging-annotations:2.2.1.Final' + annotationProcessor 'org.jboss.logging:jboss-logging-processor:2.2.1.Final' + + //Specific implementation details of Hibernate Reactive: + implementation "io.vertx:vertx-sql-client:${vertxVersion}" + implementation 'io.agroal:agroal-api:1.12' + implementation 'io.agroal:agroal-pool:1.12' + implementation "io.vertx:vertx-jdbc-client:${vertxVersion}" + + // Testing + testImplementation 'org.assertj:assertj-core:3.20.2' + testImplementation "io.vertx:vertx-unit:${vertxVersion}" + + // Optional dependency of vertx-pg-client, essential when connecting via SASL SCRAM + testImplementation 'com.ongres.scram:client:2.1' + + // JDBC driver to test with ORM and PostgreSQL + testRuntimeOnly "org.postgresql:postgresql:42.2.23" + + // EHCache + testRuntimeOnly "org.ehcache:ehcache:3.8.1" + testRuntimeOnly ("org.hibernate:hibernate-jcache:${hibernateOrmVersion}") { + //We don't need any of these: + exclude group: 'org.javassist', module: 'javassist' + exclude group: 'javax.activation', module: 'javax.activation-api' + } + + // log4j + testRuntimeOnly 'org.apache.logging.log4j:log4j-core:2.17.1' + + // Testcontainers + testImplementation "org.testcontainers:postgresql:${testcontainersVersion}" + + testImplementation "com.h2database:h2:2.1.210" +} + +// Print a summary of the results of the tests (number of failures, successes and skipped) +def loggingSummary(db, result, desc) { + if ( !desc.parent ) { // will match the outermost suite + def output = "${db} results: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} passed, ${result.failedTestCount} failed, ${result.skippedTestCount} skipped)" + def repeatLength = output.length() + 1 + logger.lifecycle '\n' + ('-' * repeatLength) + '\n' + output + '\n' + ('-' * repeatLength) + } +} + +// Configuration for the tests +tasks.withType(Test) { + defaultCharacterEncoding = "UTF-8" + testLogging { + displayGranularity 1 + showStandardStreams = project.hasProperty('showStandardOutput') + showStackTraces = true + exceptionFormat = 'full' + events 'PASSED', 'FAILED', 'SKIPPED' + } + systemProperty 'docker', project.hasProperty( 'docker' ) ? 'true' : 'false' + systemProperty 'org.hibernate.reactive.common.InternalStateAssertions.ENFORCE', 'true' + + if ( project.hasProperty( 'includeTests' ) ) { + // Example: ./gradlew testAll -PincludeTests=DefaultPortTest + filter { + includeTestsMatching project.getProperty( 'includeTests' ) ?: '*' + } + } +} + +// Example: +// gradle test -Pdb=MySQL +test { + def selectedDb = project.hasProperty( 'db' ) + ? project.getProperty( 'db' ) + : 'PostgreSQL' + afterSuite { desc, result -> + loggingSummary( selectedDb, result, desc ) + } + doFirst { + systemProperty 'db', selectedDb + } +} + +// Rule to recognize calls to testDb +// and run the tests on the selected db +// Example: +// gradle testDbMySQL testDbDB2 +tasks.addRule( "Pattern testDb" ) { String taskName -> + if ( taskName.startsWith( "testDb" ) ) { + task( type: Test, taskName ) { + def dbName = taskName.substring( "testDb".length() ) + description = "Run tests for ${dbName}" + + afterSuite { desc, result -> + loggingSummary( dbName, result, desc ) + } + doFirst() { + systemProperty 'db', dbName + } + } + } +} + +// The dbs we want to test when running testAll +def dbs = ['PostgreSQL', 'H2'] +task testAll( dependsOn: dbs.collect( [] as HashSet ) { db -> "testDb${db}" } ) { + description = "Run tests for ${dbs}" +} diff --git a/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/package-info.java b/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/package-info.java new file mode 100644 index 0000000000..96d117b1a9 --- /dev/null +++ b/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/package-info.java @@ -0,0 +1,8 @@ +/** +// * Hibernate Reactive is an adaptation of Hibernate ORM to the +// * world of reactive programming, and replaces JDBC for database +// * access with a non-blocking database client. +// *

+// *

+ */ +package org.hibernate.reactive; diff --git a/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/pool/impl/H2ModuleSqlClientPool.java b/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/pool/impl/H2ModuleSqlClientPool.java new file mode 100644 index 0000000000..dc0e63c7fc --- /dev/null +++ b/hibernate-reactive-h2/src/main/java/org/hibernate/reactive/pool/impl/H2ModuleSqlClientPool.java @@ -0,0 +1,126 @@ +/* Hibernate, Relational Persistence for Idiomatic Java + * + * SPDX-License-Identifier: Apache-2.0 + * Copyright: Red Hat Inc. and Hibernate Authors + */ +package org.hibernate.reactive.pool.impl; + + +import java.lang.invoke.MethodHandles; +import java.net.URI; +import java.util.Map; +import java.util.concurrent.CompletionStage; + +import org.hibernate.engine.jdbc.spi.JdbcServices; +import org.hibernate.engine.jdbc.spi.SqlStatementLogger; +import org.hibernate.internal.util.config.ConfigurationHelper; +import org.hibernate.reactive.logging.impl.Log; +import org.hibernate.reactive.logging.impl.LoggerFactory; +import org.hibernate.reactive.provider.Settings; +import org.hibernate.reactive.vertx.VertxInstance; +import org.hibernate.service.spi.Configurable; +import org.hibernate.service.spi.ServiceRegistryAwareService; +import org.hibernate.service.spi.ServiceRegistryImplementor; +import org.hibernate.service.spi.Startable; +import org.hibernate.service.spi.Stoppable; + +import io.vertx.core.Future; +import io.vertx.core.Vertx; +import io.vertx.jdbcclient.JDBCConnectOptions; +import io.vertx.jdbcclient.JDBCPool; +import io.vertx.sqlclient.Pool; +import io.vertx.sqlclient.PoolOptions; +import io.vertx.sqlclient.SqlConnectOptions; + +public class H2ModuleSqlClientPool extends SqlClientPool + implements ServiceRegistryAwareService, Configurable, Stoppable, Startable { + + private static final Log LOG = LoggerFactory.make( Log.class, MethodHandles.lookup() ); + + private static final String DEFAULT_URL = "jdbc:h2:~/test;DATABASE_TO_UPPER=FALSE"; + + //Asynchronous shutdown promise: we can't return it from #close as we implement a + //blocking interface. + private volatile Future closeFuture = Future.succeededFuture(); + + private Pool pools; + private URI uri; + private SqlStatementLogger sqlStatementLogger; + private ServiceRegistryImplementor serviceRegistry; + + public H2ModuleSqlClientPool() { + } + + @Override + public void injectServices(ServiceRegistryImplementor serviceRegistry) { + this.serviceRegistry = serviceRegistry; + sqlStatementLogger = serviceRegistry.getService( JdbcServices.class ).getSqlStatementLogger(); + } + + @Override + public void configure(Map configuration) { + uri = jdbcUrl( configuration ); + } + + @Override + public void start() { + if ( pools == null ) { + pools = createPool( uri ); + } + } + + @Override + public CompletionStage getCloseFuture() { + return closeFuture.toCompletionStage(); + } + + @Override + protected Pool getPool() { + return pools; + } + + private Pool createPool(URI uri) { + SqlClientPoolConfiguration configuration = serviceRegistry.getService( SqlClientPoolConfiguration.class ); + VertxInstance vertx = serviceRegistry.getService( VertxInstance.class ); + return createPool( uri, configuration.connectOptions( uri ), configuration.poolOptions(), vertx.getVertx() ); + } + + private Pool createPool(URI uri, SqlConnectOptions connectOptions, PoolOptions poolOptions, Vertx vertx) { + JDBCConnectOptions jdbcOptions = new JDBCConnectOptions(); + jdbcOptions.setUser( connectOptions.getUser() ); + jdbcOptions.setJdbcUrl( "jdbc:" + uri.toString() ); + JDBCPool pool = JDBCPool.pool( vertx, jdbcOptions, poolOptions ); + return pool; + } + + private URI jdbcUrl(Map configurationValues) { + String url = ConfigurationHelper.getString( Settings.URL, configurationValues ); + LOG.sqlClientUrl( url ); + return parse( url ); + } + + @Override + public void stop() { + if ( pools != null ) { + this.closeFuture = pools.close(); + } + } + + public static URI parse(String url) { + + if ( url == null || url.trim().isEmpty() ) { + return URI.create( url ); + } + + if ( url.startsWith( "jdbc:" ) ) { + return URI.create( url.substring( 5 ) ); + } + + return URI.create( url ); + } + + @Override + protected SqlStatementLogger getSqlStatementLogger() { + return sqlStatementLogger; + } +} diff --git a/settings.gradle b/settings.gradle index 9cf1fbd005..07d980b89c 100644 --- a/settings.gradle +++ b/settings.gradle @@ -82,6 +82,7 @@ logger.lifecycle "Java versions for main code: " + gradle.ext.javaVersions.main logger.lifecycle "Java versions for tests: " + gradle.ext.javaVersions.test include 'hibernate-reactive-core' +include 'hibernate-reactive-h2' include 'session-example' include 'native-sql-example' include 'verticle-postgres-it'