Add ./example-module

HIBERNATE-52

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/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 -f ./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

@@ -54,6 +54,23 @@ Use ["Extension for Hibernate ORM" at jira.mongodb.org](https://jira.mongodb.org
 
 Use ["Drivers & Frameworks"/"Frameworks (e.g. Django, Hibernate, EFCore)" at feedback.mongodb.com" at feedback.mongodb.com](https://feedback.mongodb.com/?category=7548141831345841376).
 
+### Examples
+
+[Maven](https://maven.apache.org/) is used as a build tool.
+
+The example applications are located in [`./example-module`](example-module).
+They require a MongoDB deployment accessible at `localhost:27017`.
+
+#### Build and Run from Source
+
+```console
+source ./.evergreen/java-config.sh \
+  && ./gradlew -PjavaVersion=${JAVA_VERSION} clean publishToMavenLocal \
+  && ./example-module/mvnw clean verify -f ./example-module/pom.xml \
+    -DjavaVersion="${JAVA_VERSION}" \
+    -DprojectVersion="$(./gradlew -q printProjectVersion)"
+```
+
 ## Contributor Documentation
 
 [Gradle](https://gradle.org/) is used as a build tool.

build.gradle.kts

@@ -354,3 +354,6 @@ tasks.register("publishArchives") {
         dependsOn(tasks.named("publishToSonatype"))
     }
 }
+
+// `./gradlew -q printProjectVersion`
+tasks.register("printProjectVersion") { doLast { logger.quiet(project.version.toString()) } }