عرض مصدر Laravel/database testing

<noinclude>{{DISPLAYTITLE:اختبارات قواعد البيانات في Laravel}}</noinclude>

== مقدمة ==
يزوّدك [[Laravel]] بمجموعة من الأدوات المفيدة لتسهيل اختبار تطبيقاتك المقادة بواسطة [https://academy.hsoub.com/devops/servers/databases/%D9%82%D9%88%D8%A7%D8%B9%D8%AF-%D8%A7%D9%84%D8%A8%D9%8A%D8%A7%D9%86%D8%A7%D8%AA-database/ قواعد البيانات]. أولاً، يمكنك استخدام التابع المساعد <code>assertDatabaseHas</code> للتأكد من أن البيانات موجودة ضمن قاعدة البيانات ضمن مجموعة الشروط المعطاة. على سبيل المثال، إن أردت التأكد من أن سجلًا ما موجود ضمن جدول <code>users</code> ببريد مطابق لـ <code>sally@example.com</code>، يمكنك فعل التالي:<syntaxhighlight lang="php">
public function testDatabase()
{
    // القيام بمناداة التطبيق...

    $this->assertDatabaseHas('users', [
        'email' => 'sally@example.com'
    ]);
}
</syntaxhighlight>يمكنك أيضًا استخدام المساعد <code>assertDatabaseMissing</code> للتأكد من عدم وجود بيانات.

بالطبع، إن التابع <code>assertDatabaseHas</code> والتوابع المساعدة الأخرى هي توابع وجدت لتسهيل أمورك. يمكنك استخدام أي تابع من توابع PHPUnit المضمّنة لاستكمال اختباراتك.

== توليد المعامل Factories ==
لتوليد معمل، استخدم أمر <code>artisan make:factory</code>:<syntaxhighlight lang="text">
php artisan make:factory PostFactory
</syntaxhighlight>سيوضع المعمل الجديد في المجلد <code>database/factories</code>.

يمكن استخدام الخيار <code>model--</code> للإشارة إلى اسم النموذج Model المنشئ بواسطة المعمل. سيعبّئ هذا الأمر مسبقًا المعمل بالنموذج المعطى:<syntaxhighlight lang="text">
php artisan make:factory PostFactory --model=Post
</syntaxhighlight>

== إعادة تعيين قاعدة البيانات بعد كل اختبار ==
من الضروري أن تعيد تعيين قاعدة بياناتك بعد كل اختبار حتى لا تتضارب البيانات المضافة من اختبار مسبق مع الاختبارات القادمة. تأخذ السمة ‎(trait) <code>RefreshDatabase</code> الحل الأمثل لتهجير قاعدة معطياتك بناءً على كونها قاعدة بيانات ذاكرية أو تقليدية. استخدم السمة على صنف الاختبار الخاص بك، وكل شيء سيعالج تلقائيًا:<syntaxhighlight lang="php">
<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;

class ExampleTest extends TestCase
{
    use RefreshDatabase;

    /**
     * مثال بسيط عن اختبار فعال.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $response = $this->get('/');

        // ...
    }
}
</syntaxhighlight>

== كتابة المعامل Writing Factories ==
قد تحتاج عند الاختبار إلى إضافة بعض السجلات إلى قاعدة بياناتك قبل البدء. بدلًا من تعيين قيم كل حقل يدويًا عند إضافة سجلات الاختبار، يتيح [[Laravel]] تعريف مجموعة افتراضية من الخصائص لكلّ من [[Laravel/eloquent|نماذج Eloquent]] الخاصة بك، وذلك باستخدام معامل النماذج. للبدء، اطلع على الملف <code>database/factories/UserFactory.php</code> في تطبيقك. بشكل افتراضي، يحتوي هذا الملف على تعريف معمل واحد:<syntaxhighlight lang="php">
use Faker\Generator as Faker;

$factory->define(App\User::class, function (Faker $faker) {
   return [
       'name' => $faker->name,
       'email' => $faker->unique()->safeEmail,
       'password' => '$2y$10$TKh8H1.PfQx37YgCzwiKb.KjNyWgaHb9cbcoQgdIVFlYg7B77UdFm', // secret
       'remember_token' => str_random(10),
   ];
});
</syntaxhighlight>يمكنك إعادة أي مجموعة افتراضية من القيم التي تريدها لنموذجك ضمن النطاق المغلق (Closure‎) الذي يعمل كتعريف للمعمل. يستقبل التعبير المغلق كائنًا من مكتبة [https://github.com/fzaninotto/Faker Faker]، التي تتيح توليد العديد من أنواع البيانات العشوائية.

يمكنك أيضًا إنشاء معامل إضافية لكل كائن على حدة لضمان تنظيم أفضل. على سبيل المثال، يمكنك إنشاء <code>UserFactory.php</code> و <code>CommentFactory.php</code> ضمن المجلد <code>database/factories</code>. ستُحمّل جميع الملفات الموجودة ضمن المجلد <code>factories</code> تلقائيًا من قبل [[Laravel]].

'''ملاحظة:'''  يمكنك تعيين الموقع locale الافتراضي لـ Faker بإضافة الخيار <code>faker_locale</code> إلى ملف الضبط <code>config/app.php</code>.

== حالات المعامل ==
تمكّنك الحالات من تعريف التعديلات الممكن تطبيقها على معامل النماذج بأي صيغة ممكنة. على سبيل المثال، قد يحتوي نموذج <code>User</code> على حالة <code>delinquent</code>، التي تقوم بتعديل خاصية من خصائصه الافتراضية. يمكنك تعريف تحويلات الحالات الخاصة بك عن طريق التابع <code>state</code>. من أجل الحالات البسيطة، يمكنك تمرير مصفوفة من التعديلات المطلوبة:<syntaxhighlight lang="php">
$factory->state(App\User::class, 'delinquent', [
   'account_status' => 'delinquent',
]);
</syntaxhighlight>إذا تطلبت حالتك احتساب معين من كائن <code>faker$</code>، يمكنك استخدام تعبير مغلق لاحتساب تعديلات الحالة:<syntaxhighlight lang="php">
$factory->state(App\User::class, 'address', function ($faker) {
   return [
       'address' => $faker->address,
   ];
});
</syntaxhighlight>

== دوال رد النداء للمعامل ==
تسجَّل دوال رد النداء للمعامل عن طريق التابعين <code>afterMaking</code> و <code>afterCreating</code>، وتمكنك من تنفيذ عمليات إضافية بعد إنشاء أو حفظ نموذج معين. على سبيل المثال، يمكنك استخدام هذه الدوال لربط النماذج الإضافية للنموذج المنشأ:<syntaxhighlight lang="php">
$factory->afterMaking(App\User::class, function ($user, $faker) {
  // ...
});

$factory->afterCreating(App\User::class, function ($user, $faker) {
   $user->accounts()->save(factory(App\Account::class)->make());
});
</syntaxhighlight>يمكنك أيضًا تعريف دوال رد نداء لحالات المعامل:<syntaxhighlight lang="php">
$factory->afterMakingState(App\User::class, 'delinquent', function ($user, $faker) {
  // ...
});

$factory->afterCreatingState(App\User::class, 'delinquent', function ($user, $faker) {
  // ...
});
</syntaxhighlight>

== استخدام المعامل ==

=== إنشاء النماذج ===
بعد تعريف المعامل الخاصة بك، يمكنك استخدام التابع العام <code>factory</code> في اختباراتك أو في ملفات البذور (seeds‎) الخاصة بك لتوليد كائنات النماذج. لنطّلع على بعض الأمثلة عن إنشاء النماذج. أولاً، سنستخدم التابع <code>make</code> لإنشاء النماذج دون حفظها في قاعدة البيانات:<syntaxhighlight lang="php">
public function testDatabase()
{
   $user = factory(App\User::class)->make();
   
   // استخدام النموذج بالاختبارات...
}
</syntaxhighlight>يمكنك أيضًا إنشاء مجموعة من عدة نماذج:<syntaxhighlight lang="php">
// إنشاء ثلاث كائنات من نوع مستخدم User...
$users = factory(App\User::class, 3)->make();
</syntaxhighlight>

==== تعيين الحالات ====
يمكنك أيضًا تعيين أي من الحالات المعرفة لنماذجك. في حال أردت تعيين أكثر من حالة، مرّر اسم كل حالة تريد تعيينها:<syntaxhighlight lang="php">
$users = factory(App\User::class, 5)->states('delinquent')->make();

$users = factory(App\User::class, 5)->states('premium', 'delinquent')->make();
</syntaxhighlight>

==== إعادة تعريف الخصائص ====
في حال أردت إعادة تعيين بعض الخصائص في نماذجك، مرّر مصفوفة قيم إلى التابع <code>make</code>. ستُستبدل القيم الموجودة بالمعمل مع القيم الممررة، وستبقى القيم غير الممررة على حالها كما عُرّفت في المعمل:<syntaxhighlight lang="php">
$user = factory(App\User::class)->make([
   'name' => 'Abigail',
]);
</syntaxhighlight>

=== حفظ وضمان استمراريّة النماذج ===
ينشئ التابع <code>create</code> ويحفظ النموذج إلى قاعدة البيانات وذلك باستخدام التابع <code>save</code> الخاص بـ [[Laravel/eloquent|Eloquent]]:<syntaxhighlight lang="php">
public function testDatabase()
{
   // إنشاء كائن مستخدم من نوع App\User وحيد..
   $user = factory(App\User::class)->create();

   // إنشاء ثلاثة كائنات مستخدمين من نوع App\User..
   $users = factory(App\User::class, 3)->create();
   
   // استخدام الكائنات في الاختبارات..
}
</syntaxhighlight>يمكنك أيضًا إعادة تعيين الخصائص المعرفة عن طريق تمرير مصفوفة إلى التابع <code>create</code>:<syntaxhighlight lang="php">
$user = factory(App\User::class)->create([
   'name' => 'Abigail',
]);
</syntaxhighlight>

=== العلاقات ===
في هذا المثال، سنربط علاقة لبعض النماذج المنشأة. عند استخدام التابع <code>create</code> لإنشاء عدة نماذج، ستُعاد مجموعة Eloquent تمكنك من استخدام أي من التوابع المزودة من المجموعة، كالتابع <code>each</code>:<syntaxhighlight lang="php">
$users = factory(App\User::class, 3)
          ->create()
          ->each(function ($u) {
               $u->posts()->save(factory(App\Post::class)->make());
           });
</syntaxhighlight>

==== العلاقات والتعابير المغلقة للخصائص ====
يمكنك أيضًا ربط العلاقات بالنماذج باستخدام تعابير مغلقة في تعاريف المعامل. على سبيل المثال، في حال أردت إنشاء كائن <code>User</code> جديد عند إنشائك لكائن <code>Post</code>، يمكنك فعل التالي:<syntaxhighlight lang="php">
$factory->define(App\Post::class, function ($faker) {
   return [
       'title' => $faker->title,
       'content' => $faker->paragraph,
       'user_id' => function () {
           return factory(App\User::class)->create()->id;
       }
   ];
});
</syntaxhighlight>تُمرّر مصفوفة من الخصائص المعالجة من المعمل إلى هذه التعابير المغلقة:<syntaxhighlight lang="php">
$factory->define(App\Post::class, function ($faker) {
   return [
       'title' => $faker->title,
       'content' => $faker->paragraph,
       'user_id' => function () {
           return factory(App\User::class)->create()->id;
       },
       'user_type' => function (array $post) {
           return App\User::find($post['user_id'])->type;
       }
   ];
});
</syntaxhighlight>

== التوكيدات المتاحة ==
يتيح Laravel مجموعة من التوكيدات الخاصة بقواعد البيانات من أجل اختبارات [https://phpunit.de/ PHPUnit] الخاصة بك:
{| class="wikitable"
!التابع
!الشرح
|-
|<syntaxhighlight lang="php">
$this->assertDatabaseHas($table, array $data);
</syntaxhighlight>
|التأكد من أن الجدول المعطى الموجود ضمن قاعدة البيانات يحتوي على البيانات المعطاة.
|-
|<syntaxhighlight lang="php">
$this->assertDatabaseMissing($table, array $data);
</syntaxhighlight>
|التأكد من أن الجدول المعطى الموجود ضمن قاعدة البيانات لا يحتوي على البيانات المعطاة.
|-
|<syntaxhighlight lang="php">
$this->assertSoftDeleted($table, array $data);
</syntaxhighlight>
|التأكد من أن السجل المعطى قد تم حذفه وهمياً.
|}

== مصادر ==
* [https://laravel.com/docs/5.6/database-testing صفحة Database Testing من توثيق Laravel الرسمي.]
[[تصنيف:Laravel|{{SUBPAGENAME}}]]
[[تصنيف:Laravel Testing|{{SUBPAGENAME}}]]