diff --git a/play-scala-rest-api-example/.gitattributes b/play-scala-rest-api-example/.gitattributes new file mode 100644 index 000000000..097f9f98d --- /dev/null +++ b/play-scala-rest-api-example/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/play-scala-rest-api-example/.gitignore b/play-scala-rest-api-example/.gitignore new file mode 100644 index 000000000..1b6985c00 --- /dev/null +++ b/play-scala-rest-api-example/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/play-scala-rest-api-example/README.md b/play-scala-rest-api-example/README.md index f90750ac6..8d30cdd7c 100644 --- a/play-scala-rest-api-example/README.md +++ b/play-scala-rest-api-example/README.md @@ -6,6 +6,8 @@ This is the example project for making a REST API in Play. ### Running +#### Running (Sbt) + You need to download and install sbt for this application to run. Once you have sbt installed, the following at the command prompt will start up Play in development mode: @@ -14,6 +16,16 @@ Once you have sbt installed, the following at the command prompt will start up P sbt run ``` +#### Running (Gradle) + +The following at the command prompt will start up Play in development mode: + +```bash +./gradlew playRun +``` + +#### Hot-reload + Play will start up on the HTTP port at . You don't need to deploy or reload anything -- changing any source code while the server is running will automatically recompile and hot-reload the application on the next HTTP request. ### Usage @@ -46,6 +58,8 @@ POST /v1/posts HTTP/1.1 The best way to see what Play can do is to run a load test. We've included Gatling in this test project for integrated load testing. +#### Play in production mode (Sbt) + Start Play in production mode, by [staging the application](https://www.playframework.com/documentation/latest/Deploying) and running the play scripts: ```bash @@ -54,6 +68,18 @@ cd target/universal/stage ./bin/play-scala-rest-api-example -Dplay.http.secret.key=some-long-key-that-will-be-used-by-your-application ``` +### Play in production mode (Gradle) + +Start Play in production mode, by [building a distribution](https://docs.gradle.org/current/userguide/application_plugin.html#sec:the_distribution) and running the next script + +```bash +./gradlew installDist +cd build/install/play-scala-rest-api-example +JAVA_OPTS="-Dplay.http.secret.key=some-long-key-that-will-be-used-by-your-application" ./bin/play-scala-rest-api-example +``` + +#### Gatling + Then you'll start the Gatling load test up (it's already integrated into the project): ```bash @@ -65,7 +91,7 @@ For best results, start the gatling load test up on another machine so you do no Once the test completes, you'll see an HTML file containing the load test chart: ```bash -./play-scala-rest-api-example/target/gatling/gatlingspec-1472579540405/index.html +./play-scala-rest-api-example/gatling/target/gatling/gatlingspec-1472579540405/index.html ``` That will contain your load test results. diff --git a/play-scala-rest-api-example/build.gradle b/play-scala-rest-api-example/build.gradle new file mode 100644 index 000000000..1b9f8e981 --- /dev/null +++ b/play-scala-rest-api-example/build.gradle @@ -0,0 +1,48 @@ +import play.gradle.Language +import play.gradle.plugin.PlayPlugin + +plugins { + alias(libs.plugins.twirl) + alias(libs.plugins.play) +} + +play { + lang = Language.SCALA +} + +def scalaVersion = System.getProperty('scala.version', PlayPlugin.DEFAULT_SCALA_VERSION).replaceAll('\\D*$', '') + +dependencies { + implementation platform("org.playframework:play-bom_${scalaVersion}:${libs.versions.play.get()}") + + implementation "org.playframework:play-pekko-http-server_${scalaVersion}" + implementation "org.playframework:play-guice_${scalaVersion}" + implementation "org.playframework:play-logback_${scalaVersion}" + implementation "net.codingwell:scala-guice_${scalaVersion}:${libs.versions.scala.guice.get()}" + implementation "io.lemonlabs:scala-uri_${scalaVersion}:${libs.versions.scala.uri.get()}" + implementation libs.logstash.logback.encoder + + testImplementation "org.playframework:play-test_${scalaVersion}" + testImplementation "org.playframework:play-filters-helpers_${scalaVersion}" + testImplementation "org.scalatestplus.play:scalatestplus-play_${scalaVersion}:${libs.versions.scalatestplus.play.get()}" + testImplementation libs.scalatest.junit.runner +} + +run { + systemProperties System.properties +} + +test { + useJUnitPlatform { + includeEngines 'scalatest' + } +} + +// TODO: Remove after release Play Gradle Plugin +repositories { + mavenCentral() + maven { + url = uri("https://oss.sonatype.org/content/repositories/snapshots") + } + mavenLocal() +} diff --git a/play-scala-rest-api-example/build.sbt b/play-scala-rest-api-example/build.sbt index 41d67245b..ee9e8f713 100644 --- a/play-scala-rest-api-example/build.sbt +++ b/play-scala-rest-api-example/build.sbt @@ -12,7 +12,6 @@ lazy val root = (project in file(".")) crossScalaVersions := Seq(scala213, scala3), libraryDependencies ++= Seq( guice, - "org.joda" % "joda-convert" % "2.2.3", "net.logstash.logback" % "logstash-logback-encoder" % "7.3", "io.lemonlabs" %% "scala-uri" % "4.0.3", "net.codingwell" %% "scala-guice" % "6.0.0", diff --git a/play-scala-rest-api-example/gradle/libs.versions.toml b/play-scala-rest-api-example/gradle/libs.versions.toml new file mode 100644 index 000000000..d827eabcb --- /dev/null +++ b/play-scala-rest-api-example/gradle/libs.versions.toml @@ -0,0 +1,17 @@ +[versions] +twirl = "2.0.3" +play = "3.0.1-03969c1e-SNAPSHOT" +scala-guice = "6.0.0" +scala-uri = "4.0.3" +scalatestplus-play = "7.0.0" + +[libraries] +logstash-logback-encoder = { group = "net.logstash.logback", name = "logstash-logback-encoder", version = "7.3" } +scalatest-junit-runner = { group = "co.helmethair", name = "scalatest-junit-runner", version = "0.1.12" } +scala-guice = { group = "net.codingwell", name = "scala-guice_2.13", version.ref = "scala-guice" } +scala-uri = { group = "io.lemonlabs", name = "scala-uri_2.13", version.ref = "scala-uri" } +scalatestplus-play = { group = "org.scalatestplus.play", name = "scalatestplus-play_2.13", version.ref = "scalatestplus-play" } + +[plugins] +twirl = { id = "org.playframework.twirl", version.ref = "twirl" } +play = { id = "org.playframework.play", version.ref = "play" } diff --git a/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.jar b/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..7f93135c4 Binary files /dev/null and b/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.jar differ diff --git a/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.properties b/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..db8c3baaf --- /dev/null +++ b/play-scala-rest-api-example/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionSha256Sum=9d926787066a081739e8200858338b4a69e837c3a821a33aca9db09dd4a41026 +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/play-scala-rest-api-example/gradlew b/play-scala-rest-api-example/gradlew new file mode 100755 index 000000000..1aa94a426 --- /dev/null +++ b/play-scala-rest-api-example/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/play-scala-rest-api-example/gradlew.bat b/play-scala-rest-api-example/gradlew.bat new file mode 100644 index 000000000..93e3f59f1 --- /dev/null +++ b/play-scala-rest-api-example/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem 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, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/play-scala-rest-api-example/scripts/test-gradle b/play-scala-rest-api-example/scripts/test-gradle new file mode 100755 index 000000000..5db141cd7 --- /dev/null +++ b/play-scala-rest-api-example/scripts/test-gradle @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e +set -o pipefail + +echo "+-------------------------------+" +echo "| Executing tests using Gradle |" +echo "+-------------------------------+" +./gradlew -Dscala.version="$MATRIX_SCALA" check diff --git a/play-scala-rest-api-example/settings.gradle b/play-scala-rest-api-example/settings.gradle new file mode 100644 index 000000000..17676bb04 --- /dev/null +++ b/play-scala-rest-api-example/settings.gradle @@ -0,0 +1,12 @@ +// TODO: Remove after release Play Gradle Plugin +pluginManagement { + repositories { + gradlePluginPortal() + maven { + url = uri("https://oss.sonatype.org/content/repositories/snapshots") + } + mavenLocal() + } +} + +rootProject.name = "play-scala-rest-api-example" diff --git a/test-gradle.sh b/test-gradle.sh index b9bcfc715..1a6f4b421 100755 --- a/test-gradle.sh +++ b/test-gradle.sh @@ -33,7 +33,7 @@ fi # fi # pushd play-scala-log4j2-example && scripts/test-gradle && popd # pushd play-scala-macwire-di-example && scripts/test-gradle && popd -# pushd play-scala-rest-api-example && scripts/test-gradle && popd +pushd play-scala-rest-api-example && scripts/test-gradle && popd # Uses libsodium # pushd play-scala-secure-session-example && scripts/test-gradle && popd # if [ "$MATRIX_SCALA" != "3.x" ]; then