diff --git a/docs/topics/jvm/jvm-test-using-junit/jvm-test-using-junit.md b/docs/topics/jvm/jvm-test-using-junit/jvm-test-using-junit.md index 97fca14696c..c1075bb443e 100644 --- a/docs/topics/jvm/jvm-test-using-junit/jvm-test-using-junit.md +++ b/docs/topics/jvm/jvm-test-using-junit/jvm-test-using-junit.md @@ -91,13 +91,8 @@ ## Add the code to test it -* TODO: -1. Open the `Main.kt` file in `src/main/kotlin`. - - The `src` directory contains Kotlin source files and resources. - The `Main.kt` file contains sample code that prints `Hello, World!`. - -2. Create the `Sample` class with the `sum()` function that adds two integers together: +1. Open the `Main.kt` file in `src/main/kotlin` +2. Create the `Sample` class with the `sum()` function / adds two integers together: ```kotlin class Sample() { @@ -110,25 +105,18 @@ ## Create a test -1. In IntelliJ IDEA, select **Code** | **Generate** | **Test...** for the `Sample` class: - - ![Create a test](generate-test.png) - -2. Specify the name of the test class. For example, `SampleTest`: +1. Ways + * via IntelliJ IDEA, select **Code** | **Generate** | **Test...** for the `Sample` class / specify the name of the test class - ![Create a test](create-test.png) + ![Create a test](generate-test.png) - IntelliJ IDEA creates the `SampleTest.kt` file in the `test` directory. - This directory contains Kotlin test source files and resources. + ![Create a test](create-test.png) + * via manually, create a `*.kt` | `src/test/kotlin` - > You can also manually create a `*.kt` file for tests in `src/test/kotlin`. - > - {type="note"} +2. Add the test code for the `sum()` function | `SampleTest.kt`: -3. Add the test code for the `sum()` function in `SampleTest.kt`: - - * Define the test `testSum()` function using the [`@Test` annotation](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/-test/index.html). - * Check that the `sum()` function returns the expected value by using the [`assertEquals()`](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/assert-equals.html) function. + * Define the test `testSum()` function -- via -- [`@Test` annotation](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/-test/index.html) + * Check that the `sum()` function returns the expected value ```kotlin import org.example.Sample @@ -149,42 +137,23 @@ ## Run a test -1. Run the test using the gutter icon: - - ![Run the test](run-test.png) +1. Ways + * via IDE + 1. Run the test using the gutter icon: - > You can also run all project tests via the command-line interface using the `./gradlew check` command. - > - {type="note"} + ![Run the test](run-test.png) + * via CLI + 1. `./gradlew test` 2. Check the result in the **Run** tool window: ![Check the test result. The test passed successfully](test-successful.png) - The test function was executed successfully. - -3. Make sure that the test works correctly by changing the `expected` variable value to 43: - - ```kotlin - @Test - fun testSum() { - val expected = 43 - assertEquals(expected, classForTesting.sum(40, 2)) - } - ``` - -4. Run the test again and check the result: - - ![Check the test result. The test has failed](test-failed.png) - - The test execution failed. +3. Make sure that the test works correctly by changing the `expected` variable value ## What's next -Once you've finished your first test, you can: - -* Write more tests using other [`kotlin.test`](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/) functions. - For example, use the [`assertNotEquals()`](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/assert-not-equals.html) function. -* Improve your test output with the [Kotlin Power-assert compiler plugin](power-assert.md). - The plugin enriches the test output with contextual information. -* [Create your first server-side application](jvm-get-started-spring-boot.md) with Kotlin and Spring Boot. \ No newline at end of file +* Check + * [`kotlin.test`](https://kotlinlang.org/api/latest/kotlin.test/kotlin.test/) + * [Kotlin Power-assert compiler plugin](power-assert.md) + * enriches the test output with contextual information diff --git a/docs/topics/jvm/jvm-test-using-junit/test/README.md b/docs/topics/jvm/jvm-test-using-junit/test/README.md index 5e4066cbfa3..b5e06690863 100644 --- a/docs/topics/jvm/jvm-test-using-junit/test/README.md +++ b/docs/topics/jvm/jvm-test-using-junit/test/README.md @@ -6,4 +6,7 @@ * click the green **Run** icon in the gutter and select **Run 'MainKt'** * via CL * `kotlinc Main.kt -include-runtime -d Main.jar` - * `java -jar Main.jar \ No newline at end of file + * `java -jar Main.jar + +## How to run the tests? +* Check "jvm-test-using-junit.md" \ No newline at end of file diff --git a/docs/topics/jvm/jvm-test-using-junit/test/build.gradle.kts b/docs/topics/jvm/jvm-test-using-junit/test/build.gradle.kts new file mode 100644 index 00000000000..e0d82043f03 --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/build.gradle.kts @@ -0,0 +1,22 @@ +plugins { + kotlin("jvm") version "2.0.0" +} + +group = "org.example" +version = "1.0-SNAPSHOT" + +repositories { + mavenCentral() +} + +dependencies { + // -> you can work with `kotlin.test` and `JUnit` + testImplementation(kotlin("test")) +} + +tasks.test { + useJUnitPlatform() +} +kotlin { + jvmToolchain(17) +} \ No newline at end of file diff --git a/docs/topics/jvm/jvm-test-using-junit/test/gradle.properties b/docs/topics/jvm/jvm-test-using-junit/test/gradle.properties new file mode 100644 index 00000000000..80987d67fde --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style = official diff --git a/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.jar b/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..249e5832f09 Binary files /dev/null and b/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.jar differ diff --git a/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.properties b/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..1ae2cbbca86 --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Tue Aug 27 23:26:43 CEST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/docs/topics/jvm/jvm-test-using-junit/test/gradlew b/docs/topics/jvm/jvm-test-using-junit/test/gradlew new file mode 100755 index 00000000000..1b6c787337f --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/gradlew @@ -0,0 +1,234 @@ +#!/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/master/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 + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${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='"-Xmx64m" "-Xms64m"' + +# 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 + 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" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + 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 + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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/docs/topics/jvm/jvm-test-using-junit/test/gradlew.bat b/docs/topics/jvm/jvm-test-using-junit/test/gradlew.bat new file mode 100644 index 00000000000..107acd32c4e --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/gradlew.bat @@ -0,0 +1,89 @@ +@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=. +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%" == "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%"=="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/docs/topics/jvm/jvm-test-using-junit/test/settings.gradle.kts b/docs/topics/jvm/jvm-test-using-junit/test/settings.gradle.kts new file mode 100644 index 00000000000..8e0ee811aa9 --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/settings.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} +rootProject.name = "test" + diff --git a/docs/topics/jvm/jvm-test-using-junit/test/src/main/kotlin/Main.kt b/docs/topics/jvm/jvm-test-using-junit/test/src/main/kotlin/Main.kt new file mode 100644 index 00000000000..8f9b9a41a1b --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/src/main/kotlin/Main.kt @@ -0,0 +1,21 @@ +package org.example + + +fun main() { + val name = "Kotlin" + //TIP Press with your caret at the highlighted text + // to see how IntelliJ IDEA suggests fixing it. + println("Hello, " + name + "!") + + for (i in 1..5) { + //TIP Press to start debugging your code. We have set one breakpoint + // for you, but you can always add more by pressing . + println("i = $i") + } +} + +class Sample() { + fun sum(a: Int, b: Int): Int { + return a + b + } +} \ No newline at end of file diff --git a/docs/topics/jvm/jvm-test-using-junit/test/src/test/kotlin/MainTest.kt b/docs/topics/jvm/jvm-test-using-junit/test/src/test/kotlin/MainTest.kt new file mode 100644 index 00000000000..91888ead75f --- /dev/null +++ b/docs/topics/jvm/jvm-test-using-junit/test/src/test/kotlin/MainTest.kt @@ -0,0 +1,15 @@ +import org.example.Sample +import org.junit.jupiter.api.Assertions.* +import kotlin.test.Test + +class SampleTest { + + private val testSample: Sample = Sample() + + @Test + fun testSum() { + val expected = 42 + //val expected = 44 Check that test fails, passing a wrong expected value + assertEquals(expected, testSample.sum(40, 2)) + } +} \ No newline at end of file