云数据库 PostgreSQL pgTAP

二、前提条件

·v17.10_r1.19、v18.4_r1.10及以上版本。

·需要 plpgsql 扩展（默认已安装）。

四、步骤1：安装扩展

CREATE EXTENSION IF NOT EXISTS pgtap;

五、步骤2：验证安装

postgres=# SELECT extname, extversion FROM pg_extension WHERE extname = 'pgtap'; extname | extversion ———+———— pgtap | 1.3.4(1 row)

如需安装到指定 Schema：

CREATE EXTENSION pgtap SCHEMA tap;

七、测试计划

每个测试套件以 plan() 开始，指定预期的测试数量，以 finish() 结束：

SELECT plan(3); — 声明将运行 3 个测试– … 测试用例 …SELECT * FROM finish();

如果不确定测试数量，可以使用 no_plan()：

SELECT no_plan();– … 任意数量的测试用例 …SELECT * FROM finish();

八、测试结果格式

每个断言输出一行 TAP 格式的结果：

ok 1 – 测试描述not ok 2 – 失败的测试描述

十一、ok( boolean, description )

最基础的断言函数，当表达式为 true 时测试通过。

SELECT ok(1 + 1 = 2, '1 加 1 等于 2');

输出：

ok 1 – 1 加 1 等于 2

十二、is( got, expected, description )

判断两个值是否相等。

SELECT is( (SELECT count(*)::int FROM pg_tables WHERE schemaname = 'public'), 5, 'public schema 应有 5 张表');

十三、cmp_ok( got, operator, expected, description )

使用指定的操作符比较两个值。

SELECT cmp_ok( (SELECT count(*)::int FROM orders), '>=', 100, '订单数应不少于 100');

十四、matches( got, pattern, description )

正则匹配断言。

SELECT matches( (SELECT version()), 'PostgreSQL 1[4-9]', '版本号应为 PostgreSQL 14-19');

十六、表相关

示例：

BEGIN;SELECT plan(5);– 创建测试表CREATE TABLE users ( id serial PRIMARY KEY, email text NOT NULL, created_at timestamptz DEFAULT now());– 验证 users 表结构SELECT has_table('public', 'users', 'users 表应存在');SELECT has_column('users', 'id', 'users 表应有 id 列');SELECT col_type_is('users', 'id', 'integer', 'id 列应为 integer 类型');SELECT col_not_null('users', 'email', 'email 列应有非空约束');SELECT col_has_default('users', 'created_at', 'created_at 应有默认值');SELECT * FROM finish();ROLLBACK;

输出：

1..5ok 1 – users 表应存在ok 2 – users 表应有 id 列ok 3 – id 列应为 integer 类型ok 4 – email 列应有非空约束ok 5 – created_at 应有默认值

十七、索引相关

SELECT has_pk('users', 'users 表应有主键');SELECT has_index('users', 'idx_users_email', 'users 表应有 email 索引');

十八、函数/存储过程相关

SELECT has_function( 'public', 'calculate_total', ARRAY['integer'], 'calculate_total(int) 函数应存在');SELECT function_returns( 'public', 'calculate_total', ARRAY['integer'], 'numeric', '函数应返回 numeric 类型');

十九、触发器相关

SELECT has_trigger('orders', 'trg_orders_updated', '应有更新触发器');

20、扩展相关

SELECT has_extension('pgtap', 'pgtap 扩展应已安装');SELECT has_schema('public', 'public schema 应存在');

22、results_eq( sql1, sql2, description )

断言两个查询的结果集完全相同（含顺序）。

SELECT results_eq( 'SELECT id, name FROM users ORDER BY id LIMIT 2', VALUES(1,′alice′),(2,′bob′), '前两个用户应为 alice 和 bob');

23、set_eq( sql1, sql2, description )

断言两个查询的结果集相同（不考虑顺序）。

SELECT set_eq( 'SELECT name FROM departments', VALUES(′Engineering′),(′Marketing′),(′Sales′), '应有三个部门');

24、bag_eq( sql1, sql2, description )

断言两个结果集包含相同的行（允许重复，不考虑顺序）。

25、set_has( sql1, sql2, description )

断言第一个结果集包含第二个结果集的所有行。

SELECT set_has( 'SELECT name FROM users', VALUES(′admin′), '用户列表应包含 admin');

27、throws_ok( sql, errcode, errmsg, description )

断言 SQL 执行会抛出指定的异常。

SELECT throws_ok( 'INSERT INTO users (id, name) VALUES (1, NULL)', '23502', NULL, '插入空 name 应触发非空约束违反');

28、lives_ok( sql, description )

断言 SQL 可以正常执行不抛异常。

SELECT lives_ok( 'SELECT 1', 'SELECT 1 应正常执行');

29、完整测试示例

以下是一个完整的、自包含的测试脚本示例，展示了 pgTAP 的典型用法：

— test_user_module.sqlBEGIN;– ========== 0. 创建测试对象 ==========CREATE TABLE users ( id serial PRIMARY KEY, email text NOT NULL, created_at timestamptz DEFAULT now());CREATE OR REPLACE FUNCTION get_user_name(p_id integer)RETURNS textLANGUAGE plpgsql AS $$DECLARE v_email text;BEGIN SELECT email INTO v_email FROM users WHERE id = p_id; RETURN coalesce(v_email, '<unknown>');END;$$;SELECT plan(12);– ========== 1. Schema 验证 ==========SELECT has_table('public', 'users', 'users 表应存在');SELECT has_column('users', 'id', '应有 id 列');SELECT has_column('users', 'email', '应有 email 列');SELECT has_column('users', 'created_at', '应有 created_at 列');SELECT col_type_is('users', 'id', 'integer', 'id 应为 integer');SELECT col_not_null('users', 'email', 'email 非空');SELECT has_pk('users', '应有主键');– ========== 2. 函数验证 ==========SELECT has_function('public', 'get_user_name', ARRAY['integer'], 'get_user_name(int) 存在');SELECT function_returns('public', 'get_user_name', ARRAY['integer'], 'text', '返回 text');– ========== 3. 数据验证 ==========SELECT cmp_ok( (SELECT count(*)::int FROM users), '>=', 0, 'users 表行数 >= 0');– ========== 4. 结果集验证 ==========SELECT results_eq( 'SELECT 1 + 1', 'SELECT 2', '1+1 应等于 2');– ========== 5. 异常验证 ==========SELECT throws_ok( SELECT1/0, '22012', NULL, '除零应抛异常');SELECT * FROM finish();ROLLBACK;

30、运行测试

psql -d mydb -f test_user_module.sql

预期输出：

1..12ok 1 – users 表应存在ok 2 – 应有 id 列ok 3 – 应有 email 列ok 4 – 应有 created_at 列ok 5 – id 应为 integerok 6 – email 非空ok 7 – 应有主键ok 8 – get_user_name(int) 存在ok 9 – 返回 textok 10 – users 表行数 >= 0ok 11 – 1+1 应等于 2ok 12 – 除零应抛异常

31、常用断言函数速查表