Skip to content

feat: Document the new configOverride available on the withServerpod #523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcelomendoncasoares wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

feat: Document the new configOverride available on the withServerpod #523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/06-concepts/19-testing/02-the-basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,20 @@ withServerpod(

## Configuration

The following optional configuration options are available to pass as a second argument to `withServerpod`:
The following optional configuration options are available to pass as named arguments to `withServerpod`:

|Property|Description|Default|
|:-----|:-----|:---:|
|`applyMigrations`|Whether pending migrations should be applied when starting Serverpod.|`true`|
|`configOverride`|A function that overrides values in the loaded Serverpod config before the test server starts.|`null`|
|`enableSessionLogging`|Whether session logging should be enabled.|`false`|
|`experimentalFeatures`|Optionally specify experimental features used by Serverpod.|`null`|
|`rollbackDatabase`|Options for when to rollback the database during the test lifecycle (or disable it). See detailed description [here](#rollback-database-configuration).|`RollbackDatabase.afterEach`|
|`runMode`|The run mode that Serverpod should be running in.|`ServerpodRunmode.test`|
|`runMode`|The run mode that Serverpod should be running in.|`test`|
|`runtimeParametersBuilder`|A callback for providing runtime parameters to Serverpod before startup.|`null`|
|`serverpodLoggingMode`|The logging mode used when creating Serverpod.|`ServerpodLoggingMode.normal`|
|`serverpodStartTimeout`|The timeout to use when starting Serverpod, which connects to the database among other things. Defaults to `Duration(seconds: 30)`.|`Duration(seconds: 30)`|
|`testServerOutputMode`|Options for controlling test server output during test execution.|`TestServerOutputMode.normal`|
|`testGroupTagsOverride`|By default Serverpod test tools tags the `withServerpod` test group with `"integration"`. This is to provide a simple way to only run unit or integration tests. This property allows this tag to be overridden to something else. Defaults to `['integration']`.|`['integration']`|

### `rollbackDatabase` {#rollback-database-configuration}
Expand Down
Loading