[TDD] 테스트 더블 - Mock vs Stub vs Spy

목차

 

 

🧑‍🤝‍🧑 테스트 더블

https://martinfowler.com/bliki/TestDouble.html

테스트 더블은 소프트웨어 테스트에서 실제 객체를 대신하여 사용되는 가짜 객체 들로, 테스트 환경에서 다양한 목적을 위해 활용된다.

마틴 파울러는 위의 게시글에서 테스트 더블을 다섯 가지로 분류했다.

• Dummy : 객체는 전달되지만 실제로 사용되지 않는다. 일반적으로 파라미터를 전달하기 위한 용도로만 사용된다.
• Fake : 실제로 동작하는 객체를 의미한다. 보통 프로덕션에 환경에 적합하지 않은 지름길 역할을 한다. (인메모리 데이터베이스 가 좋은 예시이다).
• Stub : 테스트 중에 호출된 경우에 대해 미리 정해진 값을 응답한다. 보통 테스트를 위해 만들어지며 테스트 이외에 사용되지 않는다.
• Spy : 호출 방식에 따라 일부 정보를 기록하는 스텁이라 할 수 있다. 주로 어떤 동작이 이루어졌는지 검증하는 용도로 사용한다. 전송된 메시지 수를 기록하는 이메일 서비스가 한 예시이다.
• Mock : 호출했을 때 사전에 정의된 명세대로의 결과를 돌려주도록 미리 프로그래밍되어 있다. 예상치 못한 호출이 있을 경우 예외를 던질 수 있으며, 모든 호출이 예상된 것이었는지 확인할 수 있다.

위에 정의된 테스트 더블 중에서 Mock 만 행위를 검증한다. 보통 다른 더블은 상태 검증을 위해 사용한다.

 

🔎 상태 검증 vs 행위 검증

상태 검증과 행위 검증은 소프트웨어 테스트에서 사용되는 두 가지 주요 접근 방식이며, 테스트 대상의 동작을 검증하는 방법에 차이를 두고 있다.

 

상태 검증 (State Verification)

• 시스템이 특정 상태에 도달했는지를 확인하는 테스트 방식이다.
• 주로 시스템의 메서드나 기능이 호출된 후에, 그 결과로 시스템의 상태가 예상된 대로 변했는지를 검사한다.

예시) 은행 계좌에 돈을 입금하는 메서드를 테스트할 때, 입금 후 계좌 잔고가 올바르게 업데이트되었는지를 확인한다.

• 상황 : 은행 계좌에 돈을 입금하는 기능을 테스트
• 테스트 : 계좌에 100,000원을 입금한 후, 잔고가 500,000원에서 600,000원으로 증가했는지를 확인한다.
• 검증 : 입금 후 계좌 잔고가 600,000원이 되었는지를 확인하여 상태를 검증한다.

행위 검증 (Behavior Verification)

• 시스템이 올바른 절차나 방법을 따라 작동했는지를 확인하는 테스트 방식이다.
• 특정 작업을 수행하는 동안 올바른 메서드나 절차를 호출했는지, 특정 인터페이스와 올바르게 상호작용 했는지를 검사한다.

예시) 은행 계좌에 돈을 입금하는 메서드를 테스트할 때, 입금 과정에서 올바른 메서드들이 호출되었는지를 확인한다.

• 상황: 은행 계좌에 돈을 입금하는 기능을 테스트
• 테스트: 계좌에 100,000원을 입금하는 동안, 잔고 업데이트 메서드와 입금 내역 기록 메서드가 올바른 순서로 호출되었는지를 확인한다.
• 검증: 입금 과정에서 잔고 업데이트 메서드가 호출되었고, 그 후 입금 내역 기록 메서드가 호출되었는지를 확인하여 행위를 검증한다.

상태 검증은 시스템의 결과를 중점적으로 확인하며, 최종 상태가 올바른지에 초점을 맞춘다.
행위 검증은 시스템의 행동 과정을 중점적으로 확인하며, 시스템이 올바르게 행동했는지를 평가한다.

두 검증 방식은 서로 보완적이며, 특정 상황에 따라 하나 또는 둘 다 사용할 수 있다.

 

 

 🥸 Mock : 기대한 대로 잘 호출이 되나? - 행위 검증

Mock 은 특정 메서드 호출이 예상대로 이루어졌는지 확인하기 위한 목적으로 사용된다.

Mock의 특징

• 호출에 대한 기대를 명세하고, 내용에 따라 동작하도록 프로그래밍된 객체이다.
• 행위 검증을 수행한다.
• 반환값이 없는 함수나, 특정 함수 호출 여부를 테스트할 때 주로 사용된다.
• @Mock 어노테이션을 통해 생성되며, stubbing을 통해 반환값을 설정할 수 있다. stubbing을 하지 않으면 기본 값(참조형은 null, 기본형은 0)을 반환한다.

Mock 은 테스트 중에 특정 인터페이스를 구현하는 객체를 대체하는 데 사용된다. 즉, 가짜 테스트 수단을 만들어 두는 것이다.

이렇게 대체된 Mock 객체는 위에 언급한 대로 특정 메서드가 호출되었는지, 어떤 인자로 호출되었는지 검사하는 데 중점을 둔다.

 

 

📚 Stub : 기대한 값이 잘 반환되나? - 상태 검증

Stub 객체는 특정 함수 호출 시 예상된 값을 반환하도록 설정된 객체이다.

Stub의 특징

• 인스턴스화하여 구현한 가짜 객체(Dummy, 기능 구현이 없음)를 이용해 실제로 동작하는 것처럼 보이게 만드는 객체이다.
• 인터페이스 또는 기본 클래스를 최소한으로 구현한다.
• 상태 검증을 위해 사용된다. 즉, 함수 호출 후 객체의 상태가 올바른지 확인한다.
• 테스트 시에 프로그래밍된 것 외에는 응답하지 않는다.
• 협력 객체의 특정 부분이 테스트가 어려운 경우, stub을 사용하여 수월하게 테스트할 수 있다.
• 테스트 중에 사용되는 하드코딩 된 값 또는 응답을 제공하는 데 사용된다.

Stub은 특정 객체에서 특정 함수를 호출할 때, 특정한 값이 반환되기를 기대하며 더미 데이터를 지정할 때 사용한다.

복잡한 로직이나 외부 시스템과의 상호작용을 단순화하고, 테스트를 더 예측 가능하게 만드는 데 중점을 둔다.

 

 

👀 Spy : 예상한 동작과 상태를 감시

Spy는 특정 함수만 실제 함수를 호출하게 하고 싶을 때, 기존의 객체나 함수를 감시하는 데에 사용된다. 이때 함수 호출, 전달된 인자, 반환 값 등을 기록하지만, 실제 로직의 동작을 변경하지는 않는다.

Spy의 특징

• 특정 함수의 호출 횟수, 전달된 인자, 반환 값 등을 기록한다.
• 실제 객체의 동작을 유지하면서 특정 부분만 감시하거나 조작하고 싶을 때 사용한다.
  부분적인 스터빙을 통해 유연하게 테스트를 진행할 수 있다.
• @Spy 어노테이션을 사용하며, stubbing을 하지 않으면 실제 로직이 수행된다. stubbing 을 하면 설정된 값을 반환한다.

 

❓어느 상황에 어떠한 테스트 더블을 사용해야 할까

Mock을 사용해야 하는 경우

1. 전체 객체를 가짜로 대체하고 싶을 때
   테스트 환경에서 복잡한 의존성을 제거하고, 테스트하고자 하는 부분에만 집중한다. 예를 들어, 외부 API 호출을 완전히 Mocking하여 테스트할 때 사용한다.
2. 행위 검증(Behavior Verification)에 집중하고 싶을 때
   특정 메서드가 호출되었는지, 호출된 횟수, 호출된 인자 등을 검증할 때 Mock을 사용한다.
   이때 Mock은 실제 동작을 수행하지 않으므로, 외부 시스템과의 상호작용을 테스트할 때 안전하게 사용할 수 있다.
3. 테스트가 실제 동작과 무관할 때
   테스트가 특정 로직의 실행 여부나 방식에만 관심이 있고, 그 로직의 실제 결과나 상태는 중요하지 않을 때 사용한다.
   예를 들어, 이벤트 핸들러가 올바르게 등록되고 호출되는지 확인하고, 그 결과는 중요하지 않은 경우에 적합하다.

Stub을 사용해야 하는 경우

1. 테스트의 입력에 집중할 때
   입력 값에 따라 리턴하는 결괏 값을 비교하거나, 특정 입력 값에 대한 예외 발생 여부를 확인한다. 예를 들어, 메서드가 주어진 입력에 대해 예상된 결과를 반환하는지 검증할 때 사용한다.
2. 입력에 따라 예외가 발생하는지 확인할 때
   특정 입력 값이 주어졌을 때, 메서드가 올바르게 예외를 발생시키는지 확인한다. 예를 들어, 잘못된 입력에 대한 적절한 예외 처리를 테스트할 때 사용한다.

Spy를 사용해야 하는 경우

1. 부분적으로 실제 객체의 동작을 유지하고 싶을 때
   실제 객체를 생성한 후, 일부 메서드만 감시하거나 스터빙(stubbing) 할 수 있다. 복잡한 클래스에서 특정 메서드의 호출 횟수나 인자를 확인하면서도 나머지 메서드들은 원래의 동작을 유지하고 싶을 때 사용한다.
2. 실제 로직을 테스트하면서 특정 부분만 조작하고 싶을 때
   전체 메서드 호출 흐름은 유지하면서 특정 메서드의 반환값만 변경해 테스트를 진행한다. 복잡한 계산을 수행하는 메서드의 일부 결과만 조작하고, 나머지 흐름은 그대로 유지하고 싶을 때 유용하다.

 

 

spy 사용 예시 코드

public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
    public int multiply(int a, int b) {
        return a * b;
    }
    public int subtract(int a, int b) {
        return a - b;
    } 
}

public class SpyCalculator extends Calculator {
    private final List<String> methodCalls = new ArrayList<>();

    @Override
    public int add(int a, int b) {
        methodCalls.add("add(" + a + ", " + b + ")");
        return super.add(a, b);  // 실제 메서드 호출
    }

    @Override
    public int multiply(int a, int b) {
        methodCalls.add("multiply(" + a + ", " + b + ")");
        return 100;  // 스터빙 처리된 값
    }
    
    // subtract 은 감시X, 스터빙X

    // 메서드 호출 내역을 확인하는 메서드
    public boolean wasMethodCalled(String methodCall) {
        return methodCalls.contains(methodCall);
    }
}

•  SpyCalculator 클래스는 Calculator 클래스를 확장한 것으로, 메서드 호출을 감시하고 특정 메서드에 대해 스터빙을 적용한다.
• add 메서드는 실제 계산을 수행하고, 호출 내역을 기록한다.
• multiply 메서드는 호출 내역을 기록한 후, 항상 100을 반환하는 스터빙 처리된 메서드이다.
• add와 multiply 메서드가 호출될 때 호출 내역을 methodCalls 리스트에 기록한다. -> wasMethodCalled(String methodCall) 메서드를 사용하여 특정 메서드 호출 내역이 기록되었는지 확인할 수 있다.

public class SpyCalculatorTest {

    @Test
    public void testOriginalCalculator() {
        // 원래의 Calculator 객체 생성
        Calculator calculator = new Calculator();

        // 원래 Calculator의 add 메서드는 원래 동작을 수행
        int originalAddResult = calculator.add(2, 3);
        assertEquals(5, originalAddResult);

        // 원래 Calculator의 multiply 메서드도 원래 동작을 수행
        int originalMultiplyResult = calculator.multiply(2, 3);
        assertEquals(6, originalMultiplyResult);
    }

    @Test
    public void testSpyCalculatorWithStubbingAndVerification() {
        // SpyCalculator 객체 생성
        SpyCalculator spyCalculator = new SpyCalculator();

        // multiply 메서드는 스터빙된 값(100)을 반환
        int multiplyResult = spyCalculator.multiply(2, 3);
        assertEquals(100, multiplyResult);

        // add 메서드는 실제 동작을 수행
        int addResult = spyCalculator.add(2, 3);
        assertEquals(5, addResult);

        // subtract 메서드는 실제 동작을 수행
        int subtractResult = spyCalculator.subtract(5, 3);
        assertEquals(2, subtractResult);

        // 메서드 호출 감시
        assertTrue(spyCalculator.wasMethodCalled("multiply(2, 3)"));  // multiply 메서드가 호출되었는지 확인
        assertTrue(spyCalculator.wasMethodCalled("add(2, 3)"));       // add 메서드가 호출되었는지 확인
    }
    
    // Mockito 사용
    @Test
    public void testCalculatorWithSpy() {
        // 실제 Calculator 객체 생성
        Calculator realCalculator = new Calculator();
        // Calculator의 spy 객체 생성
        Calculator spyCalculator = spy(realCalculator);

        // multiply 메서드를 스터빙 처리하여 항상 100을 반환하도록 설정
        doReturn(100).when(spyCalculator).multiply(2, 3);

        // 테스트: multiply 메서드는 스터빙된 값(100)을 반환
        int multiplyResult = spyCalculator.multiply(2, 3);
        assertEquals(100, multiplyResult);

        // 테스트: add 메서드는 실제 동작을 수행
        int addResult = spyCalculator.add(2, 3);
        assertEquals(5, addResult);

        // 테스트: subtract 메서드는 실제 동작을 수행
        int subtractResult = spyCalculator.subtract(5, 3);
        assertEquals(2, subtractResult);

        // 메서드 호출 검증
        verify(spyCalculator).multiply(2, 3); // multiply(2, 3) 호출 검증
        verify(spyCalculator).add(2, 3);      // add(2, 3) 호출 검증
        verify(spyCalculator).subtract(5, 3); // subtract(5, 3) 호출 검증
    }
 }

 

 

참고 문헌

• https://velog.io/@wjdtjdrhkd01/테스트-코드-Mock-Spy-InjectMocks-에-대해