۱۴۰۵ آبان ۲۶, سه‌شنبه
دلار آمریکا۲۶۷٬۹۰۰▼ ۰٫۳٪یورو۲۹۴٬۶۴۰▼ ۰٫۵۹٪درهم امارات۷۲٬۹۲۷▼ ۰٫۴٪سکه امامی۲۵۱٬۵۸۵٬۰۰۰▲ ۰٫۴۱٪طلای ۱۸ عیار (گرم)۲۴٬۶۷۸٬۴۰۰▲ ۰٫۴۵٪انس طلا۳٬۸۵۶ $▼ ۰٫۲۳٪تتر۲۶۹٬۵۰۳▲ ۰٫۰۴٪بیت‌کوین۶۴٬۹۶۷ $▼ ۰٫۳۶٪اتریوم۱٬۸۲۲ $▼ ۰٫۱۱٪سولانا۷۳٫۹۵ $▲ ۳٫۴۳٪اپل۳۵۲٫۷۸ $▼ ۰٫۹۸٪انویدیا۱۵۶٫۱۴ $▼ ۴٫۱۲٪مایکروسافت۵۱۷٫۹۹ $▼ ۱٫۱۲٪آلفابت (گوگل)۲۸۳٫۷۲ $▼ ۴٫۰۷٪تسلا۳۷۹٫۷۴ $▼ ۲٫۶۹٪شاخص نزدک۲۴٬۵۱۰ $▼ ۲٫۴۹٪
نرخ ارز

آموزش تست‌نویسی در پایتون؛ تست واحد و TDD با pytest

آموزش تست‌نویسی در پایتون با pytest و روش TDD: چرخه‌ی «قرمز، سبز، بازآرایی»، تست پارامتری، fixture، پوشش کد و اجرای خودکار تست‌ها در CI.

کاور گرافیکی DevNA با عنوان «pytest & TDD»: تست واحد در پایتون قدم‌به‌قدم
کاور گرافیکی DevNA با عنوان «pytest & TDD»: تست واحد در پایتون قدم‌به‌قدم
فهرست مطالب
  1. تست واحد چیست و کجای هرم تست نرم‌افزار قرار دارد؟
  2. چرا تست‌نویسی ارزش وقت گذاشتن دارد؟
  3. آماده‌سازی پروژه و نصب pytest
  4. TDD چیست؟ چرخه‌ی قرمز، سبز، بازآرایی
  5. قدم ۱ (قرمز): اولین تست
  6. قدم ۲ (سبز): ساده‌ترین پیاده‌سازی
  7. قدم ۳ (قرمز): تست پارامتری برای قالب‌های مختلف
  8. قدم ۴ (سبز): پیاده‌سازی کامل
  9. قدم ۵ (بازآرایی): تمیز کردن با خیال راحت
  10. فیکسچر: آماده‌سازی داده و محیط برای تست
  11. سنجش پوشش کد
  12. اگر نمی‌خواهید بسته‌ای نصب کنید: unittest
  13. ویژگی‌های یک تست واحد خوب
  14. اجرای خودکار تست‌ها در CI
  15. اشتباهات رایج در تست‌نویسی
  16. قدم بعدی

تست‌نویسی خودکار یعنی نوشتن کدی که درستی کد دیگر را می‌سنجد، تا هر بار که چیزی را تغییر می‌دهید، در چند ثانیه بفهمید چیزی خراب شده است یا نه. در این آموزش تست واحد را با pytest یاد می‌گیریم و با روش توسعه‌ی آزمون‌محور (Test-Driven Development یا TDD) یک تابع واقعی برای نرمال‌سازی شماره‌ی موبایل ایرانی را قدم‌به‌قدم می‌سازیم.

همه‌ی کدها روی Python 3.14 و pytest 9 اجرا و آزمایش شده‌اند.

تست واحد چیست و کجای هرم تست نرم‌افزار قرار دارد؟

تست واحد (Unit Test) کوچک‌ترین بخش منطقی برنامه، معمولاً یک تابع یا کلاس، را جدا از پایگاه داده، شبکه و فایل‌سیستم می‌آزماید. همین جداسازی باعث می‌شود صدها تست واحد در کمتر از یک ثانیه اجرا شوند.

هم وکه (Ham Vocke) در مقاله‌ی «هرم عملی تست» روی سایت مارتین فاولر، توصیه‌ی مشهور هرم تست (Test Pyramid) را این‌طور خلاصه می‌کند: تعداد زیادی تست واحد کوچک و سریع، تعدادی تست درشت‌تر یکپارچه‌سازی و تعداد خیلی کمی تست سرتاسری (End-to-End) که کل برنامه را از دید کاربر می‌آزماید.

لایه چه چیزی را می‌آزماید سرعت تعداد
تست واحد یک تابع یا کلاس میلی‌ثانیه زیاد
تست یکپارچه‌سازی تعامل با پایگاه داده یا سرویس دیگر ثانیه متوسط
تست سرتاسری کل سناریو از دید کاربر ده‌ها ثانیه کم

چرا تست‌نویسی ارزش وقت گذاشتن دارد؟

  • تغییر بدون ترس: با مجموعه‌ی تست خوب، بازآرایی و ارتقای کتابخانه‌ها دیگر قمار نیست.
  • مستندات زنده: تست‌ها دقیقاً نشان می‌دهند تابع با چه ورودی‌ای چه خروجی‌ای می‌دهد و برخلاف مستندات، کهنه نمی‌شوند.
  • طراحی بهتر: کدی که تست کردنش سخت است، معمولاً وابستگی‌های درهم دارد. تست زودتر از هر بازبینی این را فاش می‌کند.
  • باگ کمتر در محیط عملیاتی: خطا در لپ‌تاپ شما پیدا می‌شود، نه در گزارش کاربر.

آماده‌سازی پروژه و نصب pytest

یک پوشه‌ی تازه بسازید، محیط مجازی را فعال کنید و pytest را نصب کنید:

mkdir phone-normalizer && cd phone-normalizer
python -m venv .venv
source .venv/bin/activate        # Windows: .venv\Scripts\Activate.ps1
python -m pip install -U pytest pytest-cov

ساختار پروژه این‌طور خواهد بود:

phone-normalizer/
├── phone.py
├── pyproject.toml
└── tests/
    └── test_phone.py

در pyproject.toml به pytest بگویید تست‌ها کجا هستند و ریشه‌ی پروژه را در مسیر import قرار دهد:

[tool.pytest.ini_options]
pythonpath = ["."]
testpaths = ["tests"]

طبق مستندات pytest، فایل‌هایی با الگوی test_*.py یا *_test.py و توابعی که با test_ شروع می‌شوند، خودکار پیدا و اجرا می‌شوند.

TDD چیست؟ چرخه‌ی قرمز، سبز، بازآرایی

مارتین فاولر TDD را که کنت بک در اواخر دهه‌ی ۱۹۹۰ در قالب برنامه‌نویسی مفرط (Extreme Programming) توسعه داد، در سه قدم تکرارشونده خلاصه می‌کند:

  1. قرمز: برای رفتار بعدی تستی بنویسید که شکست بخورد.
  2. سبز: ساده‌ترین کدی را بنویسید که تست را پاس کند.
  3. بازآرایی: کد تازه و قدیمی را تمیز کنید، در حالی که تست‌ها سبز می‌مانند.

فاولر هشدار می‌دهد رایج‌ترین راه خراب کردن TDD، نادیده گرفتن قدم سوم است. حالا این چرخه را روی یک مسئله‌ی واقعی اجرا کنیم: تابعی که شماره موبایل ایرانی را با هر قالبی بگیرد و به قالب استاندارد بین‌المللی +989123456789 برگرداند.

قدم ۱ (قرمز): اولین تست

فایل tests/test_phone.py:

from phone import normalize_mobile


def test_local_format_becomes_international():
    assert normalize_mobile("09123456789") == "+989123456789"

و فقط اسکلت تابع در phone.py:

def normalize_mobile(raw: str) -> str:
    raise NotImplementedError

اجرا کنید:

python -m pytest -q

تست شکست می‌خورد و pytest در خلاصه‌ی خروجی علت را نشان می‌دهد: NotImplementedError. این قرمز عمدی است؛ ثابت می‌کند تست واقعاً اجرا می‌شود و می‌تواند شکست بخورد.

قدم ۲ (سبز): ساده‌ترین پیاده‌سازی

def normalize_mobile(raw: str) -> str:
    return "+98" + raw[1:]

شاید ساده‌لوحانه به نظر برسد، اما دقیقاً همین هدف است: فقط به اندازه‌ی تست فعلی کد بنویسید. تست سبز می‌شود. حالا نیاز واقعی را با تست‌های بیشتر بیان می‌کنیم.

قدم ۳ (قرمز): تست پارامتری برای قالب‌های مختلف

کاربران شماره را با فاصله، خط تیره، پیش‌شماره‌ی کشور و حتی ارقام فارسی وارد می‌کنند. به‌جای نوشتن پنج تست تکراری، از pytest.mark.parametrize استفاده کنید. برای ورودی‌های نامعتبر هم با pytest.raises انتظار خطا را بیان می‌کنیم. این‌ها را به فایل تست اضافه کنید:

import pytest


@pytest.mark.parametrize(
    "raw",
    [
        "0912 345 6789",
        "0912-345-6789",
        "+98 912 345 6789",
        "00989123456789",
        "۰۹۱۲۳۴۵۶۷۸۹",
    ],
)
def test_accepts_common_formats(raw):
    assert normalize_mobile(raw) == "+989123456789"


@pytest.mark.parametrize("raw", ["", "12345", "0212345678", "0912345678a"])
def test_rejects_invalid_numbers(raw):
    with pytest.raises(ValueError):
        normalize_mobile(raw)

با اجرای دوباره‌ی pytest، نه تست از ده تست قرمز می‌شوند. هر ورودی پارامتری در گزارش جداگانه نام برده می‌شود، پس دقیقاً می‌دانید کدام حالت شکست خورده است.

قدم ۴ (سبز): پیاده‌سازی کامل

import re


def normalize_mobile(raw: str) -> str:
    number = raw
    for digit, persian in enumerate("۰۱۲۳۴۵۶۷۸۹"):
        number = number.replace(persian, str(digit))
    number = re.sub(r"[\s\-()]", "", number)
    if number.startswith("+98"):
        number = number[3:]
    elif number.startswith("0098"):
        number = number[4:]
    elif number.startswith("0"):
        number = number[1:]
    if not re.fullmatch(r"9[0-9]{9}", number):
        raise ValueError(f"invalid Iranian mobile number: {raw!r}")
    return "+98" + number

همه‌ی ده تست سبز می‌شوند. در الگوی نهایی عمداً [0-9] نوشته‌ایم نه \d، چون \d در پایتون ارقام یونی‌کد دیگر را هم می‌پذیرد و ما فقط ارقام لاتین را پس از تبدیل می‌خواهیم.

قدم ۵ (بازآرایی): تمیز کردن با خیال راحت

کد کار می‌کند، اما زنجیره‌ی if/elif و الگوهای پراکنده خوانا نیستند. حالا که تست‌ها پشت ما هستند، ساختار را بهتر می‌کنیم:

import re

PERSIAN_DIGITS = str.maketrans("۰۱۲۳۴۵۶۷۸۹", "0123456789")
SEPARATORS = re.compile(r"[\s\-()]")
COUNTRY_PREFIXES = ("+98", "0098", "0")  # order matters: "0098" before "0"
MOBILE_PATTERN = re.compile(r"9[0-9]{9}")


def _strip_prefix(number: str) -> str:
    for prefix in COUNTRY_PREFIXES:
        if number.startswith(prefix):
            return number[len(prefix):]
    return number


def normalize_mobile(raw: str) -> str:
    """Return an Iranian mobile number in E.164 form, e.g. +989123456789."""
    number = SEPARATORS.sub("", raw.translate(PERSIAN_DIGITS))
    number = _strip_prefix(number)
    if not MOBILE_PATTERN.fullmatch(number):
        raise ValueError(f"invalid Iranian mobile number: {raw!r}")
    return "+98" + number

دوباره python -m pytest -q را اجرا کنید؛ هر ده تست سبز است. این همان اطمینانی است که TDD می‌دهد: ساختار عوض شد، رفتار نه. اصولی که در این بازآرایی به کار بردیم، مثل ثابت‌های نام‌دار و توابع کوچک، در راهنمای اصول کلین کد مفصل آمده است.

فیکسچر: آماده‌سازی داده و محیط برای تست

فیکسچر (Fixture) در pytest منبعی آماده برای تست فراهم می‌کند. فیکسچر داخلی tmp_path یک پوشه‌ی موقت و مخصوص هر تست می‌سازد. فرض کنید تابعی داریم که شماره‌ها را از فایل می‌خواند؛ این را به phone.py اضافه کنید:

def load_numbers(path):
    """Read one number per line from a text file and normalize each one."""
    lines = path.read_text(encoding="utf-8").splitlines()
    return [normalize_mobile(line) for line in lines if line.strip()]

و تستش را بدون دست زدن به فایل‌های واقعی سیستم بنویسید:

from phone import load_numbers


def test_load_numbers_skips_blank_lines(tmp_path):
    contacts = tmp_path / "contacts.txt"
    contacts.write_text("09121111111\n\n+98 935 222 3333\n", encoding="utf-8")

    assert load_numbers(contacts) == ["+989121111111", "+989352223333"]

برای جایگزین کردن موقت متغیرهای محیطی یا توابع، فیکسچر monkeypatch به کار می‌آید:

# config.py
import os

from phone import normalize_mobile


def default_sender() -> str:
    return normalize_mobile(os.environ["SMS_SENDER"])
from config import default_sender


def test_default_sender_reads_environment(monkeypatch):
    monkeypatch.setenv("SMS_SENDER", "0935 111 2222")
    assert default_sender() == "+989351112222"

monkeypatch پس از پایان تست همه‌چیز را به حالت قبل برمی‌گرداند، پس تست‌ها روی هم اثر نمی‌گذارند.

فیکسچرهای خودتان را هم می‌توانید با دکوراتور @pytest.fixture تعریف کنید و اگر در چند فایل تست به آن‌ها نیاز دارید، در فایل conftest.py کنار تست‌ها قرار دهید تا pytest خودکار پیدایشان کند.

سنجش پوشش کد

افزونه‌ی pytest-cov نشان می‌دهد تست‌ها کدام خط‌ها را اجرا کرده‌اند و کدام را نه:

python -m pytest --cov=phone --cov-report=term-missing

ستون Missing شماره‌ی خط‌های تست‌نشده را نشان می‌دهد. در پروژه‌ی ما پوشش صددرصد است، اما یادتان باشد پوشش فقط می‌گوید خطی اجرا شده، نه اینکه نتیجه‌اش درست بررسی شده باشد. تستی بدون assert هم پوشش را بالا می‌برد.

اگر نمی‌خواهید بسته‌ای نصب کنید: unittest

پایتون در کتابخانه‌ی استاندارد خود چارچوب unittest را دارد که از JUnit الهام گرفته است. همان تست‌ها با unittest این شکل را پیدا می‌کنند:

import unittest

from phone import normalize_mobile


class NormalizeMobileTest(unittest.TestCase):
    def test_local_format(self):
        self.assertEqual(normalize_mobile("09123456789"), "+989123456789")

    def test_invalid_number(self):
        with self.assertRaises(ValueError):
            normalize_mobile("12345")


if __name__ == "__main__":
    unittest.main()

این تست‌ها را از ریشه‌ی پروژه با python -m unittest discover -s tests اجرا کنید. خبر خوب اینکه pytest تست‌های نوشته‌شده با unittest را هم پیدا و اجرا می‌کند؛ پس اگر پروژه‌ی قدیمی شما تست‌های unittest دارد، می‌توانید بدون بازنویسی به pytest مهاجرت کنید و تست‌های تازه را با سبک ساده‌تر pytest بنویسید.

ویژگی‌های یک تست واحد خوب

  • سریع: اگر تست‌ها کند باشند، کسی اجرایشان نمی‌کند.
  • مستقل: ترتیب اجرای تست‌ها نباید روی نتیجه اثر بگذارد.
  • تکرارپذیر: به ساعت سیستم، شبکه یا داده‌ی تصادفی کنترل‌نشده وابسته نباشد.
  • یک رفتار در هر تست: نام تست باید بگوید چه چیزی را ثابت می‌کند؛ مثل test_rejects_invalid_numbers.
  • الگوی آماده‌سازی، اجرا، بررسی: داده را آماده کنید، تابع را صدا بزنید و نتیجه را بسنجید؛ هر بخش جدا و خوانا.

اجرای خودکار تست‌ها در CI

تستی که فقط روی لپ‌تاپ شما اجرا شود، نیمی از ارزشش را از دست می‌دهد. با افزودن این دو مرحله به پایپ‌لاین، هر push و pull request خودکار آزموده می‌شود:

- run: python -m pip install pytest pytest-cov
- run: python -m pytest --cov=phone

راه‌اندازی کامل یک workflow را در آموزش CI/CD با GitHub Actions ببینید.

اشتباهات رایج در تست‌نویسی

  • تست جزئیات پیاده‌سازی به‌جای رفتار: اگر با هر بازآرایی تست‌ها می‌شکنند، احتمالاً جزئیات داخلی را آزموده‌اید.
  • ماک کردن همه‌چیز: تستی که همه‌ی وابستگی‌هایش جعلی است، فقط ماک‌ها را می‌آزماید.
  • رها کردن تست قرمز: تستی که همیشه شکست می‌خورد و کسی به آن اهمیت نمی‌دهد، اعتماد به کل مجموعه را از بین می‌برد.
  • تستی که هرگز قرمز نشده: اگر تستی را هیچ‌وقت در حال شکست ندیده‌اید، مطمئن نیستید واقعاً چیزی را می‌سنجد. یک بار عمداً کد را خراب کنید و ببینید تست شکست می‌خورد یا نه؛ همان کاری که قدم قرمز TDD به‌طور طبیعی برایتان انجام می‌دهد.

قدم بعدی

اگر هنوز با مبانی زبان راحت نیستید، آموزش پایتون از صفر نقطه‌ی شروع است. توسعه‌دهنده‌های جاوااسکریپت هم می‌توانند همین چرخه را با ابزارهای تست آن اکوسیستم اجرا کنند؛ آموزش TypeScript برای توسعه‌دهندگان جاوااسکریپت پایه‌ی خوبی برای آن است. تمرین پیشنهادی: پشتیبانی از ارقام عربی (مثل «٠٩١٢…») را اضافه کنید، اما این بار اول تستش را بنویسید.

$ devna rate --article

—
هنوز رأیی ثبت نشده
  1. ۵۰
  2. ۴۰
  3. ۳۰
  4. ۲۰
  5. ۱۰

این مطلب چقدر به کارتان آمد؟

روی ستاره‌ها بزنید

واکنش شما

اولین نفری باشید که واکنش نشان می‌دهد.

پرسش‌های پرتکرار

فرق تست واحد (Unit Test) با تست یکپارچه‌سازی چیست؟

تست واحد یک تابع یا کلاس را جدا از بقیه‌ی سیستم و بدون پایگاه داده یا شبکه می‌آزماید و در چند میلی‌ثانیه اجرا می‌شود. تست یکپارچه‌سازی بررسی می‌کند چند بخش، مثلاً کد شما و پایگاه داده، درست با هم کار می‌کنند.

آیا TDD برای همه‌ی پروژه‌ها مناسب است؟

TDD برای منطق کسب‌وکار، محاسبات و اعتبارسنجی بسیار مفید است. برای نمونه‌سازی سریع یا کدی که هنوز نمی‌دانید چه شکلی باید داشته باشد، می‌توانید اول کد بنویسید و بعد از تثبیت طراحی، تست اضافه کنید.

آیا پوشش ۱۰۰ درصدی کد یعنی برنامه باگ ندارد؟

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

pytest بهتر است یا unittest؟

unittest در کتابخانه‌ی استاندارد پایتون است و نصب نمی‌خواهد. pytest با assert ساده، fixtureها و گزارش خطای دقیق‌تر، تست‌ها را کوتاه‌تر می‌کند و تست‌های unittest را هم اجرا می‌کند.

منابع

  1. pytest documentation – Get Started
  2. pytest documentation – How to parametrize fixtures and test functions
  3. Martin Fowler – Test Driven Development
  4. Ham Vocke – The Practical Test Pyramid (martinfowler.com)
  5. unittest — Unit testing framework

خطایی در این مطلب دیدید؟ به تحریریه گزارش دهید؛ اصلاحیه‌ها طبق اصول تحریریه ثبت می‌شوند.

دیدگاه‌ها

۰/۲٬۰۰۰

دیدگاه‌ها پس از بررسی تحریریه منتشر می‌شوند. توهین، تبلیغ و لینک‌های بی‌ربط حذف می‌شوند؛ نقد فنی و مستند همیشه خوش‌آمد است.

$ comments --count۰

هنوز کسی چیزی ننوشته. اولین دیدگاه را شما ثبت کنید.

مطالب مرتبط