Skip to content

Codeigniter 19: How to Write Unit Tests for Your CodeIgniter REST APIs

Computer pc and laptop with programming code on screens at software development company.

Codeigniter 19: How to Write Unit Tests for Your CodeIgniter REST APIs

Unit testing is an essential practice in modern software development, ensuring that individual components of your application work as expected. This guide will walk you through writing unit tests for your CodeIgniter REST API endpoints, helping you maintain a reliable and bug-free application.

 

Why Unit Testing Matters
 

  1. Identify Bugs Early: Catch issues during development before they reach production.
  2. Enhance Code Quality: Ensure every component works as intended.
  3. Facilitate Refactoring: Modify code confidently, knowing tests will catch regressions.
  4. Improve Collaboration: Clear, automated tests help teams work effectively together.

 

Setting Up Unit Testing in CodeIgniter
 

1. Install PHPUnit

CodeIgniter supports PHPUnit for unit testing.

  1. Install PHPUnit via Composer:
    composer require --dev phpunit/phpunit
  2. Verify Installation: Run the following command to confirm PHPUnit is installed:
    vendor/bin/phpunit --version


2. Configure PHPUnit

  1. Create a phpunit.xml File: Add the following configuration to the root of your project:
    <phpunit bootstrap="vendor/autoload.php" colors="true">
    <testsuites>
        <testsuite name="Application Test Suite">
            <directory>./tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">./app</directory>
        </whitelist>
    </filter>
</phpunit>
  2. Set the Environment to Testing: In app/Config/Constants.php, define the testing environment:
    define('CI_ENVIRONMENT', 'testing');

 
3. Create the tests Directory

  1. Add a tests folder to your project root.
  2. Create subdirectories such as tests/Controllers or tests/Models for organizing test cases.

 

Writing Unit Tests for REST API Endpoints


1. Testing a GET Endpoint

Example: Testing a /users endpoint.

  1. Create a Test File: Create tests/Controllers/UserControllerTest.php:
    namespace Tests\App\Controllers;

use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\FeatureTestTrait;

class UserControllerTest extends CIUnitTestCase {
    use FeatureTestTrait;

    public function testGetUsers() {
        $response = $this->get('/users');
        $response->assertStatus(200);
        $response->assertJSONFragment([
            'name' => 'John Doe',
            'email' => 'john@example.com',
        ]);
    }
}
  2. Run the Test: Execute the test using PHPUnit:
    vendor/bin/phpunit


2. Testing a POST Endpoint

Example: Testing user registration.

  1. Write the Test:
    public function testCreateUser() {
    $response = $this->post('/users', [
        'name' => 'Jane Doe',
        'email' => 'jane@example.com',
        'password' => 'securepassword',
    ]);

    $response->assertStatus(201);
    $response->assertJSONFragment([
        'message' => 'User created successfully',
    ]);
}
  2. Validate Input: Ensure invalid data is handled properly:
    public function testCreateUserValidationError() {
    $response = $this->post('/users', [
        'name' => '',
        'email' => 'invalid-email',
    ]);

    $response->assertStatus(400);
    $response->assertJSONFragment([
        'error' => 'Validation failed',
    ]);
}


3. Testing a DELETE Endpoint

Example: Testing user deletion.

  1. Write the Test:
    public function testDeleteUser() {
    $response = $this->delete('/users/1');

    $response->assertStatus(200);
    $response->assertJSONFragment([
        'message' => 'User deleted successfully',
    ]);
}
  2. Handle Non-Existent Users: Test how the API responds to invalid IDs:
    public function testDeleteUserNotFound() {
    $response = $this->delete('/users/999');

    $response->assertStatus(404);
    $response->assertJSONFragment([
        'error' => 'User not found',
    ]);
}

 

Tips for Writing Effective Unit Tests
 

  1. Use Mock Data: Mock external services and database queries to isolate tests.
    $mock = $this->createMock(UserModel::class);
$mock->method('findAll')->willReturn([
    ['id' => 1, 'name' => 'John Doe'],
]);
  2. Write Comprehensive Tests: Cover all possible scenarios, including edge cases and invalid inputs.
  3. Automate Testing: Integrate PHPUnit tests into your CI/CD pipeline for continuous testing.
  4. Maintain Test Independence: Ensure tests don’t depend on each other by resetting states before each test.

 

Conclusion
 

Unit testing is a vital part of ensuring your CodeIgniter REST APIs are reliable, secure, and performant. By using tools like PHPUnit and following the practices outlined in this guide, you can build a comprehensive test suite that safeguards your application from bugs and regressions. In the next blog, we’ll explore advanced API development techniques in CodeIgniter for large-scale applications.
 
 
   

Recent Posts