From 2b245a970045bf6ef10dd25cdc05a2a1d515abfd Mon Sep 17 00:00:00 2001 From: Hardik Singh Behl Date: Mon, 17 Jun 2024 20:11:06 +0530 Subject: [PATCH] add codebase/reducing-testcontainers-execution-time (#234) Co-authored-by: Philip Riecks --- pom.xml | 1 + .../.gitignore | 33 +++ .../.mvn/wrapper/maven-wrapper.properties | 19 ++ .../README.md | 7 + .../lombok.config | 1 + reducing-testcontainers-execution-time/mvnw | 259 ++++++++++++++++++ .../mvnw.cmd | 149 ++++++++++ .../pom.xml | 121 ++++++++ .../main/java/de/rieckpil/Application.java | 12 + .../JwtConfigurationProperties.java | 17 ++ .../configuration/RedisConfiguration.java | 31 +++ .../main/java/de/rieckpil/entity/Article.java | 30 ++ .../main/java/de/rieckpil/entity/User.java | 36 +++ .../repository/ArticleRepository.java | 12 + .../rieckpil/repository/UserRepository.java | 12 + .../de/rieckpil/utility/CacheUtility.java | 36 +++ .../src/main/resources/application.yaml | 4 + .../java/de/rieckpil/ArticleRepositoryIT.java | 39 +++ .../test/java/de/rieckpil/AuthServiceIT.java | 28 ++ .../de/rieckpil/InitializeMysqlContainer.java | 12 + .../de/rieckpil/InitializeRedisContainer.java | 12 + .../java/de/rieckpil/InitializeSecretKey.java | 12 + .../java/de/rieckpil/MySQLConfiguration.java | 16 ++ .../de/rieckpil/MySQLDatabaseInitializer.java | 31 +++ .../test/java/de/rieckpil/ProblematicIT.java | 55 ++++ .../de/rieckpil/RedisCacheInitializer.java | 37 +++ .../de/rieckpil/SecretKeyInitializer.java | 21 ++ .../java/de/rieckpil/UserRepositoryIT.java | 35 +++ .../test/java/de/rieckpil/UserServiceIT.java | 32 +++ 29 files changed, 1110 insertions(+) create mode 100644 reducing-testcontainers-execution-time/.gitignore create mode 100644 reducing-testcontainers-execution-time/.mvn/wrapper/maven-wrapper.properties create mode 100644 reducing-testcontainers-execution-time/README.md create mode 100644 reducing-testcontainers-execution-time/lombok.config create mode 100755 reducing-testcontainers-execution-time/mvnw create mode 100644 reducing-testcontainers-execution-time/mvnw.cmd create mode 100644 reducing-testcontainers-execution-time/pom.xml create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/Application.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/JwtConfigurationProperties.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/RedisConfiguration.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/Article.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/User.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/ArticleRepository.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/UserRepository.java create mode 100644 reducing-testcontainers-execution-time/src/main/java/de/rieckpil/utility/CacheUtility.java create mode 100644 reducing-testcontainers-execution-time/src/main/resources/application.yaml create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ArticleRepositoryIT.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/AuthServiceIT.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeMysqlContainer.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeRedisContainer.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeSecretKey.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLConfiguration.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLDatabaseInitializer.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ProblematicIT.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/RedisCacheInitializer.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/SecretKeyInitializer.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserRepositoryIT.java create mode 100644 reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserServiceIT.java diff --git a/pom.xml b/pom.xml index 2a5255e9..b81e2695 100644 --- a/pom.xml +++ b/pom.xml @@ -76,6 +76,7 @@ azure-blob-storage-azurite-testing caching-validation-testcontainers testing-libraries-overview + reducing-testcontainers-execution-time generating-test-data-with-instancio diff --git a/reducing-testcontainers-execution-time/.gitignore b/reducing-testcontainers-execution-time/.gitignore new file mode 100644 index 00000000..549e00a2 --- /dev/null +++ b/reducing-testcontainers-execution-time/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/reducing-testcontainers-execution-time/.mvn/wrapper/maven-wrapper.properties b/reducing-testcontainers-execution-time/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..8f96f52c --- /dev/null +++ b/reducing-testcontainers-execution-time/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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 +# +# https://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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip diff --git a/reducing-testcontainers-execution-time/README.md b/reducing-testcontainers-execution-time/README.md new file mode 100644 index 00000000..4f2d0b78 --- /dev/null +++ b/reducing-testcontainers-execution-time/README.md @@ -0,0 +1,7 @@ +### Codebase for the blog post [Reducing Testcontainers Execution Time and Boilerplate Code Using JUnit 5's Lifecycle Callbacks](https://rieckpil.de/) + +Steps to run this project: +1. Clone this Git repository +2. Navigate to the folder `reducing-testcontainers-execution-time` +3. Ensure availability of Java 21 or above in the system using `java --version` +4. Execute tests with the command `./mvnw integration-test verify` diff --git a/reducing-testcontainers-execution-time/lombok.config b/reducing-testcontainers-execution-time/lombok.config new file mode 100644 index 00000000..746d4967 --- /dev/null +++ b/reducing-testcontainers-execution-time/lombok.config @@ -0,0 +1 @@ +lombok.nonNull.exceptionType=IllegalArgumentException diff --git a/reducing-testcontainers-execution-time/mvnw b/reducing-testcontainers-execution-time/mvnw new file mode 100755 index 00000000..d7c358e5 --- /dev/null +++ b/reducing-testcontainers-execution-time/mvnw @@ -0,0 +1,259 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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 +# +# https://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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.2 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/reducing-testcontainers-execution-time/mvnw.cmd b/reducing-testcontainers-execution-time/mvnw.cmd new file mode 100644 index 00000000..6f779cff --- /dev/null +++ b/reducing-testcontainers-execution-time/mvnw.cmd @@ -0,0 +1,149 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.2 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' +$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/reducing-testcontainers-execution-time/pom.xml b/reducing-testcontainers-execution-time/pom.xml new file mode 100644 index 00000000..1a0a3019 --- /dev/null +++ b/reducing-testcontainers-execution-time/pom.xml @@ -0,0 +1,121 @@ + + + 4.0.0 + + + de.rieckpil.blog + blog-parent + 0.0.1-SNAPSHOT + ../pom.xml + + + de.rieckpil + reducing-testcontainers-execution-time + + 0.0.1 + reducing-testcontainers-execution-time + Proof of concept demonstrating approaches to reduce Testcontainers execution time and boilerplate code + + + + hardikSinghBehl + Hardik Singh Behl + behl.hardiksingh@gmail.com + + Developer + + UTC +5:30 + + + + + 21 + 0.12.5 + + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-validation + + + + + org.springframework.boot + spring-boot-starter-data-redis + + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + com.mysql + mysql-connector-j + + + + + io.jsonwebtoken + jjwt-impl + ${jjwt.version} + + + io.jsonwebtoken + jjwt-jackson + ${jjwt.version} + + + + + org.springframework.boot + spring-boot-configuration-processor + + + org.projectlombok + lombok + true + + + + + org.springframework.boot + spring-boot-starter-test + test + + + org.testcontainers + mysql + test + + + org.springframework.boot + spring-boot-testcontainers + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/Application.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/Application.java new file mode 100644 index 00000000..22638758 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/Application.java @@ -0,0 +1,12 @@ +package de.rieckpil; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/JwtConfigurationProperties.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/JwtConfigurationProperties.java new file mode 100644 index 00000000..27f47294 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/JwtConfigurationProperties.java @@ -0,0 +1,17 @@ +package de.rieckpil.configuration; + +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.Pattern; +import lombok.Getter; +import lombok.Setter; +import org.springframework.boot.context.properties.ConfigurationProperties; + +@Getter +@Setter +@ConfigurationProperties(prefix = "de.rieckpil.jwt") +public class JwtConfigurationProperties { + + @NotBlank(message = "Secret key must not be configured") + @Pattern(regexp = "^[a-zA-Z0-9+/]*={0,2}$", message = "Secret key must be Base64 encoded.") + private String secretKey; +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/RedisConfiguration.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/RedisConfiguration.java new file mode 100644 index 00000000..34a79eaf --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/configuration/RedisConfiguration.java @@ -0,0 +1,31 @@ +package de.rieckpil.configuration; + +import org.springframework.boot.autoconfigure.data.redis.RedisProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.redis.connection.RedisConnectionFactory; +import org.springframework.data.redis.connection.RedisStandaloneConfiguration; +import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; + +@Configuration +public class RedisConfiguration { + + @Bean + public RedisConnectionFactory redisConnectionFactory(final RedisProperties redisProperties) { + final var standaloneConfiguration = + new RedisStandaloneConfiguration(redisProperties.getHost(), redisProperties.getPort()); + standaloneConfiguration.setPassword(redisProperties.getPassword()); + return new LettuceConnectionFactory(standaloneConfiguration); + } + + @Bean + public RedisTemplate redisTemplate( + final RedisConnectionFactory redisConnectionFactory) { + final var redisTemplate = new RedisTemplate(); + redisTemplate.setConnectionFactory(redisConnectionFactory); + redisTemplate.setDefaultSerializer(new Jackson2JsonRedisSerializer<>(Object.class)); + return redisTemplate; + } +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/Article.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/Article.java new file mode 100644 index 00000000..fc82bb37 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/Article.java @@ -0,0 +1,30 @@ +package de.rieckpil.entity; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.PrePersist; +import jakarta.persistence.Table; +import java.util.UUID; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +@Entity +@Table(name = "articles") +public class Article { + + @Id + @Setter(AccessLevel.NONE) + private UUID id; + + private String title; + + private String writtenBy; + + @PrePersist + void onCreate() { + this.id = UUID.randomUUID(); + } +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/User.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/User.java new file mode 100644 index 00000000..0a933dbf --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/entity/User.java @@ -0,0 +1,36 @@ +package de.rieckpil.entity; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.PrePersist; +import jakarta.persistence.Table; +import java.time.LocalDateTime; +import java.time.ZoneOffset; +import java.util.UUID; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +@Entity +@Table(name = "users") +public class User { + + @Id + @Setter(AccessLevel.NONE) + private UUID id; + + private String emailId; + + private String password; + + @Setter(AccessLevel.NONE) + private LocalDateTime createdAt; + + @PrePersist + void onCreate() { + this.id = UUID.randomUUID(); + this.createdAt = LocalDateTime.now(ZoneOffset.UTC); + } +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/ArticleRepository.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/ArticleRepository.java new file mode 100644 index 00000000..c4f33b62 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/ArticleRepository.java @@ -0,0 +1,12 @@ +package de.rieckpil.repository; + +import de.rieckpil.entity.Article; +import java.util.UUID; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface ArticleRepository extends JpaRepository { + + Boolean existsByTitle(final String title); +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/UserRepository.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/UserRepository.java new file mode 100644 index 00000000..4412ea9c --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/repository/UserRepository.java @@ -0,0 +1,12 @@ +package de.rieckpil.repository; + +import de.rieckpil.entity.User; +import java.util.UUID; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface UserRepository extends JpaRepository { + + Boolean existsByEmailId(final String emailId); +} diff --git a/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/utility/CacheUtility.java b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/utility/CacheUtility.java new file mode 100644 index 00000000..c98e5525 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/java/de/rieckpil/utility/CacheUtility.java @@ -0,0 +1,36 @@ +package de.rieckpil.utility; + +import com.fasterxml.jackson.databind.ObjectMapper; +import java.time.Duration; +import java.util.Optional; +import lombok.NonNull; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.stereotype.Component; + +@Slf4j +@Component +@RequiredArgsConstructor +public class CacheUtility { + + private final RedisTemplate redisTemplate; + private final ObjectMapper objectMapper; + + public void save( + @NonNull final String key, @NonNull final Object value, @NonNull final Duration timeToLive) { + redisTemplate.opsForValue().set(key, value); + log.info("Cached value with key '{}' for {} seconds", key, timeToLive.toSeconds()); + } + + public Optional retrieve(@NonNull final String key, @NonNull final Class targetClass) { + final var value = Optional.ofNullable(redisTemplate.opsForValue().get(key)); + if (value.isEmpty()) { + log.info("No cached value found for key '{}'", key); + return Optional.empty(); + } + T result = objectMapper.convertValue(value.get(), targetClass); + log.info("Fetched cached value with key '{}'", key); + return Optional.of(result); + } +} diff --git a/reducing-testcontainers-execution-time/src/main/resources/application.yaml b/reducing-testcontainers-execution-time/src/main/resources/application.yaml new file mode 100644 index 00000000..7797cddf --- /dev/null +++ b/reducing-testcontainers-execution-time/src/main/resources/application.yaml @@ -0,0 +1,4 @@ +spring: + jpa: + hibernate: + ddl-auto: update \ No newline at end of file diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ArticleRepositoryIT.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ArticleRepositoryIT.java new file mode 100644 index 00000000..7fc9f6e3 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ArticleRepositoryIT.java @@ -0,0 +1,39 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import de.rieckpil.entity.Article; +import de.rieckpil.repository.ArticleRepository; +import net.bytebuddy.utility.RandomString; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase; +import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.Replace; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.context.annotation.Import; + +@DataJpaTest +@Import(MySQLConfiguration.class) +@AutoConfigureTestDatabase(replace = Replace.NONE) +class ArticleRepositoryIT { + + @Autowired private ArticleRepository articleRepository; + + @Test + void shouldSaveArticleInDatabaseSuccessfully() { + final var title = RandomString.make(); + final var writtenBy = RandomString.make(); + + Boolean userExistsWithEmailId = articleRepository.existsByTitle(title); + assertThat(userExistsWithEmailId).isFalse(); + + final var article = new Article(); + article.setTitle(title); + article.setWrittenBy(writtenBy); + + articleRepository.save(article); + + userExistsWithEmailId = articleRepository.existsByTitle(title); + assertThat(userExistsWithEmailId).isTrue(); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/AuthServiceIT.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/AuthServiceIT.java new file mode 100644 index 00000000..6dad4bd2 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/AuthServiceIT.java @@ -0,0 +1,28 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import de.rieckpil.configuration.JwtConfigurationProperties; +import jakarta.validation.Validator; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +@InitializeSecretKey +@InitializeMysqlContainer +@InitializeRedisContainer +@EnableConfigurationProperties(JwtConfigurationProperties.class) +class AuthServiceIT { + + @Autowired private Validator validator; + + @Autowired private JwtConfigurationProperties jwtConfigurationProperties; + + @Test + void jwtSecretKeyIsConfiguredCorrectly() { + final var violations = validator.validate(jwtConfigurationProperties); + assertThat(violations).isEmpty(); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeMysqlContainer.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeMysqlContainer.java new file mode 100644 index 00000000..64d20625 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeMysqlContainer.java @@ -0,0 +1,12 @@ +package de.rieckpil; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.junit.jupiter.api.extension.ExtendWith; + +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@ExtendWith(MySQLDatabaseInitializer.class) +@interface InitializeMysqlContainer {} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeRedisContainer.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeRedisContainer.java new file mode 100644 index 00000000..438a3083 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeRedisContainer.java @@ -0,0 +1,12 @@ +package de.rieckpil; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.junit.jupiter.api.extension.ExtendWith; + +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@ExtendWith(RedisCacheInitializer.class) +@interface InitializeRedisContainer {} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeSecretKey.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeSecretKey.java new file mode 100644 index 00000000..e0af6262 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/InitializeSecretKey.java @@ -0,0 +1,12 @@ +package de.rieckpil; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.junit.jupiter.api.extension.ExtendWith; + +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@ExtendWith(SecretKeyInitializer.class) +@interface InitializeSecretKey {} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLConfiguration.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLConfiguration.java new file mode 100644 index 00000000..65384856 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLConfiguration.java @@ -0,0 +1,16 @@ +package de.rieckpil; + +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.context.annotation.Bean; +import org.testcontainers.containers.MySQLContainer; + +@TestConfiguration(proxyBeanMethods = false) +class MySQLConfiguration { + + @Bean + @ServiceConnection + public MySQLContainer mySQLContainer() { + return new MySQLContainer<>("mysql:8"); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLDatabaseInitializer.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLDatabaseInitializer.java new file mode 100644 index 00000000..01ea4e76 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/MySQLDatabaseInitializer.java @@ -0,0 +1,31 @@ +package de.rieckpil; + +import java.util.concurrent.atomic.AtomicBoolean; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.Replace; +import org.testcontainers.containers.MySQLContainer; +import org.testcontainers.utility.DockerImageName; + +class MySQLDatabaseInitializer implements BeforeAllCallback { + + private static final AtomicBoolean INITIAL_INVOCATION = new AtomicBoolean(Boolean.TRUE); + + private static final DockerImageName MYSQL_IMAGE = DockerImageName.parse("mysql:8"); + private static final MySQLContainer mySQLContainer = new MySQLContainer<>(MYSQL_IMAGE); + + @Override + public void beforeAll(final ExtensionContext context) { + if (INITIAL_INVOCATION.getAndSet(Boolean.FALSE)) { + mySQLContainer.start(); + addDataSourceProperties(); + } + } + + private void addDataSourceProperties() { + System.setProperty("spring.datasource.url", mySQLContainer.getJdbcUrl()); + System.setProperty("spring.datasource.username", mySQLContainer.getUsername()); + System.setProperty("spring.datasource.password", mySQLContainer.getPassword()); + System.setProperty("spring.test.database.replace", Replace.NONE.name()); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ProblematicIT.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ProblematicIT.java new file mode 100644 index 00000000..dd9bde12 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/ProblematicIT.java @@ -0,0 +1,55 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import de.rieckpil.utility.CacheUtility; +import java.time.Duration; +import net.bytebuddy.utility.RandomString; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.DynamicPropertyRegistry; +import org.springframework.test.context.DynamicPropertySource; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.utility.DockerImageName; + +@SpringBootTest +@EnableAutoConfiguration(exclude = DataSourceAutoConfiguration.class) +class ProblematicIT { + + @Autowired private CacheUtility cacheUtility; + + private static final int REDIS_PORT = 6379; + private static final String REDIS_PASSWORD = RandomString.make(10); + private static final DockerImageName REDIS_IMAGE = DockerImageName.parse("redis:7.2.4"); + + private static final GenericContainer redisContainer = + new GenericContainer<>(REDIS_IMAGE) + .withCommand("redis-server", "--requirepass", REDIS_PASSWORD) + .withExposedPorts(REDIS_PORT); + + static { + redisContainer.start(); + } + + @DynamicPropertySource + static void properties(DynamicPropertyRegistry registry) { + registry.add("spring.data.redis.host", redisContainer::getHost); + registry.add("spring.data.redis.port", () -> redisContainer.getMappedPort(REDIS_PORT)); + registry.add("spring.data.redis.password", () -> REDIS_PASSWORD); + } + + @Test + void shouldSaveValueToCache() { + final var key = RandomString.make(); + final var value = RandomString.make(); + + cacheUtility.save(key, value, Duration.ofSeconds(10)); + + final var retrievedValue = cacheUtility.retrieve(key, String.class); + + assertThat(retrievedValue).isPresent().hasValue(value); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/RedisCacheInitializer.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/RedisCacheInitializer.java new file mode 100644 index 00000000..cd5f6ace --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/RedisCacheInitializer.java @@ -0,0 +1,37 @@ +package de.rieckpil; + +import java.util.concurrent.atomic.AtomicBoolean; +import net.bytebuddy.utility.RandomString; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.utility.DockerImageName; + +class RedisCacheInitializer implements BeforeAllCallback { + + private static final AtomicBoolean INITIAL_INVOCATION = new AtomicBoolean(Boolean.TRUE); + + private final int REDIS_PORT = 6379; + private final String REDIS_PASSWORD = RandomString.make(10); + private final DockerImageName REDIS_IMAGE = DockerImageName.parse("redis:7.2.4"); + + private final GenericContainer redisContainer = + new GenericContainer<>(REDIS_IMAGE) + .withCommand("redis-server", "--requirepass", REDIS_PASSWORD) + .withExposedPorts(REDIS_PORT); + + @Override + public void beforeAll(final ExtensionContext context) { + if (INITIAL_INVOCATION.getAndSet(Boolean.FALSE)) { + redisContainer.start(); + addCacheProperties(); + } + } + + private void addCacheProperties() { + System.setProperty("spring.data.redis.host", redisContainer.getHost()); + System.setProperty( + "spring.data.redis.port", String.valueOf(redisContainer.getMappedPort(REDIS_PORT))); + System.setProperty("spring.data.redis.password", REDIS_PASSWORD); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/SecretKeyInitializer.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/SecretKeyInitializer.java new file mode 100644 index 00000000..dcf57a33 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/SecretKeyInitializer.java @@ -0,0 +1,21 @@ +package de.rieckpil; + +import io.jsonwebtoken.Jwts; +import io.jsonwebtoken.io.Encoders; +import java.util.concurrent.atomic.AtomicBoolean; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.ExtensionContext; + +class SecretKeyInitializer implements BeforeAllCallback { + + private static final AtomicBoolean INITIAL_INVOCATION = new AtomicBoolean(Boolean.TRUE); + + @Override + public void beforeAll(ExtensionContext context) { + if (INITIAL_INVOCATION.getAndSet(Boolean.FALSE)) { + var secretKey = Jwts.SIG.HS256.key().build().getEncoded(); + var base64EncodedSecretKey = Encoders.BASE64.encode(secretKey); + System.setProperty("de.rieckpil.jwt.secret-key", base64EncodedSecretKey); + } + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserRepositoryIT.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserRepositoryIT.java new file mode 100644 index 00000000..6e833fe1 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserRepositoryIT.java @@ -0,0 +1,35 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import de.rieckpil.entity.User; +import de.rieckpil.repository.UserRepository; +import net.bytebuddy.utility.RandomString; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; + +@DataJpaTest +@InitializeMysqlContainer +class UserRepositoryIT { + + @Autowired private UserRepository userRepository; + + @Test + void shouldSaveUserInDatabaseSuccessfully() { + final var emailId = RandomString.make(); + final var password = RandomString.make(); + + Boolean userExistsWithEmailId = userRepository.existsByEmailId(emailId); + assertThat(userExistsWithEmailId).isFalse(); + + final var user = new User(); + user.setEmailId(emailId); + user.setPassword(password); + + userRepository.save(user); + + userExistsWithEmailId = userRepository.existsByEmailId(emailId); + assertThat(userExistsWithEmailId).isTrue(); + } +} diff --git a/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserServiceIT.java b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserServiceIT.java new file mode 100644 index 00000000..bb63e6c6 --- /dev/null +++ b/reducing-testcontainers-execution-time/src/test/java/de/rieckpil/UserServiceIT.java @@ -0,0 +1,32 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import de.rieckpil.utility.CacheUtility; +import java.time.Duration; +import net.bytebuddy.utility.RandomString; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +@InitializeRedisContainer +@EnableAutoConfiguration(exclude = DataSourceAutoConfiguration.class) +class UserServiceIT { + + @Autowired private CacheUtility cacheUtility; + + @Test + void shouldSaveValueToCache() { + final var key = RandomString.make(); + final var value = RandomString.make(); + + cacheUtility.save(key, value, Duration.ofSeconds(10)); + + final var retrievedValue = cacheUtility.retrieve(key, String.class); + + assertThat(retrievedValue).isPresent().hasValue(value); + } +}