PHPにおけるモックを用いたテスト駆動開発

テスト駆動開発（TDD）は、テストを先に書き、そのテストを満たすようにコードを実装していく開発手法です。
PHPにおいても、モックを活用することでTDDを効果的に実践できます。

ここでは、ユーザー情報を扱うシンプルなアプリケーションを例に、モックを用いたテスト駆動開発の流れを解説します。

ユーザー情報を扱うアプリケーション

まず、ユーザー情報を扱うアプリケーションの主要なコンポーネントを見ていきましょう。

User.php

<?php

namespace App;

class User {
    private $id;
    private $name;
    private $email;

    public function __construct($id, $name, $email) {
        $this->id = $id;
        $this->name = $name;
        $this->email = $email;
    }

    public function getId() {
        return $this->id;
    }

    public function getName() {
        return $this->name;
    }

    public function getEmail() {
        return $this->email;
    }
}

Userクラスは、ユーザーを表すシンプルなエンティティです。
ユーザーID、名前、メールアドレスをプロパティとして持ちます。

UserRepositoryInterface.php

<?php

namespace App;

interface UserRepositoryInterface {
    public function findById($id): ?User;
}

UserRepositoryInterfaceは、ユーザーリポジトリのインターフェースです。
findByIdメソッドを定義し、IDによるユーザーの検索を抽象化しています。

UserService.php

<?php

namespace App;

class UserService {
    private $userRepository;

    public function __construct(UserRepositoryInterface $userRepository) {
        $this->userRepository = $userRepository;
    }

    public function getUserName($userId) {
        $user = $this->userRepository->findById($userId);
        if ($user) {
            return $user->getName();
        }
        return null;
    }
}

UserServiceは、ユーザーに関連するビジネスロジックを実装するクラスです。
UserRepositoryInterfaceに依存し、ユーザーIDからユーザー名を取得するgetUserNameメソッドを提供します。

名前空間（namespace App）についてよくわからない場合は、次の記事をご覧ください。

モックを用いたテスト

次に、モックを用いてUserServiceのテストを書いてみましょう。
モックを利用するには、PHPUnitのインストールが前提となります。

UserServiceTest.php

<?php

use PHPUnit\Framework\TestCase;
use App\User;
use App\UserRepositoryInterface;
use App\UserService;

class UserServiceTest extends TestCase {
    public function testGetUserName() {
        // UserRepositoryのモックを作成
        $userRepositoryMock = $this->createMock(UserRepositoryInterface::class);

        // findByIdメソッドの期待値を設定
        $userRepositoryMock->expects($this->once())
            ->method('findById')
            ->with(1)
            ->willReturn(new User(1, 'John Doe', 'john@example.com'));

        // モックを注入してUserServiceのインスタンスを作成
        $userService = new UserService($userRepositoryMock);

        // テスト対象のメソッドを呼び出す
        $userName = $userService->getUserName(1);

        // 期待する結果とのアサーション
        $this->assertEquals('John Doe', $userName);
    }
}

UserServiceTestは、UserServiceのテストクラスです。
以下の手順でテストを実装します。