Skip to content

Commit ffed241

Browse files
committed
Explicitly document how to run the tests for other postgres versions
1 parent 0770fb0 commit ffed241

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -569,31 +569,33 @@ You can also [run the tests locally](#running-tests-locally) when doing local de
569569
### Running tests locally
570570

571571
> [!IMPORTANT]
572-
> **Before you run the tests** you need to have this software installed:
573-
> - [mise](https://mise.jdx.dev/) — see the [installing mise](#installing-mise) instructions
574-
> - [Docker](https://www.docker.com/) — see Docker's [documentation for installing](https://docs.docker.com/get-started/get-docker/)
572+
> **Before you run the tests locally** you need to [set up a local dev environment](#developing).
575573
576-
To run tests locally:
574+
To run tests locally with PostgreSQL 17:
577575

578576
``` shell
579-
# Clone the repo
580-
git clone https://github.com/cipherstash/encrypt-query-language
581-
cd encrypt-query-language
582-
583-
# Install dependencies
584-
mise trust --yes
585-
586-
# Start a postgres instance
587-
mise run postgres:up postgres-17 --extra-args "--detach --wait"
577+
# Start a postgres instance (defaults to PostgreSQL 17)
578+
mise run postgres:up --extra-args "--detach --wait"
588579

589-
# Run the tests
590-
mise run test --postgres 17
580+
# Run the tests (defaults to PostgreSQL 17)
581+
mise run test
591582

592583
# Stop and remove all containers and networks
593584
mise run postgres:down
594585
```
595586

596-
You can run the same tasks for Postgres 14, 15, 16, and 17.
587+
You can run the same tasks for Postgres 14, 15, 16, and 17 by specifying arguments:
588+
589+
```shell
590+
# Start a postgres 14 instance
591+
mise run postgres:up postgres-14 --extra-args "--detach --wait"
592+
593+
# Run the tests against postgres 14
594+
mise run test --postgres 14
595+
596+
# Stop postgres and remove all containers and networks
597+
mise run postgres:down
598+
```
597599

598600
The configuration for the Postgres containers in `tests/docker-compose.yml`.
599601

0 commit comments

Comments
 (0)