build: Added spring-petclinic sample

Author: jruaux

Dockerfile

@@ -10,6 +10,6 @@ EXPOSE 8080
 
 RUN mkdir /app
 
-COPY --from=build /app/demo/redis-smart-cache-demo/build/libs/redis-smart-cache-demo-*.jar /app/redis-smart-cache-demo.jar
+COPY --from=build /app/samples/redis-smart-cache-demo/build/libs/redis-smart-cache-demo-*.jar /app/redis-smart-cache-demo.jar
 
 ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app/redis-smart-cache-demo.jar"]

README.adoc

@@ -7,7 +7,7 @@
 :product-name:    Redis Smart Cache
 :artifact-id:     redis-smart-cache-jdbc
 :property-prefix: smartcache
-:grafana-dir:     demo/redis-smart-cache-demo/grafana
+:grafana-dir:     samples/redis-smart-cache-demo/grafana
 :imagesdir:       src/media
 :toc:
 :toc-title:

build.gradle

@@ -35,14 +35,7 @@ config {
 
     docs {
         javadoc {
-            options {
-                autoLinks {
-                    enabled = false
-                }
-            }
-            aggregate {
-                enabled = false
-            }
+            enabled = false
         }
     }
 
@@ -95,12 +88,18 @@ subprojects {
     }
 
     dependencies {
-        testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
+        testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api'
+        testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-params'
+        testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine'
+        testImplementation group: 'org.junit.platform', name: 'junit-platform-launcher'
+        testImplementation group: 'org.testcontainers', name: 'junit-jupiter', version: testcontainersVersion
+        testImplementation(group: 'com.redis', name: 'testcontainers-redis', version: testcontainersRedisVersion) {
+            exclude group: 'com.redis', module: 'lettucemod'
+        }
     }
 
     test {
         useJUnitPlatform()
-        maxHeapSize = "1g" // maximum heap size
     }
 
     configurations.all {

core/redis-smart-cache-core/redis-smart-cache-core.gradle

@@ -1,13 +1,11 @@
 dependencies {
     implementation group: 'com.redis', name: 'lettucemod', version: lettucemodVersion
-    implementation 'org.springframework:spring-beans'
     implementation 'com.fasterxml.jackson.core:jackson-databind'
     implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-properties'
     implementation group: 'io.airlift', name: 'units', version: airliftVersion
     implementation 'io.micrometer:micrometer-registry-jmx'
     implementation group: 'com.redis', name: 'micrometer-registry-redis', version: micrometerRedisVersion
     testImplementation group: 'org.awaitility', name: 'awaitility', version: awaitilityVersion
-    testImplementation group: 'com.redis.testcontainers', name: 'testcontainers-redis-junit', version: testcontainersRedisVersion
 }
 
 bootJar {

core/redis-smart-cache-core/src/main/java/com/redis/smartcache/core/ClientManager.java

@@ -5,9 +5,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
-
 import com.redis.lettucemod.RedisModulesClient;
 import com.redis.lettucemod.cluster.RedisModulesClusterClient;
 import com.redis.smartcache.core.config.RedisConfig;
@@ -37,8 +34,8 @@ private AbstractRedisClient createClient(RedisConfig config) {
 
     private RedisURI redisURI(RedisConfig config) {
         RedisURI.Builder builder = RedisURI.builder(RedisURI.create(config.getUri()));
-        if (!ObjectUtils.isEmpty(config.getPassword())) {
-            if (StringUtils.hasLength(config.getUsername())) {
+        if (config.getPassword() != null && config.getPassword().length > 0) {
+            if (config.getUsername() != null && config.getUsername().length() > 0) {
                 builder.withAuthentication(config.getUsername(), config.getPassword());
             } else {
                 builder.withPassword(config.getPassword());

core/redis-smart-cache-jdbc/redis-smart-cache-jdbc.gradle

@@ -12,7 +12,6 @@ dependencies {
     testImplementation 'com.mysql:mysql-connector-j'
     testImplementation group: 'com.microsoft.sqlserver', name: 'mssql-jdbc', version: mssqlVersion
     testImplementation group: 'com.ibm.db2', name: 'jcc', version: db2Version    
-    testImplementation group: 'com.redis.testcontainers', name: 'testcontainers-redis-junit', version: testcontainersRedisVersion
     testImplementation group: 'org.testcontainers', name: 'postgresql', version: testcontainersVersion
     testImplementation group: 'org.testcontainers', name: 'oracle-xe', version: testcontainersVersion
     testImplementation group: 'org.testcontainers', name: 'mssqlserver', version: testcontainersVersion
@@ -32,17 +31,10 @@ jar.finalizedBy shadowJar
 
 shadowJar {
    archiveClassifier = ''
+   enableRelocation = true
+   relocationPrefix = "com.redis.smartcache.shaded"
 }
 
-import com.github.jengelman.gradle.plugins.shadow.tasks.ConfigureShadowRelocation
-
-task relocateShadowJar(type: ConfigureShadowRelocation) {
-    target = tasks.shadowJar
-    prefix = "com.redis.smartcache.shaded"
-}
-
-tasks.shadowJar.dependsOn tasks.relocateShadowJar
-
 jmh {
     fork = 1
     iterations = 1

core/redis-smart-cache-jdbc/src/jmh/java/com/redis/smartcache/SqlHashingBenchmark.java

@@ -33,3 +33,10 @@ services:
     container_name: redis-server-with-cache-cli
     ports:
       - 6379:6379
+      
+  redis-cache:
+    image: redis:7.0.12
+    hostname: redis-cache
+    container_name: redis-cache
+    ports:
+      - 6380:6379

docker-compose-test.yml

@@ -1,29 +1,30 @@
 group                      = com.redis
-sourceCompatibility        = 1.8
-targetCompatibility        = 1.8
 reproducibleBuild          = true
 
-bootPluginVersion          = 2.7.14
-kordampBuildVersion        = 3.1.0
-kordampPluginVersion       = 0.51.0
-shadowPluginVersion        = 7.1.2
+bootPluginVersion          = 3.2.1
+kordampBuildVersion        = 3.4.0
+kordampPluginVersion       = 0.54.0
+shadowPluginVersion        = 8.1.1
 jmhPluginVersion           = 0.7.0
 asciidoctorVersion         = 3.3.2
 
 airliftVersion             = 1.7
 awaitilityVersion          = 4.2.0
 checkerVersion             = 3.12.0
 db2Version                 = 11.5.8.0
-datafakerVersion           = 1.9.0
-jacocoVersion              = 0.8.10
-lettucemodVersion          = 3.7.2
-lettuceVersion             = 6.2.5.RELEASE
+datafakerVersion           = 2.0.2
+errorproneVersion          = 2.21.1
+jacocoVersion              = 0.8.11
+lettucemodVersion          = 3.7.3
+lettuceVersion             = 6.2.6.RELEASE
 micrometerRedisVersion     = 0.5.1
 mssqlVersion               = 12.2.0.jre8
-progressbarVersion         = 0.9.5
-testcontainersRedisVersion = 1.6.4
-testcontainersVersion      = 1.18.3
+progressbarVersion         = 0.10.0
+testcontainersRedisVersion = 2.0.1
+testcontainersVersion      = 1.19.1
 trinoVersion               = 422
+webjarsBootstrapVersion    = 5.3.2
+webjarsFontawesomeVersion  = 4.7.0
 
 org.gradle.daemon          = false
 org.gradle.caching         = false

gradle.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -83,10 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,26 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -197,11 +198,15 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradle/wrapper/gradle-wrapper.properties

@@ -85,7 +85,7 @@ distributions:
   redis-smart-cache-demo:
     type: SINGLE_JAR
     artifacts:
-      - path: 'demo/{{distributionName}}/build/libs/{{distributionName}}-{{projectVersion}}.jar'
+      - path: 'samples/{{distributionName}}/build/libs/{{distributionName}}-{{projectVersion}}.jar'
         transform: '{{distributionName}}/{{distributionName}}-{{projectEffectiveVersion}}.jar'
     executable:
       name: 'redis-smart-cache-demo-launcher'

gradlew

@@ -0,0 +1,90 @@
+= Spring PetClinic Sample Application
+
+== Run Petclinic locally
+
+Spring Petclinic is a https://spring.io/guides/gs/spring-boot[Spring
+Boot] application built using https://spring.io/guides/gs/gradle/[Gradle].
+You can build a jar file and run it from the command line (it should work just as well with Java 17 or newer):
+
+[source,bash]
+----
+./gradlew build
+java -jar build/libs/*.jar
+----
+
+You can then access the Petclinic at http://localhost:8080/.
+
+Or you can run it from Gradle directly using the Spring Boot Gradle
+plugin. If you do this, it will pick up changes that you make in the
+project immediately (changes to Java source files require a compile as
+well - most people use an IDE for this):
+
+[source,bash]
+----
+./gradlew bootRun
+----
+
+== Database configuration
+
+A setup is provided for MySQL. 
+
+You can start MySQL locally with whatever installer works for your OS or use docker:
+
+[source,bash]
+----
+docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:8.2
+----
+
+Further documentation is provided for https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources/db/mysql/petclinic_db_setup_mysql.txt[MySQL].
+
+== Working with Petclinic in your IDE
+
+=== Prerequisites
+
+The following items should be installed in your system:
+
+* Java 17 or newer (full JDK, not a JRE)
+* https://help.github.com/articles/set-up-git[Git command line tool]
+* Your preferred IDE
+** Eclipse with the m2e plugin. Note: when m2e is available, there is an
+m2 icon in `Help -> About` dialog. If m2e is not there, follow the
+install process https://www.eclipse.org/m2e/[here]
+** https://spring.io/tools[Spring Tools Suite] (STS)
+** https://www.jetbrains.com/idea/[IntelliJ IDEA]
+** https://code.visualstudio.com[VS Code]
+
+=== Steps
+
+[arabic]
+. On the command line run:
++
+[source,bash]
+----
+git clone https://github.com/spring-projects/spring-petclinic.git
+----
+. Inside Eclipse or STS:
++
+Open the project via
+`File -> Import -> Maven -> Existing Maven project`, then select the
+root directory of the cloned repo.
++
+Then either build on the command line `./mvnw generate-resources` or use
+the Eclipse launcher (right-click on project and
+`Run As -> Maven install`) to generate the CSS. Run the application’s
+main method by right-clicking on it and choosing
+`Run As -> Java Application`.
+. Inside IntelliJ IDEA:
++
+In the main menu, choose `File -> Open` and select the Petclinic
+pom.xml. Click on the `Open` button.
+* CSS files are generated from the Maven build. You can build them on
+the command line `./mvnw generate-resources` or right-click on the
+`spring-petclinic` project then
+`Maven -> Generates sources and Update Folders`.
+* A run configuration named `PetClinicApplication` should have been
+created for you if you’re using a recent Ultimate version. Otherwise,
+run the application by right-clicking on the `PetClinicApplication` main
+class and choosing `Run 'PetClinicApplication'`.
+. Navigate to the Petclinic
++
+Visit http://localhost:8080 in your browser.

jreleaser.yml

@@ -0,0 +1,21 @@
+version: "2.2"
+
+services:
+  mysql:
+    image: mysql:8.2
+    ports:
+      - "3306:3306"
+    environment:
+      - MYSQL_ROOT_PASSWORD=
+      - MYSQL_ALLOW_EMPTY_PASSWORD=true
+      - MYSQL_USER=petclinic
+      - MYSQL_PASSWORD=petclinic
+      - MYSQL_DATABASE=petclinic
+    volumes:
+      - "./conf.d:/etc/mysql/conf.d:ro"
+      
+  redis:
+    image: redis/redis-stack-server
+    hostname: redis
+    ports:
+      - 6379:6379