Kiểm thử Python Django: TestCase vs. TransactionTestCase

Kiểm thử là một khía cạnh quan trọng của phát triển phần mềm, đảm bảo rằng ứng dụng của bạn hoạt động như mong đợi và vẫn ổn định theo thời gian. Django, một framework web Python phổ biến, cung cấp một framework kiểm thử mạnh mẽ để giúp bạn viết các bài kiểm thử hiệu quả. Bài đăng trên blog này sẽ đi sâu vào hai lớp cơ bản trong framework kiểm thử của Django: TestCase và TransactionTestCase. Chúng ta sẽ khám phá sự khác biệt, trường hợp sử dụng và cung cấp các ví dụ thực tế để giúp bạn chọn lớp phù hợp cho nhu cầu kiểm thử của mình.

Tại sao kiểm thử lại quan trọng trong Django

Trước khi đi sâu vào các chi tiết của TestCase và TransactionTestCase, chúng ta hãy thảo luận ngắn gọn về lý do tại sao kiểm thử lại quan trọng trong quá trình phát triển Django:

• Đảm bảo chất lượng mã: Kiểm thử giúp bạn phát hiện lỗi sớm trong quá trình phát triển, ngăn chặn chúng đi vào môi trường production.
• Tạo điều kiện cho việc Refactoring: Với một bộ kiểm thử toàn diện, bạn có thể tự tin refactor mã của mình, biết rằng các bài kiểm thử sẽ cảnh báo bạn nếu bạn đưa ra bất kỳ sự hồi quy nào.
• Cải thiện sự cộng tác: Các bài kiểm thử được viết tốt sẽ đóng vai trò là tài liệu cho mã của bạn, giúp các nhà phát triển khác dễ dàng hiểu và đóng góp hơn.
• Hỗ trợ Phát triển theo kiểm thử (TDD): TDD là một phương pháp phát triển mà bạn viết các bài kiểm thử trước khi viết mã thực tế. Điều này buộc bạn phải suy nghĩ về hành vi mong muốn của ứng dụng trước, dẫn đến mã sạch hơn và dễ bảo trì hơn.

Tổng quan nhanh về Framework kiểm thử của Django

Framework kiểm thử của Django được xây dựng dựa trên module unittest tích hợp sẵn của Python. Nó cung cấp một số tính năng giúp việc kiểm thử các ứng dụng Django dễ dàng hơn, bao gồm:

• Khám phá kiểm thử: Django tự động khám phá và chạy các bài kiểm thử trong dự án của bạn.
• Trình chạy kiểm thử: Django cung cấp một trình chạy kiểm thử thực thi các bài kiểm thử của bạn và báo cáo kết quả.
• Các phương thức khẳng định: Django cung cấp một bộ các phương thức khẳng định mà bạn có thể sử dụng để xác minh hành vi mong đợi của mã của bạn.
• Client: Client kiểm thử của Django cho phép bạn mô phỏng các tương tác của người dùng với ứng dụng của bạn, chẳng hạn như gửi biểu mẫu hoặc thực hiện các yêu cầu API.
• TestCase và TransactionTestCase: Đây là hai lớp cơ bản để viết các bài kiểm thử trong Django, mà chúng ta sẽ khám phá chi tiết.

TestCase: Kiểm thử đơn vị nhanh chóng và hiệu quả

TestCase là lớp chính để viết các bài kiểm thử đơn vị trong Django. Nó cung cấp một môi trường cơ sở dữ liệu sạch cho mỗi trường hợp kiểm thử, đảm bảo rằng các bài kiểm thử được cô lập và không can thiệp vào nhau.

Cách hoạt động của TestCase

Khi bạn sử dụng TestCase, Django thực hiện các bước sau cho mỗi phương thức kiểm thử:

1. Tạo một cơ sở dữ liệu kiểm thử: Django tạo một cơ sở dữ liệu kiểm thử riêng biệt cho mỗi lần chạy kiểm thử.
2. Xóa cơ sở dữ liệu: Trước mỗi phương thức kiểm thử, Django xóa cơ sở dữ liệu kiểm thử, loại bỏ tất cả dữ liệu hiện có.
3. Chạy phương thức kiểm thử: Django thực thi phương thức kiểm thử mà bạn đã định nghĩa.
4. Hoàn nguyên giao dịch: Sau mỗi phương thức kiểm thử, Django hoàn nguyên giao dịch, thực tế là hoàn tác mọi thay đổi đã thực hiện đối với cơ sở dữ liệu trong quá trình kiểm thử.

Cách tiếp cận này đảm bảo rằng mỗi phương thức kiểm thử bắt đầu với một bảng trắng sạch và bất kỳ thay đổi nào được thực hiện đối với cơ sở dữ liệu đều được tự động hoàn nguyên. Điều này làm cho TestCase trở nên lý tưởng để kiểm thử đơn vị, nơi bạn muốn kiểm thử các thành phần riêng lẻ của ứng dụng của mình một cách độc lập.

Ví dụ: Kiểm thử một Model đơn giản

Hãy xem xét một ví dụ đơn giản về việc kiểm thử một model Django bằng cách sử dụng TestCase:

from django.test import TestCase
from .models import Product

class ProductModelTest(TestCase):
 def test_product_creation(self):
 product = Product.objects.create(name="Test Product", price=10.00)
 self.assertEqual(product.name, "Test Product")
 self.assertEqual(product.price, 10.00)
 self.assertTrue(isinstance(product, Product))

Trong ví dụ này, chúng ta đang kiểm thử việc tạo một thể hiện model Product. Phương thức test_product_creation tạo một sản phẩm mới và sau đó sử dụng các phương thức khẳng định để xác minh rằng các thuộc tính của sản phẩm được đặt chính xác.

Khi nào nên sử dụng TestCase

TestCase thường là lựa chọn ưu tiên cho hầu hết các tình huống kiểm thử Django. Nó nhanh chóng, hiệu quả và cung cấp một môi trường cơ sở dữ liệu sạch cho mỗi bài kiểm thử. Sử dụng TestCase khi:

• Bạn đang kiểm thử các model, views hoặc các thành phần khác riêng lẻ của ứng dụng của bạn.
• Bạn muốn đảm bảo rằng các bài kiểm thử của bạn được cô lập và không can thiệp vào nhau.
• Bạn không cần phải kiểm thử các tương tác cơ sở dữ liệu phức tạp kéo dài nhiều giao dịch.

TransactionTestCase: Kiểm thử các tương tác cơ sở dữ liệu phức tạp

TransactionTestCase là một lớp khác để viết các bài kiểm thử trong Django, nhưng nó khác với TestCase ở cách nó xử lý các giao dịch cơ sở dữ liệu. Thay vì hoàn nguyên giao dịch sau mỗi phương thức kiểm thử, TransactionTestCase sẽ commit giao dịch. Điều này làm cho nó phù hợp để kiểm thử các tương tác cơ sở dữ liệu phức tạp trải dài nhiều giao dịch, chẳng hạn như các tương tác liên quan đến tín hiệu hoặc các giao dịch nguyên tử.

Cách hoạt động của TransactionTestCase

Khi bạn sử dụng TransactionTestCase, Django thực hiện các bước sau cho mỗi trường hợp kiểm thử:

1. Tạo một cơ sở dữ liệu kiểm thử: Django tạo một cơ sở dữ liệu kiểm thử riêng biệt cho mỗi lần chạy kiểm thử.
2. KHÔNG xóa cơ sở dữ liệu: TransactionTestCase *không* tự động xóa cơ sở dữ liệu trước mỗi bài kiểm thử. Nó mong đợi cơ sở dữ liệu ở trạng thái nhất quán trước khi mỗi bài kiểm thử được chạy.
3. Chạy phương thức kiểm thử: Django thực thi phương thức kiểm thử mà bạn đã định nghĩa.
4. Commit giao dịch: Sau mỗi phương thức kiểm thử, Django commit giao dịch, thực hiện các thay đổi vĩnh viễn trong cơ sở dữ liệu kiểm thử.
5. Cắt bớt bảng: Vào *cuối* của tất cả các bài kiểm thử trong TransactionTestCase, các bảng bị cắt bớt để xóa dữ liệu.

Bởi vì TransactionTestCase commit giao dịch sau mỗi phương thức kiểm thử, điều cần thiết là đảm bảo rằng các bài kiểm thử của bạn không để cơ sở dữ liệu ở trạng thái không nhất quán. Bạn có thể cần phải dọn dẹp thủ công bất kỳ dữ liệu nào được tạo trong quá trình kiểm thử để tránh can thiệp vào các bài kiểm thử sau đó.

Ví dụ: Kiểm thử tín hiệu

Hãy xem xét một ví dụ về việc kiểm thử tín hiệu Django bằng cách sử dụng TransactionTestCase:

from django.test import TransactionTestCase
from django.db.models.signals import post_save
from django.dispatch import receiver
from .models import Product, ProductLog

@receiver(post_save, sender=Product)
def create_product_log(sender, instance, created, **kwargs):
 if created:
 ProductLog.objects.create(product=instance, action="Created")

class ProductSignalTest(TransactionTestCase):
 def test_product_creation_signal(self):
 product = Product.objects.create(name="Test Product", price=10.00)
 self.assertEqual(ProductLog.objects.count(), 1)
 self.assertEqual(ProductLog.objects.first().product, product)
 self.assertEqual(ProductLog.objects.first().action, "Created")

Trong ví dụ này, chúng ta đang kiểm thử một tín hiệu tạo một thể hiện ProductLog bất cứ khi nào một thể hiện Product mới được tạo. Phương thức test_product_creation_signal tạo một sản phẩm mới và sau đó xác minh rằng một mục nhập nhật ký sản phẩm tương ứng được tạo.

Khi nào nên sử dụng TransactionTestCase

TransactionTestCase thường được sử dụng trong các tình huống cụ thể, nơi bạn cần kiểm thử các tương tác cơ sở dữ liệu phức tạp trải dài nhiều giao dịch. Hãy cân nhắc sử dụng TransactionTestCase khi:

• Bạn đang kiểm thử các tín hiệu được kích hoạt bởi các thao tác cơ sở dữ liệu.
• Bạn đang kiểm thử các giao dịch nguyên tử liên quan đến nhiều thao tác cơ sở dữ liệu.
• Bạn cần xác minh trạng thái của cơ sở dữ liệu sau một loạt các thao tác liên quan.
• Bạn đang sử dụng mã dựa vào ID tự tăng để duy trì giữa các bài kiểm thử (mặc dù điều này thường được coi là thực hành xấu).

Những cân nhắc quan trọng khi sử dụng TransactionTestCase

Bởi vì TransactionTestCase commit các giao dịch, điều quan trọng là phải nhận thức được những cân nhắc sau:

• Dọn dẹp cơ sở dữ liệu: Bạn có thể cần phải dọn dẹp thủ công bất kỳ dữ liệu nào được tạo trong quá trình kiểm thử để tránh can thiệp vào các bài kiểm thử sau đó. Hãy cân nhắc việc sử dụng các phương thức setUp và tearDown để quản lý dữ liệu kiểm thử.
• Cô lập kiểm thử: TransactionTestCase không cung cấp cùng mức độ cô lập kiểm thử như TestCase. Hãy lưu ý về các tương tác tiềm ẩn giữa các bài kiểm thử và đảm bảo rằng các bài kiểm thử của bạn không dựa vào trạng thái của cơ sở dữ liệu từ các bài kiểm thử trước đó.
• Hiệu suất: TransactionTestCase có thể chậm hơn TestCase vì nó liên quan đến việc commit các giao dịch. Sử dụng nó một cách thận trọng và chỉ khi cần thiết.

Các phương pháp thực hành tốt nhất để kiểm thử Django

Dưới đây là một số phương pháp thực hành tốt nhất cần ghi nhớ khi viết các bài kiểm thử trong Django:

• Viết các bài kiểm thử rõ ràng và súc tích: Các bài kiểm thử phải dễ hiểu và bảo trì. Sử dụng tên mô tả cho các phương thức kiểm thử và các khẳng định.
• Kiểm thử một thứ tại một thời điểm: Mỗi phương thức kiểm thử nên tập trung vào việc kiểm thử một khía cạnh duy nhất của mã của bạn. Điều này giúp dễ dàng xác định nguồn gốc của lỗi khi bài kiểm thử không thành công.
• Sử dụng các khẳng định có ý nghĩa: Sử dụng các phương thức khẳng định thể hiện rõ ràng hành vi mong đợi của mã của bạn. Django cung cấp một bộ phương thức khẳng định phong phú cho nhiều tình huống khác nhau.
• Tuân theo mẫu Arrange-Act-Assert: Cấu trúc các bài kiểm thử của bạn theo mẫu Arrange-Act-Assert: Sắp xếp dữ liệu kiểm thử, Hành động trên mã đang kiểm thử và Khẳng định kết quả mong đợi.
• Giữ cho các bài kiểm thử của bạn nhanh chóng: Các bài kiểm thử chậm có thể khiến các nhà phát triển không chạy chúng thường xuyên. Tối ưu hóa các bài kiểm thử của bạn để giảm thiểu thời gian thực thi.
• Sử dụng fixtures cho dữ liệu kiểm thử: Fixtures là một cách thuận tiện để tải dữ liệu ban đầu vào cơ sở dữ liệu kiểm thử của bạn. Sử dụng fixtures để tạo dữ liệu kiểm thử nhất quán và có thể tái sử dụng. Hãy cân nhắc việc sử dụng các khóa tự nhiên trong fixtures để tránh mã hóa cứng các ID.
• Cân nhắc việc sử dụng thư viện kiểm thử như pytest: Mặc dù framework kiểm thử tích hợp sẵn của Django rất mạnh mẽ, các thư viện như pytest có thể cung cấp các tính năng và tính linh hoạt bổ sung.
• Phấn đấu đạt được phạm vi bao phủ kiểm thử cao: Đặt mục tiêu đạt được phạm vi bao phủ kiểm thử cao để đảm bảo rằng mã của bạn được kiểm thử kỹ lưỡng. Sử dụng các công cụ bao phủ để đo lường phạm vi bao phủ kiểm thử của bạn và xác định các khu vực cần kiểm thử nhiều hơn.
• Tích hợp các bài kiểm thử vào quy trình CI/CD của bạn: Chạy các bài kiểm thử của bạn tự động như một phần của quy trình tích hợp liên tục và triển khai liên tục (CI/CD). Điều này đảm bảo rằng bất kỳ sự hồi quy nào đều được phát hiện sớm trong quá trình phát triển.
• Viết các bài kiểm thử phản ánh các tình huống trong thế giới thực: Kiểm thử ứng dụng của bạn theo những cách bắt chước cách người dùng thực sự tương tác với nó. Điều này sẽ giúp bạn khám phá các lỗi có thể không rõ ràng trong các bài kiểm thử đơn vị đơn giản. Ví dụ: hãy xem xét các biến thể trong địa chỉ và số điện thoại quốc tế khi kiểm thử các biểu mẫu.

Quốc tế hóa (i18n) và Kiểm thử

Khi phát triển các ứng dụng Django cho đối tượng toàn cầu, điều quan trọng là phải xem xét quốc tế hóa (i18n) và bản địa hóa (l10n). Đảm bảo các bài kiểm thử của bạn bao gồm các ngôn ngữ, định dạng ngày và ký hiệu tiền tệ khác nhau. Dưới đây là một số mẹo:

• Kiểm thử với các cài đặt ngôn ngữ khác nhau: Sử dụng trình trang trí override_settings của Django để kiểm thử ứng dụng của bạn với các cài đặt ngôn ngữ khác nhau.
• Sử dụng dữ liệu được bản địa hóa trong các bài kiểm thử của bạn: Sử dụng dữ liệu được bản địa hóa trong các fixtures kiểm thử và các phương thức kiểm thử của bạn để đảm bảo rằng ứng dụng của bạn xử lý chính xác các định dạng ngày, ký hiệu tiền tệ và các dữ liệu dành riêng cho địa phương khác nhau.
• Kiểm thử chuỗi dịch của bạn: Xác minh rằng các chuỗi dịch của bạn được dịch chính xác và chúng hiển thị chính xác bằng các ngôn ngữ khác nhau.
• Sử dụng thẻ template localize: Trong các template của bạn, hãy sử dụng thẻ template localize để định dạng ngày, số và các dữ liệu dành riêng cho địa phương khác theo ngôn ngữ hiện tại của người dùng.

Ví dụ: Kiểm thử với các cài đặt ngôn ngữ khác nhau

from django.test import TestCase
from django.utils import translation
from django.conf import settings

class InternationalizationTest(TestCase):

 def test_localized_date_format(self):
 original_language = translation.get_language()
 try:
 translation.activate('de') # Kích hoạt ngôn ngữ Đức
 with self.settings(LANGUAGE_CODE='de'): # Đặt ngôn ngữ trong cài đặt
 from django.utils import formats
 from datetime import date
 d = date(2024, 1, 20)
 formatted_date = formats.date_format(d, 'SHORT_DATE_FORMAT')
 self.assertEqual(formatted_date, '20.01.2024')
 finally:
 translation.activate(original_language) # Khôi phục ngôn ngữ gốc

Ví dụ này minh họa cách kiểm thử định dạng ngày tháng với các cài đặt ngôn ngữ khác nhau bằng cách sử dụng các module translation và formats của Django.

Kết luận

Hiểu được sự khác biệt giữa TestCase và TransactionTestCase là điều cần thiết để viết các bài kiểm thử hiệu quả và đáng tin cậy trong Django. TestCase thường là lựa chọn ưu tiên cho hầu hết các tình huống kiểm thử, cung cấp một cách nhanh chóng và hiệu quả để kiểm thử các thành phần riêng lẻ của ứng dụng của bạn một cách độc lập. TransactionTestCase hữu ích để kiểm thử các tương tác cơ sở dữ liệu phức tạp trải dài nhiều giao dịch, chẳng hạn như các tương tác liên quan đến tín hiệu hoặc các giao dịch nguyên tử. Bằng cách tuân theo các phương pháp thực hành tốt nhất và xem xét các khía cạnh quốc tế hóa, bạn có thể tạo một bộ kiểm thử mạnh mẽ, đảm bảo chất lượng và khả năng bảo trì của các ứng dụng Django của bạn.

Tìm hiểu thêm

• Tài liệu Kiểm thử Django
• Tài liệu unittest của Python
• Tài liệu pytest