diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..549e00a2a --- /dev/null +++ b/.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/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 000000000..cb28b0e37 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..5f0536eb7 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/mvnw b/mvnw new file mode 100755 index 000000000..66df28542 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/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.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 000000000..95ba6f54a --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@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.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 000000000..370c2e21d --- /dev/null +++ b/pom.xml @@ -0,0 +1,126 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.1.5 + + + com.prgrms.dev + springboot-board-jpa + 0.0.1-SNAPSHOT + springboot-board-jpa + springboot-board-jpa + + 17 + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + org.springframework.boot + spring-boot-starter-web + + + + com.h2database + h2 + runtime + + + com.mysql + mysql-connector-j + runtime + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + org.springframework.restdocs + spring-restdocs-mockmvc + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + paketobuildpacks/builder-jammy-base:latest + + + + org.projectlombok + lombok + + + + + + org.asciidoctor + asciidoctor-maven-plugin + 2.2.1 + + + generate-docs + prepare-package + + process-asciidoc + + + html + book + + + + + + org.springframework.restdocs + spring-restdocs-asciidoctor + ${spring-restdocs.version} + + + + + maven-resources-plugin + 2.7 + + + copy-resources + prepare-package + + copy-resources + + + + ${project.build.outputDirectory}/static/docs + + + + + ${project.build.directory}/generated-docs + + + + + + + + + + + diff --git a/src/docs/index.adoc b/src/docs/index.adoc new file mode 100644 index 000000000..d23de70af --- /dev/null +++ b/src/docs/index.adoc @@ -0,0 +1,47 @@ +ifndef::snippets[] +:snippets: build/generated-snippets +endif::[] + +== 단건 조회 + +.Reqeust +include::{snippets}/post-findOne/http-request.adoc[] +include::{snippets}/post-findOne/request-fields.adoc[] + +.Response +include::{snippets}/post-findOne/http-response.adoc[] +include::{snippets}/post-findOne/response-body.adoc[] + +== 전체 조회 + +.Request + +include::{snippets}/post-getAll/http-request.adoc[] +include::{snippets}/post-getAll/response-fields.adoc[] + +.Response + +include::{snippets}/post-getAll/http-response.adoc[] +include::{snippets}/post-getAll/response-body.adoc[] + +== 생성 + +.Request + +include::{snippets}/post-create/http-request.adoc[] +include::{snippets}/post-create/response-fields.adoc[] + +.Response + +include::{snippets}/post-create/http-response.adoc[] +include::{snippets}/post-create/response-body.adoc[] + +== 수정 + +include::{snippets}/post-update/http-request.adoc[] +include::{snippets}/post-update/response-fields.adoc[] + +.Response + +include::{snippets}/post-update/http-response.adoc[] +include::{snippets}/post-update/response-body.adoc[] diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/SpringbootBoardJpaApplication.java b/src/main/java/com/prgrms/dev/springbootboardjpa/SpringbootBoardJpaApplication.java new file mode 100644 index 000000000..4e7124e3a --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/SpringbootBoardJpaApplication.java @@ -0,0 +1,15 @@ +package com.prgrms.dev.springbootboardjpa; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@EnableJpaAuditing +@SpringBootApplication +public class SpringbootBoardJpaApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringbootBoardJpaApplication.class, args); + } + +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/controller/PostController.java b/src/main/java/com/prgrms/dev/springbootboardjpa/controller/PostController.java new file mode 100644 index 000000000..c5e91a987 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/controller/PostController.java @@ -0,0 +1,49 @@ +package com.prgrms.dev.springbootboardjpa.controller; + +import com.prgrms.dev.springbootboardjpa.dto.PostCreateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.PostDto; +import com.prgrms.dev.springbootboardjpa.dto.PostUpdateRequestDto; +import com.prgrms.dev.springbootboardjpa.service.PostService; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/api/v1/posts") +public class PostController { + + private final PostService postService; + + //단건 조회 -> find + @GetMapping("/{id}") + public ResponseEntity findById(@PathVariable Long id) { + PostDto postDto = postService.findById(id); + return ResponseEntity.status(HttpStatus.OK).body(postDto); + } + + //페이지 조회 -> get + @GetMapping + public ResponseEntity> getAll(Pageable pageable) { + Page postDto = postService.getAll(pageable); + return ResponseEntity.status(HttpStatus.OK).body(postDto); + } + + //생성 + @PostMapping + public ResponseEntity create(@RequestBody PostCreateRequestDto postCreateRequestDto) { + PostDto postDto = postService.create(postCreateRequestDto); + return ResponseEntity.status(HttpStatus.OK).body(postDto); + } + + //수정 + @PatchMapping("/{id}") + public ResponseEntity update(@RequestBody PostUpdateRequestDto postUpdateRequestDto, @PathVariable Long id) { + PostDto update = postService.update(postUpdateRequestDto, id); + return ResponseEntity.status(HttpStatus.OK).body(update); + } + +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/converter/Converter.java b/src/main/java/com/prgrms/dev/springbootboardjpa/converter/Converter.java new file mode 100644 index 000000000..0f908ddd2 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/converter/Converter.java @@ -0,0 +1,49 @@ +package com.prgrms.dev.springbootboardjpa.converter; + +import com.prgrms.dev.springbootboardjpa.domain.post.Post; +import com.prgrms.dev.springbootboardjpa.domain.user.User; +import com.prgrms.dev.springbootboardjpa.dto.PostCreateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.PostDto; +import com.prgrms.dev.springbootboardjpa.dto.PostUpdateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.UserDto; +import org.springframework.stereotype.Component; + +@Component +public class Converter { + + // entity -> dto + public PostDto convertPostDto(Post post) { + return PostDto.builder() + .id(post.getId()) + .title(post.getTitle()) + .content(post.getContent()) + .userDto(this.convertUserDto(post.getUser())) + .build(); + } + + // dto -> entity + public Post convertPost(PostUpdateRequestDto postDto) { + return Post.builder() + .title(postDto.title()) + .content(postDto.content()) + .build(); + } + + // dto -> entity + public Post convertPost(PostCreateRequestDto postCreateRequestDto) { + return Post.builder() + .title(postCreateRequestDto.title()) + .content(postCreateRequestDto.content()) + .build(); + } + + // entity -> dto + public UserDto convertUserDto(User user) { + return UserDto.builder() + .id(user.getId()) + .name(user.getName()) + .hobby(user.getHobby()) + .age(user.getAge()) + .build(); + } +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/BaseEntity.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/BaseEntity.java new file mode 100644 index 000000000..78d0e1f65 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/BaseEntity.java @@ -0,0 +1,25 @@ +package com.prgrms.dev.springbootboardjpa.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import lombok.Getter; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@Getter +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +public abstract class BaseEntity { + + @CreatedDate + @Column(name = "create_at") + private LocalDateTime createdAt; + + @LastModifiedDate + @Column(name = "updated_at") + private LocalDateTime updatedAt; +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/Post.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/Post.java new file mode 100644 index 000000000..9d77e3010 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/Post.java @@ -0,0 +1,60 @@ +package com.prgrms.dev.springbootboardjpa.domain.post; + +import com.prgrms.dev.springbootboardjpa.domain.BaseEntity; +import com.prgrms.dev.springbootboardjpa.domain.user.User; +import jakarta.persistence.*; +import lombok.*; + +import java.util.Objects; + +@Getter +@Entity +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@Table(name = "posts") +public class Post extends BaseEntity { + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private Long id; + + @Column(name = "title", length = 50, nullable = false) + private String title; + + @Lob // 사용이 필요한지 + @Column(name = "content", nullable = false) + private String content; + + @ManyToOne(fetch = FetchType.LAZY, cascade = CascadeType.ALL, optional = false) + @JoinColumn(name = "user_id", referencedColumnName = "id") + private User user; + + public void setUser(User user) { + if (Objects.nonNull(this.user)) { + this.user.getPosts().remove(this); + } + + this.user = user; + user.getPosts().add(this); + } + + @Builder + public Post(String title, String content) { + validateNull(title); + validateNull(content); + this.title = title; + this.content = content; + } + + public void update(String title, String content) { + if(validateNull(title) && validateNull(content)) { + throw new IllegalArgumentException("값을 입력 해야 합니다."); + } + if(!validateNull(title)) this.title = title; + if(!validateNull(content)) this.content = content; + } + + private boolean validateNull(String input) { + if(input.isEmpty() || input.isBlank()) return true; + else return false; + } + +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/PostRepository.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/PostRepository.java new file mode 100644 index 000000000..d4c10cbd0 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/post/PostRepository.java @@ -0,0 +1,6 @@ +package com.prgrms.dev.springbootboardjpa.domain.post; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface PostRepository extends JpaRepository { +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/Hobby.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/Hobby.java new file mode 100644 index 000000000..d5f32f0ec --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/Hobby.java @@ -0,0 +1,13 @@ +package com.prgrms.dev.springbootboardjpa.domain.user; + +public enum Hobby { + SPORTS, MOVIE, BOOK; + + public static Hobby getHobby(String hobby) { + try { + return Hobby.valueOf(hobby); + } catch (Exception e) { + throw new IllegalArgumentException("존재하지 않는 Hobby"); + } + } +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/User.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/User.java new file mode 100644 index 000000000..1fe6aa9df --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/User.java @@ -0,0 +1,51 @@ +package com.prgrms.dev.springbootboardjpa.domain.user; + +import com.prgrms.dev.springbootboardjpa.domain.BaseEntity; +import com.prgrms.dev.springbootboardjpa.domain.post.Post; +import jakarta.persistence.*; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Entity +@Table(name = "users") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class User extends BaseEntity { + + @OneToMany(mappedBy = "user", cascade = CascadeType.ALL, orphanRemoval = true) + List posts = new ArrayList<>(); + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private Long id; + @Column(name = "name", length = 20, nullable = false) + private String name; + @Column(name = "hobby", nullable = false) + @Enumerated(EnumType.STRING) + private Hobby hobby; + @Column(name = "age", nullable = false) + private int age; + + @Builder + public User(String name, String hobby, int age) { + validateNull(name); + validateAge(age); + + this.name = name; + this.hobby = Hobby.getHobby(hobby); + this.age = age; + } + + private void validateNull(String input) { + if (input.isEmpty() || input.isBlank()) throw new IllegalArgumentException("값을 입력 해야 합니다."); + } + + private void validateAge(int age) { + if (age <= 0 || age >= 200) throw new IllegalArgumentException("나이는 1~199세 사이의 값 이어야 합니다."); + } + +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/UserRepository.java b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/UserRepository.java new file mode 100644 index 000000000..2e5664859 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/domain/user/UserRepository.java @@ -0,0 +1,6 @@ +package com.prgrms.dev.springbootboardjpa.domain.user; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface UserRepository extends JpaRepository { +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostCreateRequestDto.java b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostCreateRequestDto.java new file mode 100644 index 000000000..6e47bc0bc --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostCreateRequestDto.java @@ -0,0 +1,16 @@ +package com.prgrms.dev.springbootboardjpa.dto; + +import lombok.Builder; + +@Builder +public record PostCreateRequestDto(Long userId, String title, String content) { + + public PostCreateRequestDto { + validateNull(title); + validateNull(content); + } + + private void validateNull(String input) { + if(input.isEmpty() || input.isBlank()) throw new IllegalArgumentException("값을 입력 해야 합니다."); + } +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostDto.java b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostDto.java new file mode 100644 index 000000000..85ce1967a --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostDto.java @@ -0,0 +1,7 @@ +package com.prgrms.dev.springbootboardjpa.dto; + +import lombok.Builder; + +@Builder +public record PostDto(Long id, String title, String content, UserDto userDto) { +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostUpdateRequestDto.java b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostUpdateRequestDto.java new file mode 100644 index 000000000..0b280e4ef --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/PostUpdateRequestDto.java @@ -0,0 +1,7 @@ +package com.prgrms.dev.springbootboardjpa.dto; + +import lombok.Builder; + +@Builder +public record PostUpdateRequestDto(String title, String content) { +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/dto/UserDto.java b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/UserDto.java new file mode 100644 index 000000000..a74c66d05 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/dto/UserDto.java @@ -0,0 +1,8 @@ +package com.prgrms.dev.springbootboardjpa.dto; + +import com.prgrms.dev.springbootboardjpa.domain.user.Hobby; +import lombok.Builder; + +@Builder +public record UserDto(Long id, String name, Hobby hobby, int age) { +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/exception/GlobalExceptionHandler.java b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/GlobalExceptionHandler.java new file mode 100644 index 000000000..855255198 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/GlobalExceptionHandler.java @@ -0,0 +1,29 @@ +package com.prgrms.dev.springbootboardjpa.exception; + +import com.prgrms.dev.springbootboardjpa.controller.PostController; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +@RestControllerAdvice(basePackageClasses = PostController.class) +public class GlobalExceptionHandler { + private static final int BAD_REQUEST = 400; + private static final int NOT_FOUND = 404; + private static final int INTERNAL_SERVER_ERROR = 500; + + @ExceptionHandler(IllegalArgumentException.class) + public ResponseEntity internalServerErrorHandler(IllegalArgumentException e) { + return ResponseEntity.status(BAD_REQUEST).body(e.getMessage()); + } + + @ExceptionHandler({PostNotFoundException.class, UserNotFoundException.class}) + public ResponseEntity NotFoundHandler(RuntimeException e) { + return ResponseEntity.status(NOT_FOUND).body(e.getMessage()); + } + + @ExceptionHandler(Exception.class) + public ResponseEntity internalServerErrorHandler(Exception e) { + return ResponseEntity.status(INTERNAL_SERVER_ERROR).body(e.getMessage()); + } + +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/exception/PostNotFoundException.java b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/PostNotFoundException.java new file mode 100644 index 000000000..0826e3b97 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/PostNotFoundException.java @@ -0,0 +1,7 @@ +package com.prgrms.dev.springbootboardjpa.exception; + +public class PostNotFoundException extends RuntimeException { + public PostNotFoundException() { + super("게시글을 찾을 수 없습니다."); + } +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/exception/UserNotFoundException.java b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/UserNotFoundException.java new file mode 100644 index 000000000..5cde130a4 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/exception/UserNotFoundException.java @@ -0,0 +1,7 @@ +package com.prgrms.dev.springbootboardjpa.exception; + +public class UserNotFoundException extends RuntimeException { + public UserNotFoundException() { + super("회원을 찾을 수 없습니다."); + } +} diff --git a/src/main/java/com/prgrms/dev/springbootboardjpa/service/PostService.java b/src/main/java/com/prgrms/dev/springbootboardjpa/service/PostService.java new file mode 100644 index 000000000..0bd0a2915 --- /dev/null +++ b/src/main/java/com/prgrms/dev/springbootboardjpa/service/PostService.java @@ -0,0 +1,57 @@ +package com.prgrms.dev.springbootboardjpa.service; + +import com.prgrms.dev.springbootboardjpa.converter.Converter; +import com.prgrms.dev.springbootboardjpa.domain.post.Post; +import com.prgrms.dev.springbootboardjpa.domain.post.PostRepository; +import com.prgrms.dev.springbootboardjpa.domain.user.User; +import com.prgrms.dev.springbootboardjpa.domain.user.UserRepository; +import com.prgrms.dev.springbootboardjpa.dto.PostCreateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.PostDto; +import com.prgrms.dev.springbootboardjpa.dto.PostUpdateRequestDto; +import com.prgrms.dev.springbootboardjpa.exception.PostNotFoundException; +import com.prgrms.dev.springbootboardjpa.exception.UserNotFoundException; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +@Service +@RequiredArgsConstructor +public class PostService { + + private final PostRepository postRepository; + private final UserRepository userRepository; + private final Converter converter; + + @Transactional(readOnly = true) + public PostDto findById(Long id) { + return postRepository.findById(id) + .map(converter::convertPostDto) + .orElseThrow(PostNotFoundException::new); + } + + @Transactional(readOnly = true) + public Page getAll(Pageable pageable) { + return postRepository.findAll(pageable) + .map(converter::convertPostDto); + } + + @Transactional + public PostDto create(PostCreateRequestDto postCreateRequestDto) { + Post post = converter.convertPost(postCreateRequestDto); + User user = userRepository.findById(postCreateRequestDto.userId()) + .orElseThrow(UserNotFoundException::new); + post.setUser(user); + return converter.convertPostDto(postRepository.save(post)); + } + + @Transactional + public PostDto update(PostUpdateRequestDto requestDto, Long id) { + Post post = postRepository.findById(id) + .orElseThrow(PostNotFoundException::new); + post.update(requestDto.title(), requestDto.content()); + return converter.convertPostDto(post); + } + +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..05c638663 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,29 @@ +spring: + datasource: + driver-class-name: org.h2.Driver + hikari: + jdbc-url: jdbc:h2:tcp://localhost/./board;DB_CLOSE_ON_EXIT=FALSE + username: sa + password: 1234 + h2: + console: + enabled: true + jpa: + generate-ddl: true + database: h2 + show-sql: true + open-in-view: false + properties: + hibernate: + dialect: org.hibernate.dialect.H2Dialect + query.in_clause_parameter_padding: true + hbm2ddl: + auto: create + format_sql: true +server: + servlet: + encoding: + charset: UTF-8 + enabled: true + force: true + port: 8090 diff --git a/src/test/java/com/prgrms/dev/springbootboardjpa/controller/PostControllerTest.java b/src/test/java/com/prgrms/dev/springbootboardjpa/controller/PostControllerTest.java new file mode 100644 index 000000000..9f4c442a3 --- /dev/null +++ b/src/test/java/com/prgrms/dev/springbootboardjpa/controller/PostControllerTest.java @@ -0,0 +1,217 @@ +package com.prgrms.dev.springbootboardjpa.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.prgrms.dev.springbootboardjpa.domain.post.PostRepository; +import com.prgrms.dev.springbootboardjpa.domain.user.User; +import com.prgrms.dev.springbootboardjpa.domain.user.UserRepository; +import com.prgrms.dev.springbootboardjpa.dto.PostCreateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.PostDto; +import com.prgrms.dev.springbootboardjpa.service.PostService; +import lombok.extern.slf4j.Slf4j; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; +import org.springframework.http.MediaType; +import org.springframework.restdocs.payload.JsonFieldType; +import org.springframework.test.web.servlet.MockMvc; + +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get; +import static org.springframework.restdocs.payload.PayloadDocumentation.*; +import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName; +import static org.springframework.restdocs.request.RequestDocumentation.queryParameters; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@Slf4j +@SpringBootTest +@AutoConfigureMockMvc +@AutoConfigureRestDocs +class PostControllerTest { + @Autowired + private MockMvc mockMvc; + @Autowired + private ObjectMapper objectMapper; + @Autowired + private PostService postService; + @Autowired + private PostRepository postRepository; + @Autowired + private UserRepository userRepository; + + private PostCreateRequestDto postRequestDto; + private PostDto postDto; + private User user; + + @BeforeEach + void setup() { + postRepository.deleteAll(); + + user = User.builder() + .name("박씨") + .age(22) + .hobby("SPORTS").build(); + + userRepository.save(user); + + postRequestDto = PostCreateRequestDto.builder() + .title("테스트") + .content("테스트 콘") + .build(); + + postDto = postService.create(postRequestDto); + } // 분리해보기 + + @Test + void create() throws Exception { + mockMvc.perform(post("/api/v1/posts") + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(postRequestDto)) + .param("userId", String.valueOf(user.getId()))) + .andExpect(status().isOk()) + .andDo(document("post-create", + queryParameters( + parameterWithName("userId").description("userId") + ), + requestFields( + fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("content").type(JsonFieldType.STRING).description("content") + ), + responseFields( + fieldWithPath("statusCode").type(JsonFieldType.NUMBER).description("status code"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("data"), + fieldWithPath("data.id").type(JsonFieldType.NUMBER).description("id"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.userDto").type(JsonFieldType.OBJECT).description("userDto"), + fieldWithPath("data.userDto.id").type(JsonFieldType.NUMBER).description("userDto.id"), + fieldWithPath("data.userDto.name").type(JsonFieldType.STRING).description("userDto.name"), + fieldWithPath("data.userDto.hobby").type(JsonFieldType.STRING).description("userDto.hobby"), + fieldWithPath("data.userDto.age").type(JsonFieldType.NUMBER).description("userDto.age"), + fieldWithPath("responseTime").type(JsonFieldType.STRING).description("response time") + ) + )); + } + + @Test + void update() throws Exception { + PostCreateRequestDto requestDto = PostCreateRequestDto.builder() + .title("수정된 이름") + .content("수정된 콘텐츠") + .build(); + + mockMvc.perform(post("/api/v1/posts/{id}", postDto.id()) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(requestDto))) + .andExpect(status().isOk()) + .andDo(document("post-update", + requestFields( + fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("content").type(JsonFieldType.STRING).description("content") + ), + responseFields( + fieldWithPath("statusCode").type(JsonFieldType.NUMBER).description("status code"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("data"), + fieldWithPath("data.id").type(JsonFieldType.NUMBER).description("id"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.userDto").type(JsonFieldType.OBJECT).description("userDto"), + fieldWithPath("data.userDto.id").type(JsonFieldType.NUMBER).description("userDto.id"), + fieldWithPath("data.userDto.name").type(JsonFieldType.STRING).description("userDto.name"), + fieldWithPath("data.userDto.hobby").type(JsonFieldType.STRING).description("userDto.hobby"), + fieldWithPath("data.userDto.age").type(JsonFieldType.NUMBER).description("userDto.age"), + fieldWithPath("responseTime").type(JsonFieldType.STRING).description("response time") + ) + )); + } + + @Test + void findOne() throws Exception { + PostDto findDto = postService.findById(postDto.id()); + + mockMvc.perform(get("/api/v1/posts/{id}", postDto.id()) + .contentType(MediaType.APPLICATION_JSON) + .content(objectMapper.writeValueAsString(findDto))) + .andExpect(status().isOk()) //-> 테스트 + .andDo(document("post-findOne", + requestFields( + fieldWithPath("id").type(JsonFieldType.NUMBER).description("id"), + fieldWithPath("title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("userDto").type(JsonFieldType.OBJECT).description("userDto"), + fieldWithPath("userDto.id").type(JsonFieldType.NUMBER).description("userDto.id"), + fieldWithPath("userDto.name").type(JsonFieldType.STRING).description("userDto.name"), + fieldWithPath("userDto.hobby").type(JsonFieldType.STRING).description("userDto.hobby"), + fieldWithPath("userDto.age").type(JsonFieldType.NUMBER).description("userDto.age") + ), + responseFields( + fieldWithPath("statusCode").type(JsonFieldType.NUMBER).description("status code"), + fieldWithPath("data").type(JsonFieldType.OBJECT).description("data"), + fieldWithPath("data.id").type(JsonFieldType.NUMBER).description("id"), + fieldWithPath("data.title").type(JsonFieldType.STRING).description("title"), + fieldWithPath("data.content").type(JsonFieldType.STRING).description("content"), + fieldWithPath("data.userDto").type(JsonFieldType.OBJECT).description("userDto"), + fieldWithPath("data.userDto.id").type(JsonFieldType.NUMBER).description("userDto.id"), + fieldWithPath("data.userDto.name").type(JsonFieldType.STRING).description("userDto.name"), + fieldWithPath("data.userDto.hobby").type(JsonFieldType.STRING).description("userDto.hobby"), + fieldWithPath("data.userDto.age").type(JsonFieldType.NUMBER).description("userDto.age"), + fieldWithPath("responseTime").type(JsonFieldType.STRING).description("response time") + ) + )); + } + // 인코딩, 해싱, 암호화 ............. end .. + // 헉... + + // paging -> 수많은 데이터 => + + @Test + void getAll() throws Exception { + PageRequest page = PageRequest.of(0, 10); + Page findDtos = postService.getAll(page); + + mockMvc.perform(get("/api/v1/posts")) + .andExpect(status().isOk()) + .andDo(document("post-getAll", + responseFields( + fieldWithPath("statusCode").type(JsonFieldType.NUMBER).description("상태 코드"), + fieldWithPath("data.content").type(JsonFieldType.ARRAY).description("데이터 목록"), + fieldWithPath("data.content[].id").type(JsonFieldType.NUMBER).description("데이터 ID"), + fieldWithPath("data.content[].title").type(JsonFieldType.STRING).description("데이터 제목"), + fieldWithPath("data.content[].content").type(JsonFieldType.STRING).description("데이터 내용"), + fieldWithPath("data.content[].userDto").type(JsonFieldType.OBJECT).description("데이터의 유저 정보"), + fieldWithPath("data.content[].userDto.id").type(JsonFieldType.NUMBER).description("데이터의 유저 ID"), + fieldWithPath("data.content[].userDto.name").type(JsonFieldType.STRING).description("데이터의 유저 이름"), + fieldWithPath("data.content[].userDto.hobby").type(JsonFieldType.STRING).description("데이터의 유저 취미"), + fieldWithPath("data.content[].userDto.age").type(JsonFieldType.NUMBER).description("데이터의 유저 나이"), + fieldWithPath("data.pageable").type(JsonFieldType.OBJECT).description("페이지 정보"), + fieldWithPath("data.pageable.pageNumber").type(JsonFieldType.NUMBER).description("현재 페이지 번호"), + fieldWithPath("data.pageable.pageSize").type(JsonFieldType.NUMBER).description("페이지 크기"), + fieldWithPath("responseTime").type(JsonFieldType.STRING).description("응답 시간"), + + fieldWithPath("data.pageable.sort").type(JsonFieldType.OBJECT).description("페이지의 정렬 정보").ignored(), + fieldWithPath("data.pageable.sort.empty").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.pageable.sort.sorted").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.pageable.sort.unsorted").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.pageable.offset").type(JsonFieldType.NUMBER).description("새 데이터").ignored(), + fieldWithPath("data.pageable.paged").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.pageable.unpaged").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.sort.empty").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.sort.sorted").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.sort.unsorted").type(JsonFieldType.BOOLEAN).description("새 데이터").ignored(), + fieldWithPath("data.last").type(JsonFieldType.BOOLEAN).description("마지막 페이지 여부").ignored(), + fieldWithPath("data.totalPages").type(JsonFieldType.NUMBER).description("총 페이지 수").ignored(), + fieldWithPath("data.totalElements").type(JsonFieldType.NUMBER).description("총 요소 수").ignored(), + fieldWithPath("data.first").type(JsonFieldType.BOOLEAN).description("첫 번째 페이지 여부").ignored(), + fieldWithPath("data.size").type(JsonFieldType.NUMBER).description("페이지 크기").ignored(), + fieldWithPath("data.number").type(JsonFieldType.NUMBER).description("현재 페이지 번호").ignored(), + fieldWithPath("data.numberOfElements").type(JsonFieldType.NUMBER).description("현재 페이지의 요소 수").ignored(), + fieldWithPath("data.empty").type(JsonFieldType.BOOLEAN).description("데이터가 비어 있는지 여부").ignored() + ) // 필요한 정보만 표현하는 방식을 고민 + )); + } +} diff --git a/src/test/java/com/prgrms/dev/springbootboardjpa/service/PostServiceTest.java b/src/test/java/com/prgrms/dev/springbootboardjpa/service/PostServiceTest.java new file mode 100644 index 000000000..62ddee2cf --- /dev/null +++ b/src/test/java/com/prgrms/dev/springbootboardjpa/service/PostServiceTest.java @@ -0,0 +1,90 @@ +package com.prgrms.dev.springbootboardjpa.service; + +import com.prgrms.dev.springbootboardjpa.domain.post.PostRepository; +import com.prgrms.dev.springbootboardjpa.domain.user.User; +import com.prgrms.dev.springbootboardjpa.domain.user.UserRepository; +import com.prgrms.dev.springbootboardjpa.dto.PostCreateRequestDto; +import com.prgrms.dev.springbootboardjpa.dto.PostDto; +import com.prgrms.dev.springbootboardjpa.dto.PostUpdateRequestDto; +import jakarta.persistence.EntityNotFoundException; +import lombok.extern.slf4j.Slf4j; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assertions.assertThrows; + +@Slf4j +@SpringBootTest // 굳이 모든 bean을 긁어오지 말고 필요한 값들만 가져와보자 +class PostServiceTest { + + // yml 파일 test 분리, db qn + + @Autowired + private PostService postService; + @Autowired + private PostRepository postRepository; + @Autowired + private UserRepository userRepository; + + private PostDto postDto; + private User user; + + @BeforeEach + void setup() { + postRepository.deleteAll(); + + user = User.builder() + .name("박씨") + .age(22) + .hobby("SPORTS").build(); + + userRepository.save(user); + + PostCreateRequestDto postRequestDto = PostCreateRequestDto.builder() + .userId(user.getId()) + .title("테스트") + .content("테스트 콘") + .build(); + + postDto = postService.create(postRequestDto); + } + + @Test + @DisplayName("게시글이 존재하는 경우") + void find_success_test() { + PostDto findDto = postService.findById(postDto.id()); + assertThat(findDto.id()).isEqualTo(postDto.id()); + } + + @Test + @DisplayName("게시글이 존재하지 않는 경우") + void find_fail_test() { + assertThrows(EntityNotFoundException.class, () -> postService.findById(100L)); + } + + @Test + void getAll() { + PageRequest page = PageRequest.of(0, 10); + Page findDtos = postService.getAll(page); + assertThat(findDtos.getTotalElements()).isEqualTo(1L); + } + + // 테스트 대상을 명확하게 구분해보자 , ex update 대상 존재 x + @Test + void update() { + PostUpdateRequestDto requestDto = PostUpdateRequestDto.builder() + .title("수정된 이름") + .content("수정된 콘텐츠") + .build(); + Long id = postDto.id(); + PostDto updatedDto = postService.update(requestDto, id); + assertThat(updatedDto.title()).isEqualTo(requestDto.title()); + assertThat(updatedDto.content()).isEqualTo(requestDto.content()); + } +} diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml new file mode 100644 index 000000000..41e5c1559 --- /dev/null +++ b/src/test/resources/application.yml @@ -0,0 +1,28 @@ +spring: + datasource: + driver-class-name: org.h2.Driver + hikari: + jdbc-url: jdbc:h2:mem:board_test + username: sa + password: 1234 + h2: + console: + enabled: true + jpa: + generate-ddl: true + database: h2 + show-sql: true + open-in-view: false + properties: + hibernate: + dialect: org.hibernate.dialect.H2Dialect + query.in_clause_parameter_padding: true + hbm2ddl: + auto: create + format_sql: true +server: + servlet: + encoding: + charset: UTF-8 + enabled: true + force: true