├── .github └── workflows │ └── azure-spring-cloud.yml ├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── README.md ├── docker-compose.yml ├── mvnw ├── mvnw.cmd ├── pom.xml ├── src ├── main │ ├── java │ │ └── dev │ │ │ └── danvega │ │ │ └── blog │ │ │ ├── Application.java │ │ │ ├── controller │ │ │ └── PostController.java │ │ │ ├── model │ │ │ ├── Author.java │ │ │ ├── Comment.java │ │ │ ├── Post.java │ │ │ ├── dto │ │ │ │ └── PostDetails.java │ │ │ └── json │ │ │ │ └── AuthorDeserializer.java │ │ │ └── repository │ │ │ ├── AuthorRepository.java │ │ │ └── PostRepository.java │ └── resources │ │ ├── application-dev.yml │ │ ├── application-prod.yml │ │ ├── application-test.yml │ │ ├── application.yml │ │ └── schema.sql └── test │ ├── java │ └── dev │ │ └── danvega │ │ └── blog │ │ ├── TestDataLoader.java │ │ ├── controller │ │ └── PostControllerTest.java │ │ └── repository │ │ ├── AuthorRepositoryTest.java │ │ └── PostRepositoryTest.java │ └── resources │ └── logback.xml └── system.properties /.github/workflows/azure-spring-cloud.yml: -------------------------------------------------------------------------------- 1 | name: AzureSpringCloud 2 | on: push 3 | env: 4 | ASC_PACKAGE_PATH: ${{ github.workspace }} 5 | JAVA_VERSION: 17 6 | AZURE_SUBSCRIPTION: c70085e6-c3ce-4d50-b40c-d03cb762d680 7 | 8 | jobs: 9 | deploy_to_production: 10 | runs-on: ubuntu-latest 11 | name: deploy to production with artifact 12 | steps: 13 | - name: Checkout Github Action 14 | uses: actions/checkout@v2 15 | 16 | - name: Set up JDK ${{ env.JAVA_VERSION }} 17 | uses: actions/setup-java@v1 18 | with: 19 | java-version: ${{ env.JAVA_VERSION }} 20 | 21 | - name: maven build, clean 22 | run: | 23 | mvn clean package -DskipTests 24 | 25 | - name: Login via Azure CLI 26 | uses: azure/login@v1 27 | with: 28 | creds: ${{ secrets.AZURE_CREDENTIALS }} 29 | 30 | - name: deploy to production with artifact 31 | uses: azure/spring-cloud-deploy@v1 32 | with: 33 | azure-subscription: ${{ env.AZURE_SUBSCRIPTION }} 34 | action: Deploy 35 | service-name: spring-blog 36 | app-name: spring-blog 37 | use-staging-deployment: false 38 | package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/danvega/spring-blog/de1c1f25644af6692b0615ecffb4dd1f0b5e8e92/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Blog 2 | 3 | This is a sample blog application that I created to use as an example of how to take a Spring Boot application to production. 4 | It's not enough to understand how to create applications, you need to understand how to take them to production. This document 5 | will walk you through what this application is, how to run it and how to execute the tests associated with it. 6 | 7 | ## About the Application 8 | 9 | This is a simple web application that exposes a REST API. This application uses Maven as the build tool and the current 10 | LTS version of Java, 17. I hope to add more functionality to this application in the future but 11 | for now this project uses the following dependencies: 12 | 13 | - Spring Web 14 | - Spring Data JDBC 15 | - PostgreSQL Database 16 | - Spring Actuator 17 | - Testcontainers 18 | 19 | ## Running the application 20 | 21 | You can run this application from your favorite IDE or by running the following command: 22 | 23 | ```bash 24 | ./mvnw spring-boot:run 25 | ``` 26 | 27 | ## Testing the application 28 | 29 | This application uses Junit 5 and [Tescontainers](https://www.testcontainers.org/). To run the tests you will need Docker 30 | desktop installed and running. You need Docker to execute the tests because this application uses Testcontainers to spin 31 | up PostgreSQL database. This allows us to test as close to production as possible on our development machines as well as 32 | a clean and reproducible testing environment each time. 33 | 34 | ## Building for Production 35 | 36 | If you want to build an artifact that can be used in production you have 2 options. This application uses `JAR` as the 37 | packaging type. This means that you can run the following command to create something that is ready to be used in production. 38 | 39 | ```bash 40 | ./mvnw clean package 41 | ``` 42 | 43 | If you would like to create a Docker Image which can be used on a variety of platforms you can run the following command: 44 | 45 | ```bash 46 | ./mvnw spring-boot:build-image 47 | ``` 48 | 49 | ## Spring to Production 50 | 51 | This is a collection of the different platforms that I have pushed this application to. I will also include any information 52 | that might help you out and any related tutorials I have created for that platform. The idea for this project came from an 53 | episode of [Spring Office Hours](https://tanzu.vmware.com/developer/tv/spring-office-hours/0015/) in which DaShaun and I 54 | discussed some different options for taking your Spring Boot application to production. 55 | 56 | ![Spring Office Hours: Episode 15 - Spring to Production](https://tanzu.vmware.com/developer/tv/spring-office-hours/0015/images/0015.png) 57 | 58 | ### Local Development 59 | 60 | When working on this application locally you will need Docker Desktop installed. To start an instance of PostgreSQL run the Docker 61 | Compose file located in the root of the project. 62 | 63 | ### Azure Spring Apps 64 | 65 | Azure Spring Apps is a platform as a service (PaaS) for Spring developers. Manage the lifecycle of your Spring Boot applications with 66 | comprehensive monitoring and diagnostics, configuration management, service discovery, CI/CD integration, and blue-green deployments. 67 | 68 | [https://azure.microsoft.com/en-us/products/spring-apps](https://azure.microsoft.com/en-us/products/spring-apps) 69 | 70 | #### GitHub Actions 71 | 72 | You could create a new artifact each time and deploy it to Azure Spring Apps using the Azure CLI. This can be tedious though and if you want to deploy a new version of your application each time a commit is made or merged into the master branch you can use GitHub actions. The following is a workflow that I am currently using to do that. 73 | 74 | ```yaml 75 | name: AzureSpringCloud 76 | on: push 77 | env: 78 | ASC_PACKAGE_PATH: ${{ github.workspace }} 79 | JAVA_VERSION: 17 80 | AZURE_SUBSCRIPTION: YOUR_SUBSCRIPTION_ID_HERE 81 | 82 | jobs: 83 | deploy_to_production: 84 | runs-on: ubuntu-latest 85 | name: deploy to production with artifact 86 | steps: 87 | - name: Checkout Github Action 88 | uses: actions/checkout@v2 89 | 90 | - name: Set up JDK ${{ env.JAVA_VERSION }} 91 | uses: actions/setup-java@v1 92 | with: 93 | java-version: ${{ env.JAVA_VERSION }} 94 | 95 | - name: maven build, clean 96 | run: | 97 | mvn clean package -DskipTests 98 | 99 | - name: Login via Azure CLI 100 | uses: azure/login@v1 101 | with: 102 | creds: ${{ secrets.AZURE_CREDENTIALS }} 103 | 104 | - name: deploy to production with artifact 105 | uses: azure/spring-cloud-deploy@v1 106 | with: 107 | azure-subscription: ${{ env.AZURE_SUBSCRIPTION }} 108 | action: Deploy 109 | service-name: spring-blog 110 | app-name: spring-blog 111 | use-staging-deployment: false 112 | package: ${{ env.ASC_PACKAGE_PATH }}/**/*.jar 113 | ``` 114 | 115 | ### Railway 116 | 117 | Bring your code, we'll handle the rest. Made for any language, for projects big and small. [Railway](https://railway.app/) 118 | is the cloud that takes the complexity out of shipping software. 119 | 120 | Create a new empty project in Railway and start by creating a PostgreSQL database. Once you have that created you can create 121 | a new project from GitHub. You can use the following environment variables based on the database you just created. 122 | 123 | ```properties 124 | spring_profiles_active=prod 125 | PROD_DB_HOST=HOST_HERE 126 | PROD_DB_PORT=POST_HERE 127 | PROD_DB_NAME=railway 128 | PROD_DB_PASSWORD=PASSWORD_HERE 129 | PROD_DB_USERNAME=postgres 130 | ``` 131 | 132 | You don't need GitHub Actions or any type of pipeline for this setup because Railway handles this for you. Simply push your code to GitHub 133 | and a new build and deploy will be triggered. If you want to disable this functionality you can from the settings of your project 134 | on Railway. 135 | 136 | ### Coming Soon 137 | 138 | - [https://www.heroku.com](https://www.heroku.com/) 139 | - [https://render.com](https://render.com/) 140 | - [https://fly.io](https://fly.io/) 141 | - [https://porter.run](https://porter.run/) 142 | - [https://www.cloudfoundry.org/](https://www.cloudfoundry.org/) 143 | - [https://www.digitalocean.com](https://www.digitalocean.com/) 144 | - [https://aws.amazon.com](https://aws.amazon.com/) 145 | - [https://cloud.google.com](https://cloud.google.com/) 146 | - [OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift) 147 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.8' 2 | 3 | services: 4 | db: 5 | image: postgres:alpine 6 | ports: 7 | - "5432:5432" 8 | environment: 9 | POSTGRES_PASSWORD: password 10 | POSTGRES_DB: blog -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 2.7.4 9 | 10 | 11 | dev.danvega 12 | spring-blog 13 | 0.0.1-SNAPSHOT 14 | spring-blog 15 | Sample Blog Project used for hosting demos 16 | 17 | 17 18 | 1.17.4 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-web 24 | 25 | 26 | org.springframework.boot 27 | spring-boot-starter-data-jdbc 28 | 29 | 30 | org.springframework.boot 31 | spring-boot-starter-actuator 32 | 33 | 34 | org.postgresql 35 | postgresql 36 | runtime 37 | 38 | 39 | org.springframework.boot 40 | spring-boot-starter-test 41 | test 42 | 43 | 44 | org.testcontainers 45 | junit-jupiter 46 | test 47 | 48 | 49 | org.testcontainers 50 | postgresql 51 | test 52 | 53 | 54 | 55 | 56 | 57 | 58 | org.testcontainers 59 | testcontainers-bom 60 | ${testcontainers.version} 61 | pom 62 | import 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | org.springframework.boot 71 | spring-boot-maven-plugin 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/Application.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import dev.danvega.blog.model.Comment; 5 | import dev.danvega.blog.model.Post; 6 | import dev.danvega.blog.repository.AuthorRepository; 7 | import dev.danvega.blog.repository.PostRepository; 8 | import org.springframework.boot.CommandLineRunner; 9 | import org.springframework.boot.SpringApplication; 10 | import org.springframework.boot.autoconfigure.SpringBootApplication; 11 | import org.springframework.context.annotation.Bean; 12 | import org.springframework.context.annotation.Profile; 13 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 14 | 15 | @SpringBootApplication 16 | public class Application { 17 | 18 | public static void main(String[] args) { 19 | SpringApplication.run(Application.class, args); 20 | } 21 | 22 | @Profile({"dev","prod"}) 23 | @Bean 24 | CommandLineRunner run(PostRepository postRepository, AuthorRepository authorRepository) { 25 | return args -> { 26 | AggregateReference author = AggregateReference.to(authorRepository.save(new Author(null, "Dan", "Vega", "danvega@gmail.com", "dvega")).id()); 27 | 28 | Post post = new Post( "Dan's First Post", "This is Dan's First Post",author); 29 | post.addComment(new Comment( "Dan", "This is a comment")); 30 | post.addComment(new Comment( "John", "This is another comment")); 31 | postRepository.save(post); 32 | }; 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/controller/PostController.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.controller; 2 | 3 | import dev.danvega.blog.model.Post; 4 | import dev.danvega.blog.model.dto.PostDetails; 5 | import dev.danvega.blog.repository.AuthorRepository; 6 | import dev.danvega.blog.repository.PostRepository; 7 | import org.slf4j.Logger; 8 | import org.slf4j.LoggerFactory; 9 | import org.springframework.web.bind.annotation.GetMapping; 10 | import org.springframework.web.bind.annotation.PathVariable; 11 | import org.springframework.web.bind.annotation.RequestMapping; 12 | import org.springframework.web.bind.annotation.RestController; 13 | 14 | @RestController 15 | @RequestMapping("/api/posts") 16 | public class PostController { 17 | 18 | private static final Logger LOG = LoggerFactory.getLogger(PostController.class); 19 | 20 | private final PostRepository posts; 21 | private final AuthorRepository authors; 22 | 23 | public PostController(PostRepository postRepository, AuthorRepository authorRepository) { 24 | this.posts = postRepository; 25 | this.authors = authorRepository; 26 | } 27 | 28 | @GetMapping 29 | public Iterable findAll() { 30 | return posts.findAll(); 31 | } 32 | 33 | @GetMapping("/{id}") 34 | public Post findById(@PathVariable("id") Post post) { 35 | return post; 36 | } 37 | 38 | @GetMapping("/{id}/details") 39 | public PostDetails getPostDetails(@PathVariable("id") Post post) { 40 | LOG.info("Post Details called for: " + post.getId()); 41 | return new PostDetails(post,authors.findById(post.getAuthor().getId()).get()); 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/model/Author.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.model; 2 | 3 | import com.fasterxml.jackson.annotation.JsonIgnore; 4 | import org.springframework.data.annotation.Id; 5 | 6 | public record Author( 7 | @Id @JsonIgnore Integer id, 8 | String firstName, 9 | String lastName, 10 | String email, 11 | String username 12 | ) { 13 | } -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/model/Comment.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.model; 2 | 3 | import com.fasterxml.jackson.annotation.JsonCreator; 4 | import org.springframework.data.annotation.PersistenceCreator; 5 | import org.springframework.data.annotation.Transient; 6 | 7 | import java.time.LocalDateTime; 8 | 9 | public final class Comment { 10 | 11 | private String name; 12 | private String content; 13 | private LocalDateTime publishedOn; 14 | private LocalDateTime updatedOn; 15 | @Transient 16 | Post post; 17 | 18 | public Comment(String name, String content) { 19 | this.name = name; 20 | this.content = content; 21 | this.publishedOn = LocalDateTime.now(); 22 | } 23 | 24 | @PersistenceCreator 25 | @JsonCreator 26 | public Comment(String name, String content, LocalDateTime publishedOn, LocalDateTime updatedOn) { 27 | this.name = name; 28 | this.content = content; 29 | this.publishedOn = publishedOn; 30 | this.updatedOn = updatedOn; 31 | } 32 | 33 | public String getName() { 34 | return name; 35 | } 36 | 37 | public void setName(String name) { 38 | this.name = name; 39 | } 40 | 41 | public String getContent() { 42 | return content; 43 | } 44 | 45 | public void setContent(String content) { 46 | this.content = content; 47 | } 48 | 49 | public LocalDateTime getPublishedOn() { 50 | return publishedOn; 51 | } 52 | 53 | public void setPublishedOn(LocalDateTime publishedOn) { 54 | this.publishedOn = publishedOn; 55 | } 56 | 57 | public LocalDateTime getUpdatedOn() { 58 | return updatedOn; 59 | } 60 | 61 | public void setUpdatedOn(LocalDateTime updatedOn) { 62 | this.updatedOn = updatedOn; 63 | } 64 | 65 | @Override 66 | public String toString() { 67 | return "Comment{" + 68 | "name='" + name + '\'' + 69 | ", content='" + content + '\'' + 70 | ", publishedOn=" + publishedOn + 71 | ", updatedOn=" + updatedOn + 72 | '}'; 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/model/Post.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.model; 2 | 3 | import com.fasterxml.jackson.annotation.JsonCreator; 4 | import com.fasterxml.jackson.annotation.JsonIgnore; 5 | import com.fasterxml.jackson.databind.annotation.JsonDeserialize; 6 | import dev.danvega.blog.model.json.AuthorDeserializer; 7 | import org.springframework.data.annotation.Id; 8 | import org.springframework.data.annotation.PersistenceCreator; 9 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 10 | 11 | import java.time.LocalDateTime; 12 | import java.util.Collection; 13 | import java.util.HashSet; 14 | import java.util.List; 15 | import java.util.Set; 16 | 17 | public final class Post { 18 | @Id @JsonIgnore 19 | private Integer id; 20 | private String title; 21 | private String content; 22 | private LocalDateTime publishedOn; 23 | private LocalDateTime updatedOn; 24 | private final Set comments = new HashSet<>(); 25 | private AggregateReference author; 26 | 27 | public Post(String title,String content, AggregateReference author) { 28 | this.title = title; 29 | this.content = content; 30 | this.author = author; 31 | this.publishedOn = LocalDateTime.now(); 32 | } 33 | 34 | @PersistenceCreator 35 | @JsonCreator 36 | public Post(String title, String content, LocalDateTime publishedOn, LocalDateTime updatedOn, AggregateReference author, Set comments) { 37 | this.title = title; 38 | this.content = content; 39 | this.publishedOn = publishedOn; 40 | this.updatedOn = updatedOn; 41 | this.author = author; 42 | comments.forEach(this::addComment); 43 | } 44 | 45 | public Integer getId() { 46 | return id; 47 | } 48 | 49 | public void setId(Integer id) { 50 | this.id = id; 51 | } 52 | 53 | public String getTitle() { 54 | return title; 55 | } 56 | 57 | public void setTitle(String title) { 58 | this.title = title; 59 | } 60 | 61 | public String getContent() { 62 | return content; 63 | } 64 | 65 | public void setContent(String content) { 66 | this.content = content; 67 | } 68 | 69 | public LocalDateTime getPublishedOn() { 70 | return publishedOn; 71 | } 72 | 73 | public void setPublishedOn(LocalDateTime publishedOn) { 74 | this.publishedOn = publishedOn; 75 | } 76 | 77 | public LocalDateTime getUpdatedOn() { 78 | return updatedOn; 79 | } 80 | 81 | public void setUpdatedOn(LocalDateTime updatedOn) { 82 | this.updatedOn = updatedOn; 83 | } 84 | 85 | public void addComments(List comments) { 86 | comments.forEach(this::addComment); 87 | } 88 | 89 | public void addComment(Comment comment) { 90 | comments.add(comment); 91 | comment.post = this; 92 | } 93 | 94 | public Set getComments() { 95 | return comments; 96 | } 97 | 98 | public AggregateReference getAuthor() { 99 | return author; 100 | } 101 | 102 | public void setAuthor(AggregateReference author) { 103 | this.author = author; 104 | } 105 | 106 | @Override 107 | public String toString() { 108 | return "Post{" + 109 | "id=" + id + 110 | ", title='" + title + '\'' + 111 | ", content='" + content + '\'' + 112 | ", publishedOn=" + publishedOn + 113 | ", updatedOn=" + updatedOn + 114 | '}'; 115 | } 116 | } -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/model/dto/PostDetails.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.model.dto; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import dev.danvega.blog.model.Post; 5 | 6 | public record PostDetails(Post post, Author author) { } 7 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/model/json/AuthorDeserializer.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.model.json; 2 | 3 | import com.fasterxml.jackson.core.JacksonException; 4 | import com.fasterxml.jackson.core.JsonParser; 5 | import com.fasterxml.jackson.core.TreeNode; 6 | import com.fasterxml.jackson.databind.DeserializationContext; 7 | import com.fasterxml.jackson.databind.JsonDeserializer; 8 | import dev.danvega.blog.model.Author; 9 | import org.springframework.boot.jackson.JsonComponent; 10 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 11 | 12 | import java.io.IOException; 13 | 14 | @JsonComponent 15 | public class AuthorDeserializer extends JsonDeserializer> { 16 | 17 | @Override 18 | public AggregateReference deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JacksonException { 19 | TreeNode treeNode = jsonParser.getCodec().readTree(jsonParser); 20 | return AggregateReference.to(Integer.parseInt( treeNode.get("id").toString() )); 21 | } 22 | 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/repository/AuthorRepository.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.repository; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import org.springframework.data.repository.CrudRepository; 5 | 6 | public interface AuthorRepository extends CrudRepository { 7 | Author findByUsername(String username); 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/dev/danvega/blog/repository/PostRepository.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.repository; 2 | 3 | import dev.danvega.blog.model.Post; 4 | import org.springframework.data.jdbc.repository.query.Query; 5 | import org.springframework.data.repository.CrudRepository; 6 | 7 | import java.util.List; 8 | 9 | public interface PostRepository extends CrudRepository { 10 | 11 | @Query("SELECT * FROM POST WHERE author = :id") 12 | List findByAuthor(Integer id); 13 | 14 | } 15 | -------------------------------------------------------------------------------- /src/main/resources/application-dev.yml: -------------------------------------------------------------------------------- 1 | spring: 2 | datasource: 3 | url: jdbc:postgresql://localhost:5432/blog 4 | username: postgres 5 | password: password 6 | 7 | sql: 8 | init: 9 | mode: always -------------------------------------------------------------------------------- /src/main/resources/application-prod.yml: -------------------------------------------------------------------------------- 1 | spring: 2 | datasource: 3 | url: jdbc:postgresql://${PROD_DB_HOST}:${PROD_DB_PORT}/${PROD_DB_NAME} 4 | username: ${PROD_DB_USERNAME} 5 | password: ${PROD_DB_PASSWORD} 6 | name: spring-blog 7 | 8 | sql: 9 | init: 10 | mode: always # you won't do this in prod, I'm just doing this for demo purposes -------------------------------------------------------------------------------- /src/main/resources/application-test.yml: -------------------------------------------------------------------------------- 1 | spring: 2 | datasource: 3 | url: jdbc:tc:postgresql:14-alpine:///spring-blog 4 | sql: 5 | init: 6 | mode: always -------------------------------------------------------------------------------- /src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | 2 | management: 3 | endpoints: 4 | web: 5 | exposure: 6 | include: '*' 7 | info: 8 | env: 9 | enabled: true 10 | 11 | info: 12 | application: 13 | name: spring-blog 14 | description: A blog with articles about The Spring Framework. 15 | author: Dan Vega 16 | version: '@project.version@' 17 | spring: 18 | profiles: 19 | active: dev -------------------------------------------------------------------------------- /src/main/resources/schema.sql: -------------------------------------------------------------------------------- 1 | -- author 2 | create table IF NOT EXISTS Author( 3 | id serial primary key, 4 | first_name varchar(100) not null, 5 | last_name varchar(100) not null, 6 | email varchar(255) not null, 7 | username varchar(100) not null 8 | ); 9 | 10 | -- post 11 | create table IF NOT EXISTS Post ( 12 | id serial primary key , 13 | version int, 14 | title varchar(255) not null, 15 | content text not null, 16 | published_on timestamp not null, 17 | updated_on timestamp, 18 | author int, 19 | foreign key (author) references Author(id) 20 | ); 21 | 22 | -- comment 23 | create table IF NOT EXISTS Comment( 24 | post int not null, 25 | name varchar(100) not null, 26 | content text not null, 27 | published_on timestamp not null, 28 | updated_on timestamp, 29 | foreign key (post) references Post(id) 30 | ); -------------------------------------------------------------------------------- /src/test/java/dev/danvega/blog/TestDataLoader.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import dev.danvega.blog.model.Comment; 5 | import dev.danvega.blog.model.Post; 6 | import dev.danvega.blog.repository.AuthorRepository; 7 | import dev.danvega.blog.repository.PostRepository; 8 | import org.springframework.boot.CommandLineRunner; 9 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 10 | import org.springframework.stereotype.Component; 11 | import org.springframework.test.context.ActiveProfiles; 12 | 13 | @Component 14 | @ActiveProfiles("test") 15 | public class TestDataLoader implements CommandLineRunner { 16 | 17 | private final AuthorRepository authors; 18 | private final PostRepository posts; 19 | 20 | public TestDataLoader(AuthorRepository authors, PostRepository posts) { 21 | this.authors = authors; 22 | this.posts = posts; 23 | } 24 | 25 | @Override 26 | public void run(String... args) throws Exception { 27 | AggregateReference author = AggregateReference.to(authors.save(new Author(null, "Dan", "Vega", "danvega@gmail.com", "dvega")).id()); 28 | Post post = new Post("Hello, World!","Welcome to my Spring Blog", author); 29 | post.addComment(new Comment( "Dan", "This is a comment")); 30 | post.addComment(new Comment( "John", "This is another comment")); 31 | posts.save(post); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/test/java/dev/danvega/blog/controller/PostControllerTest.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.controller; 2 | 3 | import dev.danvega.blog.model.Post; 4 | import org.junit.jupiter.api.Test; 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.boot.test.context.SpringBootTest; 7 | import org.springframework.boot.test.web.client.TestRestTemplate; 8 | import org.springframework.core.ParameterizedTypeReference; 9 | import org.springframework.http.HttpMethod; 10 | import org.springframework.http.HttpStatus; 11 | import org.springframework.http.ResponseEntity; 12 | import org.springframework.test.context.ActiveProfiles; 13 | 14 | import java.util.List; 15 | 16 | import static org.junit.jupiter.api.Assertions.*; 17 | 18 | @ActiveProfiles("test") 19 | @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) 20 | class PostControllerTest { 21 | 22 | @Autowired 23 | TestRestTemplate restTemplate; 24 | 25 | @Test 26 | void shouldFindAllPosts() { 27 | ResponseEntity> exchange = restTemplate.exchange("/api/posts", HttpMethod.GET, null, new ParameterizedTypeReference>() {}); 28 | assertNotNull(exchange); 29 | List posts = exchange.getBody(); 30 | assertEquals(1,posts.size()); 31 | assertEquals( 1,posts.get(0).getAuthor().getId()); 32 | assertEquals(2,posts.get(0).getComments().size()); 33 | } 34 | 35 | @Test 36 | void shouldFindOneValidPost() { 37 | ResponseEntity entity = restTemplate.getForEntity("/api/posts/1", Post.class); 38 | assertEquals(HttpStatus.OK,entity.getStatusCode()); 39 | Post post = entity.getBody(); 40 | assertEquals("Hello, World!",post.getTitle()); 41 | } 42 | 43 | } -------------------------------------------------------------------------------- /src/test/java/dev/danvega/blog/repository/AuthorRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.repository; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import org.junit.jupiter.api.BeforeEach; 5 | import org.junit.jupiter.api.Test; 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.boot.test.context.SpringBootTest; 8 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 9 | import org.springframework.test.context.ActiveProfiles; 10 | 11 | import java.util.stream.StreamSupport; 12 | 13 | import static org.junit.jupiter.api.Assertions.assertEquals; 14 | 15 | @SpringBootTest 16 | @ActiveProfiles("test") 17 | class AuthorRepositoryTest { 18 | 19 | @Autowired 20 | AuthorRepository authors; 21 | 22 | @Test 23 | void shouldReturnAllAuthors() { 24 | long count = StreamSupport.stream(authors.findAll().spliterator(), false).count(); 25 | assertEquals(1, count); 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/test/java/dev/danvega/blog/repository/PostRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package dev.danvega.blog.repository; 2 | 3 | import dev.danvega.blog.model.Author; 4 | import dev.danvega.blog.model.Comment; 5 | import dev.danvega.blog.model.Post; 6 | import org.junit.jupiter.api.BeforeEach; 7 | import org.junit.jupiter.api.Test; 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.boot.test.context.SpringBootTest; 10 | import org.springframework.data.jdbc.core.mapping.AggregateReference; 11 | import org.springframework.test.context.ActiveProfiles; 12 | 13 | import java.util.List; 14 | 15 | import static org.junit.jupiter.api.Assertions.*; 16 | 17 | @SpringBootTest 18 | @ActiveProfiles("test") 19 | class PostRepositoryTest { 20 | 21 | @Autowired 22 | PostRepository posts; 23 | 24 | @Autowired 25 | AuthorRepository authors; 26 | 27 | AggregateReference author; 28 | 29 | @BeforeEach 30 | void setUp() { 31 | author = AggregateReference.to(authors.save(new Author(null, "Dan", "Vega", "danvega@gmail.com", "dvega")).id()); 32 | } 33 | 34 | @Test 35 | void shouldSaveValidPost() { 36 | Post post = new Post( "TEST", "...",author); 37 | assertNull(post.getId()); 38 | Post reloaded = posts.save(post); 39 | assertNotNull(reloaded.getId()); 40 | } 41 | 42 | @Test 43 | void shouldSaveValidPostWithoutAuthor() { 44 | Post post = new Post( "TEST", "...",null); 45 | assertNull(post.getId()); 46 | Post reloaded = posts.save(post); 47 | assertNotNull(reloaded.getId()); 48 | assertNull(reloaded.getAuthor()); 49 | } 50 | 51 | @Test 52 | void shouldPostWithComments() { 53 | Post post = new Post( "TEST", "...",null); 54 | post.addComments(List.of(new Comment("Dan","test comment"),new Comment("Dan","test comment 2"))); 55 | posts.save(post); 56 | 57 | Post p = posts.findById(post.getId()).orElse(null); 58 | assertNotNull(p); 59 | assertNotNull(p.getId()); 60 | assertEquals(2,p.getComments().size()); 61 | assertEquals("Dan",p.getComments().iterator().next().getName()); 62 | } 63 | 64 | @Test 65 | void shouldPostWithNoCommentsReturns0AndNotNull() { 66 | Post post = new Post( "TEST", "...",null); 67 | posts.save(post); 68 | Post p = posts.findById(post.getId()).orElse(null); 69 | assertNotNull(p); 70 | assertEquals(0,p.getComments().size()); 71 | } 72 | 73 | } -------------------------------------------------------------------------------- /src/test/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /system.properties: -------------------------------------------------------------------------------- 1 | java.runtime.version=17 --------------------------------------------------------------------------------