在 Flask 中执行单元测试

Flask 提供了很好的单元测试支持，以下是完整的单元测试实施指南：

1. 基本测试设置

首先，确保你的 Flask 应用采用工厂模式创建：

# app.py
from flask import Flask

def create_app():
    app = Flask(__name__)
    app.config['TESTING'] = True  # 测试配置

    @app.route('/')
    def index():
        return 'Hello, World!'

    return app

2. 创建测试文件

创建一个 tests 目录，并添加 test_app.py：

# tests/test_app.py
import unittest
from app import create_app

class BasicTestCase(unittest.TestCase):
    def setUp(self):
        # 在每个测试前创建测试客户端
        self.app = create_app()
        self.client = self.app.test_client()

    def tearDown(self):
        # 测试后清理
        pass

    def test_index_page(self):
        response = self.client.get('/')
        self.assertEqual(response.status_code, 200)
        self.assertIn(b'Hello, World!', response.data)

3. 使用 pytest (推荐)

安装 pytest 和 pytest-flask：

pip install pytest pytest-flask

创建 conftest.py 配置：

# tests/conftest.py
import pytest
from app import create_app

@pytest.fixture
def app():
    app = create_app()
    return app

@pytest.fixture
def client(app):
    return app.test_client()

然后编写 pytest 测试：

# tests/test_with_pytest.py
def test_index_page(client):
    response = client.get('/')
    assert response.status_code == 200
    assert b'Hello, World!' in response.data

4. 测试数据库操作

如果你的应用使用数据库：

# tests/test_db.py
import pytest
from app import create_app
from models import db, User

@pytest.fixture
def app():
    app = create_app()
    app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///:memory:'
    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

    with app.app_context():
        db.create_all()

    yield app

    with app.app_context():
        db.drop_all()

def test_user_creation(client, app):
    with app.app_context():
        user = User(username='test', email='test@example.com')
        db.session.add(user)
        db.session.commit()

        assert User.query.count() == 1

5. 测试认证和会话

测试需要登录的端点：

def test_protected_route(client):
    # 先登录
    client.post('/login', data={
        'username': 'test',
        'password': 'password'
    })

    # 然后测试受保护路由
    response = client.get('/dashboard')
    assert response.status_code == 200

6. 测试 JSON API

def test_json_api(client):
    response = client.post('/api/data', 
        json={'key': 'value'},
        headers={'Content-Type': 'application/json'}
    )

    assert response.status_code == 201
    assert response.json['status'] == 'success'

7. 运行测试

运行所有测试：

python -m pytest

或者使用 unittest 运行：

python -m unittest discover -s tests

8. 测试覆盖率

安装 coverage 工具：

pip install pytest-cov

运行测试并检查覆盖率：

pytest --cov=app tests/

最佳实践

1. 每个测试应该只测试一个功能
2. 使用有意义的测试名称
3. 测试应该独立，不依赖其他测试的执行顺序
4. 测试应该快速执行
5. 包含正面和负面测试用例
6. 模拟外部服务（如使用 unittest.mock）

通过以上方法，你可以为 Flask 应用构建全面的测试套件，确保代码质量和可靠性。