[TIL] 221107 - SpringBoot Part2 : Spring Test 시작하기

SpringBoot Part2 - Spring Test 시작하기

 

1. 소프트웨어 테스팅

소프트웨어의 결함을 찾는 과정

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

 

 

Testing Level

• Unit tests
• Integration tests
• Component tests
• End-to-end tests

 

 

2. 단위 테스트

가장 작은 단위의 테스트

: 보편적으로 하나의 class에 하나의 단위테스트를 작성한다.

: 고립해서 테스트 한다.

: 새로운 기능을 추가했을때 기존 기능들이 단위테스트에 의해 잘 작동하는지 확인할 수 있다.

: 테스트 코드(테스트 케이스) 자체가 기능 명세서가 될 수 있다.

: Spring 환경에서도 제공이 되나 하나의 class의 기능에 집중한 테스트를 해야하기 때문에 큰 이점은 없다.

→ Spring은 통합 테스트에 더 큰 도움을 준다.

SUT

: System Under Test, 테스트 대상

: 전체 시스템이 아닌 단위 테스트의 하나의 단위를 지칭한다.

: 시스템 혹은 class에서 제공하는 기능

 

의존관계에 있는 다른 객체들을 협력관계자라고 부르며, 실제 객체를 만들어 전달하기 보다는 테스트 더블로 대체하여 주입한다

 

 

테스트 더블

: 실재 객체가 아닌 의존 구성요소를 사용할 수 없을때 테스트 대상 코드와 상호작용하는 객체

: Stub, Mock 객체 등이 있다.

 

 

3. 통합테스트

: 테스트하고자 하는 코드가 다른 의존관계와 연동이 잘 되었는지 확인

https://codeutopia.net/blog/2015/04/11/what-are-unit-testing-integration-testing-and-functional-testing/

 

 

4. JUnit

가장 많이 사용하는 오픈소스 프레임워크

• 매 단위 테스트시마다 테스트 클래스의 인스턴스가 생성되어 독립적인 테스트가 가능하게 합니다.
• 애노테이션을 제공해서 테스트 라이프 사이클을 관리하게 해주고 테스트 코드를 간결하게 작성하도록 지원해줍니다.
• 테스트 러너를 제공해서 인텔리제이 / 이클립스 / 메이븐 등에서 테스트 코드를 쉽게 실행하 게 해줍니다.
• assert로 테스트 케이스의 수행 결과를 판별하게 해줍니다. → assertEquals(예상 값, 실제 값)
• 결과는 성공(녹색), 실패(붉은색) 중 하나로 표시해줍니다

 

JUnit 4 → 하나의 jar파일로 구성됬으면 확장성이 떨어져 연동이 힘들었다.

JUnit 5 → 확정성을 위해 3개의 모듈로 분리가 되었다. Junit Platform, JUnit Jupitor, JUnit Vintage

 

 

Junit Platform : 테스팅 프레임워크를 런칭하기 위한 기반, 플렛폼을 제공. 테스트를 실행하고 결과를 보여줌

JUnit Jupitor : 실제 구현체. 테스트 코드를 발견하고 실행한다.

JUnit Vintage : 기존 JUnit 4에서 작성한 코드를 실행해줌.

 

5. JUnit 실습

: 어떻게 해야 망가트릴 수 있을지 코트를 짜기

: 테스트 메소드는 return 값이 있으면 안된다.

class FixedAmountVoucherTest { // FixedAmountVoucher -> SUT
    private static final Logger logger = LoggerFactory.getLogger(FixedAmountVoucherTest.class);
    @BeforeAll
    static void setup(){
        logger.info("@BeforeAll - 단 한번 실행");
    }

    @BeforeEach
    void init(){
        logger.info("@BefeorEach - 매 테스트 마다 실행");
    }

    @Test
    @DisplayName("기본적인 assertEqual 테스트 ")
    @Disabled // 이 테스트 건너뛰기
    void testAssertEqual(){ // 어떠한 값도 return 하면 안된다.
        assertEquals("1","1");
    }

    @Test
    @DisplayName("주어진 금액만큼 할인을 해야한다.")
    void testDiscount() {
        var sut = new FixedAmountVoucher(UUID.randomUUID(),100);
        assertEquals(900, sut.discount(1000));
    }

    @Test
    @DisplayName("할인된 큼액은 마이너스가 될 수 없다.")
    void testMinusDiscountAmount() {
        var sut = new FixedAmountVoucher(UUID.randomUUID(),1000);
        assertEquals(0, sut.discount(900));
    }

    @Test
    @DisplayName("할인 금액은 음수가 되서는 안된다")
    void testWithMinus(){
        assertThrows(IllegalArgumentException.class,() ->new FixedAmountVoucher(UUID.randomUUID(),-100));
        // 발생될 예외 class를 인자로 받아 예외가 잘 발생하나 확인 : 예외가 발생하지 않으면 실패
    }

    @Test
    @DisplayName("유효한 할인 금액으로만 생성할 수 있다.")
    void testVoucherCreation(){
        // 여러 케이스의 테스트를 한번에 테스트
        assertAll("FixedAmountVoucher creation",
                ()-> assertThrows(IllegalArgumentException.class,()-> new FixedAmountVoucher(UUID.randomUUID(),0)),
                ()-> assertThrows(IllegalArgumentException.class,()-> new FixedAmountVoucher(UUID.randomUUID(),-100)),
                ()-> assertThrows(IllegalArgumentException.class,()-> new FixedAmountVoucher(UUID.randomUUID(),10000000)));
    }

}

 

TTD ?

 

DDD ?

 

 

→ 어떤 방식을 하던 테스트 코드를 꼭 작성해야한다.

 

 

hamcrest

: 더욱 다양한 검증 로직을 제공해주는 라이브러리

import static org.hamcrest.MatcherAssert.*;
import static org.hamcrest.Matchers.*;
import static org.junit.jupiter.api.Assertions.*;

public class HamcrestAssertionTests {

    @Test
    @DisplayName("여러 hamcrest matcher 테스트")
    void hamcrestTest() {
        assertEquals(2, 1 + 1);
        assertThat(1 + 1, equalTo(2)); //MatcherAssert 메소드
        assertThat(1 + 1, is(2));
        assertThat(1 + 1, anyOf(is(2), is(3)));

        assertNotEquals(1,1+1);
        assertThat(1+1, not(equalTo(1)));
    }

    // list나 collection을 테스트 하기 위한 편리성을 제공한다.
    @Test
    @DisplayName("컬렉션에 대한 matcher 테스트")
    void hamcrestListMatcherTest(){
        var prices = List.of(1,2,3);
        assertThat(prices, hasSize(3));
        assertThat(prices, everyItem(greaterThan(0)));
        assertThat(prices, containsInAnyOrder(1,2,3));
        assertThat(prices, hasItem(greaterThanOrEqualTo(2)));
    }
}

 

 

6. Mock Object

: 모의 객체!

https://khalilstemmler.com/wiki/test-doubles/

 

stub → 말그대로 가짜 객체

mock → 호출에 대한 기대를 명세. 행위에 집중

 

목 객체는 행위검증을 사용하고, stub를 포함한 다른 대역들을 상태 검증을 사용한다.

상태 검증 : 메소드가 수행된 후, 객체의 상태를 확인하여 올바르게 동작했는지를 확인하는 검증법. stub으로 확인

행위 검증 : 메소드의 리턴 값을 판단할 수 없는 경우 특정 동작을 수행하는지 확인하는 검증법. 특정 메소드가 호출되었는지 확인

 

 

Mock Object 생성을 도와주는 TestFramework

• Mockito
• JMock
• EasyMock

 

 

7. 유닛테스트 실습

import static org.junit.jupiter.api.Assertions.*;

import static org.hamcrest.MatcherAssert.*;
import static org.hamcrest.Matchers.*;
import static org.mockito.Mockito.*;
class OrderServiceTest {

    class OrderRepositoryStub implements OrderRepository{

        @Override
        public Order insert(Order order) {
            return null;
        }
    }

    // 상태에 집중을 한 테스트
    @Test
    @DisplayName("order가 생성되야아한다. (stub)")
    void TestCreateOrder() {
        // Given - 사용할 객체 만들기
        var voucherRepository = new MemoryVoucherRepository();
        var fixedAmountVoucher = new FixedAmountVoucher(UUID.randomUUID(),100);
        voucherRepository.insert(fixedAmountVoucher);
        var sut = new OrderService(new VoucherService(voucherRepository),new OrderRepositoryStub());

        // When
        var order = sut.createOrder(UUID.randomUUID(), List.of(new OrderItem(UUID.randomUUID(), 200, 1)),fixedAmountVoucher.getVoucherId());

        //Then
        assertThat(order.totalAmount(), is(100L));
        assertThat(order.getVoucher().isEmpty(), is(false));
        assertThat(order.getVoucher().get().getVoucherId(), is(fixedAmountVoucher.getVoucherId()));
        assertThat(order.getOrderStatus(), is(OrderStatus.ACCEPTED));

    }

    @Test
    @DisplayName("order가 생성되야아한다. (mock)")
    void TestCreateOrderByMock() {
        // Given - 이러한 상황을 만듬
        var voucherServiceMock = mock(VoucherService.class);
        var orderRepositoryMock = mock(OrderRepository.class);
        var fixedAmountVoucher = new FixedAmountVoucher(UUID.randomUUID(),100);

        when(voucherServiceMock.getVoucher(fixedAmountVoucher.getVoucherId())).thenReturn(fixedAmountVoucher);// 해당부분만 동작한다.
        var sut = new OrderService(voucherServiceMock,orderRepositoryMock);

        // When - order만들기
        var order = sut.createOrder(UUID.randomUUID(), List.of(new OrderItem(UUID.randomUUID(), 200, 1)),
                fixedAmountVoucher.getVoucherId());

        // Then - order에 대한 상태검사, orderservice안에서 사용되는 mock들이 어떠한 행동을 하는지 검증
        assertThat(order.totalAmount(), is(100L));
        assertThat(order.getVoucher().isEmpty(), is(false));

        var inOrder = inOrder(voucherServiceMock, orderRepositoryMock);//mock에 대한 순서를 보장할수있다.
        // 행위에 대한 assert가 아니라 어떠한 메소드가 호출됬는지 verify

        inOrder.verify(voucherServiceMock).getVoucher(fixedAmountVoucher.getVoucherId());
        inOrder.verify(orderRepositoryMock).insert(order);
        inOrder.verify(voucherServiceMock).useVoucher(fixedAmountVoucher);
    }
}

: mock을 통해 별도의 코드를 추가하지않고 메소드 호출여부를 검사할 수 있다.

 

8. Spring Test

Spring의 JUnit 지원

https://docs.spring.io/spring-framework/docs/current/reference/html/testing.html

 

 

• 단위테스트 지원

→ but 비지니스로직은 프레임워크에 작성하는 것이 좋다.

 

• 통합테스트 지원

: 서버를 띄우지않고 spring container 내에서 각각의 bean들간의 연동을 테스트 할때 사용된다.

Spring TestContext

: 어노테이션을 이용해서 applicationContext를 만들수 있다.

: 캐시기능이 있어 동일한 내용의 컨테이너라면 재사용이 가능하여 빠르게 구동 가능하다.

 

 

 

9. Spring Test 실습

//@ExtendWith(SpringExtension.class) //test context와 상호작용하게 해줌
//@ContextConfiguration
@SpringJUnitConfig
@ActiveProfiles("local")
public class KdtSpringContextTest {

    @Configuration
    @ComponentScan
    static  class Config{

    }
    @Autowired
    ApplicationContext applicationContext;

    @Autowired
    OrderService orderService;

    @Autowired
    VoucherRepository voucherRepository;

    @Test
    @DisplayName("application context가 생성된다.")
    public void testApplicationContext(){
        assertThat(applicationContext, notNullValue());
    }

    @Test
    @DisplayName("VoucherRepository가 빈으로 등록되어있어야한다.")
    public void testVoucherRepository(){
        var been = applicationContext.getBean(VoucherRepository.class);
        assertThat(been, notNullValue());

    }

    @Test
    @DisplayName("OrderService를 사용해서 주문을 생성할수있다.")
    public void testOrderService(){

        // Given
        var fixedAmountVoucher = new FixedAmountVoucher(UUID.randomUUID(),100);
        voucherRepository.insert(fixedAmountVoucher);

        // When
        var order = orderService.createOrder(UUID.randomUUID(), List.of(new OrderItem(UUID.randomUUID(), 200, 1)),
                fixedAmountVoucher.getVoucherId());

        //Then
        assertThat(order.totalAmount(), is(100L));
        assertThat(order.getVoucher().isEmpty(), is(false));
        assertThat(order.getVoucher().get().getVoucherId(), is(fixedAmountVoucher.getVoucherId()));
        assertThat(order.getOrderStatus(), is(OrderStatus.ACCEPTED));

    }
}

 

 

 

 

출처 - 해리 : SpringBoot Part1