11、PostgreSQL测试框架实战指南

最新推荐文章于 2026-06-29 10:25:12 发布

原创最新推荐文章于 2026-06-29 10:25:12 发布 · 228 阅读 GEO检测

代码可运行

PostgreSQL实战：从入门到精通专栏收录该内容

15 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

PostgreSQL测试框架实战指南

1. 引言

在现代数据库开发和管理中，测试框架扮演着至关重要的角色。通过自动化测试，我们可以确保数据库系统的稳定性和可靠性。本文将详细介绍如何为现有的存储过程编写自动化测试，或使用单元测试和测试驱动开发（TDD）的概念来开发新的存储过程。所有测试用例都存储在数据库中，因此不需要外部资源（如文件、版本控制系统和命令行工具）来保存测试。每个测试用例可以有自己的环境初始化代码，但所有测试仍然独立执行，因为它们的效果会在执行后自动回滚。

2. 使用pgTAP编写单元测试

pgTAP是一个功能强大的单元测试框架，广泛应用于PostgreSQL数据库的测试。它提供了多种用于用例测试的函数，并且其输出格式为TAP（Test Anything Protocol），非常适合用于收集、分析和报告测试结果。

2.1 安装pgTAP

要为PostgreSQL RDS设置pgTAP，我们需要执行以下步骤：

使用pgAdmin连接到我们在AWS上的ATM RDS，并选择ATM数据库。
导航到顶部菜单栏，点击工具 | 查询工具，然后通过点击工具栏上的图标来执行以下SQL语句：

CREATE SCHEMA IF NOT EXISTS pgTAP;
CREATE EXTENSION IF NOT EXISTS pgTAP WITH SCHEMA pgTAP;

图11.1展示了pgTAP的安装过程。

图11.1 – AWS RDS的pgTAP安装过程

2.2 pgTAP测试示例

在编写测试用例之前，我们需要制定一个测试计划。这可以通过调用 plan() 函数来声明测试的数量，以防止过早失败。例如：

SET search_path TO pgTAP;
SELECT plan(1);
SELECT is_empty('select "ID" from public."ATM locations" where "ZipCode" NOT IN (select "zip" from public."Zip coordinates") LIMIT 1', 'Check if the ATM locations inside the ATM database are not empty');
SELECT * FROM finish();

这段代码确保了ATM位置表中的所有记录都存在于邮政坐标表中。

3. 使用PGUnit编写单元测试

尽管PGUnit不像pgTAP那样频繁更新，但它凭借其简单性和标准化，仍然是一个有效的测试工具。我们可以使用它在pgAdmin中编写和运行测试用例。

3.1 安装PGUnit

要为PostgreSQL RDS设置PGUnit，请按照以下步骤操作：

打开PGUnit的安装脚本链接： PGUnit安装脚本。
复制脚本内容并在pgAdmin中执行。

图11.5展示了PGUnit的安装脚本。

图11.5 – PGUnit安装脚本

3.2 PGUnit测试示例

下面是一个简单的PGUnit测试用例，用于验证ATM位置表是否为空：

BEGIN;
CREATE OR REPLACE FUNCTION test_atm_locations_not_empty()
RETURNS void AS $$
BEGIN
    PERFORM * FROM public."ATM locations";
    IF NOT FOUND THEN
        RAISE EXCEPTION 'ATM locations table is empty';
    END IF;
END;
$$ LANGUAGE plpgsql;
COMMIT;

此测试用例确保了ATM位置表中至少有一条记录。

4. 使用Python进行测试 – Testgres

Testgres是一个基于Python的测试框架，旨在简化PostgreSQL的测试过程。它不仅可以管理Postgres集群，还能执行初始化、编辑配置文件、启动/停止集群以及执行查询等操作。

4.1 安装Testgres

要在Jenkins Ubuntu服务器上安装Testgres，请执行以下步骤：

打开SSH连接到Jenkins服务器，并以管理员身份启动PowerShell。
安装pip3：

sudo apt install -y python3-pip

安装Testgres：

sudo pip3 install testgres

图11.16展示了Testgres的安装过程。

图11.16 – Testgres安装

4.2 Testgres测试示例

下面是一个简单的Testgres测试用例，用于验证PostgreSQL节点的状态：

from testgres import get_new_node

node = get_new_node('test_node')
node.init()
node.start()

# 执行查询并获取结果
result = node.safe_psql("SELECT 1")
print(f"Query Result: {result}")

node.stop()

这段代码展示了如何启动一个PostgreSQL节点，执行查询，并在完成后停止节点。

通过上述内容，我们已经介绍了如何使用pgTAP、PGUnit和Testgres为PostgreSQL编写和运行单元测试。接下来，我们将进一步探讨如何优化这些测试框架的使用，以提高测试效率和准确性。

5. 优化测试框架的使用

在掌握了如何使用pgTAP、PGUnit和Testgres编写和运行单元测试后，接下来我们将探讨如何优化这些测试框架的使用，以提高测试效率和准确性。优化测试框架不仅有助于减少测试时间，还能确保测试结果的可靠性。

5.1 优化pgTAP测试

pgTAP的测试用例可以通过以下几种方式进行优化：

减少重复代码 ：通过创建公共函数和重用代码片段，可以减少测试用例中的重复代码。
并行执行测试 ：通过并行执行多个测试用例，可以显著缩短测试时间。
使用事务 ：将测试用例包裹在事务中，确保每次测试后数据库状态的一致性。

示例：减少重复代码

假设我们有多个测试用例需要检查邮政编码的存在性，可以创建一个公共函数来简化代码：

CREATE OR REPLACE FUNCTION check_zip_code(zip_code INTEGER)
RETURNS BOOLEAN AS $$
BEGIN
    RETURN EXISTS (
        SELECT 1 
        FROM public."Zip coordinates" 
        WHERE "zip" = zip_code
    );
END;
$$ LANGUAGE plpgsql;

-- 使用公共函数进行测试
SELECT ok(check_zip_code(12345), 'Zip code 12345 exists');

5.2 优化PGUnit测试

PGUnit的测试用例可以通过以下几种方式进行优化：

使用事务 ：将测试用例包裹在事务中，确保每次测试后数据库状态的一致性。
批量执行测试 ：通过批量执行多个测试用例，可以显著缩短测试时间。
使用索引 ：为常用的查询创建索引，以提高查询速度。

示例：批量执行测试

假设我们有多个测试用例需要检查ATM位置表中的记录，可以批量执行这些测试用例：

DO $$ BEGIN
    -- 测试用例1
    PERFORM * FROM public."ATM locations" WHERE "ID" = 1;
    IF NOT FOUND THEN
        RAISE EXCEPTION 'ATM location with ID 1 not found';
    END IF;

    -- 测试用例2
    PERFORM * FROM public."ATM locations" WHERE "ID" = 2;
    IF NOT FOUND THEN
        RAISE EXCEPTION 'ATM location with ID 2 not found';
    END IF;

    -- 更多测试用例...

EXCEPTION WHEN OTHERS THEN
    -- 捕获异常并记录日志
    RAISE NOTICE 'An error occurred during testing';
END $$;

5.3 优化Testgres测试

Testgres的测试用例可以通过以下几种方式进行优化：

使用虚拟环境 ：通过使用虚拟环境，可以确保测试环境的一致性，避免依赖冲突。
并行执行测试 ：通过并行执行多个测试用例，可以显著缩短测试时间。
使用日志记录 ：通过日志记录，可以更好地跟踪测试过程中的问题。

示例：使用虚拟环境

假设我们要在一个虚拟环境中运行Testgres测试，可以按照以下步骤操作：

创建虚拟环境：

python3 -m venv testgres_env
source testgres_env/bin/activate

安装Testgres：

pip install testgres

编写并运行测试用例：

import testgres
import unittest

class TestAtmLocations(unittest.TestCase):
    def setUp(self):
        self.node = testgres.get_new_node('test_node')
        self.node.init()
        self.node.start()

    def test_bank_zipcode(self):
        with self.node.connect('atm', 'dba', 'bookdemo') as conn:
            conn.begin('serializable')
            data = conn.execute('''
                SELECT "ATM locations"."ID" 
                FROM "ATM locations" 
                WHERE "ATM locations"."ZipCode" NOT IN (
                    SELECT "Zip coordinates".zip 
                    FROM "Zip coordinates"
                ) LIMIT 1;
            ''')
            self.assertFalse(data, 'Bank ZipCode is not included in Zip coordinates table')

    def tearDown(self):
        self.node.stop()

if __name__ == '__main__':
    unittest.main()

图 11.19 展示了使用虚拟环境运行Testgres测试的过程。

graph TD;
    A[创建虚拟环境] --> B(安装Testgres);
    B --> C(编写测试用例);
    C --> D(运行测试用例);
    D --> E(销毁虚拟环境);

6. 实际案例分析

为了更好地理解如何应用这些测试框架，我们将通过一个实际案例来演示如何验证数据库中的数据完整性。假设我们有一个银行ATM位置数据库，需要确保以下几点：

所有ATM位置的邮政编码都存在于邮政坐标表中。
ATM位置表中没有重复的记录。
ATM位置表中有足够的记录数。

6.1 验证邮政编码的存在性

我们可以使用pgTAP编写一个测试用例来验证邮政编码的存在性：

SET search_path TO pgTAP;
SELECT plan(1);
SELECT is_empty('
    SELECT "ID" 
    FROM public."ATM locations" 
    WHERE "ZipCode" NOT IN (
        SELECT "zip" 
        FROM public."Zip coordinates"
    ) LIMIT 1
', 'Check if all ATM locations have valid ZipCodes');
SELECT * FROM finish();

6.2 检查重复记录

我们可以使用PGUnit编写一个测试用例来检查ATM位置表中是否有重复记录：

BEGIN;
CREATE OR REPLACE FUNCTION test_no_duplicate_atm_locations()
RETURNS void AS $$
BEGIN
    WITH duplicates AS (
        SELECT "ID", COUNT(*) AS count
        FROM public."ATM locations"
        GROUP BY "ID"
        HAVING COUNT(*) > 1
    )
    SELECT * FROM duplicates;
    IF FOUND THEN
        RAISE EXCEPTION 'Duplicate ATM locations found';
    END IF;
END;
$$ LANGUAGE plpgsql;
COMMIT;

6.3 检查记录数量

我们可以使用Testgres编写一个测试用例来检查ATM位置表中是否有足够的记录：

import testgres
import unittest

class TestAtmLocations(unittest.TestCase):
    def setUp(self):
        self.node = testgres.get_new_node('test_node')
        self.node.init()
        self.node.start()

    def test_sufficient_records(self):
        with self.node.connect('atm', 'dba', 'bookdemo') as conn:
            conn.begin('serializable')
            data = conn.execute('''
                SELECT COUNT(DISTINCT "ID") 
                FROM public."ATM locations"
            ''')
            self.assertGreater(data[0][0], 0, 'No ATM locations found in the database')

    def tearDown(self):
        self.node.stop()

if __name__ == '__main__':
    unittest.main()