diff --git a/docs/website/docs/tutorials/index.md b/docs/website/docs/tutorials/index.md index 62d6225..05eebb6 100644 --- a/docs/website/docs/tutorials/index.md +++ b/docs/website/docs/tutorials/index.md @@ -19,6 +19,11 @@ Prepared doesn't include a built-in test runner. The `kotlin-test` runner is based on the [Kotlin standard test library](https://kotlinlang.org/api/core/kotlin-test/). To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-kotlin-test/index.html). +=== "TestBalloon" + + The TestBalloon runner is based on the [TestBalloon framework](https://github.com/infix-de/testBalloon/). + To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-testballoon/index.html). + === "Kotest" The `kotest` runner is based on the [Kotest framework](https://kotest.io/docs/framework/framework.html). -- 2.51.2 From b9770af4f19eb0519250363eef87b2e63412be33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 31 May 2025 11:21:34 +0200 Subject: [PATCH 2/2] docs(website): Add an example for each test runner in the tutorial --- docs/website/docs/tutorials/index.md | 44 ++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/website/docs/tutorials/index.md b/docs/website/docs/tutorials/index.md index 05eebb6..665c920 100644 --- a/docs/website/docs/tutorials/index.md +++ b/docs/website/docs/tutorials/index.md @@ -17,16 +17,60 @@ Prepared doesn't include a built-in test runner. === "Kotlin-test" The `kotlin-test` runner is based on the [Kotlin standard test library](https://kotlinlang.org/api/core/kotlin-test/). + + ```kotlin + class FooTest : TestExecutor() { + override fun SuiteDsl.register() { + test("Test 1") { + assertEquals("Hello world", "Hello world") + } + + suite("A group of tests") { + test("Test 2") { /* … */ } + test("Test 3") { /* … */ } + } + } + } + ``` + To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-kotlin-test/index.html). === "TestBalloon" The TestBalloon runner is based on the [TestBalloon framework](https://github.com/infix-de/testBalloon/). + + ```kotlin + val FooTest by preparedSuite { + test("Test 1") { + check("Hello world" == "Hello world") + } + + suite("A group of tests") { + test("Test 2") { /* … */ } + test("Test 3") { /* … */ } + } + } + ``` + To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-testballoon/index.html). === "Kotest" The `kotest` runner is based on the [Kotest framework](https://kotest.io/docs/framework/framework.html). + + ```kotlin + val FooTest : PreparedSpec({ + test("Test 1") { + "Hello world" shouldBe "Hello world" + } + + suite("A group of tests") { + test("Test 2") { /* … */ } + test("Test 3") { /* … */ } + } + }) + ``` + To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-kotest/index.html). === "Without a runner"