단위 테스트를 작성할 때 중요한 과제는 테스트가 외부 시스템이나 종속성의 간섭 없이 테스트 중인 코드에 초점을 맞추도록 하는 것입니다. 여기가 PHPUnit에서 모의 객체가 작동하는 곳입니다. 이를 통해 제어된 방식으로 실제 객체의 동작을 시뮬레이션할 수 있으므로 테스트가 더욱 안정적이고 유지 관리가 쉬워집니다. 이 글에서는 모의 객체가 무엇인지, 왜 유용한지, PHPUnit에서 효과적으로 사용하는 방법을 살펴보겠습니다.

모의 객체란 무엇입니까?

모의 객체는 단위 테스트에 사용되는 실제 객체의 시뮬레이션 버전입니다. 이를 통해 다음을 수행할 수 있습니다.

• 테스트 중인 코드 격리: 모의 개체는 종속성의 동작을 시뮬레이션하여 테스트 결과가 해당 종속성의 실제 구현에 영향을 받지 않도록 합니다.
• 컨트롤 종속성 동작: 특정 메서드가 호출될 때 모의 객체가 어떻게 동작해야 하는지 지정할 수 있어 다양한 시나리오를 테스트할 수 있습니다.
• 상호작용 확인: 모의 추적 메서드 호출 및 해당 매개변수를 사용하여 테스트 중인 코드가 종속성과 올바르게 상호작용하는지 확인합니다.

모의 객체를 사용하는 이유는 무엇입니까?

모의는 다음 시나리오에서 특히 유용합니다.

• 복잡한 종속성: 코드가 데이터베이스, API 또는 타사 서비스와 같은 외부 시스템에 의존하는 경우 모의 객체는 해당 시스템과 상호 작용할 필요를 제거하여 테스트를 단순화합니다.
• 상호작용 테스트: 모의를 사용하면 특정 메서드가 올바른 인수로 호출되는지 확인하여 코드가 예상대로 작동하는지 확인할 수 있습니다.
• 더 빠른 테스트 실행: 데이터베이스 쿼리나 API 요청과 같은 실제 작업으로 인해 테스트 속도가 느려질 수 있습니다. 이러한 종속성을 모의하면 테스트 실행 속도가 빨라집니다.

스터빙과 모킹: 차이점은 무엇입니까?

모의 개체로 작업할 때 스터빙과 모의:

• 스터빙: 모의 객체에 대한 메서드 동작을 정의하는 것을 의미합니다(예: 특정 값을 반환하도록 메서드에 지시).
• 모의: 메소드 호출 방법에 대한 기대치를 설정하는 작업(예: 메소드 호출 횟수 및 해당 매개변수 확인)과 관련됩니다.

PHPUnit에서 모의 ​​객체를 생성하고 사용하는 방법

PHPUnit을 사용하면 createMock() 메서드를 사용하여 모의 객체를 쉽게 만들고 사용할 수 있습니다. 다음은 모의 객체를 효과적으로 사용하는 방법을 보여주는 몇 가지 예입니다.

예제 1: 기본 모의 객체 사용법

이 예에서는 클래스 종속성에 대한 모의 객체를 만들고 해당 동작을 지정합니다.

use PHPUnit\Framework\TestCase;

class MyTest extends TestCase
{
    public function testMockExample()
    {
        // Create a mock for the SomeClass dependency
        $mock = $this->createMock(SomeClass::class);

        // Specify that when the someMethod method is called, it returns 'mocked value'
        $mock->method('someMethod')
             ->willReturn('mocked value');

        // Pass the mock object to the class under test
        $unitUnderTest = new ClassUnderTest($mock);

        // Perform the action and assert that the result matches the expected value
        $result = $unitUnderTest->performAction();
        $this->assertEquals('expected result', $result);
    }
}

설명:

• createMock(SomeClass::class)는 SomeClass에 대한 모의 객체를 생성합니다.
• method('someMethod')->willReturn('mocked value') 는 모의 객체의 동작을 정의합니다.
• 모의 개체가 테스트 중인 클래스에 전달되어 실제 SomeClass 구현이 사용되지 않도록 합니다.

예제 2: 메서드 호출 확인

경우에 따라 올바른 매개변수를 사용하여 메소드가 호출되는지 확인해야 합니다. 그렇게 하는 방법은 다음과 같습니다.

public function testMethodCallVerification()
{
    // Create a mock object
    $mock = $this->createMock(SomeClass::class);

    // Expect the someMethod to be called once with 'expected argument'
    $mock->expects($this->once())
         ->method('someMethod')
         ->with($this->equalTo('expected argument'))
         ->willReturn('mocked value');

    // Pass the mock to the class under test
    $unitUnderTest = new ClassUnderTest($mock);

    // Perform an action that calls the mock's method
    $unitUnderTest->performAction();
}

핵심 사항:

• Expects($this->once())는 someMethod가 정확히 한 번 호출되도록 보장합니다.
• with($this->equalTo('expected 인수')) 는 메소드가 올바른 인수로 호출되었는지 확인합니다.

예: PaymentProcessor를 사용한 테스트

모의 객체의 실제 적용을 보여주기 위해 외부 PaymentGateway 인터페이스에 의존하는 PaymentProcessor 클래스의 예를 들어보겠습니다. 우리는 PaymentGateway의 실제 구현에 의존하지 않고 PaymentProcessor의 processPayment 메소드를 테스트하고 싶습니다.

PaymentProcessor 클래스는 다음과 같습니다.

class PaymentProcessor
{
    private $gateway;

    public function __construct(PaymentGateway $gateway)
    {
        $this->gateway = $gateway;
    }

    public function processPayment(float $amount): bool
    {
        return $this->gateway->charge($amount);
    }
}

이제 실제 결제 게이트웨이와 상호작용하지 않고 processPayment 메소드를 테스트하기 위해 PaymentGateway에 대한 모의를 생성할 수 있습니다.

모의 객체를 사용하여 PaymentProcessor 테스트하기

use PHPUnit\Framework\TestCase;

class PaymentProcessorTest extends TestCase
{
    public function testProcessPayment()
    {
        // Create a mock object for the PaymentGateway interface
        $gatewayMock = $this->createMock(PaymentGateway::class);

        // Define the expected behavior of the mock
        $gatewayMock->method('charge')
                    ->with(100.0)
                    ->willReturn(true);

        // Inject the mock into the PaymentProcessor
        $paymentProcessor = new PaymentProcessor($gatewayMock);

        // Assert that processPayment returns true
        $this->assertTrue($paymentProcessor->processPayment(100.0));
    }
}

테스트 분석:

• createMock(PaymentGateway::class)는 PaymentGateway 인터페이스를 시뮬레이션하는 모의 객체를 생성합니다.
• method('charge')->with(100.0)->willReturn(true)는 100.0을 인수로 사용하여 Charge 메소드를 호출할 때 true를 반환해야 함을 지정합니다.
• 모의 개체가 PaymentProcessor 클래스에 전달되므로 실제 결제 게이트웨이에 의존하지 않고 processPayment를 테스트할 수 있습니다.

상호작용 확인

결제를 처리할 때 청구 방법이 정확히 한 번 호출되는지 확인할 수도 있습니다.

public function testProcessPaymentCallsCharge()
{
    $gatewayMock = $this->createMock(PaymentGateway::class);

    // Expect the charge method to be called once with the argument 100.0
    $gatewayMock->expects($this->once())
                ->method('charge')
                ->with(100.0)
                ->willReturn(true);

    $paymentProcessor = new PaymentProcessor($gatewayMock);
    $paymentProcessor->processPayment(100.0);
}

이 예에서 Expects($this->once())는 청구 메소드가 정확히 한 번 호출되도록 보장합니다. 메서드가 호출되지 않거나 두 번 이상 호출되면 테스트가 실패합니다.

예: 리포지토리로 테스트

사용자 데이터를 가져오기 위해 UserRepository에 의존하는 UserService 클래스가 있다고 가정해 보겠습니다. UserService를 독립적으로 테스트하려면 UserRepository를 모의할 수 있습니다.

class UserService
{
    private $repository;

    public function __construct(UserRepository $repository)
    {
        $this->repository = $repository;
    }

    public function getUserName($id)
    {
        $user = $this->repository->find($id);
        return $user->name;
    }
}

이 클래스를 테스트하기 위해 저장소를 모의할 수 있습니다.

use PHPUnit\Framework\TestCase;

class UserServiceTest extends TestCase
{
    public function testGetUserName()
    {
        // Create a mock for the UserRepository
        $mockRepo = $this->createMock(UserRepository::class);

        // Define that the find method should return a user object with a predefined name
        $mockRepo->method('find')
                 ->willReturn((object) ['name' => 'John Doe']);

        // Instantiate the UserService with the mock repository
        $service = new UserService($mockRepo);

        // Assert that the getUserName method returns 'John Doe'
        $this->assertEquals('John Doe', $service->getUserName(1));
    }
}

모의 사용 모범 사례

1. 필요할 때만 모의를 사용하세요: 모의는 코드를 분리하는 데 유용하지만 과도하게 사용하면 테스트를 이해하기 어렵게 만들 수 있습니다. 테스트에 필요한 모의 종속성만.
2. 구현이 아닌 동작에 초점: 모의는 종속성의 특정 구현 세부 사항이 아니라 코드의 동작을 테스트하는 데 도움이 되어야 합니다.
3. 너무 많은 종속성을 모의하는 것을 피하세요: 클래스에 모의된 종속성이 많이 필요한 경우 이는 클래스에 책임이 너무 많다는 신호일 수 있습니다. 필요한 경우 리팩토링하세요.
4. 상호작용을 드물게 확인: 테스트에 꼭 필요한 경우를 제외하고 메서드 호출을 과도하게 확인하지 마세요.

결론

모의 객체는 PHPUnit에서 단위 테스트를 작성하는 데 매우 유용한 도구입니다. 이를 통해 코드를 외부 종속성으로부터 격리할 수 있으므로 테스트가 더 빠르고 안정적이며 유지 관리가 더 쉬워집니다. 또한 모의 객체는 테스트 중인 코드와 해당 종속성 간의 상호 작용을 확인하여 코드가 다양한 시나리오에서 올바르게 작동하는지 확인하는 데 도움이 됩니다