Skip to content

Commit

Permalink
docs: add upgrade to 2.2 page
Browse files Browse the repository at this point in the history
  • Loading branch information
hampuslavin committed Nov 26, 2024
1 parent b3bc7da commit cb1976e
Showing 1 changed file with 180 additions and 0 deletions.
180 changes: 180 additions & 0 deletions docs/08-upgrading/04-upgrade-to-two-point-two.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
# Upgrade to 2.2

Serverpod 2.2 includes new test tools that make it very easy to create tests for endpoint methods. For new projects they are configured by default, but existing projects need to go through some steps to enable it (see below). The full documentation of this feature can also be found [here](../concepts/testing/get-started).

## Add test tools to existing projects

For existing non-Mini projects, a few extra things need to be done:

1. Add the `server_test_tools_path` key with the value `test/integration/test_tools` to `config/generator.yaml`:

```yaml
server_test_tools_path: test/integration/test_tools
```
Without this key, the test tools file is not generated. With the above config the location of the test tools file is `test/integration/test_tools/serverpod_test_tools.dart`, but this can be set to any folder (though should be outside of `lib` as per Dart's test conventions).

2. New projects now come with a test profile in `docker-compose.yaml`. This is not strictly mandatory, but is recommended to ensure that the testing state is never polluted. Add the snippet below to the `docker-compose.yaml` file in the server directory:

Check failure on line 17 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]

```yaml
# Add to the existing services
postgres_test:
image: postgres:16.3
ports:
- '9090:5432'
environment:
POSTGRES_USER: postgres
POSTGRES_DB: <projectname>_test
POSTGRES_PASSWORD: "<insert database test password>"
volumes:
- <projectname>_test_data:/var/lib/postgresql/data
profiles:
- '' # Default profile
- test
redis_test:
image: redis:6.2.6
ports:
- '9091:6379'
command: redis-server --requirepass "<insert redis test password>"
environment:
- REDIS_REPLICATION_MODE=master
profiles:
- '' # Default profile
- test
volumes:
# ...
<projectname>_test_data:
```

<details>

Check failure on line 49 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Inline HTML [Element: details]
<summary>Or copy the complete file here.</summary>

Check failure on line 50 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Inline HTML [Element: summary]
<p>

Check failure on line 51 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Inline HTML [Element: p]

```yaml
services:
# Development services
postgres:
image: postgres:16.3
ports:
- '8090:5432'
environment:
POSTGRES_USER: postgres
POSTGRES_DB: <projectname>
POSTGRES_PASSWORD: "<insert database development password>"
volumes:
- <projectname>_data:/var/lib/postgresql/data
profiles:
- '' # Default profile
- dev
redis:
image: redis:6.2.6
ports:
- '8091:6379'
command: redis-server --requirepass "<insert redis development password>"
environment:
- REDIS_REPLICATION_MODE=master
profiles:
- '' # Default profile
- dev
# Test services
postgres_test:
image: postgres:16.3
ports:
- '9090:5432'
environment:
POSTGRES_USER: postgres
POSTGRES_DB: <projectname>_test
POSTGRES_PASSWORD: "<insert database test password>"
volumes:
- <projectname>_test_data:/var/lib/postgresql/data
profiles:
- '' # Default profile
- test
redis_test:
image: redis:6.2.6
ports:
- '9091:6379'
command: redis-server --requirepass "<insert redis test password>"
environment:
- REDIS_REPLICATION_MODE=master
profiles:
- '' # Default profile
- test
volumes:
<projectname>_data:
<projectname>_test_data:
```

</p>
</details>
3. Create a `test.yaml` file and add it to the `config` directory:

```yaml
# This is the configuration file for your test environment.
# All ports are set to zero in this file which makes the server find the next available port.
# This is needed to enable running tests concurrently. To set up your server, you will
# need to add the name of the database you are connecting to and the user name.
# The password for the database is stored in the config/passwords.yaml.
# Configuration for the main API test server.
apiServer:
port: 0
publicHost: localhost
publicPort: 0
publicScheme: http
# Configuration for the Insights test server.
insightsServer:
port: 0
publicHost: localhost
publicPort: 0
publicScheme: http
# Configuration for the web test server.
webServer:
port: 0
publicHost: localhost
publicPort: 0
publicScheme: http
# This is the database setup for your test server.
database:
host: localhost
port: 9090
name: <projectname>_test
user: postgres
# This is the setup for your Redis test instance.
redis:
enabled: false
host: localhost
port: 9091
```

4. Add this entry to `config/passwords.yaml`

Check failure on line 156 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]

```yaml
test:
database: '<insert database test password>'
redis: '<insert redis test password>'
```

5. Add a `dart_test.yaml` file to the `server` directory (next to `pubspec.yaml`) with the following contents:

Check failure on line 164 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]

```yaml
tags:
integration: {}
```

6. Finally, add the `test` and `serverpod_test` packages as dev dependencies in `pubspec.yaml`:

Check failure on line 172 in docs/08-upgrading/04-upgrade-to-two-point-two.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1]

```yaml
dev_dependencies:
serverpod_test: <serverpod version> # Should be same version as the `serverpod` package
test: ^1.24.2
```
That's it, the project setup should be ready to start using the test tools!

0 comments on commit cb1976e

Please sign in to comment.