PHPUnit setup in Laravel - Mini Project: Build & Apply

PHPUnit Setup in Laravel

📖 Scenario: You are building a Laravel web application and want to ensure your code works correctly by writing automated tests. Laravel uses PHPUnit as its testing framework.Setting up PHPUnit properly in your Laravel project is the first step to start writing tests.

🎯 Goal: Set up PHPUnit testing in a Laravel project by configuring the test database connection, creating a test case, and running a basic test.

📋 What You'll Learn

Create a phpunit.xml configuration file with the correct environment settings

Set up a test database connection in .env.testing

Create a basic test class extending TestsTestCase

Write a simple test method that asserts true is true

Run PHPUnit tests using the php artisan test command

💡 Why This Matters

🌍 Real World

Automated testing helps catch bugs early and ensures your Laravel application works as expected before deployment.

💼 Career

Knowing how to set up and run PHPUnit tests is essential for Laravel developers to maintain code quality and collaborate in teams.

1

Create phpunit.xml Configuration File

Create a phpunit.xml file in the root of your Laravel project with the following content exactly: set the APP_ENV to testing, and configure the DB_CONNECTION to sqlite with an in-memory database by setting DB_DATABASE=:memory: inside the phpunit.xml environment variables.

Laravel

Hint

The phpunit.xml file sets environment variables for testing. Use APP_ENV as testing and configure the database to use SQLite in-memory.

2

Create .env.testing File for Test Environment

Create a file named .env.testing in the root of your Laravel project. Inside it, set DB_CONNECTION=sqlite and DB_DATABASE=:memory: exactly as shown.

Laravel

    
        
        
        
    


# Create .env.testing file with DB settings
# Your code here

Hint

The .env.testing file overrides environment variables when running tests. It should match the database settings in phpunit.xml.

3

Create a Basic Test Class

Create a new PHP test class file named ExampleTest.php inside the tests/Feature directory. Define a class ExampleTest that extends Tests\TestCase. Inside it, write a public method test_true_is_true that asserts true is true using $this->assertTrue(true);.

Laravel

<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    // Write test_true_is_true method here
    // Your code here
}

Hint

Test classes extend Tests\TestCase. Test methods start with test and use assertions like assertTrue.

4

Run PHPUnit Tests Using Artisan

Run the Laravel test suite using the command php artisan test in your terminal to execute the tests you created.

Laravel

# Run the tests using artisan
# Your code here

Hint

Use php artisan test to run all tests in your Laravel project.

Practice

1. What is the primary purpose of using PHPUnit in a Laravel project?

easy

A. To test the application and catch bugs early

B. To deploy the application to a server

C. To write database migration scripts

D. To create user interface designs

Solution

1. Step 1: Understand PHPUnit's role

   PHPUnit is a testing framework used to check if code works correctly.

2. Step 2: Connect PHPUnit to Laravel usage

   In Laravel, PHPUnit helps find bugs early by running automated tests.

3. Final Answer:

   To test the application and catch bugs early -> Option A

4. Quick Check:

   Testing = Catch bugs early [OK]

Hint: PHPUnit is for testing, not deployment or design [OK]

Common Mistakes:

• Confusing testing with deployment
• Thinking PHPUnit creates UI or migrations
• Assuming PHPUnit runs the app

2. Which command correctly creates a new test class in Laravel using Artisan?

easy

A. php artisan make:test UserTest

B. php artisan create:test UserTest

C. php artisan test:make UserTest

D. php artisan generate:test UserTest

Solution

1. Step 1: Recall Laravel Artisan test creation command

   The correct command to create a test is php artisan make:test.

2. Step 2: Match the command with options

   Only php artisan make:test UserTest uses the correct syntax: php artisan make:test UserTest.

3. Final Answer:

   php artisan make:test UserTest -> Option A

4. Quick Check:

   Make test command = make:test [OK]

Hint: Use 'make:test' to create tests with Artisan [OK]

Common Mistakes:

• Using incorrect Artisan command verbs
• Mixing test creation with test running commands
• Misspelling 'make:test'

3. Given this test method in Laravel, what will be the output when running php artisan test if the home page returns status 200?

public function test_home_page_status()
{
    $response = $this->get('/');
    $response->assertStatus(200);
}

medium

A. Test fails with status code error

B. Test passes with success message

C. Syntax error in test method

D. Test is skipped automatically

Solution

1. Step 1: Analyze the test method

   The test sends a GET request to '/' and expects HTTP status 200.

2. Step 2: Check expected vs actual response

   If the home page returns 200, the assertion assertStatus(200) passes.

3. Final Answer:

   Test passes with success message -> Option B

4. Quick Check:

   Correct status = test passes [OK]

Hint: If status matches assertStatus, test passes [OK]

Common Mistakes:

• Assuming test fails if status is 200
• Confusing assertStatus with assertSee
• Thinking test skips without reason

4. You wrote this test but it fails with an error:

public function test_example()
{
    $response = $this->get('/home');
    $response->assertStatus(200)
}

What is the likely cause?

medium

A. Test method name is invalid

B. Wrong HTTP method used in get()

C. Missing semicolon after assertStatus(200)

D. Route '/home' does not exist

Solution

1. Step 1: Check syntax in test method

   The line $response->assertStatus(200) lacks a semicolon at the end.

2. Step 2: Understand PHP syntax rules

   Missing semicolon causes a syntax error and test fails to run.

3. Final Answer:

   Missing semicolon after assertStatus(200) -> Option C

4. Quick Check:

   Semicolon missing = syntax error [OK]

Hint: Always end PHP statements with semicolon [OK]

Common Mistakes:

• Ignoring missing semicolon errors
• Assuming wrong HTTP method causes syntax error
• Thinking test method name causes syntax error

5. You want to run only tests related to user authentication in Laravel. Which command helps you run tests in the tests/Feature/AuthTest.php file only?

hard

A. php artisan test --run=AuthTest

B. php artisan make:test AuthTest

C. php artisan test --only=AuthTest

D. php artisan test --filter=AuthTest

Solution

1. Step 1: Identify how to filter tests in Laravel

   Laravel's test command supports --filter to run specific tests.

2. Step 2: Match correct syntax for filtering

   php artisan test --filter=AuthTest uses php artisan test --filter=AuthTest, which runs tests matching 'AuthTest'.

3. Final Answer:

   php artisan test --filter=AuthTest -> Option D

4. Quick Check:

   Filter option runs specific tests [OK]

Hint: Use --filter to run specific test files or methods [OK]

Common Mistakes:

• Using nonexistent options like --only or --run
• Confusing make:test with running tests
• Not specifying filter correctly