mirror of
https://github.com/supabase/supabase.git
synced 2026-10-15 22:29:11 +03:00
Joshen Lim
ca37f16f58
* Set up E2E tests for staging * update * Update * Update .env.staging.example * Fix node modules * Fix * Attempt to swap local-studio-tests to use the new studio-tests directory * Omit storage state if running tests for local self host * Fix test:local command * Deprecate local-studio-test folder * Rename local studio tests GH action to E2E test
49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# Studio E2E Tests
|
|
|
|
In an effort to make the local + hosted studio more stable, we've added tests which test features which are commonly used in local
|
|
development. Built with [Playwright](https://playwright.dev/docs/intro).
|
|
|
|
## How to run tests
|
|
|
|
Before running the tests, make sure you've done the following:
|
|
|
|
- Run `npm install` in the root folder of this repo
|
|
- `docker` or `orbstack` is currently running
|
|
- `supabase` CLI is already [installed](https://github.com/supabase/cli?tab=readme-ov-file#install-the-cli)
|
|
- no other supabase local environment is running (infrastructure environment is ok)
|
|
|
|
You can run the tests by running `npm run test` in this folder.
|
|
|
|
When you run the command, it includes:
|
|
|
|
1. Setting up the local environment using the `supabase` CLI
|
|
2. Extracting the environment variables and saving them into a `.env.test` file in the studio app
|
|
3. Running the `studio` app in dev mode (`npm run dev`)
|
|
4. Running the tests
|
|
5. Stopping the `studio` app and the local environment
|
|
|
|
If the environment does't stop for some reason, you'll see `supabase start is already running` on the next run. In this
|
|
case, just run `supabase stop` between test runs.
|
|
|
|
## How to write tests
|
|
|
|
Playwright has a nice [Codegen tool](https://playwright.dev/docs/codegen-intro#running-codegen) which you can use to
|
|
record your actions:
|
|
|
|
```bash
|
|
pnpm codegen:setup
|
|
# in a separate terminal
|
|
pnpm codegen
|
|
```
|
|
|
|
## How to debug/fix tests
|
|
|
|
If you've run the tests locally and you want to see the results, Playwright has a [UI mode](https://playwright.dev/docs/test-ui-mode)
|
|
which you can use to run and replay specific tests:
|
|
|
|
```bash
|
|
pnpm test -- --ui
|
|
```
|
|
|
|
It will also record any failing tests when running `npm run test` in this folder.
|