高级 pgTAP 测试
虽然基本的 pgTAP 提供了出色的测试功能,但你可以使用数据库开发工具和辅助包来增强测试流程。本指南介绍了使用 database.dev 和社区维护的测试辅助工具的高级测试技巧。
🌐 While basic pgTAP provides excellent testing capabilities, you can enhance the testing workflow using database development tools and helper packages. This guide covers advanced testing techniques using database.dev and community-maintained test helpers.
使用 database.dev #
🌐 Using database.dev
Database.dev 是一个针对 Postgres 的包管理器,允许安装和使用社区维护的包,包括测试工具。
设置 dbdev #
🌐 Setting up dbdev
要使用数据库开发工具和软件包,请先安装一些前提条件:
🌐 To use database development tools and packages, install some prerequisites:
create extension if not exists http with schema extensions;create extension if not exists pg_tle;drop extension if exists "supabase-dbdev";select pgtle.uninstall_extension_if_exists('supabase-dbdev');select pgtle.install_extension( 'supabase-dbdev', resp.contents ->> 'version', 'PostgreSQL package manager', resp.contents ->> 'sql' )from extensions.http( ( 'GET', 'https://api.database.dev/rest/v1/' || 'package_versions?select=sql,version' || '&package_name=eq.supabase-dbdev' || '&order=version.desc' || '&limit=1', array[ ('apiKey', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhtdXB0cHBsZnZpaWZyYndtbXR2Iiwicm9sZSI6ImFub24iLCJpYXQiOjE2ODAxMDczNzIsImV4cCI6MTk5NTY4MzM3Mn0.z2CN0mvO2No8wSi46Gw59DFGCTJrzM0AQKsu_5k134s')::extensions.http_header ], null, null )) x,lateral ( select ((row_to_json(x) -> 'content') #>> '{}')::json -> 0) resp(contents);create extension "supabase-dbdev";select dbdev.install('supabase-dbdev');-- Drop and recreate the extension to ensure a clean installationdrop extension if exists "supabase-dbdev";create extension "supabase-dbdev";安装测试助手 #
🌐 Installing test helpers
Test Helpers 包提供了一些工具,用来简化 Supabase 特定功能的测试:
🌐 The Test Helpers package provides utilities that simplify testing Supabase-specific features:
select dbdev.install('basejump-supabase_test_helpers');create extension if not exists "basejump-supabase_test_helpers" version '0.0.6';测试助手的好处 #
🌐 Test helper benefits
测试辅助包相比直接写原生 pgTAP 测试有几个好处:
🌐 The test helpers package provides several advantages over writing raw pgTAP tests:
- 简化用户管理
- 用
tests.create_supabase_user()创建测试用户 - 用
tests.authenticate_as()切换上下文 - 使用
tests.get_supabase_uid()获取用户 ID
- 用
- 行级安全 (RLS) 测试工具
- 用
tests.rls_enabled()检查 RLS 状态 - 测试政策执行
- 模拟不同的用户场景
- 用
- 减少模板代码
- 不需要手动插入 auth.users
- 简化的 JWT 声明管理
- 清理测试设置和收尾
架构范围的行级安全性测试 #
🌐 Schema-wide Row Level Security testing
在使用行级安全时,确保所有需要的表都启用了 RLS 非常重要。创建一个基本测试来验证整个架构中是否都启用了 RLS:
🌐 When working with Row Level Security, it's crucial to ensure that RLS is enabled on all tables that need it. Create a basic test to verify RLS is enabled across an entire schema:
begin;select plan(1);-- Verify RLS is enabled on all tables in the public schemaselect tests.rls_enabled('public');select * from finish();rollback;测试文件整理 #
🌐 Test file organization
在处理多个共享相同设置要求的测试文件时,创建一个单独的“预测试”文件来处理全局环境设置会很有用。这种方法可以减少重复操作,并确保测试环境一致。
🌐 When working with multiple test files that share common setup requirements, it's beneficial to create a single "pre-test" file that handles the global environment setup. This approach reduces duplication and ensures consistent test environments.
创建一个预测试钩子 #
🌐 Creating a pre-test hook
由于 pgTAP 测试文件是按字母顺序执行的,所以可以创建一个通过使用像 000-setup-tests-hooks.sql 这样的命名约定来最先运行的设置文件:
🌐 Since pgTAP test files are executed in alphabetical order, create a setup file that runs first by using a naming convention like 000-setup-tests-hooks.sql:
supabase test new 000-setup-tests-hooks这个安装文件应该包含:
🌐 This setup file should contain:
- 所有共享的扩展和依赖
- 常用测试工具
- 一个基本的常绿测试来验证设置
这是一个示例设置文件:
🌐 Here's an example setup file:
-- install tests utilities-- install pgtap extension for testingcreate extension if not exists pgtap with schema extensions;/*------------------------- install dbdev --------------------------Requires: - pg_tle: https://github.com/aws/pg_tle - pgsql-http: https://github.com/pramsey/pgsql-http*/create extension if not exists http with schema extensions;create extension if not exists pg_tle;drop extension if exists "supabase-dbdev";select pgtle.uninstall_extension_if_exists('supabase-dbdev');select pgtle.install_extension( 'supabase-dbdev', resp.contents ->> 'version', 'PostgreSQL package manager', resp.contents ->> 'sql' )from extensions.http( ( 'GET', 'https://api.database.dev/rest/v1/' || 'package_versions?select=sql,version' || '&package_name=eq.supabase-dbdev' || '&order=version.desc' || '&limit=1', array[ ('apiKey', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhtdXB0cHBsZnZpaWZyYndtbXR2Iiwicm9sZSI6ImFub24iLCJpYXQiOjE2ODAxMDczNzIsImV4cCI6MTk5NTY4MzM3Mn0.z2CN0mvO2No8wSi46Gw59DFGCTJrzM0AQKsu_5k134s')::extensions.http_header ], null, null )) x,lateral ( select ((row_to_json(x) -> 'content') #>> '{}')::json -> 0) resp(contents);create extension "supabase-dbdev";select dbdev.install('supabase-dbdev');drop extension if exists "supabase-dbdev";create extension "supabase-dbdev";-- Install test helpersselect dbdev.install('basejump-supabase_test_helpers');create extension if not exists "basejump-supabase_test_helpers" version '0.0.6';-- Verify setup with a no-op testbegin;select plan(1);select ok(true, 'Pre-test hook completed successfully');select * from finish();rollback;好处 #
🌐 Benefits
这种方法有几个好处:
🌐 This approach provides several advantages:
- 减少测试文件中的代码重复
- 确保测试环境设置一致
- 让维护和更新共享依赖更容易
- 如果设置过程失败,会立即反馈
你后续的测试文件(001-auth-tests.sql,002-rls-tests.sql)可以只专注于它们的特定测试用例,因为环境已经正确配置好了。
🌐 Your subsequent test files (001-auth-tests.sql, 002-rls-tests.sql) can focus solely on their specific test cases, knowing that the environment is properly configured.
示例:高级RLS测试 #
🌐 Example: Advanced RLS testing
这是一个完整的示例,使用测试辅助工具来验证 RLS 策略,把所有步骤整合在一起:
🌐 Here's a complete example using test helpers to verify RLS policies putting it all together:
begin;-- Assuming 000-setup-tests-hooks.sql file is present to use tests helpersselect plan(4);-- Set up test data-- Create test supabase usersselect tests.create_supabase_user('user1@test.com');select tests.create_supabase_user('user2@test.com');-- Create test datainsert into public.todos (task, user_id) values ('User 1 Task 1', tests.get_supabase_uid('user1@test.com')), ('User 1 Task 2', tests.get_supabase_uid('user1@test.com')), ('User 2 Task 1', tests.get_supabase_uid('user2@test.com'));-- Test as User 1select tests.authenticate_as('user1@test.com');-- Test 1: User 1 should only see their own todosselect results_eq( 'select count(*) from todos', ARRAY[2::bigint], 'User 1 should only see their 2 todos');-- Test 2: User 1 can create their own todoselect lives_ok( $$insert into todos (task, user_id) values ('New Task', tests.get_supabase_uid('user1@test.com'))$$, 'User 1 can create their own todo');-- Test as User 2select tests.authenticate_as('user2@test.com');-- Test 3: User 2 should only see their own todosselect results_eq( 'select count(*) from todos', ARRAY[1::bigint], 'User 2 should only see their 1 todo');-- Test 4: User 2 cannot modify User 1's todoSELECT results_ne( $$ update todos set task = 'Hacked!' where user_id = tests.get_supabase_uid('user1@test.com') returning 1 $$, $$ values(1) $$, 'User 2 cannot modify User 1 todos');select * from finish();rollback;别又来一个待办事项应用:测试复杂组织 #
🌐 Not another todo app: Testing complex organizations
待办事项应用非常适合学习,但本节将探讨测试一个更现实的场景:多租户内容发布平台。这个例子展示了如何测试复杂的权限、计划限制和内容管理。
🌐 Todo apps are great for learning, but this section explores testing a more realistic scenario: a multi-tenant content publishing platform. This example demonstrates testing complex permissions, plan restrictions, and content management.
系统概览 #
🌐 System overview
这个演示应用实现了:
🌐 This demo app implements:
- 有分级方案的组织(免费/专业/企业)
- 基于角色的访问(所有者/管理员/编辑/查看者)
- 内容管理(帖子/评论)
- 优质内容限制
- 计划上的限制
这有什么复杂的? #
🌐 What makes this complex?
- 分层权限
- 角色层级会影响访问权限
- 套餐类型会影响用户功能
- 内容状态(草稿/已发布)会影响权限
- 业务规则
- 免费计划发帖限制
- 优质内容可见性
- 跨组织安全
测试重点字段 #
🌐 Testing focus areas
写测试时,确认:
🌐 When writing tests, verify:
- 组织成员访问控制
- 不同角色的内容可见性
- 计划限制执行
- 跨组织数据隔离
1. 应用架构定义 #
🌐 1. App schema definitions
应用的架构表是这样定义的:
🌐 The app schema tables are defined like this:
create table public.profiles ( id uuid references auth.users(id) primary key, username text unique not null, full_name text, bio text, created_at timestamptz default now(), updated_at timestamptz default now());create table public.organizations ( id bigint primary key generated always as identity, name text not null, slug text unique not null, plan_type text not null check (plan_type in ('free', 'pro', 'enterprise')), max_posts int not null default 5, created_at timestamptz default now());create table public.org_members ( org_id bigint references public.organizations(id) on delete cascade, user_id uuid references auth.users(id) on delete cascade, role text not null check (role in ('owner', 'admin', 'editor', 'viewer')), created_at timestamptz default now(), primary key (org_id, user_id));create table public.posts ( id bigint primary key generated always as identity, title text not null, content text not null, author_id uuid references public.profiles(id) not null, org_id bigint references public.organizations(id), status text not null check (status in ('draft', 'published', 'archived')), is_premium boolean default false, scheduled_for timestamptz, category text, view_count int default 0, published_at timestamptz, created_at timestamptz default now(), updated_at timestamptz default now());create table public.comments ( id bigint primary key generated always as identity, post_id bigint references public.posts(id) on delete cascade, author_id uuid references public.profiles(id), content text not null, is_deleted boolean default false, created_at timestamptz default now(), updated_at timestamptz default now());2. 授予角色权限 #
🌐 2. Grant role privileges
为每个角色授予必要的权限,确保遵循最小权限原则:
🌐 Grant the necessary privileges for each role, ensuring the principle of least privilege is followed:
-- Grant the privileges that roles needGRANT SELECT ON public.profiles TO anon;GRANT SELECT, INSERT, UPDATE, DELETE ON public.profiles TO authenticated;GRANT SELECT, INSERT, UPDATE, DELETE ON public.profiles TO service_role;GRANT SELECT ON public.organizations TO anon;GRANT SELECT, INSERT, UPDATE, DELETE ON public.organizations TO authenticated;GRANT SELECT, INSERT, UPDATE, DELETE ON public.organizations TO service_role;GRANT SELECT ON public.org_members TO anon;GRANT SELECT, INSERT, UPDATE, DELETE ON public.org_members TO authenticated;GRANT SELECT, INSERT, UPDATE, DELETE ON public.org_members TO service_role;GRANT SELECT ON public.posts TO anon;GRANT SELECT, INSERT, UPDATE, DELETE ON public.posts TO authenticated;GRANT SELECT, INSERT, UPDATE, DELETE ON public.posts TO service_role;GRANT SELECT ON public.comments TO anon;GRANT SELECT, INSERT, UPDATE, DELETE ON public.comments TO authenticated;GRANT SELECT, INSERT, UPDATE, DELETE ON public.comments TO service_role;3. RLS 政策声明 #
🌐 3. RLS policies declaration
现在来为每个表设置 RLS 策略:
🌐 Now to setup the RLS policies for each tables:
-- Create a private schema to store all security definer functions utils-- As such functions should never be in an API exposed schemacreate schema if not exists private;-- Helper function for role checkscreate or replace function private.get_user_org_role(org_id bigint, user_id uuid)returns textset search_path = ''as $$ select role from public.org_members where org_id = $1 and user_id = $2;-- Note the use of security definer to avoid RLS checking recursion issue-- see: https://supabase.nodejs.cn/docs/guides/database/postgres/row-level-security#use-security-definer-functions$$ language sql security definer;-- Helper utils to check if an org is below the max post limitcreate or replace function private.can_add_post(org_id bigint)returns booleanset search_path = ''as $$ select (select count(*) from public.posts p where p.org_id = $1) < o.max_posts from public.organizations o where o.id = $1$$ language sql security definer;-- Enable RLS for all tablesalter table public.profiles enable row level security;alter table public.organizations enable row level security;alter table public.org_members enable row level security;alter table public.posts enable row level security;alter table public.comments enable row level security;-- Profiles policiescreate policy "Public profiles are viewable by everyone" on public.profiles for select using (true);create policy "Users can insert their own profile" on public.profiles for insert with check ((select auth.uid()) = id);create policy "Users can update their own profile" on public.profiles for update using ((select auth.uid()) = id) with check ((select auth.uid()) = id);-- Organizations policiescreate policy "Public org info visible to all" on public.organizations for select using (true);create policy "Org management restricted to owners" on public.organizations for all using ( private.get_user_org_role(id, (select auth.uid())) = 'owner' );-- Org Members policiescreate policy "Members visible to org members" on public.org_members for select using ( private.get_user_org_role(org_id, (select auth.uid())) is not null );create policy "Member management restricted to admins and owners" on public.org_members for all using ( private.get_user_org_role(org_id, (select auth.uid())) in ('owner', 'admin') );-- Posts policiescreate policy "Complex post visibility" on public.posts for select using ( -- Published non-premium posts are visible to all (status = 'published' and not is_premium) or -- Premium posts visible to org members only (status = 'published' and is_premium and private.get_user_org_role(org_id, (select auth.uid())) is not null) or -- All posts visible to editors and above private.get_user_org_role(org_id, (select auth.uid())) in ('owner', 'admin', 'editor') );create policy "Post creation rules" on public.posts for insert with check ( -- Must be org member with appropriate role private.get_user_org_role(org_id, (select auth.uid())) in ('owner', 'admin', 'editor') and -- Check org post limits for free plans ( (select o.plan_type != 'free' from organizations o where o.id = org_id) or (select private.can_add_post(org_id)) ) );create policy "Post update rules" on public.posts for update using ( exists ( select 1 where -- Editors can update non-published posts (private.get_user_org_role(org_id, (select auth.uid())) = 'editor' and status != 'published') or -- Admins and owners can update any post private.get_user_org_role(org_id, (select auth.uid())) in ('owner', 'admin') ) );-- Comments policiescreate policy "Comments on published posts are viewable by everyone" on public.comments for select using ( exists ( select 1 from public.posts where id = post_id and status = 'published' ) and not is_deleted );create policy "Authenticated users can create comments" on public.comments for insert with check ((select auth.uid()) = author_id);create policy "Users can update their own comments" on public.comments for update using (author_id = (select auth.uid()));4. 测试用例: #
🌐 4. Test cases:
设置完成后,编写 RLS 测试用例。每个部分可以放在自己的测试中:
🌐 With setup complete, write RLS test cases. Each section can be in its own test:
-- Assuming we already have: 000-setup-tests-hooks.sql file we can use tests helpersbegin;-- Declare total number of testsselect plan(10);-- Create test usersselect tests.create_supabase_user('org_owner', 'owner@test.com');select tests.create_supabase_user('org_admin', 'admin@test.com');select tests.create_supabase_user('org_editor', 'editor@test.com');select tests.create_supabase_user('premium_user', 'premium@test.com');select tests.create_supabase_user('free_user', 'free@test.com');select tests.create_supabase_user('scheduler', 'scheduler@test.com');select tests.create_supabase_user('free_author', 'free_author@test.com');-- Create profiles for test usersinsert into profiles (id, username, full_name)values (tests.get_supabase_uid('org_owner'), 'org_owner', 'Organization Owner'), (tests.get_supabase_uid('org_admin'), 'org_admin', 'Organization Admin'), (tests.get_supabase_uid('org_editor'), 'org_editor', 'Organization Editor'), (tests.get_supabase_uid('premium_user'), 'premium_user', 'Premium User'), (tests.get_supabase_uid('free_user'), 'free_user', 'Free User'), (tests.get_supabase_uid('scheduler'), 'scheduler', 'Scheduler User'), (tests.get_supabase_uid('free_author'), 'free_author', 'Free Author');-- First authenticate as service role to bypass RLS for initial setupselect tests.authenticate_as_service_role();-- Create test organizations and setup datawith new_org as ( insert into organizations (name, slug, plan_type, max_posts) values ('Test Org', 'test-org', 'pro', 100), ('Premium Org', 'premium-org', 'enterprise', 1000), ('Schedule Org', 'schedule-org', 'pro', 100), ('Free Org', 'free-org', 'free', 2) returning id, slug),-- Setup members and postsmember_setup as ( insert into org_members (org_id, user_id, role) select org.id, user_id, role from new_org org cross join ( values (tests.get_supabase_uid('org_owner'), 'owner'), (tests.get_supabase_uid('org_admin'), 'admin'), (tests.get_supabase_uid('org_editor'), 'editor'), (tests.get_supabase_uid('premium_user'), 'viewer'), (tests.get_supabase_uid('scheduler'), 'editor'), (tests.get_supabase_uid('free_author'), 'editor') ) as members(user_id, role) where org.slug = 'test-org' or (org.slug = 'premium-org' and role = 'viewer') or (org.slug = 'schedule-org' and role = 'editor') or (org.slug = 'free-org' and role = 'editor'))-- Setup initial postsinsert into posts (title, content, org_id, author_id, status, is_premium, scheduled_for)select title, content, org.id, author_id, status, is_premium, scheduled_forfrom new_org org cross join ( values ('Premium Post', 'Premium content', tests.get_supabase_uid('premium_user'), 'published', true, null), ('Free Post', 'Free content', tests.get_supabase_uid('premium_user'), 'published', false, null), ('Future Post', 'Future content', tests.get_supabase_uid('scheduler'), 'published', false, '2024-01-02 12:00:00+00'::timestamptz)) as posts(title, content, author_id, status, is_premium, scheduled_for)where org.slug in ('premium-org', 'schedule-org');-- Test owner privilegesselect tests.authenticate_as('org_owner');select lives_ok( $$ update organizations set name = 'Updated Org' where id = (select id from organizations limit 1) $$, 'Owner can update organization');-- Test admin privilegesselect tests.authenticate_as('org_admin');select results_eq( $$select count(*) from org_members$$, ARRAY[6::bigint], 'Admin can view all members');-- Test editor restrictionsselect tests.authenticate_as('org_editor');select throws_ok( $$ insert into org_members (org_id, user_id, role) values ( (select id from organizations limit 1), (select tests.get_supabase_uid('org_editor')), 'viewer' ) $$, '42501', 'new row violates row-level security policy for table "org_members"', 'Editor cannot manage members');-- Premium Content Access Testsselect tests.authenticate_as('premium_user');select results_eq( $$select count(*) from posts where org_id = (select id from organizations where slug = 'premium-org')$$, ARRAY[3::bigint], 'Premium user can see all posts');select tests.clear_authentication();select results_eq( $$select count(*) from posts where org_id = (select id from organizations where slug = 'premium-org')$$, ARRAY[2::bigint], 'Anonymous users can only see free posts');-- Time-Based Publishing Testsselect tests.authenticate_as('scheduler');select tests.freeze_time('2024-01-01 12:00:00+00'::timestamptz);select results_eq( $$select count(*) from posts where scheduled_for > now() and org_id = (select id from organizations where slug = 'schedule-org')$$, ARRAY[1::bigint], 'Can see scheduled posts');select tests.freeze_time('2024-01-02 13:00:00+00'::timestamptz);select results_eq( $$select count(*) from posts where scheduled_for < now() and org_id = (select id from organizations where slug = 'schedule-org')$$, ARRAY[1::bigint], 'Can see posts after schedule time');select tests.unfreeze_time();-- Plan Limit Testsselect tests.authenticate_as('free_author');select lives_ok( $$ insert into posts (title, content, org_id, author_id, status) select 'Post 1', 'Content 1', id, auth.uid(), 'draft' from organizations where slug = 'free-org' limit 1 $$, 'First post creates successfully');select lives_ok( $$ insert into posts (title, content, org_id, author_id, status) select 'Post 2', 'Content 2', id, auth.uid(), 'draft' from organizations where slug = 'free-org' limit 1 $$, 'Second post creates successfully');select throws_ok( $$ insert into posts (title, content, org_id, author_id, status) select 'Post 3', 'Content 3', id, auth.uid(), 'draft' from organizations where slug = 'free-org' limit 1 $$, '42501', 'new row violates row-level security policy for table "posts"', 'Cannot exceed free plan post limit');select * from finish();rollback;额外资源 #
🌐 Additional resources