Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-31 00:16:47 +01:00
Code Issues Projects Releases Wiki Activity

docs: explicitly call out how to run e2e tests in CONTRIBUTING.md (#6672)

Browse Source 
There was some confusion on how to run the e2e tests in #6447, so I'm
adding a small section to CONTRIBUTING.md to make it clearer.
This commit is contained in:
Thomas Heartman 2024-04-04 11:45:22 +02:00 committed by GitHub
parent 6d4060d8d2
commit 99a32a4265
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -148,6 +148,16 @@ If you can't connect to the docker container, check its status by running `docke
To fix this, start a new container and make sure you give it the `-p 5432:5432` option.
### Running end-to-end (e2e) tests
To run the e2e tests, you'll need a running Postgres instance that you can connect to. The easiest way to set this up is to use Docker. This command starts a Postgres instance with the required configuration (according to the details in `src/test/e2e/helpers/database-config.ts`):
```sh
docker run --name unleash-postgres -p 5432:5432 -e POSTGRES_USER=unleash_user -e POSTGRES_PASSWORD=password -e POSTGRES_DB=unleash_test -d postgres:15
```
Unleash will attempt to connect using the connection string in `src/test/e2e/helpers/database-config.ts` or the environment variable `TEST_DATABASE_URL`.
## Nice to know
### Controllers