사내 세미나 - 테스트 코드에 대해 알아보자

들어가기 앞서

테스트 코드란 무엇인가?

테스트 코드의 정의

• x=2, y=3인 상황에서 add(x, y)라는 함수가 실행되었을 때, 5라는 결과가 반환된다.

• 장바구니가 빈 고객이 상품 주문을 실행했을 때, 예외가 발생한다.

코드로 확인해보자

@Test
@DisplayName("두 숫자를 더한다")
void add() {
    // given
    int x = 6;
    int y = 3;
    Calculator calc = new Calculator();

    // when
    int result = calc.add(x, y);

    // then
    assertEquals(9, result);
}

왜 해야 하는가?

🤔: 테스트는 그냥 직접 실행해보면서 하면 되는거 아니야?

테스트를 짜야 하는 이유

1. 거대한 프로젝트에서 개발자가 직접 어플리케이션을 켜서 조작해가면서 기능을 테스트하는 건 너무 귀찮다.

2. 새로운 기능을 추가했는데 원래 있던 기능이 갑자기 돌아가지 않는 사례를 겪어본 적 있을 것이다. 이런 경우 나는 분명 테스트를 했음에도 오류가 발생하는 것을 놓치고 넘어갈 수 있다.

3. 내가 코드를 커밋할 때, 내 코드가 정상적으로 동작하는 것을 확인을 했다는 일종의 보증서 역할을 하여 팀원에게 신뢰감을 줄 수 있다.

4. 코드를 만약 수정해야 할 때 (리팩토링, 라이브러리 교체 등) 다시 직접 해당 코드가 쓰이는 모든 것을 테스트해보지 않아도 변경으로 인한 영향을 쉽게 알 수 있다.

어떻게 해야 하는가?

JUnit5 사용법

class CalculatorTest {
    @Test
    void add() {
        // 주어진 상황에서 (given)
        int a = 1;
        int b = 2;
        Calculator calculator = new Calculator();

        // 어떤 코드가 실행되었을 때 (when)
        int result = calculator.add(a, b);

        // 어떤 결과가 나온다 (then)
        Assertions.assertEquals(3, result);
    }
}

Spring Boot와 JUnit 사용법

@SpringBootTest
class MemberControllerTest {
    @Autowired
    MemberController controller;

    @Test
    void getValue() {
        // when
        String result = controller.getValue();

        // then
        Assertions.assertEquals("setting-for-test", result);
    }
}

@RestController
public class MemberController {
    @Autowired
    ApplicationPropertyChecker checker;

    @GetMapping("/test")
    public String getValue() {
        return checker.getTestValue();
    }
}

@Component
public class ApplicationPropertyChecker {
    @Value("${test.value}")
    private String testValue;

    public String getTestValue() {
        return this.testValue;
    }
}

무엇을 해야 하는가?

계층형 아키텍처 (Layered Architecture)

• Controller에서는 데이터의 유효성을 제대로 검증하는지, Service 계층에서 일어난 결과로 HTTP Status Code를 제대로 리턴 하는지 체크한다.

• Service, Domain에서는 비즈니스 로직이 정상적으로 작동하는지 체크한다.

• Repository / Mapper에서는 내가 작성한 쿼리가 정상적으로 작동하는지, JPA라면 연관관계가 정상적으로 작동하는지 등을 체크한다.

인수 테스트

1. 사용자가 서로 다른 6개의 번호를 고르고 로또를 구매하면 구매에 성공한다.

2. 사용자가 6개 미만의 번호를 고르고 구매를 하면 구매에 실패한다.

3. 사용자는 같은 번호를 여러번 고를 수 없다 등등..

테스트하기 쉬운 코드

테스트를 하려니 api가 진짜로 쏴져요 😱

@Service
public class MemberJoinService {
    @Autowired
    private MemberDao memberDao;

    @Transactional
    public void join(JoinRequest joinRequest) {
        checkDuplicateMemberByEmail(joinRequest.getEmail());

        Member newMember = new Member(
            joinRequest.getEmail(),
            joinRequest.getPassword(),
            joinRequest.getName(),
            LocalDateTime.now()
        );

        memberDao.insert(newMember);

        // 회원 가입 축하 이메일 발송
        WebClient.create("<https://email-service.com>")
                .post()
                .uri("/send")
                .body(BodyInserters.fromValue(newMember.getEmail()))
                .retrieve()
                .subscribe();
    }

    private void checkDuplicateMemberByEmail(String email) {
        if (memberDao.selectByEmail(email) != null) {
            throw new DuplicateMemberException("중복 이메일입니다");
        }
    }
}

@SpringBootTest
public class MemberJoinServiceTest {
    @Autowired
    MemberJoinService memberJoinService;

    @Autowired
    MemberDao memberDao;

    @Test
    public void joinTest() {
        // given
        JoinRequest joinRequest = new JoinRequest(
            "myc1365@entropykorea.com",
            "1234",
            "문영채"
        );

        // when
        memberJoinService.join(joinRequest);

        // then
        Member member = memberDao.selectByEmail(joinRequest.getEmail());
        assertNotNull(member);
    }
}

테스트하기 쉬운 코드가 좋은 코드다

@Service
public class MemberJoinService {
    private final MemberDao memberDao;
    private final EmailService emailService;

    public MemberJoinService(MemberDao memberDao, EmailService emailService) {
        this.memberDao = memberDao;
        this.emailService = emailService;
    }

    @Transactional
    public void join(JoinRequest joinRequest) {
        checkDuplicateMemberByEmail(joinRequest.getEmail());

        Member newMember = new Member(
            joinRequest.getEmail(),
            joinRequest.getPassword(),
            joinRequest.getName(),
            LocalDateTime.now()
        );

        memberDao.insert(newMember);

        // 회원 가입 축하 이메일 발송
        emailService.send(newMember.getEmail(), "회원 가입 축하 메일", "회원 가입을 축하합니다");
    }

    private void checkDuplicateMemberByEmail(String email) {
        if (memberDao.selectByEmail(email) != null) {
            throw new DuplicateMemberException("중복 이메일입니다");
        }
    }
}

interface EmailService {
    void send(String email, String title, String content);
}

public class MemberJoinServiceTest {
    @Test
    public void joinTest() {
        // make Fake Services
        EmailService emailService = new FakeEmailService();
        MemberDao memberDao = new MemoryMemberDao();

        // given
        MemberJoinService memberJoinService = new MemberJoinService(memberDao, emailService);
        JoinRequest joinRequest = new JoinRequest(
            "myc1365@entropykorea.com",
            "1234",
            "문영채"
        );

        // when
        memberJoinService.join(joinRequest);

        // then
        Member member = memberDao.selectByEmail(joinRequest.getEmail());
        assertNotNull(member);
    }
}

변경에 유연한 코드

• 좋은 디자인으로 구현된 코드는 대부분 테스트하기 쉽다.

• 만약 테스트하기 어렵게 코드가 구현되어 있다면, 코드의 확장성과 의존성 등의 설계가 잘못 되었을 확률이 높다.

• 테스트 코드는 우리가 코드의 악취를 맡게 해주는 좋은 수단이다.

이렇게 좋은 테스트 코드, 이래도 안 짜실건가요?

테스트 작성할 시간이 없어요

나중은 절대 오지 않는다.

테스트를 처음 작성할 때에는 귀찮고 개발을 느리게 한다는 느낌을 받을 수 있지만,

마무리