تست واحد در Laravel: راهنمای جامع

تست واحد (Unit Testing) یکی از مهم‌ترین جنبه‌های توسعه نرم‌افزار مدرن است. در Laravel، فریم‌ورک محبوب PHP، تست واحد به شما کمک می‌کند تا اطمینان حاصل کنید که هر بخش کوچک از کد شما (واحد) به درستی کار می‌کند. این مقاله به بررسی عمیق تست واحد در Laravel می‌پردازد، از مفاهیم پایه تا پیاده‌سازی عملی و بهترین شیوه‌ها.

چرا تست واحد مهم است؟

تست واحد مزایای متعددی دارد که عبارتند از:

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

مفاهیم پایه تست واحد

قبل از شروع نوشتن تست واحد در Laravel، باید با مفاهیم پایه آن آشنا شوید:

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

ساختار تست در Laravel

Laravel ساختار مشخصی برای تست‌ها ارائه می‌دهد. به طور پیش‌فرض، تست‌های شما در دایرکتوری tests قرار می‌گیرند. در داخل این دایرکتوری، معمولاً دو زیردایرکتوری وجود دارد:

• Unit: برای تست‌های واحد منطق کسب و کار (Business Logic)
• Feature: برای تست‌های یکپارچگی (Integration Tests) که تعامل بین چندین بخش از کد را بررسی می‌کنند.

برای ایجاد یک تست واحد، می‌توانید از دستور Artisan زیر استفاده کنید:

php artisan make:test YourTestClass

این دستور یک فایل تست جدید در دایرکتوری tests/Unit ایجاد می‌کند.

نوشتن تست واحد در Laravel

برای نوشتن یک تست واحد، باید یک کلاس تست ایجاد کنید که از کلاس TestCase ارث‌بری کند. در داخل کلاس تست، می‌توانید متدهایی را تعریف کنید که هر کدام یک تست واحد را نشان می‌دهند. نام متدهای تست باید با پیشوند test شروع شوند.

در اینجا یک مثال ساده از یک تست واحد برای یک تابع جمع آورده شده است:

namespace TestsUnit;

use PHPUnitFrameworkTestCase;

class ExampleTest extends TestCase
{
    public function testSum()
    {
        $result = 2 + 2;
        $this->assertEquals(4, $result);
    }
}

در این مثال، متد testSum یک تست واحد است که بررسی می‌کند آیا نتیجه جمع 2 و 2 برابر با 4 است یا خیر. از متد assertEquals برای بررسی برابری دو مقدار استفاده شده است.

Assertions در Laravel

Laravel مجموعه‌ای غنی از assertions را ارائه می‌دهد که می‌توانید از آنها برای بررسی عملکرد کد خود استفاده کنید. برخی از مهم‌ترین assertions عبارتند از:

• assertEquals($expected, $actual): بررسی می‌کند که آیا دو مقدار برابر هستند یا خیر.
• assertNotEquals($expected, $actual): بررسی می‌کند که آیا دو مقدار برابر نیستند یا خیر.
• assertTrue($condition): بررسی می‌کند که آیا یک شرط درست است یا خیر.
• assertFalse($condition): بررسی می‌کند که آیا یک شرط نادرست است یا خیر.
• assertNull($value): بررسی می‌کند که آیا یک مقدار null است یا خیر.
• assertNotNull($value): بررسی می‌کند که آیا یک مقدار null نیست یا خیر.
• assertContains($needle, $haystack): بررسی می‌کند که آیا یک مقدار در یک آرایه وجود دارد یا خیر.
• assertCount($count, $array): بررسی می‌کند که آیا تعداد عناصر یک آرایه با یک مقدار مشخص برابر است یا خیر.
• assertThrows(Exception::class, function() { … }); بررسی می‌کند که آیا یک تابع یک استثنا (Exception) خاص را پرتاب می‌کند یا خیر.

Mocking در Laravel

Mocking یک تکنیک مهم در تست واحد است که به شما امکان می‌دهد وابستگی‌های یک واحد را شبیه‌سازی کنید. این کار به شما کمک می‌کند تا واحد مورد نظر را به طور مستقل تست کنید، بدون اینکه نگران عملکرد وابستگی‌های آن باشید.

Laravel از کتابخانه Mockery برای mocking استفاده می‌کند. برای ایجاد یک mock، می‌توانید از متد mock در کلاس TestCase استفاده کنید.

در اینجا یک مثال از استفاده از mocking آورده شده است:

namespace TestsUnit;

use AppServicesUserService;
use Mockery;
use PHPUnitFrameworkTestCase;

class UserTest extends TestCase
{
    public function testGetUserById()
    {
        $userService = $this->mock(UserService::class);
        $userService->shouldReceive('getUserById')
            ->with(1)
            ->andReturn(['id' => 1, 'name' => 'John Doe']);

        $user = $userService->getUserById(1);

        $this->assertEquals('John Doe', $user['name']);
    }
}

در این مثال، یک mock از کلاس UserService ایجاد شده است. سپس، با استفاده از متد shouldReceive، مشخص شده است که متد getUserById باید با آرگومان 1 فراخوانی شود و یک آرایه مشخص را برگرداند. در نهایت، متد getUserById فراخوانی شده و نتیجه بررسی می‌شود.

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

برای نوشتن تست‌های واحد موثر و قابل نگهداری، باید از بهترین شیوه‌ها پیروی کنید:

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

اجرای تست‌ها در Laravel

برای اجرای تست‌ها در Laravel، می‌توانید از دستور Artisan زیر استفاده کنید:

php artisan test

این دستور تمام تست‌های شما را اجرا می‌کند و نتایج را در ترمینال نمایش می‌دهد.

همچنین می‌توانید تست‌ها را به صورت گروهی اجرا کنید. برای مثال، برای اجرای تمام تست‌های موجود در دایرکتوری tests/Unit، می‌توانید از دستور زیر استفاده کنید:

php artisan test --filter Unit

نتیجه‌گیری

تست واحد یک بخش ضروری از توسعه نرم‌افزار مدرن است. با استفاده از تست واحد در Laravel، می‌توانید کیفیت کد خود را بهبود بخشید، خطاها را کاهش دهید و با اطمینان بیشتری کد خود را تغییر دهید. با پیروی از بهترین شیوه‌ها و استفاده از ابزارهای ارائه شده توسط Laravel، می‌توانید تست‌های واحد موثر و قابل نگهداری بنویسید.