diff --git a/README.md b/README.md
index 63a2e00..d33eb12 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ fun SuiteDsl.showcase() = suite("Showcase Prepared") {
}
```
-To learn more, [read the documentation](https://opensavvy.gitlab.io/groundwork/prepared/docs).
+To learn more, [read the documentation](https://prepared.opensavvy.dev).
## Project structure
diff --git a/compat/compat-arrow/build.gradle.kts b/compat/compat-arrow/build.gradle.kts
index 010ae21..1af3b88 100644
--- a/compat/compat-arrow/build.gradle.kts
+++ b/compat/compat-arrow/build.gradle.kts
@@ -69,7 +69,7 @@ kotlin {
library {
name.set("Compatibility with Arrow")
description.set("Bind Either and Validated to fail test cases, with origin tracing")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/compat-arrow.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-filesystem/build.gradle.kts b/compat/compat-filesystem/build.gradle.kts
index 9b04b71..3f68d87 100644
--- a/compat/compat-filesystem/build.gradle.kts
+++ b/compat/compat-filesystem/build.gradle.kts
@@ -23,7 +23,7 @@ kotlin {
library {
name.set("Filesystem access")
description.set("Create and check files from the filesystem")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/files.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-gradle/build.gradle.kts b/compat/compat-gradle/build.gradle.kts
index 8ea53d2..fb7a75b 100644
--- a/compat/compat-gradle/build.gradle.kts
+++ b/compat/compat-gradle/build.gradle.kts
@@ -26,7 +26,7 @@ kotlin {
library {
name.set("Compatibility with Gradle TestKit")
description.set("Test Gradle plugins using Prepared")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-gradle/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/compat-gradle.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-java-time/build.gradle.kts b/compat/compat-java-time/build.gradle.kts
index 0a49028..940498d 100644
--- a/compat/compat-java-time/build.gradle.kts
+++ b/compat/compat-java-time/build.gradle.kts
@@ -23,7 +23,7 @@ kotlin {
library {
name.set("Compatibility with java.time")
description.set("Control the passing of time in Prepared tests using objects and methods from java.time, including Clock and Instant")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/time.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-kotlinx-datetime/build.gradle.kts b/compat/compat-kotlinx-datetime/build.gradle.kts
index b99ebd8..2f4708c 100644
--- a/compat/compat-kotlinx-datetime/build.gradle.kts
+++ b/compat/compat-kotlinx-datetime/build.gradle.kts
@@ -53,7 +53,7 @@ kotlin {
library {
name.set("Compatibility with KotlinX.Datetime (DEPRECATED)")
description.set("Control the passing of time in Prepared tests using objects and methods from KotlinX.Datetime, including Clock and Instant")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/time.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-ktor/build.gradle.kts b/compat/compat-ktor/build.gradle.kts
index c5776d4..5628b59 100644
--- a/compat/compat-ktor/build.gradle.kts
+++ b/compat/compat-ktor/build.gradle.kts
@@ -45,7 +45,7 @@ kotlin {
library {
name.set("Compatibility with Ktor")
description.set("Declare Ktor in-memory servers and clients as test fixtures")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/compat-ktor.html")
license.set {
name.set("Apache 2.0")
diff --git a/compat/compat-parameterize/build.gradle.kts b/compat/compat-parameterize/build.gradle.kts
index a642bb5..c508a54 100644
--- a/compat/compat-parameterize/build.gradle.kts
+++ b/compat/compat-parameterize/build.gradle.kts
@@ -51,7 +51,7 @@ kotlin {
library {
name.set("Compatibility with Parameterize")
description.set("Concise DSL for parameterized tests")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-parameterize/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/features/parameterize.html")
license.set {
name.set("Apache 2.0")
diff --git a/docs/website/.gitlab-ci.yml b/docs/website/.gitlab-ci.yml
index 254ace4..dfb21c0 100644
--- a/docs/website/.gitlab-ci.yml
+++ b/docs/website/.gitlab-ci.yml
@@ -15,7 +15,7 @@ mkdocs:
- ls
- 'echo "repo_url: $CI_PROJECT_URL">>mkdocs.yml'
- 'echo "repo_name: $CI_PROJECT_TITLE">>mkdocs.yml'
- - 'echo "site_url: $CI_PAGES_URL">>mkdocs.yml'
+ - 'echo "site_url: \"https://prepared.opensavvy.dev\"">>mkdocs.yml'
script:
- pwd
diff --git a/docs/website/docs/features/async.md b/docs/website/docs/features/async.md
index d619fbd..43bff15 100644
--- a/docs/website/docs/features/async.md
+++ b/docs/website/docs/features/async.md
@@ -16,7 +16,7 @@ For example, a test will fail if some foreground tasks are still running at the
## Launching foreground tasks
-To start a task in the foreground, use [`launch`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/launch.html) within a test:
+To start a task in the foreground, use [`launch`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/launch.html) within a test:
```kotlin
test("This is a test that starts a foreground task") {
launch {
@@ -41,7 +41,7 @@ The launched coroutine has the following properties:
## Launching background tasks
-To start a task in the background, use [`launchInBackground`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/launch-in-background.html) within a test:
+To start a task in the background, use [`launchInBackground`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/launch-in-background.html) within a test:
```kotlin
test("This is a test that starts a background task") {
launchInBackground {
@@ -77,7 +77,7 @@ The launched coroutine has the following properties:
Sometimes, a service used inside a test must itself be able to start asynchronous operations.
When written properly, this service accepts a `CoroutineScope` on creation.
-To allow the service to create foreground or background tasks, pass it either [`foregroundScope`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/foreground-scope.html) or [`backgroundScope`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/background-scope.html):
+To allow the service to create foreground or background tasks, pass it either [`foregroundScope`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/foreground-scope.html) or [`backgroundScope`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/background-scope.html):
```kotlin hl_lines="6 12"
val inMemoryCache by prepared { // (1)!
diff --git a/docs/website/docs/features/compat-arrow.md b/docs/website/docs/features/compat-arrow.md
index b57a8ab..16739c8 100644
--- a/docs/website/docs/features/compat-arrow.md
+++ b/docs/website/docs/features/compat-arrow.md
@@ -5,7 +5,7 @@
!!! info "Configuration"
Add a dependency on `dev.opensavvy.prepared:compat-arrow` to use the features on this page.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-arrow/index.html).
!!! info
The examples on this page use the [Kotest assertion library](../tutorials/index.md#assertion-libraries).
@@ -26,7 +26,7 @@ fun sqrt(value: Double): Double {
1. Failure conditions are declared as part of the function's signature. In this example, we use the experimental [context parameter](https://github.com/Kotlin/KEEP/blob/master/proposals/context-receivers.md) syntax.
If you do not have access to this syntax, you can also use regular extension receivers: `#!kotlin fun Raise.sqrt(value: Double): Double { … }`.
2. [`ensure`](https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/ensure.html) is Arrow's equivalent to [`require`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/require.html) and [`check`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/check.html): we test a condition, and raise a failure if it is `false`.
-To test a successful case, we use the [`failOnRaise`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/fail-on-raise.html) function:
+To test a successful case, we use the [`failOnRaise`](https://prepared.opensavvy.dev/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/fail-on-raise.html) function:
```kotlin
test("√4 is successful") {
failOnRaise {
@@ -35,7 +35,7 @@ test("√4 is successful") {
}
```
-To test a failed case, we use the [`assertRaises`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/assert-raises.html) or [`assertRaisesWith`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/assert-raises-with.html) functions:
+To test a failed case, we use the [`assertRaises`](https://prepared.opensavvy.dev/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/assert-raises.html) or [`assertRaisesWith`](https://prepared.opensavvy.dev/api-docs/compat/compat-arrow/opensavvy.prepared.compat.arrow.core/assert-raises-with.html) functions:
```kotlin
test("√-1 raises") {
assertRaises(NegativeSquareRoot) { //(1)!
diff --git a/docs/website/docs/features/compat-gradle.md b/docs/website/docs/features/compat-gradle.md
index eddaeb1..18b3ce0 100644
--- a/docs/website/docs/features/compat-gradle.md
+++ b/docs/website/docs/features/compat-gradle.md
@@ -7,7 +7,7 @@ All types of Gradle plugins can be tested (settings plugins, project plugins, pr
!!! info "Configuration"
Add a dependency on `dev.opensavvy.prepared:compat-gradle` to use the features on this page.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-gradle/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-gradle/index.html).
Prepared provides helpers to entire Gradle builds inside tests. Typically, this is done to test a plugin. In this example, we will create a plugin and test its behavior.
@@ -93,7 +93,7 @@ class MainPluginTest : TestExecutor() {
```
1. Declare the project setup in a [prepared value](prepared-values.md) for convenience: we will be able to reuse it between multiple tests.
-2. Use the [`gradle`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-gradle/opensavvy.prepared.compat.gradle/gradle.html) extension point and its [`settingsKts`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-gradle/opensavvy.prepared.compat.gradle/settings-kts.html) function to create the `settings.gradle.kts` file.
+2. Use the [`gradle`](https://prepared.opensavvy.dev/api-docs/compat/compat-gradle/opensavvy.prepared.compat.gradle/gradle.html) extension point and its [`settingsKts`](https://prepared.opensavvy.dev/api-docs/compat/compat-gradle/opensavvy.prepared.compat.gradle/settings-kts.html) function to create the `settings.gradle.kts` file.
3. Create an empty root `build.gradle.kts` file.
4. Create a `foo/build.gradle.kts` file that applies our plugin.
5. Invokes the [prepared value](prepared-values.md) we defined earlier.
diff --git a/docs/website/docs/features/compat-ktor.md b/docs/website/docs/features/compat-ktor.md
index 42c7e15..72738c0 100644
--- a/docs/website/docs/features/compat-ktor.md
+++ b/docs/website/docs/features/compat-ktor.md
@@ -7,7 +7,7 @@ Prepared provides helpers to easily test clients and servers.
!!! info "Configuration"
Add a dependency on `dev.opensavvy.prepared:compat-ktor` to use the features on this page.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-ktor/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-ktor/index.html).
## Testing a server
@@ -41,9 +41,9 @@ val server by preparedServer { //(1)!
val client by server.preparedClient() //(3)!
```
-1. The [`preparedServer`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-ktor/opensavvy.prepared.compat.ktor/prepared-server.html) function declares a Ktor server as a [prepared value](prepared-values.md).
+1. The [`preparedServer`](https://prepared.opensavvy.dev/api-docs/compat/compat-ktor/opensavvy.prepared.compat.ktor/prepared-server.html) function declares a Ktor server as a [prepared value](prepared-values.md).
2. Load the server module we want to test.
If you use the `application.conf` file, modules are loaded automatically.
-3. The [`preparedClient`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-ktor/opensavvy.prepared.compat.ktor/prepared-client.html) function declares a Ktor client based on a server, as a [prepared value](prepared-values.md).
+3. The [`preparedClient`](https://prepared.opensavvy.dev/api-docs/compat/compat-ktor/opensavvy.prepared.compat.ktor/prepared-client.html) function declares a Ktor client based on a server, as a [prepared value](prepared-values.md).
```kotlin
fun SuiteDsl.pingTest() = suite("Testing the ping server") {
diff --git a/docs/website/docs/features/files.md b/docs/website/docs/features/files.md
index b61ce1f..a66e6d6 100644
--- a/docs/website/docs/features/files.md
+++ b/docs/website/docs/features/files.md
@@ -7,11 +7,11 @@ Prepared provides helpers to refer to files even before they are created.
!!! info "Configuration"
Add a dependency on `dev.opensavvy.prepared:compat-filesystem` to use the features on this page. Not all platforms are supported.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-filesystem/index.html).
## Creating temporary files and directories
-[New files](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/create-random-file.html) and [new directories](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/create-random-directory.html) can be created as [prepared values](prepared-values.md):
+[New files](https://prepared.opensavvy.dev/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/create-random-file.html) and [new directories](https://prepared.opensavvy.dev/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/create-random-directory.html) can be created as [prepared values](prepared-values.md):
```kotlin
val workingDirectory by createRandomDirectory()
@@ -30,7 +30,7 @@ test("…") {
}
```
-1. The `/` operator can be used to refer to child files or directories before the test starts executing. [Learn more](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/div.html).
+1. The `/` operator can be used to refer to child files or directories before the test starts executing. [Learn more](https://prepared.opensavvy.dev/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem/div.html).
The files are based on prepared values, so they are created lazily as they are needed, and each test gets a different set of files to work with, ensuring no two tests can attempt to modify the same files.
@@ -38,7 +38,7 @@ All the created files are deleted automatically if the test is successful. Howev
## Reading Java resources
-On the JVM, it is possible to organize resources files in the same packages as source classes to avoid conflicts. To access these files, use the [resource](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem.resources/resource.html) helper:
+On the JVM, it is possible to organize resources files in the same packages as source classes to avoid conflicts. To access these files, use the [resource](https://prepared.opensavvy.dev/api-docs/compat/compat-filesystem/opensavvy.prepared.compat.filesystem.resources/resource.html) helper:
```kotlin
package foo.bar.baz
diff --git a/docs/website/docs/features/finalizers.md b/docs/website/docs/features/finalizers.md
index 7139b09..398bced 100644
--- a/docs/website/docs/features/finalizers.md
+++ b/docs/website/docs/features/finalizers.md
@@ -1,6 +1,6 @@
# Finalizers
-[Finalizers](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/clean-up.html) allow to execute code at the end of the test.
+[Finalizers](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/clean-up.html) allow to execute code at the end of the test.
## Usage
diff --git a/docs/website/docs/features/parameterize.md b/docs/website/docs/features/parameterize.md
index 7973b10..eed6c2f 100644
--- a/docs/website/docs/features/parameterize.md
+++ b/docs/website/docs/features/parameterize.md
@@ -74,7 +74,7 @@ The added indentation levels make the intent of the code harder to understand. I
!!! info "Configuration"
Add a dependency on `dev.opensavvy.prepared:compat-parameterize` to use the features in this section.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-parameterize/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-parameterize/index.html).
The previous example can be rewritten as:
```kotlin
@@ -93,4 +93,4 @@ fun SuiteDsl.foo() = suite("Foo") {
As you can see, this is much easier to read, and the intent of the test is conveyed much more clearly.
-To learn more about this module, and the way it interacts with [prepared values](prepared-values.md), see [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-parameterize/index.html).
+To learn more about this module, and the way it interacts with [prepared values](prepared-values.md), see [the reference](https://prepared.opensavvy.dev/api-docs/compat/compat-parameterize/index.html).
diff --git a/docs/website/docs/features/prepared-values.md b/docs/website/docs/features/prepared-values.md
index b6519a5..6a6ad85 100644
--- a/docs/website/docs/features/prepared-values.md
+++ b/docs/website/docs/features/prepared-values.md
@@ -52,7 +52,7 @@ This approach has a few downsides:
Prepared values are lazy data generators that are executed when they are first referred to by a test, then return the same value for the remainder of the test. Each test receives its own value that is independent of any other test.
-Prepared values can be instantiated anywhere, including at the top-level, using the [prepared builder](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/prepared.html):
+Prepared values can be instantiated anywhere, including at the top-level, using the [prepared builder](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/prepared.html):
```kotlin
val adminEmail by prepared { "my-account-${random.nextInt()}@mail.com" }
```
diff --git a/docs/website/docs/features/shared-values.md b/docs/website/docs/features/shared-values.md
index cb1f9de..093b65c 100644
--- a/docs/website/docs/features/shared-values.md
+++ b/docs/website/docs/features/shared-values.md
@@ -17,7 +17,7 @@ Shared values are computed once on first access, and then are shared between all
## Using shared values
-Shared values can be defined anywhere using the [shared builder](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/shared.html) (including at the top-level) and are accessed using function-call syntax, similarly to prepared values.
+Shared values can be defined anywhere using the [shared builder](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/shared.html) (including at the top-level) and are accessed using function-call syntax, similarly to prepared values.
```kotlin
import java.nio.file.Path
@@ -40,7 +40,7 @@ Shared values otherwise behave the same as prepared values, and their syntax is
??? note "Creating multiple shared values from the same generator"
Although this is supported, it is not recommended.
- To learn why, see [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/-shared-provider/index.html).
+ To learn why, see [the reference](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/-shared-provider/index.html).
### Shared values do not have access to the test context
diff --git a/docs/website/docs/features/time.md b/docs/website/docs/features/time.md
index 4f49786..25d2787 100644
--- a/docs/website/docs/features/time.md
+++ b/docs/website/docs/features/time.md
@@ -2,7 +2,7 @@
Tests run in virtual time: a fixed timescale which is controlled by the developer.
-The current virtual time can be accessed using the [`time.nowMillis`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/now-millis.html) property.
+The current virtual time can be accessed using the [`time.nowMillis`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/now-millis.html) property.
To control the current date as proper datetime types, or to inject a controllable clock into other services, see [Using the virtual time](#using-the-virtual-date-and-time).
## Delay-skipping
@@ -64,7 +64,7 @@ As we can see, the execution can be deterministically tested. Systems that wait
This is one of the reasons why real code should never refer to specific dispatchers directly. Instead, services that must start coroutines should accept a `CoroutineScope` or `CoroutineContext` parameter. Test code can initialize them with:
- If the service accepts a `CoroutineScope`, see [the asynchronous helpers section](async.md#controlling-the-execution-of-external-services).
- - If the service accepts a `CoroutineContext`, see [`time.scheduler`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/-time/scheduler.html).
+ - If the service accepts a `CoroutineContext`, see [`time.scheduler`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/-time/scheduler.html).
### Interaction with fixtures
@@ -82,7 +82,7 @@ It is possible to measure how long an operation takes in virtual time or in real
### Measuring in virtual time
-See [`time.source`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/-time/source.html):
+See [`time.source`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/-time/source.html):
```kotlin
test("Measure how long an operation takes in virtual time") {
@@ -123,18 +123,18 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "KotlinX.Datetime"
Add a dependency on `dev.opensavvy.prepared:compat-kotlinx-datetime`.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-kotlinx-datetime/index.html).
=== "Java Time"
Add a dependency on `dev.opensavvy.prepared:compat-java-time`.
- See the [reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/index.html).
+ See the [reference](https://prepared.opensavvy.dev/api-docs/compat/compat-java-time/index.html).
### Accessing the current time
=== "Kotlin.time"
- [`time.now`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/now.html) can be used to access the current time as an `Instant`:
+ [`time.now`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/now.html) can be used to access the current time as an `Instant`:
```kotlin
test("Access the current time") {
@@ -146,7 +146,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "KotlinX.Datetime"
- [`time.now`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/now.html) can be used to access the current time as an `Instant`:
+ [`time.now`](https://prepared.opensavvy.dev/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/now.html) can be used to access the current time as an `Instant`:
```kotlin
test("Access the current time") {
@@ -158,7 +158,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Java Time"
- [`time.nowJava`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/now-java.html) can be used to access the current time as an `Instant`:
+ [`time.nowJava`](https://prepared.opensavvy.dev/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/now-java.html) can be used to access the current time as an `Instant`:
```kotlin
test("Access the current time") {
@@ -172,7 +172,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Kotlin.time"
- By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/set.html):
+ By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/set.html):
```kotlin
test("Set the initial time of a test") {
@@ -185,7 +185,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "KotlinX.Datetime"
- By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/set.html):
+ By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://prepared.opensavvy.dev/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/set.html):
```kotlin
test("Set the initial time of a test") {
@@ -198,7 +198,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Java Time"
- By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/set.html):
+ By default, the virtual time is set to UNIX Time 0, January 1st, 1970 at 00:00:00. To set the initial time to another initial date, use [`time.set`](https://prepared.opensavvy.dev/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/set.html):
```kotlin
test("Set the initial time of a test") {
@@ -214,7 +214,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Kotlin.time"
- Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clock`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/clock.html):
+ Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clock`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/clock.html):
```kotlin
test("Test an algorithm that performs time-sensitive operations") {
@@ -228,7 +228,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "KotlinX.Datetime"
- Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clock`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/clock.html):
+ Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clock`](https://prepared.opensavvy.dev/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/clock.html):
```kotlin
test("Test an algorithm that performs time-sensitive operations") {
@@ -242,7 +242,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Java Time"
- Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clockJava`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/clock-java.html):
+ Algorithms we want to test need to have access to the virtual time. Traditionally, this is done by accepting a `Clock` in the algorithm's constructor. We can generate such a clock with [`time.clockJava`](https://prepared.opensavvy.dev/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/clock-java.html):
```kotlin
test("Test an algorithm that performs time-sensitive operations") {
@@ -258,7 +258,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Kotlin.time"
- Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/delay-until.html) to wait until a specific instant.
+ Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/delay-until.html) to wait until a specific instant.
```kotlin
test("Observe what happens when the year changes") {
@@ -274,7 +274,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "KotlinX.Datetime"
- Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/delay-until.html) to wait until a specific instant.
+ Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://prepared.opensavvy.dev/api-docs/compat/compat-kotlinx-datetime/opensavvy.prepared.compat.kotlinx.datetime/delay-until.html) to wait until a specific instant.
```kotlin
test("Observe what happens when the year changes") {
@@ -290,7 +290,7 @@ Often, `time.nowMillis` is insufficient: we want to trigger algorithms at specif
=== "Java Time"
- Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/delay-until.html) to wait until a specific instant.
+ Instead of using `delay` to wait for a specific duration, we can also use [`delayUntil`](https://prepared.opensavvy.dev/api-docs/compat/compat-java-time/opensavvy.prepared.compat.java.time/delay-until.html) to wait until a specific instant.
```kotlin
test("Observe what happens when the year changes") {
diff --git a/docs/website/docs/tutorials/index.md b/docs/website/docs/tutorials/index.md
index 665c920..49a2b8f 100644
--- a/docs/website/docs/tutorials/index.md
+++ b/docs/website/docs/tutorials/index.md
@@ -33,7 +33,7 @@ Prepared doesn't include a built-in test runner.
}
```
- 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).
+ To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://prepared.opensavvy.dev/api-docs/runners/runner-kotlin-test/index.html).
=== "TestBalloon"
@@ -52,7 +52,7 @@ Prepared doesn't include a built-in test runner.
}
```
- 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).
+ To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://prepared.opensavvy.dev/api-docs/runners/runner-testballoon/index.html).
=== "Kotest"
@@ -71,7 +71,7 @@ Prepared doesn't include a built-in test runner.
})
```
- 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).
+ To decide whether it is appropriate for your project, see the available platforms and see the required configuration, refer to [the reference](https://prepared.opensavvy.dev/api-docs/runners/runner-kotest/index.html).
=== "Without a runner"
@@ -79,7 +79,7 @@ Prepared doesn't include a built-in test runner.
This is useful when creating a test utility module that is imported into other test modules.
By not depending on any runner, the test utility module can be imported into a project that uses any runner.
- To do this, simply declare a dependency on `dev.opensavvy.prepared:suite`. To learn more, refer to [the reference](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/index.html).
+ To do this, simply declare a dependency on `dev.opensavvy.prepared:suite`. To learn more, refer to [the reference](https://prepared.opensavvy.dev/api-docs/suite/index.html).
Test suites can be exported as top-level functions:
diff --git a/docs/website/docs/tutorials/syntax.md b/docs/website/docs/tutorials/syntax.md
index c2f6b9d..68fbf59 100644
--- a/docs/website/docs/tutorials/syntax.md
+++ b/docs/website/docs/tutorials/syntax.md
@@ -9,7 +9,7 @@ In this article, we showcase how tests are declared with Prepared. Users familia
## Declaring tests
-A test is declared by calling the [`test`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/-suite-dsl/test.html) function within a suite:
+A test is declared by calling the [`test`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/-suite-dsl/test.html) function within a suite:
```kotlin
test("This is the name of the test") {
@@ -19,7 +19,7 @@ test("This is the name of the test") {
Tests can `suspend` and have access to a [wide array of features](../features). You can name tests however you want.
-Tests are grouped in suites. Suites are declared by calling the [`suite`](https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/opensavvy.prepared.suite/-suite-dsl/suite.html) function within another suite. Suites can be arbitrarily nested:
+Tests are grouped in suites. Suites are declared by calling the [`suite`](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/-suite-dsl/suite.html) function within another suite. Suites can be arbitrarily nested:
```kotlin
suite("Users") {
diff --git a/runners/runner-kotest/build.gradle.kts b/runners/runner-kotest/build.gradle.kts
index 15ff301..dff7bb1 100644
--- a/runners/runner-kotest/build.gradle.kts
+++ b/runners/runner-kotest/build.gradle.kts
@@ -67,7 +67,7 @@ tasks.withType(Test::class) {
library {
name.set("Execute with Kotest")
description.set("Execute Prepared test suites in projects that use Kotest")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-kotest/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/api-docs/runners/runner-kotest/index.html")
license.set {
name.set("Apache 2.0")
diff --git a/runners/runner-kotlin-test/build.gradle.kts b/runners/runner-kotlin-test/build.gradle.kts
index ad94d4e..1fc9879 100644
--- a/runners/runner-kotlin-test/build.gradle.kts
+++ b/runners/runner-kotlin-test/build.gradle.kts
@@ -52,7 +52,7 @@ tasks.withType(Test::class) {
library {
name.set("Execute with Kotlin-test")
description.set("Execute Prepared test suites in projects that use kotlin-test")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-kotlin-test/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/api-docs/runners/runner-kotlin-test/index.html")
license.set {
name.set("Apache 2.0")
diff --git a/runners/runner-test-initiative/build.gradle.kts b/runners/runner-test-initiative/build.gradle.kts
index 0e251b2..c7d62d7 100644
--- a/runners/runner-test-initiative/build.gradle.kts
+++ b/runners/runner-test-initiative/build.gradle.kts
@@ -45,7 +45,7 @@ kotlin {
library {
name.set("Execute with Kotlin Test Initiative compatibility")
description.set("Execute Prepared test suites with Kotlin Test Initiative compatibility")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-test-initiative/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/api-docs/runners/runner-test-initiative/index.html")
license.set {
name.set("Apache 2.0")
diff --git a/runners/runner-testballoon/build.gradle.kts b/runners/runner-testballoon/build.gradle.kts
index ce58973..0d09300 100644
--- a/runners/runner-testballoon/build.gradle.kts
+++ b/runners/runner-testballoon/build.gradle.kts
@@ -49,7 +49,7 @@ kotlin {
library {
name.set("Execute with TestBalloon")
description.set("Execute Prepared test suites with the TestBalloon multiplatform-first framework")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/runners/runner-testballoon/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev/api-docs/runners/runner-testballoon/index.html")
license.set {
name.set("Apache 2.0")
diff --git a/suite/build.gradle.kts b/suite/build.gradle.kts
index 746b510..8fb1274 100644
--- a/suite/build.gradle.kts
+++ b/suite/build.gradle.kts
@@ -53,7 +53,7 @@ kotlin {
library {
name.set("Suite")
description.set("Magicless test framework for Kotlin Multiplatform")
- homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/index.html")
+ homeUrl.set("https://prepared.opensavvy.dev")
license.set {
name.set("Apache 2.0")