diff --git a/samples/README.md b/samples/README.md index 4176b0245..91055199e 100644 --- a/samples/README.md +++ b/samples/README.md @@ -22,6 +22,7 @@ The Gradle projects in this directory demonstrate typical use cases with and fea - [`hello-kapt`](./hello-kapt): demonstrates a Kotlin-based Gradle build script for a project that is itself written in Kotlin and uses [`kapt`](https://kotlinlang.org/docs/reference/kapt.html) (Kotlin Annotation Processing Tool) - [`hello-kotlin`](./hello-kotlin): demonstrates a Kotlin-based Gradle build script for a project that is itself written in Kotlin - [`hello-world`](./hello-world): demonstrates plugin application and configuration, dependency management, JUnit testing + - [`hello-spring-boot`](./hello-spring-boot): demonstrates a Kotlin-based Gradle build script for a Kotlin-based spring boot application - [`kotlin-friendly-groovy-plugin`](./kotlin-friendly-groovy-plugin): demonstrates a Groovy Gradle plugin and its use from Kotlin-based build scripts - [`maven-plugin`](./maven-plugin): demonstrates how to configure the Gradle `maven` plugin - [`maven-publish`](./maven-publish): demonstrates how to configure the Gradle `maven-publish` plugin diff --git a/samples/hello-spring-boot/.gitignore b/samples/hello-spring-boot/.gitignore new file mode 100644 index 000000000..0d7761537 --- /dev/null +++ b/samples/hello-spring-boot/.gitignore @@ -0,0 +1,6 @@ +build/ +out/ +classes/ +.idea/ +*.iml +.gradle/ diff --git a/samples/hello-spring-boot/README.md b/samples/hello-spring-boot/README.md new file mode 100644 index 000000000..d1838e142 --- /dev/null +++ b/samples/hello-spring-boot/README.md @@ -0,0 +1,4 @@ +Hello, Spring Boot! +=================== + +This sample demonstrates a simple spring-boot application with a Kotlin based build script. diff --git a/samples/hello-spring-boot/build.gradle.kts b/samples/hello-spring-boot/build.gradle.kts new file mode 100644 index 000000000..5089cf894 --- /dev/null +++ b/samples/hello-spring-boot/build.gradle.kts @@ -0,0 +1,37 @@ +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + +group = "com.spring.boot" +version = "1.0.0-SNAPSHOT" + +plugins { + val kotlinVersion = "1.2.40" + id("org.springframework.boot") version "2.0.1.RELEASE" + kotlin("jvm") version kotlinVersion + kotlin("plugin.spring") version kotlinVersion + id("io.spring.dependency-management") version "1.0.5.RELEASE" +} + +tasks.withType { + kotlinOptions { + jvmTarget = "1.8" + freeCompilerArgs = listOf("-Xjsr305=strict") + } +} + +(tasks.findByName("test") as Test).useJUnitPlatform() + +repositories { + mavenCentral() +} + +dependencies { + compile("org.springframework.boot:spring-boot-starter-web") + compile(kotlin("stdlib-jdk8")) + compile(kotlin("reflect")) + compile("com.fasterxml.jackson.module:jackson-module-kotlin") + testCompile("org.springframework.boot:spring-boot-starter-test") { + exclude(module = "junit") + } + testImplementation("org.junit.jupiter:junit-jupiter-api") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine") +} diff --git a/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.jar b/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..27768f1bb Binary files /dev/null and b/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.jar differ diff --git a/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.properties b/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..405c577d6 --- /dev/null +++ b/samples/hello-spring-boot/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://repo.gradle.org/gradle/kotlin-dsl-snapshots-local/gradle-kotlin-dsl-4.8-20180427080143+0000-all.zip diff --git a/samples/hello-spring-boot/gradlew b/samples/hello-spring-boot/gradlew new file mode 100755 index 000000000..cccdd3d51 --- /dev/null +++ b/samples/hello-spring-boot/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/samples/hello-spring-boot/gradlew.bat b/samples/hello-spring-boot/gradlew.bat new file mode 100644 index 000000000..e95643d6a --- /dev/null +++ b/samples/hello-spring-boot/gradlew.bat @@ -0,0 +1,84 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +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 init + +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 + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/samples/hello-spring-boot/settings.gradle.kts b/samples/hello-spring-boot/settings.gradle.kts new file mode 100644 index 000000000..05ff9c1c9 --- /dev/null +++ b/samples/hello-spring-boot/settings.gradle.kts @@ -0,0 +1,3 @@ +rootProject.name = "hello-spring-boot" +rootProject.buildFileName = "build.gradle.kts" + diff --git a/samples/hello-spring-boot/src/main/kotlin/hello/Application.kt b/samples/hello-spring-boot/src/main/kotlin/hello/Application.kt new file mode 100644 index 000000000..0789b23d8 --- /dev/null +++ b/samples/hello-spring-boot/src/main/kotlin/hello/Application.kt @@ -0,0 +1,11 @@ +package hello + +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.boot.runApplication + +@SpringBootApplication +class Application + +fun main(args: Array) { + runApplication(*args) +} \ No newline at end of file diff --git a/samples/hello-spring-boot/src/main/kotlin/hello/HelloController.kt b/samples/hello-spring-boot/src/main/kotlin/hello/HelloController.kt new file mode 100644 index 000000000..21393d00a --- /dev/null +++ b/samples/hello-spring-boot/src/main/kotlin/hello/HelloController.kt @@ -0,0 +1,11 @@ +package hello + +import org.springframework.web.bind.annotation.GetMapping +import org.springframework.web.bind.annotation.RestController + +@RestController +class HelloController { + + @GetMapping("/hello") + fun hello() = "Hello, Spring Boot!.." +} \ No newline at end of file diff --git a/samples/hello-spring-boot/src/test/kotlin/hello/ApplicationTest.kt b/samples/hello-spring-boot/src/test/kotlin/hello/ApplicationTest.kt new file mode 100644 index 000000000..6c23ba5e7 --- /dev/null +++ b/samples/hello-spring-boot/src/test/kotlin/hello/ApplicationTest.kt @@ -0,0 +1,20 @@ +package hello + +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.extension.ExtendWith +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.context.SpringBootTest +import org.springframework.boot.test.web.client.TestRestTemplate +import org.springframework.boot.test.web.client.getForObject +import org.springframework.test.context.junit.jupiter.SpringExtension + +@ExtendWith(SpringExtension::class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +class ApplicationTest(@Autowired private val restTemplate: TestRestTemplate) { + + @Test + fun hello() { + assertEquals("Hello, Spring Boot!..", restTemplate.getForObject("/hello")) + } +} \ No newline at end of file