From 21616f814506512388e2fb0918f092ae0b638ba3 Mon Sep 17 00:00:00 2001 From: Hardik Singh Behl Date: Mon, 17 Jun 2024 20:09:18 +0530 Subject: [PATCH] add codebase for instancio article --- .../.gitignore | 33 +++ .../.mvn/wrapper/maven-wrapper.properties | 19 ++ generating-test-data-with-instancio/README.md | 7 + .../lombok.config | 1 + generating-test-data-with-instancio/mvnw | 259 ++++++++++++++++++ generating-test-data-with-instancio/mvnw.cmd | 149 ++++++++++ generating-test-data-with-instancio/pom.xml | 85 ++++++ .../main/java/de/rieckpil/Application.java | 12 + .../rieckpil/controller/UserController.java | 19 ++ .../java/de/rieckpil/BeanValidationTest.java | 35 +++ .../de/rieckpil/ClassSettingOverrideTest.java | 32 +++ .../java/de/rieckpil/CustomizeFieldsTest.java | 34 +++ .../java/de/rieckpil/FieldsIgnoreTest.java | 63 +++++ .../rieckpil/GlobalSettingOverrideTest.java | 21 ++ .../de/rieckpil/InstructorCoursesTest.java | 74 +++++ .../rieckpil/ObjectSettingOverrideTest.java | 20 ++ .../de/rieckpil/ParameterizedSupportTest.java | 22 ++ .../java/de/rieckpil/ReusableModelTest.java | 40 +++ .../java/de/rieckpil/UserControllerTest.java | 32 +++ .../java/de/rieckpil/utility/JsonUtil.java | 15 + .../src/test/resources/instancio.properties | 3 + pom.xml | 1 + 22 files changed, 976 insertions(+) create mode 100644 generating-test-data-with-instancio/.gitignore create mode 100644 generating-test-data-with-instancio/.mvn/wrapper/maven-wrapper.properties create mode 100644 generating-test-data-with-instancio/README.md create mode 100644 generating-test-data-with-instancio/lombok.config create mode 100755 generating-test-data-with-instancio/mvnw create mode 100644 generating-test-data-with-instancio/mvnw.cmd create mode 100644 generating-test-data-with-instancio/pom.xml create mode 100644 generating-test-data-with-instancio/src/main/java/de/rieckpil/Application.java create mode 100644 generating-test-data-with-instancio/src/main/java/de/rieckpil/controller/UserController.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/BeanValidationTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/ClassSettingOverrideTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/CustomizeFieldsTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/FieldsIgnoreTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/GlobalSettingOverrideTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/InstructorCoursesTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/ObjectSettingOverrideTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/ParameterizedSupportTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/ReusableModelTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/UserControllerTest.java create mode 100644 generating-test-data-with-instancio/src/test/java/de/rieckpil/utility/JsonUtil.java create mode 100644 generating-test-data-with-instancio/src/test/resources/instancio.properties diff --git a/generating-test-data-with-instancio/.gitignore b/generating-test-data-with-instancio/.gitignore new file mode 100644 index 00000000..549e00a2 --- /dev/null +++ b/generating-test-data-with-instancio/.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/generating-test-data-with-instancio/.mvn/wrapper/maven-wrapper.properties b/generating-test-data-with-instancio/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..8f96f52c --- /dev/null +++ b/generating-test-data-with-instancio/.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/generating-test-data-with-instancio/README.md b/generating-test-data-with-instancio/README.md new file mode 100644 index 00000000..84c4939d --- /dev/null +++ b/generating-test-data-with-instancio/README.md @@ -0,0 +1,7 @@ +### Codebase for the blog post [Generating Test Data in Java Using Instancio](https://rieckpil.de/) + +Steps to run this project: +1. Clone this Git repository +2. Navigate to the folder `generating-test-data-with-instancio` +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/generating-test-data-with-instancio/lombok.config b/generating-test-data-with-instancio/lombok.config new file mode 100644 index 00000000..a886d464 --- /dev/null +++ b/generating-test-data-with-instancio/lombok.config @@ -0,0 +1 @@ +lombok.nonNull.exceptionType=IllegalArgumentException \ No newline at end of file diff --git a/generating-test-data-with-instancio/mvnw b/generating-test-data-with-instancio/mvnw new file mode 100755 index 00000000..d7c358e5 --- /dev/null +++ b/generating-test-data-with-instancio/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/generating-test-data-with-instancio/mvnw.cmd b/generating-test-data-with-instancio/mvnw.cmd new file mode 100644 index 00000000..6f779cff --- /dev/null +++ b/generating-test-data-with-instancio/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/generating-test-data-with-instancio/pom.xml b/generating-test-data-with-instancio/pom.xml new file mode 100644 index 00000000..61b8fbb1 --- /dev/null +++ b/generating-test-data-with-instancio/pom.xml @@ -0,0 +1,85 @@ + + + 4.0.0 + + + de.rieckpil.blog + blog-parent + 0.0.1-SNAPSHOT + ../pom.xml + + + de.rieckpil + generating-test-data-with-instancio + + 0.0.1 + generating-test-data-with-instancio + Project demonstrating usage of Instancio to simplify test generation process + + + + hardikSinghBehl + Hardik Singh Behl + behl.hardiksingh@gmail.com + + Developer + + UTC +5:30 + + + + + 21 + 4.8.0 + + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-validation + + + + + org.projectlombok + lombok + true + + + + + org.springframework.boot + spring-boot-starter-test + test + + + org.instancio + instancio-junit + ${instancio.version} + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/generating-test-data-with-instancio/src/main/java/de/rieckpil/Application.java b/generating-test-data-with-instancio/src/main/java/de/rieckpil/Application.java new file mode 100644 index 00000000..22638758 --- /dev/null +++ b/generating-test-data-with-instancio/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/generating-test-data-with-instancio/src/main/java/de/rieckpil/controller/UserController.java b/generating-test-data-with-instancio/src/main/java/de/rieckpil/controller/UserController.java new file mode 100644 index 00000000..53558112 --- /dev/null +++ b/generating-test-data-with-instancio/src/main/java/de/rieckpil/controller/UserController.java @@ -0,0 +1,19 @@ +package de.rieckpil.controller; + +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping(value = "/api/v1/users") +public class UserController { + + @PostMapping + public ResponseEntity createUser(@RequestBody UserCreationRequest request) { + return ResponseEntity.ok().build(); + } + + public record UserCreationRequest(String name, String email, String password) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/BeanValidationTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/BeanValidationTest.java new file mode 100644 index 00000000..e2f87409 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/BeanValidationTest.java @@ -0,0 +1,35 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import jakarta.validation.Validation; +import jakarta.validation.constraints.Email; +import jakarta.validation.constraints.Negative; +import jakarta.validation.constraints.Past; +import java.time.LocalDate; +import org.instancio.Instancio; +import org.instancio.junit.InstancioExtension; +import org.instancio.junit.WithSettings; +import org.instancio.settings.Keys; +import org.instancio.settings.Settings; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; + +@ExtendWith(InstancioExtension.class) +class BeanValidationTest { + + @WithSettings + private final Settings settings = Settings.create().set(Keys.BEAN_VALIDATION_ENABLED, true); + + @Test + void shouldValidateBeanConstrains() { + var request = Instancio.of(User.class).create(); + + var validator = Validation.buildDefaultValidatorFactory().getValidator(); + var violations = validator.validate(request); + + assertThat(violations).isEmpty(); + } + + record User(@Email String emailId, @Past LocalDate dateOfBirth, @Negative Double bankBalance) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/ClassSettingOverrideTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ClassSettingOverrideTest.java new file mode 100644 index 00000000..4b18ed8c --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ClassSettingOverrideTest.java @@ -0,0 +1,32 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.List; +import org.instancio.Instancio; +import org.instancio.junit.InstancioExtension; +import org.instancio.junit.WithSettings; +import org.instancio.settings.Keys; +import org.instancio.settings.Settings; +import org.instancio.settings.StringType; +import org.junit.jupiter.api.RepeatedTest; +import org.junit.jupiter.api.extension.ExtendWith; + +@ExtendWith(InstancioExtension.class) +class ClassSettingOverrideTest { + + @WithSettings + private static final Settings settings = + Settings.create().set(Keys.STRING_TYPE, StringType.UNICODE).set(Keys.COLLECTION_MAX_SIZE, 10); + + @RepeatedTest(value = 100) + void shouldCreateUserWithClassLevelSettings() { + var user = Instancio.of(User.class).create(); + + assertThat(user.bio()).inUnicode(); + + assertThat(user.petPeeves()).hasSizeLessThanOrEqualTo(10); + } + + record User(String bio, List petPeeves) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/CustomizeFieldsTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/CustomizeFieldsTest.java new file mode 100644 index 00000000..0115c9ba --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/CustomizeFieldsTest.java @@ -0,0 +1,34 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.instancio.Select.field; + +import java.time.LocalDate; +import org.instancio.Instancio; +import org.junit.jupiter.api.Test; + +class CustomizeFieldsTest { + + @Test + void shouldGenerateUserWithCustomFieldValues() { + var user = + Instancio.of(User.class) + .generate(field(User::bio), gen -> gen.text().loremIpsum().paragraphs(3).words(200)) + .generate(field(User::age), gen -> gen.ints().range(1, 100)) + .generate( + field(User::dateOfBirth), + gen -> gen.temporal().localDate().past().min(LocalDate.ofYearDay(1940, 1))) + .generate(field(User::cardNumber), gen -> gen.finance().creditCard().masterCard()) + .generate( + field(User::betAgainst), gen -> gen.oneOf("Conor McGregor", "Michael Chandler")) + .create(); + + assertThat(user.bio().split("\\s+")).hasSize(200); + assertThat(user.age()).isBetween(1, 100); + assertThat(user.dateOfBirth()).isBefore(LocalDate.now()); + assertThat(user.cardNumber()).startsWith("5").hasSize(16); + assertThat(user.betAgainst()).isIn("Conor McGregor", "Michael Chandler"); + } + + record User(String bio, int age, LocalDate dateOfBirth, String cardNumber, String betAgainst) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/FieldsIgnoreTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/FieldsIgnoreTest.java new file mode 100644 index 00000000..ba03d385 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/FieldsIgnoreTest.java @@ -0,0 +1,63 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.instancio.Select.field; + +import lombok.Getter; +import lombok.Setter; +import org.instancio.Instancio; +import org.junit.jupiter.api.RepeatedTest; +import org.junit.jupiter.api.Test; + +class FieldsIgnoreTest { + + @Test + void shouldCreateUserForValidRequest() { + var request = + Instancio.of(UserCreationRequest.class) + .ignore(field(UserCreationRequest::getMiddleName)) + .ignore(field("referralCode")) + .create(); + + assertThat(request.getFirstName()).isNotBlank(); + assertThat(request.getLastName()).isNotBlank(); + assertThat(request.getEmail()).isNotBlank(); + assertThat(request.getPassword()).isNotBlank(); + + assertThat(request.getMiddleName()).isNull(); + assertThat(request.getReferralCode()).isNull(); + } + + @RepeatedTest(value = 10) + void shouldCreateUserHandlingOptionalUserFields() { + var request = + Instancio.of(UserCreationRequest.class) + .withNullable(field(UserCreationRequest::getMiddleName)) + .withNullable(field(UserCreationRequest::getReferralCode)) + .create(); + + assertThat(request.getFirstName()).isNotBlank(); + assertThat(request.getLastName()).isNotBlank(); + assertThat(request.getEmail()).isNotBlank(); + assertThat(request.getPassword()).isNotBlank(); + + assertThat(request.getMiddleName()) + .satisfiesAnyOf( + value -> assertThat(value).isNull(), value -> assertThat(value).isNotNull()); + assertThat(request.getMiddleName()) + .satisfiesAnyOf( + value -> assertThat(value).isNull(), value -> assertThat(value).isNotNull()); + } + + @Getter + @Setter + static class UserCreationRequest { + + private String firstName; + private String lastName; + private String middleName; + private String email; + private String password; + private String referralCode; + } +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/GlobalSettingOverrideTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/GlobalSettingOverrideTest.java new file mode 100644 index 00000000..e0e3a8c9 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/GlobalSettingOverrideTest.java @@ -0,0 +1,21 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.List; +import org.instancio.Instancio; +import org.junit.jupiter.api.RepeatedTest; + +class GlobalSettingOverrideTest { + + @RepeatedTest(value = 100) + void valuesAdhereToGlobalSettings() { + var article = Instancio.create(Article.class); + + assertThat(article.content).isAlphanumeric(); + assertThat(article.content).hasSizeLessThanOrEqualTo(200); + assertThat(article.tags).hasSizeLessThanOrEqualTo(50); + } + + record Article(String content, List tags) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/InstructorCoursesTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/InstructorCoursesTest.java new file mode 100644 index 00000000..21046b2c --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/InstructorCoursesTest.java @@ -0,0 +1,74 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.time.Duration; +import java.util.List; +import lombok.Getter; +import lombok.Setter; +import org.instancio.Instancio; +import org.junit.jupiter.api.Test; + +class InstructorCoursesTest { + + @Test + void livingUnderARock() { + // Arrange + Course course = new Course(); + course.setName("test-course"); + course.setDescription("description-of-test-course"); + course.setDuration(Duration.ofHours(15)); + + Course anotherCourse = new Course(); + anotherCourse.setName("another-test-course"); + anotherCourse.setDescription("description-of-another-test-course"); + anotherCourse.setDuration(Duration.ofDays(2)); + + List courses = List.of(course, anotherCourse); + + Instructor instructor = new Instructor(); + instructor.setFirstName("test-first-name"); + instructor.setLastName("test-last-name"); + instructor.setEmailId("test-email-id"); + instructor.setCategory("test-category"); + instructor.setCourses(courses); + + // Act + int totalCourses = instructor.getCourses().size(); + + // Assert + assertThat(totalCourses).isEqualTo(2); + } + + @Test + void livingInTheKnow() { + // Arrange + Instructor instructor = Instancio.of(Instructor.class).create(); + + // Act + int totalCourses = instructor.getCourses().size(); + + // Assert + assertThat(totalCourses).isGreaterThan(0); + } + + @Getter + @Setter + static class Course { + + private String name; + private String description; + private Duration duration; + } + + @Getter + @Setter + static class Instructor { + + private String firstName; + private String lastName; + private String emailId; + private String category; + private List courses; + } +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/ObjectSettingOverrideTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ObjectSettingOverrideTest.java new file mode 100644 index 00000000..192b9ee4 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ObjectSettingOverrideTest.java @@ -0,0 +1,20 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.instancio.Instancio; +import org.instancio.settings.Keys; +import org.instancio.settings.StringType; +import org.junit.jupiter.api.Test; + +class ObjectSettingOverrideTest { + + @Test + void shouldCreateUserWithObjectLevelSettings() { + var user = Instancio.of(User.class).withSetting(Keys.STRING_TYPE, StringType.DIGITS).create(); + + assertThat(user.bio()).containsOnlyDigits(); + } + + record User(String bio) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/ParameterizedSupportTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ParameterizedSupportTest.java new file mode 100644 index 00000000..4e10e697 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ParameterizedSupportTest.java @@ -0,0 +1,22 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.UUID; +import org.instancio.junit.InstancioExtension; +import org.instancio.junit.InstancioSource; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; + +@ExtendWith(InstancioExtension.class) +class ParameterizedSupportTest { + + @InstancioSource + @ParameterizedTest + void shouldDoXyz(UUID userId, UserCreationRequest request) { + assertThat(userId).isNotNull(); + assertThat(request).isNotNull().hasNoNullFieldsOrProperties(); + } + + record UserCreationRequest(String emailId, String password) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/ReusableModelTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ReusableModelTest.java new file mode 100644 index 00000000..24c5a3ef --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/ReusableModelTest.java @@ -0,0 +1,40 @@ +package de.rieckpil; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.instancio.Select.field; + +import java.time.LocalDate; +import org.instancio.Instancio; +import org.instancio.Model; +import org.junit.jupiter.api.Test; + +class ReusableModelTest { + + private final Model userModel = + Instancio.of(User.class) + .generate(field(User::emailId), gen -> gen.text().pattern("#a#a#a@rieckpil.de")) + .generate(field(User::dateOfBirth), gen -> gen.temporal().localDate().past()) + .toModel(); + + @Test + void whenUserHasMasterCard_thenXyz() { + var user = + Instancio.of(userModel) + .generate(field(User::creditCardNumber), gen -> gen.finance().creditCard().masterCard()) + .create(); + + assertThat(user.creditCardNumber()).startsWith("5").hasSize(16); + } + + @Test + void whenUserHasVisa_thenXyz() { + var user = + Instancio.of(userModel) + .generate(field(User::creditCardNumber), gen -> gen.finance().creditCard().visa()) + .create(); + + assertThat(user.creditCardNumber()).startsWith("4").hasSize(16); + } + + record User(String emailId, LocalDate dateOfBirth, String creditCardNumber) {} +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/UserControllerTest.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/UserControllerTest.java new file mode 100644 index 00000000..f0156386 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/UserControllerTest.java @@ -0,0 +1,32 @@ +package de.rieckpil; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import de.rieckpil.controller.UserController; +import de.rieckpil.controller.UserController.UserCreationRequest; +import de.rieckpil.utility.JsonUtil; +import lombok.SneakyThrows; +import org.instancio.Instancio; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; + +@WebMvcTest(controllers = UserController.class) +class UserControllerTest { + + @Autowired private MockMvc mockMvc; + + @Test + @SneakyThrows + void shouldCreateUserWithValidRequest() { + var request = Instancio.of(UserCreationRequest.class).as(JsonUtil::convert); + + var apiPath = "/api/v1/users"; + mockMvc + .perform(post(apiPath).contentType(MediaType.APPLICATION_JSON).content(request)) + .andExpect(status().isOk()); + } +} diff --git a/generating-test-data-with-instancio/src/test/java/de/rieckpil/utility/JsonUtil.java b/generating-test-data-with-instancio/src/test/java/de/rieckpil/utility/JsonUtil.java new file mode 100644 index 00000000..8194668f --- /dev/null +++ b/generating-test-data-with-instancio/src/test/java/de/rieckpil/utility/JsonUtil.java @@ -0,0 +1,15 @@ +package de.rieckpil.utility; + +import com.fasterxml.jackson.databind.ObjectMapper; +import lombok.NonNull; +import lombok.SneakyThrows; +import lombok.experimental.UtilityClass; + +@UtilityClass +public class JsonUtil { + + @SneakyThrows + public String convert(@NonNull Object object) { + return new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(object); + } +} diff --git a/generating-test-data-with-instancio/src/test/resources/instancio.properties b/generating-test-data-with-instancio/src/test/resources/instancio.properties new file mode 100644 index 00000000..d1279ed5 --- /dev/null +++ b/generating-test-data-with-instancio/src/test/resources/instancio.properties @@ -0,0 +1,3 @@ +string.type=ALPHANUMERIC +string.max.length=200 +collection.max.size=50 \ No newline at end of file diff --git a/pom.xml b/pom.xml index 25a88b9f..2a5255e9 100644 --- a/pom.xml +++ b/pom.xml @@ -76,6 +76,7 @@ azure-blob-storage-azurite-testing caching-validation-testcontainers testing-libraries-overview + generating-test-data-with-instancio