tests

Repo with system and integration tests that can be used across different Supabase services to check if everything works together.

test-reports

• supabase-integration local

  • new report (js/ts): https://supabase.github.io/test-reports/integration-local

• platform-verification

  • stage: https://supabase.github.io/test-reports/verification-stage
  • prod: https://supabase.github.io/test-reports/verification-prod

Repo structure

gh-bugs-project

Script to sync new GitHub issues with GitHub Project. Script is running hourly by cron as GH workflow.

src

Common actions and scripts. Includes auth related functions, some common fetch enhancements to add retries and timeout. Also Supabase Project related scripts, such as project creation, deletion, pause and restore, apply simple migrations.

verification

Few tests that check via Supabase platform UI and API routes used by dashboard that platform works correctly.

integration

Tests that check if supabase-js client library works correctly with Supabase services. Can be run against local setup using docker-compose or supabase-cli, and against production supabase project.

restore

Additional tests that check if Supabase project works correctly after pause and restore procedure. Preparation steps (to run before pause-restore) should be placed in preparations directory, it will be run all together before project is paused. And then after project is restored, tests will run.

This may not be the best practice, but it significantly increases tests speed, because pause and restore action will be run only once.

frontend

Tests for supabase dashboard. Place for e2e and integration tests.

---

How to run

To run locally you need to download .env files from Bitwarden for the environment you are going to use: either staging or prod. Put these in the root directory in .env.staging or .env.prod.

Run npm install to install dependencies. And then run npm install in each project you want to run tests from.

integration tests

To run integration tests against staging or prod environment you have to create a project first:

NODE_ENV=staging npm run project:create
cp .env .env.migrate
npm run project:migrate
cp .env integration/.env.staging

NODE_ENV=prod npm run project:create
cp .env .env.migrate
npm run project:migrate
cp .env integration/.env.prod

Then go to the integration tests folder cd integration and run npm run test:stage or npm run test:prod.

Cleanup

Don't forget to delete project after you've done with it:

NODE_ENV=prod npm run project:delete

NODE_ENV=staging npm run project:delete

frontend tests

Make sure you've got .env.prod and/or .env.staging from Bitwarden in the root directory. Then:

1. Navigate to /frontend
2. npm i
3. npx playwright install --with-deps to install browsers for Playwright
4. Navigate back to the root directory
5. Run either: npm run test:frontend:stage or npm run test:frontend:prod

To run tests against vercel preview build just change the following env in .env.staging:

SUPA_DASHBOARD='https://supabase-studio-staging-...-supabase.vercel.app'

This will open the Playwright interface (expect 10-20s delay). When that opens hit the Play button for specific tests, or the one on top for "Run all".

Additional notes

• The Playwright UI session is limited to 10 minutes only, as the gotrue token will expire after. When you get logged out, just close the UI and rer-run npm run test:frontend:stage/prod

• To clean old browser context folders that conquered your workspace run:

  npm run browserCtx:clean