Make mongo-hibernate.jar a Java module (#149)

Also: fix the INFO log message about the DBMS and the driver

HIBERNATE-52
HIBERNATE-141

Author: stIncMale

.evergreen/config.yml

@@ -137,6 +137,21 @@ tasks:
           args:
             - run-integration-tests.sh
 
+  - name: run-smoke-tests
+    tags:
+      - pr
+    commands:
+      - func: bootstrap-mongo-orchestration
+      - command: subprocess.exec
+        type: test
+        params:
+          working_dir: src
+          binary: bash
+          add_to_path:
+            - .evergreen
+          args:
+            - run-smoke-tests.sh
+
   - name: publish-snapshot
     depends_on:
       - variant: static-checks
@@ -227,9 +242,16 @@ buildvariants:
     tasks:
       - name: run-unit-tests
 
-  - matrix_name: mongo-hibernate
-    matrix_spec: { mongo-version: "*", topology: "*", os: "*" }
+  - matrix_name: run-smoke-tests
+    matrix_spec: { mongo-version: "8.0", topology: replicaset, os: linux }
+    display_name: "Smoke Tests"
+    tags:
+      - pr
+    tasks:
+      - name: run-smoke-tests
 
+  - matrix_name: run-integration-tests
+    matrix_spec: { mongo-version: "*", topology: "*", os: "*" }
     display_name: "${mongo-version} ${topology} ${os}"
     tags:
       - pr

.evergreen/fetch-drivers-tools.sh

@@ -7,5 +7,5 @@ if [[ -z "$DRIVERS_TOOLS" ]]; then
     exit 1
 fi
 
-rm -rf $DRIVERS_TOOLS
-git clone https://github.com/mongodb-labs/drivers-evergreen-tools.git $DRIVERS_TOOLS
+rm -rf "$DRIVERS_TOOLS"
+git clone https://github.com/mongodb-labs/drivers-evergreen-tools.git "$DRIVERS_TOOLS"

.evergreen/java-config.sh

@@ -3,7 +3,6 @@
 # Java configurations for evergreen
 
 export JDK17="/opt/java/jdk17"
-export JDK21="/opt/java/jdk21"
 
 if [ -d "$JDK17" ]; then
   export JAVA_HOME=$JDK17

.evergreen/publish.sh

@@ -25,4 +25,4 @@ fi
 SYSTEM_PROPERTIES="-Dorg.gradle.internal.publish.checksums.insecure=true"
 
 ./gradlew -version
-./gradlew ${SYSTEM_PROPERTIES} --stacktrace --info  ${TASK}
+./gradlew ${SYSTEM_PROPERTIES} --stacktrace --info "${TASK}"

.evergreen/run-integration-tests.sh

@@ -15,4 +15,4 @@ echo "MongoDB version: ${MONGODB_VERSION}; topology: ${TOPOLOGY}"
 
 ./gradlew -version
 
-./gradlew -PjavaVersion=${JAVA_VERSION} --stacktrace --info --continue clean integrationTest
+./gradlew -PjavaVersion="${JAVA_VERSION}" --stacktrace --info --continue clean integrationTest

.evergreen/run-smoke-tests.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -o xtrace   # Write all commands first to stderr
+set -o errexit  # Exit the script with error if any of the commands fail
+
+############################################
+#            Main Program                  #
+############################################
+
+source java-config.sh
+
+echo "mongo-hibernate: running smoke tests ..."
+
+echo "MongoDB version: ${MONGODB_VERSION}; topology: ${TOPOLOGY}"
+
+./gradlew -version
+
+./gradlew -PjavaVersion="${JAVA_VERSION}" publishToMavenLocal \
+  && ./example-module/mvnw clean verify --file ./example-module/pom.xml \
+    -DjavaVersion="${JAVA_VERSION}" \
+    -DprojectVersion="$(./gradlew -q printProjectVersion)"

.evergreen/run-unit-tests.sh

@@ -13,4 +13,4 @@ echo "mongo-hibernate: running unit tests ..."
 
 ./gradlew -version
 
-./gradlew -PjavaVersion=${JAVA_VERSION} --stacktrace --info --continue clean test
+./gradlew -PjavaVersion="${JAVA_VERSION}" --stacktrace --info --continue clean test

.gitattributes

@@ -6,7 +6,7 @@
 
 # These are Windows script files and should use crlf
 *.bat           text eol=crlf
+*.cmd           text eol=crlf
 
 # Binary files should be left untouched
 *.jar           binary
-

.gitignore

@@ -24,7 +24,7 @@
 /bin/
 
 # Intellij IDEA
-/.idea/
+.idea/
 /*.ipr
 /*.iws
 /*.iml
@@ -34,4 +34,5 @@
 # Gradle
 .gradle/
 .kotlin/
-build/
+build/
+target/

README.md

@@ -35,7 +35,7 @@ instead of SQL. This product works by:
 - [Manual](https://www.mongodb.com/docs/languages/java/mongodb-hibernate/current)
 - [API](https://javadoc.io/doc/org.mongodb/mongodb-hibernate/latest/index.html)
 
-[Standalone deployments](https://www.mongodb.com/docs/manual/reference/glossary/#std-term-standalone) are not supported,
+MongoDB [standalone deployments](https://www.mongodb.com/docs/manual/reference/glossary/#std-term-standalone) are not supported,
 because they [do not support transactions](https://www.mongodb.com/docs/manual/core/transactions-production-consideration/).
 If you use one, you may [convert it to a replica set](https://www.mongodb.com/docs/manual/tutorial/convert-standalone-to-replica-set/).
 
@@ -46,6 +46,16 @@ The `groupId:artifactId` coordinates: `org.mongodb:mongodb-hibernate`.
   - [Maven Central Repository](https://repo.maven.apache.org/maven2/org/mongodb/mongodb-hibernate/)
   - [Maven Central Repository Search](https://central.sonatype.com/artifact/org.mongodb/mongodb-hibernate)
 
+### Examples
+
+[Maven](https://maven.apache.org/) is used as a build tool.
+
+The Java module with example applications is located in
+
+- [`./example-module`](example-module)
+
+The examples may be run by running the smoke tests as specified in [Run Smoke Tests](#run-smoke-tests).
+
 ### Bug Reports
 
 Use ["Extension for Hibernate ORM" at jira.mongodb.org](https://jira.mongodb.org/projects/HIBERNATE/issues).
@@ -61,7 +71,7 @@ Use ["Drivers & Frameworks"/"Frameworks (e.g. Django, Hibernate, EFCore)" at fee
 ### Build from Source
 
 ```console
-./gradlew clean build
+./gradlew build
 ```
 
 ### Static Code Analysis
@@ -97,19 +107,11 @@ The analysis is done as part of the Gradle `compileJava` task execution.
 
 ### Testing
 
-This project uses separate directories for unit and integration tests:
+This project uses separate directories for unit, integration, smoke tests:
 
 - [`./src/test`](src/test)
 - [`./src/integrationTest`](src/integrationTest)
-
-Integration tests require a MongoDB deployment with test commands enabled,  which may be achieved with the
-[`--setParameter enableTestCommands=1`](https://www.mongodb.com/docs/manual/reference/parameters/)
-command-line arguments.
-
-You may change the [MongoDB connection string](https://www.mongodb.com/docs/manual/reference/connection-string/)
-via the [`jakarta.persistence.jdbc.url`](https://docs.hibernate.org/orm/6.6/userguide/html_single/#settings-jakarta.persistence.jdbc.url)
-configuration property
-in [`./src/integrationTest/resources/hibernate.properties`](src/integrationTest/resources/hibernate.properties).
+- [`./example-module/src/smokeTest`](example-module/src/smokeTest)
 
 #### Run Unit Tests
 
@@ -119,10 +121,38 @@ in [`./src/integrationTest/resources/hibernate.properties`](src/integrationTest/
 
 #### Run Integration Tests
 
+The integration tests require a MongoDB deployment that
+
+- is accessible at `localhost:27017`;
+  - You may change the [MongoDB connection string](https://www.mongodb.com/docs/manual/reference/connection-string/)
+    via the [`jakarta.persistence.jdbc.url`](https://docs.hibernate.org/orm/6.6/userguide/html_single/#settings-jakarta.persistence.jdbc.url)
+    configuration property
+    in [`./src/integrationTest/resources/hibernate.properties`](src/integrationTest/resources/hibernate.properties). 
+- has test commands enabled.
+  - This may be achieved with the
+    [`--setParameter enableTestCommands=1`](https://www.mongodb.com/docs/manual/reference/parameters/)
+    command-line arguments.
+
 ```console
 ./gradlew integrationTest
 ```
 
+#### Run Smoke Tests
+
+The smoke tests with the `Tests` suffix do not require a MongoDB deployment.
+The smoke tests with the `IntegrationTests` suffix, as well as the examples, require a MongoDB deployment that
+
+- is accessible at `localhost:27017`.
+  - You may change this by modifying the examples run by the smoke tests.
+
+```console
+source ./.evergreen/java-config.sh \
+  && ./gradlew -PjavaVersion=${JAVA_VERSION} publishToMavenLocal \
+  && ./example-module/mvnw verify --file ./example-module/pom.xml \
+    -DjavaVersion="${JAVA_VERSION}" \
+    -DprojectVersion="$(./gradlew -q printProjectVersion)"
+```
+
 ### Continuous Integration
-[Evergreen](https://github.com/evergreen-ci/evergreen) and [GitHub actions](https://docs.github.com/en/actions)
+[Evergreen](https://github.com/evergreen-ci/evergreen) and [GitHub Actions](https://docs.github.com/en/actions)
 are used for continuous integration.