Zuvo Docs

Guide

Testing Your Database

Test your database schema, tables, functions, and policies.

To ensure that queries return the expected data, RLS policies are correctly applied and etc., we encourage you to write automated tests. There are essentially two approaches to testing:

  • Firstly, you can write tests that interface with a Zuvo client instance (same way you use Zuvo client in your application code) in the programming language(s) you use in your application and using your favorite testing framework.

  • Secondly, you can test through the Zuvo CLI, which is a more low-level approach where you write tests in SQL.

Testing using the Zuvo CLI

You can use the Zuvo CLI to test your database. The minimum required version of the CLI is v1.11.4. To get started:

Creating a test

Create a tests folder inside the supabase folder:

mkdir -p ./supabase/tests/database

Create a new file with the .sql extension which will contain the test.

touch ./supabase/tests/database/hello_world_test.sql

Writing tests

All sql files use pgTAP as the test runner.

Write a test to check that our auth.users table has an ID column. Open hello_world_test.sql and add the following code:

begin;
select plan(1); -- only one statement to run

SELECT has_column(
    'auth',
    'users',
    'id',
    'id should exist'
);

select * from finish();
rollback;

Running tests

To run the test, you can use:

supabase test db

This will produce the following output:

$ supabase test db
supabase/tests/database/hello_world_test.sql .. ok
All tests successful.
Files=1, Tests=1,  1 wallclock secs ( 0.01 usr  0.00 sys +  0.04 cusr  0.02 csys =  0.07 CPU)
Result: PASS

More resources