• مدیر سایت
• ژانویه 01, 2020

آموزش Unit testing Api در لاراول

آیا تا به حال هنگام ارائه پروژه به مدیر یا مشتری، با یک باگ غیرمنتظره مواجه شده‌اید؟ این لحظات پراسترس، نتیجه مستقیم عدم اطمینان از صحت عملکرد کد است. خوشبختانه، راه‌حلی قدرتمند برای این مشکل وجود دارد. در این راهنمای جامع، قصد داریم به آموزش Unit testing Api در لاراول بپردازیم. این تکنیک به شما کمک می‌کند تا با اطمینان کامل کد بزنید و نرم‌افزاری پایدار و قابل اعتماد توسعه دهید. 🎯

تست واحد (Unit Testing) در لاراول چیست و چرا یک ضرورت است؟

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

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

مزایای کلیدی Unit Testing برای API های لاراول 📈

شاید نوشتن تست در ابتدا زمان‌بر به نظر برسد. اما سرمایه‌گذاری روی آن، مزایای فوق‌العاده‌ای در بلندمدت به همراه دارد. در ادامه به مهم‌ترین مزیت‌های آن می‌پردازیم.

• 🎯 افزایش اطمینان و کیفیت کد: با نوشتن تست برای هر بخش، مطمئن می‌شوید که کد شما دقیقاً همان کاری را انجام می‌دهد که انتظار دارید.
• 🐛 شناسایی سریع باگ‌ها: تست‌های واحد به شما کمک می‌کنند باگ‌ها را در مراحل اولیه توسعه پیدا کنید. این کار هزینه و زمان رفع خطا را به شدت کاهش می‌دهد.
• 💰 کاهش هزینه‌های بلندمدت: رفع باگ در مراحل نهایی پروژه بسیار پرهزینه‌تر از شناسایی آن در ابتدا است. تست‌نویسی یک سرمایه‌گذاری هوشمندانه است.
• 🚀 توسعه و نگهداری آسان‌تر: زمانی که قصد دارید ویژگی جدیدی اضافه کنید یا کدهای قدیمی را بهبود دهید (Refactor)، تست‌ها به شما اطمینان می‌دهند که تغییرات جدید، عملکرد بخش‌های دیگر را مختل نکرده است.
• 🤝 مستندسازی زنده پروژه: تست‌های شما مانند یک مستند فنی عمل می‌کنند. هر توسعه‌دهنده جدیدی با خواندن تست‌ها می‌تواند به سرعت کاربرد هر متد را درک کند.

کاربردهای عملی تست واحد در پروژه های API محور

تست واحد فقط یک مفهوم تئوری نیست. این تکنیک در سناریوهای واقعی پروژه‌های API محور کاربردهای مشخصی دارد. در اینجا چند نمونه از این کاربردها را بررسی می‌کنیم.

• ✅ اعتبارسنجی ورودی‌ها (Validation): تست کنید که آیا API شما ورودی‌های نامعتبر را به درستی رد می‌کند یا خیر.
• 🔐 بررسی سطوح دسترسی (Authorization): اطمینان حاصل کنید که کاربران فقط به اندپوینت‌هایی دسترسی دارند که مجاز هستند.
• 🔄 صحت عملکرد CRUD: تست کنید که عملیات ایجاد (Create)، خواندن (Read)، به‌روزرسانی (Update) و حذف (Delete) به درستی در دیتابیس انجام می‌شود.
• 📈 بررسی کدهای وضعیت (Status Codes): مطمئن شوید که API شما در شرایط مختلف (موفقیت، خطا، عدم دسترسی) کدهای وضعیت HTTP صحیح (مانند 200، 201، 404، 403) را برمی‌گرداند.

آموزش گام به گام نوشتن Unit Test برای یک API در لاراول

اکنون زمان آن رسیده که به صورت عملی وارد عمل شویم. در این بخش، یک API ساده برای مدیریت پست‌ها می‌سازیم و برای تمام عملیات آن، تست واحد می‌نویسیم.

قدم اول: ساخت مدل، کنترلر و مایگریشن

ابتدا با یک دستور ساده آرتین، تمام فایل‌های مورد نیاز برای مدل Post را ایجاد می‌کنیم.

php artisan make:model Post -mcf

سپس، فایل مایگریشن ایجاد شده در مسیر database/migrations را باز کرده و فیلدهای title و content را به آن اضافه کنید.

// Inside up() method
$table->id();
$table->string('title');
$table->text('content');
$table->timestamps();

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

فکتوری‌ها به ما کمک می‌کنند داده‌های فیک و تستی به سرعت تولید کنیم. فایل database/factories/PostFactory.php را به صورت زیر ویرایش کنید.

<?php

namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

class PostFactory extends Factory
{
    public function definition(): array
    {
        return [
            'title' => $this->faker->sentence,
            'content' => $this->faker->paragraph,
        ];
    }
}

قدم سوم: پیاده‌سازی متدهای CRUD در کنترلر

حالا کنترلر app/Http/Controllers/PostController.php را برای مدیریت عملیات CRUD تکمیل می‌کنیم.

<?php

namespace App\Http\Controllers;

use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function index()
    {
        return Post::all();
    }

    public function store(Request $request)
    {
        $post = Post::create($request->all());
        return response()->json($post, 201);
    }

    public function show(Post $post)
    {
        return $post;
    }

    public function update(Request $request, Post $post)
    {
        $post->update($request->all());
        return response()->json($post);
    }

    public function delete(Post $post)
    {
        $post->delete();
        return response()->json(null, 204);
    }
}

فراموش نکنید که در مدل Post، فیلدهای title و content را در پراپرتی $fillable قرار دهید.

// In App\Models\Post.php
protected $fillable = ['title', 'content'];

قدم چهارم: تعریف روت‌های API

روت‌های مورد نیاز برای دسترسی به متدهای کنترلر را در فایل routes/api.php تعریف کنید.

use App\Http\Controllers\PostController;

Route::apiResource('posts', PostController::class);

قدم پنجم: آماده‌سازی محیط تست

لاراول به صورت پیش‌فرض از یک دیتابیس مجزا (in-memory) برای تست‌ها استفاده می‌کند تا دیتابیس اصلی شما دست‌نخورده باقی بماند. برای اینکه بعد از هر تست، دیتابیس ریست شود، تِرِیت RefreshDatabase را به فایل تست خود اضافه کنید.

قدم ششم: نوشتن تست‌های واحد با PHPUnit

با دستور زیر یک فایل تست جدید بسازید.

php artisan make:test PostTest --unit

سپس فایل ایجاد شده در tests/Unit/PostTest.php را باز کرده و تست‌های زیر را در آن بنویسید. ما از تریت RefreshDatabase برای پاکسازی دیتابیس بعد از هر تست استفاده می‌کنیم.

<?php

namespace Tests\Unit;

use Tests\TestCase;
use App\Models\Post;
use Illuminate\Foundation\Testing\RefreshDatabase;

class PostTest extends TestCase
{
    use RefreshDatabase;

    // تست ایجاد یک پست جدید
    public function test_can_create_post()
    {
        $data = [
            'title' => 'Test Title',
            'content' => 'Test Content',
        ];

        $this->postJson(route('posts.store'), $data)
            ->assertStatus(201)
            ->assertJsonFragment($data);
    }

    // تست نمایش لیست پست‌ها
    public function test_can_list_posts()
    {
        Post::factory()->count(2)->create();

        $this->getJson(route('posts.index'))
            ->assertStatus(200)
            ->assertJsonCount(2);
    }

    // تست نمایش یک پست خاص
    public function test_can_show_post()
    {
        $post = Post::factory()->create();

        $this->getJson(route('posts.show', $post->id))
            ->assertStatus(200);
    }

    // تست به‌روزرسانی یک پست
    public function test_can_update_post()
    {
        $post = Post::factory()->create();
        $data = ['title' => 'Updated Title'];

        $this->putJson(route('posts.update', $post->id), $data)
            ->assertStatus(200)
            ->assertJsonFragment($data);
    }

    // تست حذف یک پست
    public function test_can_delete_post()
    {
        $post = Post::factory()->create();

        $this->deleteJson(route('posts.delete', $post->id))
            ->assertStatus(204);
    }
}

قدم هفتم: اجرای تست‌ها و تحلیل نتایج

در نهایت، برای اجرای تمام تست‌ها، دستور زیر را در ترمینال خود وارد کنید.

./vendor/bin/phpunit

اگر تمام مراحل را به درستی انجام داده باشید، خروجی سبز رنگی مشاهده خواهید کرد که نشان‌دهنده موفقیت‌آمیز بودن تمام تست‌ها است. ✅

ثبت‌نام و دسترسی به APIهای ما ✍️

برای استفاده از سرویس‌های API ما و دسترسی به مستندات کامل، ابتدا باید یک حساب کاربری ایجاد کنید. فرآیند ثبت‌نام بسیار ساده است و کمتر از یک دقیقه زمان می‌برد. برای شروع، کافیست به لینک p.api.ir مراجعه کرده و فرم ثبت‌نام را تکمیل نمایید.

 با تست واحد، با اطمینان کد بزنید!

در این مقاله، به صورت کامل با مفاهیم، مزایا و نحوه پیاده‌سازی Unit Testing API در لاراول آشنا شدید. تست‌نویسی شاید در نگاه اول یک مرحله اضافی به نظر برسد، اما در واقع یک سرمایه‌گذاری حیاتی برای سلامت و پایداری پروژه شماست. با نوشتن تست، شما کیفیت کد خود را تضمین می‌کنید، از بروز باگ‌های شرم‌آور جلوگیری کرده و فرآیند توسعه را برای خود و هم‌تیمی‌هایتان لذت‌بخش‌تر می‌سازید.

تجربه شما در زمینه تست‌نویسی چیست؟ آیا نکته‌ای وجود دارد که در این مقاله به آن اشاره نشده باشد؟ نظرات و سوالات خود را در بخش دیدگاه‌ها با ما در میان بگذارید.

• برچسب ها:
• تست api در php
• تست api در لاراول
• تست وب سرویس
• تست وب سرویس در لاراول
• تست وب سرویس رد php