Levelwise
فارسی
تست

توسعه آزمون‌محور (TDD)

در TDD اول یک تست کوچک می‌نویسیم که شکست می‌خورد. بعد ساده‌ترین کدی را می‌نویسیم که آن را سبز کند. بعد کد را تمیز می‌کنیم. این چرخه کوتاه هم تست می‌سازد و هم طراحی کد را بهتر می‌کند.

بازبینی نشدهبا کمک AI نوشته شدهزمان خواندن: ۱۲ دقیقهمثال هزینه ارسال در فروشگاه اینترنتیکد C# و xUnit

نویسنده: bezzad

مشکل: تستی که هیچ وقت نوشته نمی‌شود

تیم فروش فروشگاه ما یک قانون جدید می‌خواهد: «هزینه ارسال ۵۰ هزار تومان است. ولی سفارش ۵۰۰ هزار تومانی یا بیشتر، ارسال رایگان دارد.»

روش معمول این است:

  1. کد کامل را یک‌جا می‌نویسیم. گاهی همراه چند حالت اضافه که «شاید بعداً لازم شود».
  2. دستی امتحان می‌کنیم. کار می‌کند. خوشحالیم.
  3. می‌گوییم تست را بعداً می‌نویسیم. ولی کار بعدی می‌رسد و تست هیچ وقت نوشته نمی‌شود.
  4. اگر هم بنویسیم، سخت است. چون کلاس از اول برای تست شدن طراحی نشده است. مثلاً مستقیم به دیتابیس یا ساعت سیستم وصل است.
اول کد، بعد تستکد کامل، یک‌جاکلاس با وابستگی سخت«تست را بعداً می‌نویسم»تست کم یا هیچاول تست، بعد کدیک تست کوچککد کم برای سبز شدنتمیز کردن با خیال راحتهر رفتار یک تست دارد

ایده TDD: اول تست، بعد کد

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

Red۱. یک تست شکست‌خوردهفقط یک رفتار کوچکباید به دلیل درست قرمز شودGreen۲. ساده‌ترین کدفقط تا تست سبز شودزیبایی مهم نیستRefactor۳. تمیز کردناسم بهتر، حذف تکرارهمه تست‌ها سبز می‌مانندتست بعدی، رفتار بعدیهر دور معمولاً چند دقیقه طول می‌کشد
سه قدم کوتاه که مدام تکرار می‌شوند.
  1. قرمز (Red). یک تست کوچک برای یک رفتار جدید بنویس. آن را اجرا کن و ببین که شکست می‌خورد. اگر سبز شد، یا رفتار از قبل وجود داشت یا تست اشتباه است.
  2. سبز (Green). ساده‌ترین کدی را بنویس که تست را سبز کند. در این قدم زیبایی کد مهم نیست. فقط سبز شدن مهم است.
  3. بازسازی (Refactor). حالا که همه تست‌ها سبزند، کد را تمیز کن. اسم‌ها را بهتر کن و تکرار را حذف کن. بعد از هر تغییر کوچک، تست‌ها را اجرا کن.
چرا باید اول قرمز شدن را ببینیم؟ تستی که هیچ وقت قرمز نشده، شاید هیچ چیزی را چک نمی‌کند. مثلاً Assert آن اشتباه است یا اصلاً اجرا نمی‌شود. دیدن قرمز ثابت می‌کند که تست واقعاً می‌تواند خطا را بگیرد.

مثال زنده

قانون هزینه ارسال را قدم به قدم با TDD بساز. به رنگ هر قدم و به تغییر کد دقت کن:

مثال زنده: قانون هزینه ارسال با TDD
تست‌ها
    کد اصلی

    به قدم دوم دقت کن. کد «همیشه ۵۰ هزار برگردان» عجیب به نظر می‌رسد. ولی این کار عمدی است و دو دلیل دارد:

    1. قدم کوچک می‌ماند. اگر چیزی خراب شد، می‌دانیم دقیقاً کدام تغییر آن را خراب کرد.
    2. تست بعدی کد را مجبور به کلی شدن می‌کند. کنت بک (Kent Beck) به این کار Triangulation می‌گوید. یعنی با دو یا چند مثال، کد را به سمت قانون کلی هل می‌دهیم.

    اگر راه حل از اول کاملاً روشن است، لازم نیست این قدم‌های خیلی کوچک را برداری. می‌توانی مستقیم کد درست را بنویسی. ولی وقتی مطمئن نیستی، قدم‌ها را کوچک‌تر کن.

    کد نهایی

    بعد از چند دور، تست‌ها و کد این شکل را دارند:

    public class ShippingCostTests
    {
        [Theory]
        [InlineData(200_000, false, 50_000)]
        [InlineData(499_999, false, 50_000)]
        [InlineData(500_000, false, 0)]
        [InlineData(200_000, true, 0)]
        public void Shipping_cost_follows_the_rules(int total, bool isVip, int expected)
        {
            var cost = ShippingCost.For(total, isVip);
    
            Assert.Equal(expected, cost);
        }
    }
    public static class ShippingCost
    {
        private const decimal FreeFrom = 500_000m;
        private const decimal Standard = 50_000m;
    
        public static decimal For(decimal orderTotal, bool isVip) =>
            isVip || orderTotal >= FreeFrom ? 0m : Standard;
    }

    به دو ردیف ۴۹۹٬۹۹۹ و ۵۰۰٬۰۰۰ دقت کن. این‌ها مرز قانون هستند. نوشتن تست قبل از کد، ما را مجبور می‌کند درباره همین مرزها فکر کنیم و از تیم فروش بپرسیم: «۵۰۰ هزار دقیقاً رایگان است یا از آن به بعد؟»

    چرا TDD کمک می‌کند؟

    1. طراحی بهتر. وقتی اول تست را می‌نویسی، اول از دید استفاده‌کننده به کلاس نگاه می‌کنی. کلاسی که تستش سخت است، معمولاً طراحی بدی دارد. این را خیلی زود می‌فهمی.
    2. فقط کد لازم. هر خط کد به خاطر یک تست نوشته شده است. کد اضافه «برای روز مبادا» کمتر نوشته می‌شود.
    3. شبکه ایمنی. هر رفتار یک تست دارد. پس بازسازی بعدی ترسناک نیست.
    4. مستندات زنده. اسم تست‌ها قانون‌های کسب‌وکار را توضیح می‌دهند و همیشه با کد هماهنگ هستند.
    5. قدم‌های کوچک. همیشه چند دقیقه با یک حالت سالم فاصله داری. اگر گم شدی، تغییر آخر را برمی‌گردانی.
    هزینه هم دارد: در شروع کار، TDD کندتر از نوشتن مستقیم کد است. یادگرفتنش هم تمرین می‌خواهد. سود آن بیشتر بعداً دیده می‌شود: باگ کمتر و تغییر راحت‌تر.

    دو سبک: از داخل به بیرون، از بیرون به داخل

    از داخل به بیرون (سبک کلاسیک)

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

    از بیرون به داخل (سبک لندن)

    • از یک تست برای کل قابلیت، مثلاً Endpoint ثبت سفارش، شروع می‌کنی.
    • کلاس‌های داخلی را اول با Mock فرض می‌کنی، بعد یکی یکی می‌سازی.
    • رابط کلاس‌ها از نیاز واقعی استفاده‌کننده بیرون می‌آید.
    • خطر: Mock زیاد، تست را به پیاده‌سازی وابسته می‌کند.

    قانون‌های مهم

    1. هر بار فقط یک تست قرمز. چند تست قرمز با هم یعنی قدم خیلی بزرگ است.
    2. قدم بازسازی را جا نینداز. بدون آن، TDD فقط کد شلوغ با تست تولید می‌کند.
    3. در قدم سبز، کد اضافه ننویس. اگر رفتار جدیدی به ذهنت رسید، آن را در یک لیست بنویس. بعداً با یک تست جدید سراغش برو.
    4. رفتار را تست کن، نه پیاده‌سازی را. وگرنه قدم بازسازی تست‌ها را می‌شکند و TDD دردناک می‌شود.
    5. تست‌ها سریع باشند. چرخه TDD چند دقیقه است. اگر اجرای تست‌ها یک دقیقه طول بکشد، چرخه از بین می‌رود.

    اشتباه‌های رایج

    اشتباه نتیجه راه درست
    نوشتن ده تست، بعد نوشتن کد چند تست قرمز با هم. معلوم نیست از کجا شروع کنی. یک تست، یک قدم.
    ندیدن قرمز قبل از سبز تستی که هیچ چیزی را چک نمی‌کند، سبز می‌ماند. همیشه اول شکست را ببین.
    حذف قدم بازسازی کد کار می‌کند، ولی کثیف و پر از تکرار است. بعد از هر سبز، کمی تمیز کن.
    تست متدهای خصوصی و جزئیات هر بازسازی تست‌ها را می‌شکند. فقط از راه رفتار عمومی تست کن.
    اجبار به TDD برای همه چیز زمان روی کدهای آزمایشی و دورریختنی هدر می‌رود. جایی که منطق و قانون هست.

    چه وقت TDD؟

    مناسب

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

    نامناسب

    • کد آزمایشی (Spike) برای یاد گرفتن یک کتابخانه. بعد از یادگیری، آن را دور بریز و با TDD دوباره بنویس.
    • چیدمان و ظاهر صفحه.
    • وقتی هنوز نمی‌دانی مسئله دقیقاً چیست.

    خلاصه در شش خط

    1. در TDD هیچ کد اصلی بدون یک تست قرمز نوشته نمی‌شود.
    2. چرخه سه قدم دارد: قرمز، سبز، بازسازی.
    3. در قدم سبز ساده‌ترین کد کافی است. تست‌های بعدی کد را کلی‌تر می‌کنند.
    4. بازسازی فقط وقتی انجام می‌شود که همه تست‌ها سبزند.
    5. سود اصلی TDD طراحی بهتر و شبکه ایمنی برای تغییر است، نه فقط تعداد تست.
    6. برای منطق و قانون عالی است. برای کد آزمایشی و ظاهر صفحه لازم نیست.