Python 测试中的 Mock 与 Stub:unittest.mock 完全指南

Stub = “假数据提供者”Mock = “行为记录仪 + 断言器”

from unittest.mock import Mock# 创建一个 Mock 对象fake_db = Mock()# 预设方法返回值（Stub 行为）fake_db.get_user.return_value = {"id": 1, "name": "Alice"}# 调用它user = fake_db.get_user(1)assert user["name"] == "Alice"# 验证是否被调用（Mock 行为）

from unittest.mock import MagicMock# 模拟一个可迭代对象fake_list = MagicMock()fake_list.__iter__.return_value = iter([1, 2, 3])# 可用于 for 循环for item in fake_list:    print(item)  # 输出 1, 2, 3# 也可模拟 len()fake_list.__len__.return_value = 3assert len(fake_list) == 3

from unittest.mock import patchimport my_module  # 假设它调用了 requests.get# 场景：my_module.fetch_data() 内部调用了 requests.get@patch('my_module.requests.get')  # 注意：路径是被测模块中的导入路径！def test_fetch_data(mock_get):    # 预设返回值    mock_get.return_value.json.return_value = {"data": "test"}    result = my_module.fetch_data()    assert result == "test"    # 验证是否被调用    mock_get.assert_called_once_with("https://api.example.com/data")

# payment.pyimport requestsdef process_payment(amount):    resp = requests.post("https://payment-gateway.com/pay", json={"amount": amount})    return resp.json()["transaction_id"]# test_payment.pyfrom unittest.mock import patch@patch('payment.requests.post')def test_process_payment(mock_post):    # 预设网关返回    mock_post.return_value.json.return_value = {"transaction_id": "txn_123"}    txn_id = process_payment(100)    assert txn_id == "txn_123"    # 验证请求参数    mock_post.assert_called_once_with(        "https://payment-gateway.com/pay",        json={"amount": 100}    )

# report.pyfrom datetime import datetimedef generate_daily_report():    today = datetime.now().strftime("%Y-%m-%d")    return f"Report for {today}"# test_report.pyfrom unittest.mock import patchfrom datetime import datetime@patch('report.datetime')def test_generate_daily_report(mock_datetime):    # 固定当前时间为 2025-01-01    mock_datetime.now.return_value = datetime(2025, 1, 1)    mock_datetime.strftime = lambda self, fmt: self.strftime(fmt)    report = generate_daily_report()    assert report == "Report for 2025-01-01"💡 技巧：Mock datetime 时需同时处理 now() 和 strftime。

# user_service.pyimport sqlite3def get_user(user_id):    conn = sqlite3.connect("app.db")    cursor = conn.cursor()    cursor.execute("SELECT name FROM users WHERE id=?", (user_id,))    row = cursor.fetchone()    conn.close()    return row[0] if row else None# test_user_service.pyfrom unittest.mock import patch, MagicMock@patch('user_service.sqlite3')def test_get_user(mock_sqlite3):    # 模拟数据库连接和游标    mock_conn = MagicMock()    mock_cursor = MagicMock()    mock_sqlite3.connect.return_value = mock_conn    mock_conn.cursor.return_value = mock_cursor    mock_cursor.fetchone.return_value = ("Alice",)    name = get_user(1)    assert name == "Alice"    # 验证 SQL 是否正确执行    mock_cursor.execute.assert_called_once_with(        "SELECT name FROM users WHERE id=?", (1,)    )

# api_client.pyimport requestsdef fetch_user(user_id):    try:        resp = requests.get(f"https://api.example.com/users/{user_id}")        resp.raise_for_status()        return resp.json()    except requests.RequestException:        return {"error": "Network failed"}# test_api_client.pyfrom unittest.mock import patchimport requests@patch('api_client.requests.get')def test_fetch_user_network_error(mock_get):    # 模拟网络异常    mock_get.side_effect = requests.RequestException("Timeout")    result = fetch_user(123)    assert result == {"error": "Network failed"}

# email_service.pyclass EmailClient:    def __init__(self, api_key):        self.api_key = api_key    def send(self, to, subject):        # 调用真实邮件服务        passdef notify_user(user_email):    client = EmailClient("SECRET_KEY")    client.send(user_email, "Welcome!")# test_email_service.pyfrom unittest.mock import patch@patch('email_service.EmailClient')def test_notify_user(mock_client_class):    # mock_client_class 是类的 Mock    mock_instance = mock_client_class.return_value  # 实例的 Mock    notify_user("alice@example.com")    # 验证是否创建了实例    mock_client_class.assert_called_once_with("SECRET_KEY")    # 验证实例方法是否被调用    mock_instance.send.assert_called_once_with("alice@example.com", "Welcome!")‍

from unittest.mock import Mock# 假设真实类有 connect() 和 close() 方法class RealDB:    def connect(self): pass    def close(self): pass# 创建带 spec 的 Mockfake_db = Mock(spec=RealDB)fake_db.connect()      # OKfake_db.connet()       # 拼写错误！会抛出 AttributeError

def test_with_context():    with patch('my_module.external_api') as mock_api:        mock_api.return_value = "mocked"        result = my_module.call_api()        assert result == "mocked"    # 退出 with 后自动恢复原对象

# 模拟 User.objects.filter(active=True).first()mock_user = Mock()mock_queryset = Mock()mock_manager = Mock()mock_manager.filter.return_value = mock_querysetmock_queryset.first.return_value = mock_userwith patch('my_app.models.User.objects', mock_manager):    user = User.objects.filter(active=True).first()    assert user == mock_user‍