Database testing (RefreshDatabase) in Laravel - Mini Project: Build & Apply

Database testing with RefreshDatabase in Laravel

📖 Scenario: You are building a simple Laravel application that stores information about books. You want to write tests that check if the database correctly saves and retrieves book data. To keep your tests clean and isolated, you will use Laravel's RefreshDatabase trait to reset the database before each test.

🎯 Goal: Write a Laravel test class that uses the RefreshDatabase trait. Create a test that inserts a book record into the database and verifies it exists.

📋 What You'll Learn

Create a Laravel test class named BookTest

Use the RefreshDatabase trait in the test class

Write a test method named test_book_can_be_created

Insert a book with title 'The Great Gatsby' and author 'F. Scott Fitzgerald'

Assert the database has the inserted book record

💡 Why This Matters

🌍 Real World

Database testing is essential to ensure your application stores and retrieves data correctly. Using RefreshDatabase keeps tests isolated and reliable.

💼 Career

Many Laravel developer roles require writing automated tests to maintain code quality and prevent bugs in database operations.

1

Create the test class with namespace and imports

Create a Laravel test class named BookTest inside the Tests\Feature namespace. Import Tests\TestCase and Illuminate\Foundation\Testing\RefreshDatabase. Define the class extending TestCase.

Laravel

<?php

namespace Tests\Feature;

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

class BookTest extends TestCase
{
    // Your code here
}

Hint

Remember to declare the namespace and import the RefreshDatabase trait. Use the trait inside the class.

2

Add the test method skeleton

Inside the BookTest class, add a public method named test_book_can_be_created with no parameters. Leave the method body empty for now.

Laravel

<?php

namespace Tests\Feature;

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

class BookTest extends TestCase
{
    use RefreshDatabase;

    public function test_book_can_be_created()
    {
        // Your code here
    }
}

Hint

Define a public function with the exact name test_book_can_be_created inside the class.

3

Insert a book record into the database

Inside the test_book_can_be_created method, insert a new record into the books table with title set to 'The Great Gatsby' and author set to 'F. Scott Fitzgerald' using Laravel's DB::table('books')->insert() method. Import the DB facade at the top.

Laravel

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\DB;

class BookTest extends TestCase
{
    use RefreshDatabase;

    public function test_book_can_be_created()
    {
        // Insert book record here
    }
}

Hint

Use DB::table('books')->insert() with an array containing the exact keys and values.

4

Assert the book record exists in the database

Still inside the test_book_can_be_created method, add an assertion using $this->assertDatabaseHas('books', [...]) to check that the books table contains a record with title 'The Great Gatsby' and author 'F. Scott Fitzgerald'.

Laravel

insert([
            'title' => 'The Great Gatsby',
            'author' => 'F. Scott Fitzgerald'
        ]);

        // Add assertion to check database here
    }
}

Hint

Use $this->assertDatabaseHas() with the exact table name and data array.

Practice

1. What is the main purpose of using the RefreshDatabase trait in Laravel tests?

easy

A. To seed the database with test data before tests run

B. To speed up tests by skipping database migrations

C. To reset the database after each test to ensure a clean state

D. To backup the database before running tests

Solution

1. Step 1: Understand the role of RefreshDatabase

   The trait resets the database by running migrations fresh for each test.

2. Step 2: Identify why resetting is important

   Resetting ensures tests do not affect each other by leftover data.

3. Final Answer:

   To reset the database after each test to ensure a clean state -> Option C

4. Quick Check:

   Database reset = Clean test state [OK]

Hint: Remember: RefreshDatabase cleans database for every test [OK]

Common Mistakes:

• Thinking it seeds data automatically
• Confusing it with speeding up tests
• Assuming it backs up data

2. Which of the following is the correct way to use RefreshDatabase in a Laravel test class?

easy

A. class ExampleTest extends TestCase { implements RefreshDatabase }

B. class ExampleTest extends TestCase { RefreshDatabase(); }

C. class ExampleTest extends TestCase { @RefreshDatabase }

D. class ExampleTest extends TestCase { use RefreshDatabase; }

Solution

1. Step 1: Recall trait usage syntax in PHP

   Traits are included using the use keyword inside the class body.

2. Step 2: Match syntax with options

   Only class ExampleTest extends TestCase { use RefreshDatabase; } correctly uses use RefreshDatabase; inside the class.

3. Final Answer:

   class ExampleTest extends TestCase { use RefreshDatabase; } -> Option D

4. Quick Check:

   Traits use use keyword inside class [OK]

Hint: Traits use 'use' keyword inside class body [OK]

Common Mistakes:

• Using parentheses like a method call
• Using annotations instead of traits
• Trying to implement traits as interfaces

3. Given this Laravel test code snippet using RefreshDatabase:

public function test_user_creation() {
    User::factory()->create(['name' => 'Alice']);
    $this->assertDatabaseHas('users', ['name' => 'Alice']);
}

What will happen if you run this test twice in a row?

medium

A. Both tests pass because the database is reset each time

B. The second test fails due to duplicate user entries

C. Both tests fail because the database is not migrated

D. The first test passes, second test errors out with connection issue

Solution

1. Step 1: Understand RefreshDatabase effect

   It resets the database before each test, so no leftover data remains.

2. Step 2: Analyze test behavior on repeated runs

   Each test run starts fresh, so creating 'Alice' user and asserting passes every time.

3. Final Answer:

   Both tests pass because the database is reset each time -> Option A

4. Quick Check:

   Database reset = independent test runs [OK]

Hint: RefreshDatabase resets DB so repeated tests stay clean [OK]

Common Mistakes:

• Assuming data persists between tests
• Thinking duplicate entries cause failure
• Confusing RefreshDatabase with no migration

4. You wrote a Laravel test using RefreshDatabase but the database is not resetting between tests. What is the most likely cause?

medium

A. You did not call migrate:fresh manually before tests

B. You forgot to add use RefreshDatabase; trait in your test class

C. You used RefreshDatabase but did not seed the database

D. You ran tests without the --database option

Solution

1. Step 1: Check trait usage in test class

   Without adding use RefreshDatabase;, the trait's reset logic won't run.

2. Step 2: Understand that manual migration commands are not needed

   The trait handles migrations automatically; manual commands are unnecessary.

3. Final Answer:

   You forgot to add use RefreshDatabase; trait in your test class -> Option B

4. Quick Check:

   Trait must be included to reset DB [OK]

Hint: Always add trait with 'use RefreshDatabase;' inside test class [OK]

Common Mistakes:

• Thinking manual migration commands are required
• Confusing seeding with resetting
• Assuming command line options affect trait behavior

5. You want to write a Laravel test that uses RefreshDatabase but also seeds some initial data before each test. Which approach is correct?

hard

A. Use RefreshDatabase trait and call $this->seed() in the test's setUp() method

B. Use RefreshDatabase trait and add seeder class name as a parameter to the trait

C. Manually run php artisan migrate:fresh --seed before running tests

D. Use RefreshDatabase trait and override the refreshDatabase() method to seed

Solution

1. Step 1: Understand how to seed with RefreshDatabase

   The trait resets the database, but seeding must be triggered manually in tests.

2. Step 2: Use $this->seed() in setUp() method

   This ensures seeding runs before each test after database reset.

3. Final Answer:

   Use RefreshDatabase trait and call $this->seed() in the test's setUp() method -> Option A

4. Quick Check:

   Seed manually after refresh in setUp() [OK]

Hint: Call $this->seed() in setUp() when using RefreshDatabase [OK]

Common Mistakes:

• Trying to pass seeder to trait directly
• Running artisan commands manually during tests
• Overriding trait methods unnecessarily