Bỏ qua đến nội dung chính
Mục lục

Mock trong Python với unittest.mock: mock, patch, stub

AIDev Team · duyệt: Nguyễn Việt Chung

Bài 7/10 · Chương 16

Code sạch, kiểm thử và gỡ lỗi

  • 7 phút
  • Trung cấp
  • Python 3.14
  • Cập nhật

Mock trong Python là đối tượng giả của module unittest.mock: nó đứng thay một hàm thật, ghi lại các lời gọi cùng tham số, và trả về kết quả bạn đặt sẵn. Bạn cần nó khi test một hàm gửi email, gọi mạng hay đọc file mà không muốn gửi thư thật, chờ mạng hay tạo file thật.

Cần biết trước: unittest, decorator và monkey patching.

Mock ghi lại các lời gọi

Mock() tạo một đối tượng gọi được như hàm. Mỗi lần gọi, nó ghi lại tham số. Sau đó bạn hỏi lại nó hoặc kiểm bằng các phương thức assert_...:

python
from unittest.mock import Mock

gui = Mock()
gui("an@example.com", "Đơn A1 chưa thanh toán")
print(gui.called, gui.call_count)
print(gui.call_args)
gui.assert_called_once_with("an@example.com",
                            "Đơn A1 chưa thanh toán")
print("Gọi đúng một lần, đúng tham số")

KẾT QUẢ

True 1
call('an@example.com', 'Đơn A1 chưa thanh toán')
Gọi đúng một lần, đúng tham số

called cho biết đã gọi chưa, call_count là số lần gọi, call_args là tham số của lần gọi cuối. assert_called_once_with(...) báo AssertionError khi số lần gọi khác một hay tham số khác. Còn assert_not_called() kiểm rằng chưa gọi lần nào. Đổi "an@example.com" ở dòng gui(...) thành "binh@example.com" rồi chạy lại: chương trình dừng ở AssertionError, dòng cuối cho biết lời gọi thật là mock('binh@example.com', 'Đơn A1 chưa thanh toán').

MagicMock là một Mock biết thêm các phương thức đặc biệt như __len__ hay __iter__, nên len() hay vòng for trên nó không báo lỗi. patch ở mục sau tạo sẵn một MagicMock.

Stub: bản giả trả kết quả đặt sẵn

Stub là bản giả chỉ có một việc: trả về kết quả cố định để code chạy tiếp. Khi hàm nhận phần chậm qua tham số, như hàm lấy tỷ giá dưới đây, test truyền vào một Mock có return_value:

python
from unittest.mock import Mock

def gia_usd(gia_vnd, lay_ty_gia):
    return round(gia_vnd / lay_ty_gia("USD"), 2)

ty_gia_gia = Mock(return_value=25000)
print(gia_usd(45000, ty_gia_gia))
ty_gia_gia.assert_called_once_with("USD")

KẾT QUẢ

1.8

Test không cần mạng và lần nào cũng ra 1.8, vì tỷ giá là số đặt sẵn. Muốn bản giả ném lỗi để thử nhánh xử lý lỗi, dùng side_effect:

python
from unittest.mock import Mock

def gia_usd_an_toan(gia_vnd, lay_ty_gia):
    try:
        return round(gia_vnd / lay_ty_gia("USD"), 2)
    except ConnectionError:
        return None

mat_mang = Mock(side_effect=ConnectionError("mất mạng"))
print(gia_usd_an_toan(45000, mat_mang), mat_mang.call_count)

KẾT QUẢ

None 1

side_effect là một lớp lỗi hay đối tượng lỗi thì mỗi lần gọi Mock ném lỗi đó. side_effect là một list thì mỗi lần gọi trả về phần tử kế tiếp.

Thay tạm một tên bằng patch

Hàm gọi thẳng input() hay open() thì không truyền bản giả qua tham số được. patch("tên.đầy.đủ", ...) thay tạm tên đó trong một khối with, rồi trả lại tên thật khi khối kết thúc. mock_open(read_data=...) tạo một bản giả của open() đọc ra chuỗi cho sẵn, nên không cần file thật:

python
from unittest.mock import mock_open, patch

def doc_bang_gia(duong_dan):
    with open(duong_dan, encoding="utf-8") as f:
        return [dong.strip() for dong in f]

noi_dung = "cà phê sữa,29000\nbạc xỉu,32000\n"
with patch("builtins.open", mock_open(read_data=noi_dung)) as m:
    print(doc_bang_gia("bang_gia.csv"))
m.assert_called_once_with("bang_gia.csv", encoding="utf-8")

KẾT QUẢ

['cà phê sữa,29000', 'bạc xỉu,32000']

builtins là module chứa các hàm có sẵn như open và input. Theo cách đó, patch("builtins.input", side_effect=["2", "3"]) cho hai lần gọi input() trả về "2" rồi "3". Với một phương thức của class, patch.object(Class, "ten") làm cùng việc, và patch còn viết được thành decorator của hàm test:

python
from unittest.mock import patch

class CuaHang:
    def lay_ty_gia(self):
        raise RuntimeError("cần mạng")
    def gia_usd(self, gia_vnd):
        return round(gia_vnd / self.lay_ty_gia(), 2)

@patch.object(CuaHang, "lay_ty_gia", return_value=25000)
def test_gia_usd(ty_gia_gia):
    assert CuaHang().gia_usd(45000) == 1.8
    ty_gia_gia.assert_called_once()

test_gia_usd()
print(CuaHang.lay_ty_gia.__name__)

KẾT QUẢ

lay_ty_gia

Decorator truyền Mock vào hàm test qua tham số đầu tiên. Khi test xong, CuaHang.lay_ty_gia là phương thức thật trở lại, nên dòng cuối in được tên của nó.

Kiểm tra nhanh

  1. Sau dòng from unittest.mock import Mock, lệnh print(Mock(return_value="đã gửi")("an@example.com")) in ra gì?

    • None
    • an@example.com
    • đã gửi
  2. Test có dòng gui.called_once_with("an@example.com"), thiếu chữ assert_. Chạy test thì thế nào?

    • Test qua, vì Mock nhận mọi tên thuộc tính
    • Báo AttributeError, vì tên giống một phép kiểm viết sai
    • Báo AssertionError, vì Mock chưa được gọi
  3. Những câu nào đúng về with patch("builtins.input", side_effect=["2", "3"]):?

    • Trong khối, lần gọi input() đầu tiên trả về "2"
    • Khi khối kết thúc, input là hàm thật trở lại
    • Trong khối, mỗi lần gọi input() đều trả về list ["2", "3"]
    • Trong khối, chương trình không chờ người dùng gõ
  4. Khung bẫy patch random.randint nhưng tung_xuc_xac() vẫn ra 2. Vì sao?

    • Vì hàm dùng tên randint đã chép riêng bằng from random import randint
    • Vì random.seed(1) chặn patch
    • Vì patch chỉ thay được hàm do bạn tự viết
Đúng hết lần đầu +15 XP

Bài tập

Test hàm nhắc thanh toán bằng Mock

Viết hàm nhac_thanh_toan(cac_don, gui): cac_don là list các dict có khóa "ma", "email", "da_tra", gui là hàm gửi tin. Với mỗi đơn chưa trả, theo thứ tự, hàm gọi gui(email, f"Đơn {ma} chưa thanh toán") và không sửa cac_don. Rồi viết test_nhac_thanh_toan(): tạo gui = Mock(), gọi hàm với một đơn chưa trả và một đơn đã trả, kiểm bằng gui.assert_called_once_with(...). Phần chấm thay hàm bằng vài bản sai (nhắc mọi đơn hay đơn đã trả, gửi nhầm người, gửi hai lần, sai nội dung, không gửi gì): test phải báo AssertionError với từng bản sai, qua với bản đúng. Ghi sẵn email và nội dung mong đợi trong test.

Ví dụ: với đơn {"ma": "A1", "email": "an@example.com", "da_tra": False}, hàm gọi gui("an@example.com", "Đơn A1 chưa thanh toán").

Trả về: nhac_thanh_toan trả về None, nó chỉ gọi gui.

python
from unittest.mock import Mock

def nhac_thanh_toan(cac_don, gui):
    pass  # Viết thân hàm thay cho dòng này

def test_nhac_thanh_toan():
    pass  # Viết test dùng Mock thay cho dòng này

test_nhac_thanh_toan()

Tóm tắt

  • Mock() ghi lại các lời gọi: called, call_count, call_args.

  • Kiểm lời gọi bằng assert_called_once_with(...) hay assert_not_called(), có đủ chữ assert_ ở đầu.

  • Stub là bản giả trả kết quả đặt sẵn: Mock(return_value=...); side_effect ném lỗi hay trả lần lượt.

  • patch("module.ten", ...) thay tạm một tên trong khối with hay dưới dạng decorator, rồi trả lại tên thật.

  • mock_open(read_data=...) giả open() để test đọc file mà không cần file thật.

  • Patch tên ở đúng nơi code dùng nó, như xuc_xac.randint khi file đó có from random import randint.

Câu hỏi thường gặp

Mock, stub và fake khác nhau thế nào?

Stub chỉ trả kết quả đặt sẵn để code chạy tiếp. Mock làm được thế và còn ghi lại lời gọi để test kiểm lại sau. Fake là một bản thay chạy được thật nhưng đơn giản, như một dict đứng thay cơ sở dữ liệu. Trong unittest.mock, cùng một đối tượng Mock dùng được làm stub hay mock.

Mock Python test hàm gọi API qua mạng thế nào?

Patch hàm gửi yêu cầu ở nơi code của bạn dùng nó, đặt return_value là một đối tượng giả có các thuộc tính bạn cần (như mã trạng thái và dữ liệu JSON). Test khi đó chạy không cần mạng; bài requests có hàm gọi mạng thật để thử cách này.

Patch trong Python có dùng được ngoài unittest không?

Được: patch là một phần của thư viện chuẩn, chạy trong test của unittest hay pytest như nhau. pytest còn có fixture monkeypatch làm việc tương tự cho thuộc tính và biến môi trường.

Có nên mock thật nhiều để test chạy nhanh?

Không nên. Mock chỉ thay phần ngoài tầm kiểm soát của bạn: mạng, đồng hồ, file, email. Mock cả code của chính bạn thì test chỉ còn kiểm rằng code gọi đúng những gì nó gọi, và vẫn qua khi phần bị mock đã hỏng.

Chủ đề

mock python

Bài này có hữu ích?

Hỏi đáp

Đang tải câu hỏi…

Tham vấn chuyên môn

Nguyễn Việt Chung

Nhà sáng lập AIDev và VietPlatform · Thạc sĩ AI MSE

  • Tốt nghiệp thủ khoa xuất sắc Thạc sĩ AI MSE.
  • Đồng sáng lập, CTO E-University, SVOnline: số hóa 10+ đại học, 40.000+ sinh viên.
  • Xây hệ thống AI cho doanh nghiệp tại VietPlatform.
Biên soạn: AIDev Team · Rà soát · Quy trình biên tập