Database testing (RefreshDatabase) in Laravel - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the RefreshDatabase trait in Laravel testing?

The RefreshDatabase trait resets the database before each test by running migrations. This ensures tests start with a clean database state, avoiding data conflicts.

intermediate

How does RefreshDatabase differ from DatabaseTransactions in Laravel tests?

RefreshDatabase rebuilds the database schema before each test, while DatabaseTransactions wraps tests in a transaction that rolls back after the test. RefreshDatabase is better for tests that modify schema or need a fresh start.

beginner

When should you use RefreshDatabase in your Laravel tests?

Use RefreshDatabase when your tests change the database schema or when you want to ensure no leftover data affects your tests. It is ideal for integration tests involving database state.

intermediate

What happens behind the scenes when you use RefreshDatabase in a Laravel test?

Laravel runs the database migrations to rebuild the schema from scratch before each test. This wipes all data and resets tables to their initial state.

intermediate

Can RefreshDatabase be used with in-memory SQLite databases? Why or why not?

Yes, RefreshDatabase works well with in-memory SQLite databases because migrations run quickly and the database is fresh for each test run, making tests fast and isolated.

What does the RefreshDatabase trait do in Laravel tests?

A Caches database queries for faster tests

B Rolls back database transactions after each test

C Resets the database by running migrations before each test

D Seeds the database with test data automatically

RefreshDatabase resets the database by running migrations before each test to ensure a clean state.

Which trait is better for tests that only need to rollback data changes without rebuilding schema?

A WithFaker

B RefreshDatabase

C WithoutMiddleware

D DatabaseTransactions

DatabaseTransactions wraps tests in a transaction and rolls back changes, which is faster if schema changes are not needed.

Why might RefreshDatabase slow down tests compared to DatabaseTransactions?

A Because it runs migrations before each test

B Because it caches queries

C Because it disables middleware

D Because it seeds the database multiple times

Running migrations before each test takes more time than rolling back transactions.

Can RefreshDatabase be used with an in-memory SQLite database?

A Yes, it works well and is fast

B No, it only works with MySQL

C No, it requires a persistent database

D Yes, but it disables migrations

In-memory SQLite databases are fast and reset on each test, making RefreshDatabase ideal.

What is a key benefit of using RefreshDatabase in tests?

A Disables authentication middleware

B Ensures tests run with a clean database state

C Automatically mocks external APIs

D Improves query performance caching

It ensures each test starts with a fresh database, avoiding data conflicts.

Explain how the RefreshDatabase trait helps maintain test reliability in Laravel.

Think about how tests can fail if old data remains.

Compare RefreshDatabase and DatabaseTransactions traits and when to use each.

Consider schema changes versus data changes.

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