Database Testing

• Introduction
  • Resetting The Database After Each Test
• Model Factories
• Running Seeders
• Available Assertions

Introduction

Laravel provides a variety of helpful tools and assertions to make it easier to test your database driven applications. In addition, Laravel model factories and seeders make it painless to create test database records using your application's Eloquent models and relationships. We'll discuss all of these powerful features in the following documentation.

Resetting The Database After Each Test

Before proceeding much further, let's discuss how to reset your database after each of your tests so that data from a previous test does not interfere with subsequent tests. Laravel's included Illuminate\Foundation\Testing\RefreshDatabase trait will take care of this for you. Simply use the trait on your test class:

 1<?php
 2 
 3namespace Tests\Feature;
 4 
 5use Illuminate\Foundation\Testing\RefreshDatabase;
 6use Illuminate\Foundation\Testing\WithoutMiddleware;
 7use Tests\TestCase;
 8 
 9class ExampleTest extends TestCase
10{
11    use RefreshDatabase;
12 
13    /**
14     * A basic functional test example.
15     */
16    public function test_basic_example(): void
17    {
18        $response = $this->get('/');
19 
20        // ...
21    }
22}
 1<?php
 2 
 3namespace Tests\Feature;
 4 
 5use Illuminate\Foundation\Testing\RefreshDatabase;
 6use Illuminate\Foundation\Testing\WithoutMiddleware;
 7use Tests\TestCase;
 8 
 9class ExampleTest extends TestCase
10{
11    use RefreshDatabase;
12 
13    /**
14     * A basic functional test example.
15     */
16    public function test_basic_example(): void
17    {
18        $response = $this->get('/');
19 
20        // ...
21    }
22}

The Illuminate\Foundation\Testing\RefreshDatabase trait does not migrate your database if your schema is up to date. Instead, it will only execute the test within a database transaction. Therefore, any records added to the database by test cases that do not use this trait may still exist in the database.

If you would like to totally reset the database, you may use the Illuminate\Foundation\Testing\DatabaseMigrations or Illuminate\Foundation\Testing\DatabaseTruncation traits instead. However, both of these options are significantly slower than the RefreshDatabase trait.

Model Factories

When testing, you may need to insert a few records into your database before executing your test. Instead of manually specifying the value of each column when you create this test data, Laravel allows you to define a set of default attributes for each of your Eloquent models using model factories.

To learn more about creating and utilizing model factories to create models, please consult the complete model factory documentation. Once you have defined a model factory, you may utilize the factory within your test to create models:

1use App\Models\User;
2 
3public function test_models_can_be_instantiated(): void
4{
5    $user = User::factory()->create();
6 
7    // ...
8}
1use App\Models\User;
2 
3public function test_models_can_be_instantiated(): void
4{
5    $user = User::factory()->create();
6 
7    // ...
8}

Running Seeders

If you would like to use database seeders to populate your database during a feature test, you may invoke the seed method. By default, the seed method will execute the DatabaseSeeder, which should execute all of your other seeders. Alternatively, you pass a specific seeder class name to the seed method:

 1<?php
 2 
 3namespace Tests\Feature;
 4 
 5use Database\Seeders\OrderStatusSeeder;
 6use Database\Seeders\TransactionStatusSeeder;
 7use Illuminate\Foundation\Testing\RefreshDatabase;
 8use Illuminate\Foundation\Testing\WithoutMiddleware;
 9use Tests\TestCase;
10 
11class ExampleTest extends TestCase
12{
13    use RefreshDatabase;
14 
15    /**
16     * Test creating a new order.
17     */
18    public function test_orders_can_be_created(): void
19    {
20        // Run the DatabaseSeeder...
21        $this->seed();
22 
23        // Run a specific seeder...
24        $this->seed(OrderStatusSeeder::class);
25 
26        // ...
27 
28        // Run an array of specific seeders...
29        $this->seed([
30            OrderStatusSeeder::class,
31            TransactionStatusSeeder::class,
32            // ...
33        ]);
34    }
35}
 1<?php
 2 
 3namespace Tests\Feature;
 4 
 5use Database\Seeders\OrderStatusSeeder;
 6use Database\Seeders\TransactionStatusSeeder;
 7use Illuminate\Foundation\Testing\RefreshDatabase;
 8use Illuminate\Foundation\Testing\WithoutMiddleware;
 9use Tests\TestCase;
10 
11class ExampleTest extends TestCase
12{
13    use RefreshDatabase;
14 
15    /**
16     * Test creating a new order.
17     */
18    public function test_orders_can_be_created(): void
19    {
20        // Run the DatabaseSeeder...
21        $this->seed();
22 
23        // Run a specific seeder...
24        $this->seed(OrderStatusSeeder::class);
25 
26        // ...
27 
28        // Run an array of specific seeders...
29        $this->seed([
30            OrderStatusSeeder::class,
31            TransactionStatusSeeder::class,
32            // ...
33        ]);
34    }
35}

Alternatively, you may instruct Laravel to automatically seed the database before each test that uses the RefreshDatabase trait. You may accomplish this by defining a $seed property on your base test class:

 1<?php
 2 
 3namespace Tests;
 4 
 5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 6 
 7abstract class TestCase extends BaseTestCase
 8{
 9    use CreatesApplication;
10 
11    /**
12     * Indicates whether the default seeder should run before each test.
13     *
14     * @var bool
15     */
16    protected $seed = true;
17}
 1<?php
 2 
 3namespace Tests;
 4 
 5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 6 
 7abstract class TestCase extends BaseTestCase
 8{
 9    use CreatesApplication;
10 
11    /**
12     * Indicates whether the default seeder should run before each test.
13     *
14     * @var bool
15     */
16    protected $seed = true;
17}

When the $seed property is true, the test will run the Database\Seeders\DatabaseSeeder class before each test that uses the RefreshDatabase trait. However, you may specify a specific seeder that should be executed by defining a $seeder property on your test class:

1use Database\Seeders\OrderStatusSeeder;
2 
3/**
4 * Run a specific seeder before each test.
5 *
6 * @var string
7 */
8protected $seeder = OrderStatusSeeder::class;
1use Database\Seeders\OrderStatusSeeder;
2 
3/**
4 * Run a specific seeder before each test.
5 *
6 * @var string
7 */
8protected $seeder = OrderStatusSeeder::class;

Available Assertions

Laravel provides several database assertions for your PHPUnit feature tests. We'll discuss each of these assertions below.

assertDatabaseCount

Assert that a table in the database contains the given number of records:

1$this->assertDatabaseCount('users', 5);
1$this->assertDatabaseCount('users', 5);

assertDatabaseHas

Assert that a table in the database contains records matching the given key / value query constraints:

1$this->assertDatabaseHas('users', [
2    'email' => '[email protected]',
3]);
1$this->assertDatabaseHas('users', [
2    'email' => '[email protected]',
3]);

assertDatabaseMissing

Assert that a table in the database does not contain records matching the given key / value query constraints:

1$this->assertDatabaseMissing('users', [
2    'email' => '[email protected]',
3]);
1$this->assertDatabaseMissing('users', [
2    'email' => '[email protected]',
3]);

assertSoftDeleted

The assertSoftDeleted method may be used to assert a given Eloquent model has been "soft deleted":

1$this->assertSoftDeleted($user);
1$this->assertSoftDeleted($user);

assertNotSoftDeleted

The assertNotSoftDeleted method may be used to assert a given Eloquent model hasn't been "soft deleted":

1$this->assertNotSoftDeleted($user);
1$this->assertNotSoftDeleted($user);

assertModelExists

Assert that a given model exists in the database:

1use App\Models\User;
2 
3$user = User::factory()->create();
4 
5$this->assertModelExists($user);
1use App\Models\User;
2 
3$user = User::factory()->create();
4 
5$this->assertModelExists($user);

assertModelMissing

Assert that a given model does not exist in the database:

1use App\Models\User;
2 
3$user = User::factory()->create();
4 
5$user->delete();
6 
7$this->assertModelMissing($user);
1use App\Models\User;
2 
3$user = User::factory()->create();
4 
5$user->delete();
6 
7$this->assertModelMissing($user);

expectsDatabaseQueryCount

The expectsDatabaseQueryCount method may be invoked at the beginning of your test to specify the total number of database queries that you expect to be run during the test. If the actual number of executed queries does not exactly match this expectation, the test will fail:

1$this->expectsDatabaseQueryCount(5);
2 
3// Test...
1$this->expectsDatabaseQueryCount(5);
2 
3// Test...