استفاده از Mock در پایتون: مفاهیم متوسط

در توسعه نرم‌افزار، به ویژه در پایتون، نوشتن تست‌های واحد (Unit Tests) برای اطمینان از صحت عملکرد کد بسیار مهم است. اما گاهی اوقات، تست کردن یک تابع یا کلاس به دلیل وابستگی به اجزای خارجی (مانند پایگاه داده، APIهای وب، یا سایر ماژول‌ها) دشوار می‌شود. در این موارد، استفاده از تکنیک Mocking می‌تواند بسیار مفید باشد. این مقاله به بررسی عمیق Mocking در پایتون می‌پردازد و نحوه استفاده از کتابخانه unittest.mock را توضیح می‌دهد.

چرا Mocking؟

Mocking به معنای جایگزین کردن وابستگی‌های خارجی با نسخه‌های شبیه‌سازی شده (Mock) است. این کار چندین مزیت دارد:

• جلوگیری از وابستگی به محیط خارجی: تست‌ها نباید به عوامل خارجی مانند اتصال به اینترنت یا وجود یک پایگاه داده خاص وابسته باشند. Mocking این وابستگی‌ها را حذف می‌کند.
• سرعت تست‌ها: فراخوانی APIهای وب یا دسترسی به پایگاه داده می‌تواند زمان‌بر باشد. Mocking باعث می‌شود تست‌ها بسیار سریع‌تر اجرا شوند.
• کنترل کامل بر رفتار وابستگی‌ها: با استفاده از Mocking، می‌توانید رفتار وابستگی‌ها را به طور دقیق کنترل کنید و سناریوهای مختلفی را شبیه‌سازی کنید، از جمله سناریوهای خطا.
• تست ایزوله: Mocking به شما کمک می‌کند تا کد خود را به صورت ایزوله تست کنید، یعنی فقط عملکرد واحد مورد نظر را بررسی کنید بدون اینکه نگران تاثیر سایر اجزا باشید.

کتابخانه unittest.mock

کتابخانه unittest.mock که به طور پیش‌فرض در پایتون 3.3 و بالاتر موجود است، ابزارهای قدرتمندی برای ایجاد Mock فراهم می‌کند. این کتابخانه به شما امکان می‌دهد تا اشیاء، توابع و کلاس‌ها را Mock کنید.

Mock کردن توابع و متدها

ساده‌ترین حالت Mocking، جایگزین کردن یک تابع یا متد با یک Mock است. برای این کار می‌توانید از Mock یا patch استفاده کنید.

استفاده از Mock

Mock یک کلاس است که می‌توانید از آن برای ایجاد یک Mock object استفاده کنید. این Mock object می‌تواند رفتار مورد نظر شما را شبیه‌سازی کند.

from unittest.mock import Mock

def my_function():
  # کد اصلی
  pass

mock_function = Mock()
mock_function.return_value = "Mocked Value"

result = mock_function()
print(result)  # Output: Mocked Value

در این مثال، my_function با mock_function جایگزین شده است. وقتی mock_function فراخوانی می‌شود، به جای اجرای کد اصلی، مقدار return_value را برمی‌گرداند.

استفاده از patch

patch یک دکوراتور یا context manager است که به شما امکان می‌دهد یک تابع یا متد را به طور موقت با یک Mock جایگزین کنید. این روش معمولاً برای تست کردن توابعی که به ماژول‌های دیگر وابسته هستند، استفاده می‌شود.

from unittest.mock import patch

def function_to_test(dependency):
  return dependency()

@patch('module_name.dependency')
def test_function_to_test(mock_dependency):
  mock_dependency.return_value = "Mocked Dependency"
  result = function_to_test(mock_dependency)
  assert result == "Mocked Dependency"

در این مثال، تابع dependency در ماژول module_name با یک Mock object جایگزین شده است. در طول اجرای تست، هر بار که function_to_test تابع dependency را فراخوانی می‌کند، در واقع Mock object فراخوانی می‌شود.

Mock کردن کلاس‌ها

همانطور که می‌توانید توابع و متدها را Mock کنید، می‌توانید کلاس‌ها را نیز Mock کنید. این کار به شما امکان می‌دهد رفتار یک کلاس را بدون نیاز به ایجاد یک نمونه واقعی از آن شبیه‌سازی کنید.

from unittest.mock import Mock

class MyClass:
  def __init__(self, value):
    self.value = value

  def my_method(self):
    return self.value * 2

mock_class = Mock(spec=MyClass)
mock_class.my_method.return_value = 10

result = mock_class.my_method()
print(result)  # Output: 10

در این مثال، کلاس MyClass با mock_class جایگزین شده است. پارامتر spec در Mock به شما امکان می‌دهد تا نوع کلاس اصلی را مشخص کنید. این کار باعث می‌شود Mock object فقط متدهایی را داشته باشد که در کلاس اصلی وجود دارند.

بررسی فراخوانی‌ها (Assertions)

یکی از مهم‌ترین جنبه‌های Mocking، بررسی این است که آیا توابع و متدهای Mock شده به درستی فراخوانی شده‌اند یا خیر. کتابخانه unittest.mock ابزارهای مختلفی برای این کار فراهم می‌کند.

• assert_called(): بررسی می‌کند که آیا Mock object حداقل یک بار فراخوانی شده است یا خیر.
• assert_called_once(): بررسی می‌کند که آیا Mock object دقیقاً یک بار فراخوانی شده است یا خیر.
• assert_called_with(): بررسی می‌کند که آیا Mock object با آرگومان‌های مشخصی فراخوانی شده است یا خیر.
• assert_called_once_with(): بررسی می‌کند که آیا Mock object دقیقاً یک بار با آرگومان‌های مشخصی فراخوانی شده است یا خیر.
• call_count: تعداد دفعاتی که Mock object فراخوانی شده است را برمی‌گرداند.
• call_args: آرگومان‌هایی که با آن‌ها Mock object فراخوانی شده است را برمی‌گرداند.

from unittest.mock import Mock

mock_function = Mock()
mock_function(1, 2)
mock_function(3, 4)

mock_function.assert_called_with(3, 4)
assert mock_function.call_count == 2

Mock کردن وابستگی‌های پیچیده

در برخی موارد، ممکن است نیاز به Mock کردن وابستگی‌های پیچیده‌تری داشته باشید، مانند اشیاء با چندین متد یا کلاس‌هایی که از سایر کلاس‌ها ارث‌بری می‌کنند. در این موارد، می‌توانید از side_effect استفاده کنید.

side_effect به شما امکان می‌دهد تا یک تابع را به عنوان رفتار Mock object تعریف کنید. این تابع هر بار که Mock object فراخوانی می‌شود، اجرا می‌شود و می‌تواند مقدار بازگشتی یا استثنایی را تعیین کند.

from unittest.mock import Mock

def side_effect_function(arg1, arg2):
  return arg1 + arg2

mock_function = Mock(side_effect=side_effect_function)

result = mock_function(1, 2)
print(result)  # Output: 3

در این مثال، تابع side_effect_function هر بار که mock_function فراخوانی می‌شود، اجرا می‌شود و مجموع آرگومان‌ها را برمی‌گرداند.

نکات مهم در استفاده از Mocking

• فقط وابستگی‌های خارجی را Mock کنید: Mocking نباید برای تست کردن منطق داخلی کد استفاده شود. هدف Mocking، ایزوله کردن کد از وابستگی‌های خارجی است.
• Mocking را به حداقل برسانید: هرچه Mocking کمتری داشته باشید، تست‌های شما واقعی‌تر و قابل اعتمادتر خواهند بود.
• رفتار Mock را به دقت تعریف کنید: Mock object باید رفتار وابستگی خارجی را به طور دقیق شبیه‌سازی کند.
• از نام‌های واضح برای Mock objectها استفاده کنید: این کار باعث می‌شود تست‌های شما خواناتر و قابل فهم‌تر باشند.

نتیجه‌گیری

Mocking یک تکنیک قدرتمند برای نوشتن تست‌های واحد در پایتون است. با استفاده از کتابخانه unittest.mock، می‌توانید وابستگی‌های خارجی را به راحتی Mock کنید و تست‌های سریع، ایزوله و قابل اعتماد بنویسید. با رعایت نکات مهم در استفاده از Mocking، می‌توانید از مزایای این تکنیک به طور کامل بهره‌مند شوید و کیفیت کد خود را بهبود بخشید.