카테켐 | [STEP2 clone coding] 3주차 과제

3주차

카카오 테크 캠퍼스 2단계 - BE - 3주차 클론 과제

과제명

1. 레포지토리 단위테스트

 

과제 설명

1. 레포지토리 단위테스트를 구현하여 소스코드를 제출하시오.
2. 쿼리를 테스트하면서 가장 좋은 쿼리를 작성해보시오.

 

과제 상세 : 수강생들이 과제를 진행할 때, 유념해야할 것

아래 항목은 반드시 포함하여 과제 수행해주세요!

 

레포지토리 단위테스트가 구현되었는가?
테스트 메서드끼리 유기적으로 연결되지 않았는가? (테스트는 격리성이 필요하다)
Persistene Context를 clear하여서 테스트가 구현되었는가? (더미데이터를 JPA를 이용해서 insert 할 예정인데, 레포지토리 테스트시에 영속화된 데이터 때문에 쿼리를 제대로 보지 못할 수 있기 때문에)
테스트 코드의 쿼리 관련된 메서드가 너무 많은 select를 유발하지 않는지? (적절한 한방쿼리, 효율적인 in query, N+1 문제 등이 해결된 쿼리)
BDD 패턴으로 구현되었는가? given, when, then

 

---

1. 레포지토리 단위테스트

---

01) 레포지토리 단위테스트를 구현하여 소스코드를 업로드하시오.

 

---

📝 사전 개념

 

ⅰ. 테스트 방법론

 

TDD(테스트 주도 개발)의 개발 접근 방식
- Outside In
- Inside Out

 

1. Outside In

 

• 테스트 주도 개발의 일반적인 접근 방식
• 외부 동작이나 시스템의 사용자 인터페이스(UI)부터 시작하여 내부 구현으로 진행
• 사용자의 요구사항이나 기능을 먼저 정의하고 테스트 케이스를 작성
• 테스트 케이스 작성 후에는 해당 테스트를 통과할 수 있는 코드를 작성
• 외부에서 내부로 진행하면서 필요한 객체 또는 모듈들을 스텁 또는 목(mock)으로 대체하여 테스트를 진행
• 외부와 내부 간의 협력이 중요한 경우에 유용한 방식

 

2. Inside Out

 

• 내부 구현부터 시작하여 외부 동작이나 UI로 진행
• 시스템의 내부에서 시작하여 외부로 향해가는 방식
• 시스템의 내부 로직이나 구현부터 시작하여 테스트 케이스를 작성
• 내부 구현에 초점을 맞추고 해당 구현을 테스트하기 위해 필요한 테스트 케이스를 작성
• 내부 구현을 완료하고 테스트를 통과한 후에는 외부 동작이나 UI를 개발하는 단계로 진행
• 내부 로직의 정확성에 더 중점을 둠

 

Outside In과 Inside Out은 개발자가 시스템을 개발하고 테스트하는 방식에 대한 관점에서 차이가 있다. 각 방식은 상황과 요구사항에 따라 적합한 경우가 있으며, 프로젝트의 특성에 따라 선택할 수 있다.

 

---

ⅱ. 연관관계

 

Hibernate는 객체-관계 매핑(Object-Relational Mapping, ORM)을 지원하여, 객체 지향 프로그래 밍에서 사용되는 객체와 관계형 데이터베이스의 테이블 간의 연관관계를 매핑할 수 있다. Hibernate에서는 다음과 같은 연관관계를 지원한다.

 

1. 일대일(One-to-One) : 연관관계 두 개의 엔티티 간에 하나의 관계만 존재하는 경우

2. 일대다(One-to-Many) : 연관관계 하나의 엔티티가 다른 엔티티 여러 개와 연관된 경우

3. 다대일(Many-to-One) : 연관관계 여러 개의 엔티티가 하나의 엔티티와 연관된 경우

4. 다대다(Many-to-Many) : 연관관계 여러 개의 엔티티가 다른 여러 개의 엔티티와 연관된 경우

 

연관관계를 매핑할 때는 @ManyToOne, @OneToMany, @OneToOne, @ManyToMany 등의 어노테이션을 사용하여 매핑한다. 연관관계의 주인은 mappedBy 속성으로 설정할 수 있다. Hibernate에서는 연관관계의 설정을 통해 객체 간의 관계를 매핑하고, 이를 바탕으로 SQL 쿼리를 생성하여 데이터베이스와 상호작용한다. User, Board, Reply 테이블을 설계하면 아래와 같은 연관관계가 설정된다.

 

FK는 N쪽에 붙이면 되며, N 쪽이 항상 연관관계의 주인이다.

 

User(1) - Board(N)
User(1) - Reply(N)
Board(1) - Reply(N)

 

---

ⅲ. DataJpaTest

 

1. 임베디드 데이터베이스: @DataJpaTest 를 사용하면 테스트를 위한 임베디드 데이터베이스를 메모리에 올린다. 기본적으로 H2 데이터베이스가 사용되며, 각각의 테스트마다 독립적인 데이터베이스가 생성된다.

 

2. JPA 설정: @DataJpaTest 는 JPA와 관련된 설정을 자동으로 구성한다. 이를 통해 JPA 엔티티와 리포지토리를 사용하는 테스트를 실행할 수 있다.

 

3. 스프링 데이터 JPA 리포지토리 스캔: @DataJpaTest는 스프링 데이터 JPA 리포지토리를 스캔하여 테스트할 수 있는 환경을 제공한다. 따라서 JPA 엔티티와 리포지토리를 사용하는 코드를 테스트할 수 있다.

 

4. 트랜잭션 관리: @DataJpaTest 는 각각의 테스트 메소드를 실행할 때 트랜잭션을 자동으로 시작하고, 테스트가 완료되면 롤백한다. 이를 통해 테스트 간의 데이터 상태를 격리시켜 각각의 테스트가 독립적으로 실행될 수 있다.

 

5. 기타 지원 기능: @DataJpaTest 는 JPA 관련 기능을 위해 추가적인 기능들을 제공한다. 예를 들어, TestEntityManager 를 사용하여 엔티티를 테스트용 데이터베이스에 쉽게 저장하고 조회할 수 있한다.

 

---

ⅳ. BDD 패턴

 

Given-When-Then

• 테스트 케이스를 구성하는 패턴으로, 테스트의 상황, 동작, 결과를 명확하게 정의하고 표현하는 방법
• 테스트의 가독성과 이해도를 높이며, 테스트 케이스를 구성할 때 도움

 

1. Given (주어진 상황): 테스트를 수행하기 위해 필요한 초기 상태를 설정한다. 테스트에 필요한 객체, 데이터 또는 환경을 준비한다.

 

2. When (동작): 실제로 테스트하려는 동작이 발생한다. 특정 메서드를 호출하거나 어떤 이벤트가 발생하는 등의 동작을 실행한다.

 

3. Then (결과): 기대하는 결과를 명시한다. 예상되는 동작의 출력, 상태 변화 또는 예외 발생 등을 확인한다. 테스트 결과를 검증하는 단언문(assertion)을 사용하여 실제 결과와 기대하는 결과를 비교한다.

 

---

 

JPA Repository를 잘 몰라서 이번 과제 진짜 많이 막막했다....

그래서 JPA Repository부터 공부함

 

1. CartJPARepositoryTest

 

@Import(ObjectMapper.class)
@DataJpaTest
public class CartJPARepositoryTest extends DummyEntity {

    @Autowired
    private EntityManager em;

    @Autowired
    private ProductJPARepository productJPARepository;

    @Autowired
    private OptionJPARepository optionJPARepository;

    @Autowired
    private CartJPARepository cartJPARepository;

    @Autowired
    private UserJPARepository userJPARepository;

    @Autowired
    private ObjectMapper om;

    @BeforeEach
    public void setUp(){

        // 더미데이터 불러오기

        // user 저장
        User user = userJPARepository.save(newUser("jihye"));

        // product, option Dummy 데이터를 리스트로 불러옴
        List<Product> productListPS = productJPARepository.saveAll(productDummyList());
        List<Option> optionListPS = optionJPARepository.saveAll(optionDummyList(productListPS));

        // newCart(User user, Option option, Integer quantity)
        cartJPARepository.save(newCart(user, optionListPS.get(0),1));
        cartJPARepository.save(newCart(user, optionListPS.get(1),1));

        em.clear();
    }
}

 

@Autowired : 스프링 DI(Dependency Injection)에서 사용되는 어노테이션

 

스프링에서 빈 인스턴스가 생성된 이후 @Autowired를 설정한 메서드가 자동으로 호출되고, 인스턴스가 자동으로 주입된다. 즉, 해당 변수 및 메서드에 스프링이 관리하는 Bean을 자동으로 매핑해주는 개념이다. @Autowired 는 변수, Setter메서드, 생성자, 일반 메서드에 적용이 가능하다.

 

EntityManager는 JPA Repository에서 제공하는 것으로, 엔티티를 관리하는 역할을 수행한다.

 

먼저, setUp() 메서드를 통해 더미데이터를 불러온다. 상품 리스트와 옵션 리스트를 만들어 더미데이터를 저장하고 cartJPARepository에 save() 메서드를 통해 user와 옵션, 수량을 저장한다.

 

Cart Find Test

@DisplayName("장바구니 조회 테스트")
@Test
public void cart_findAll_test() {

    //given
    int id = 1;

    //when
    List<Cart> cartListPS = cartJPARepository.findByUserId(id);

    //then
    Assertions.assertThat(cartListPS.get(0).getQuantity()).isEqualTo(1);
    Assertions.assertThat(cartListPS.get(0).getPrice()).isEqualTo(10000);
    Assertions.assertThat(cartListPS.get(0).getOption().getOptionName()).isEqualTo("01. 슬라이딩 지퍼백 크리스마스에디션 4종");
    Assertions.assertThat(cartListPS.get(0).getUser().getUsername()).isEqualTo("jihye");

}

 

cart_findAll_test는 장바구니를 조회하는 테스트이다. 

id를 1로 주고 cartList 내에서 해당 아이디를 갖는 cart를 찾는다.

 

그런 뒤에 수량과 가격, 옵션, 유저 이름 등을 확인한다.

 

Cart Save Test

@DisplayName("장바구니 담기 테스트")
@Test
public void cart_save_test() {

    //given
    User user = userJPARepository.findById(1).get();
    Option option = optionJPARepository.findById(5).get();
    newCart(user, option, 1);

    //when
    Cart cart = cartJPARepository.save(newCart(user, option, 1));
    System.out.println("id : " + cart.getId());

    //then

}

 

다음으로 장바구니 담기를 테스트 한다. newCart() 메서드로 장바구니에 넣는다.

 

Cart Update Test

@DisplayName("장바구니 업데이트 테스트")
@Test
public void cart_update_test(){

    //given
    int id = 1;
    int quantity = 3;
    int price;
    Cart selectCart = cartJPARepository.findById(id).get();

    //when
    price = selectCart.getOption().getPrice() * quantity;
    selectCart.update(quantity, price);
    em.flush();

    //then

}

 

selectCart를 통해 선택한 장바구니를 업데이트 한다.

 

업데이트 후의 price는 장바구니 내의 옵션의 가격과 수량을 곱하여 계산 한다.

 

Cart Delete Test

@DisplayName("장바구니 삭제 테스트")
@Test
public void cart_deleteByUserId_test(){

    //given
    int id = 1;

    //when
    cartJPARepository.deleteByUserId(id);
    List<Cart> cartListPS = cartJPARepository.findByUserId(id);

    //given
    Assertions.assertThat(cartListPS.size()).isEqualTo(0);
}

 

2. OrderJPARepositoryTest

 

@Import(ObjectMapper.class)
@DataJpaTest
public class OrderJPARepositoryTest extends DummyEntity {
    

    @Autowired
    private EntityManager em;

    @Autowired
    private OrderJPARepository orderJPARepository;

    @Autowired
    private ItemJPARepository itemJPARepository;

    @Autowired
    private UserJPARepository userJPARepository;

    @Autowired
    private ProductJPARepository productJPARepository;

    @Autowired
    private OptionJPARepository optionJPARepository;

    @Autowired
    private CartJPARepository cartJPARepository;

    @BeforeEach
    public void setUp(){

        User userPS = userJPARepository.save(newUser("jihye"));

        List<Product> productListPS = productJPARepository.saveAll(productDummyList());
        List<Option> optionListPS = optionJPARepository.saveAll(optionDummyList(productListPS));
        Order orderPS = orderJPARepository.save(newOrder(userPS));

        Cart cartPS1 = newCart(userPS, optionListPS.get(0), 1);
        Cart cartPS2 = newCart(userPS, optionListPS.get(1), 1);

        itemJPARepository.save(newItem(cartPS1, orderPS));
        itemJPARepository.save(newItem(cartPS2, orderPS));

        em.clear();
    }

    @DisplayName("주문 테스트")
    @Test
    public void item_findByOrderId_test(){

        //given
        int id = 1;

        //when
        List<Item> itemListPS = itemJPARepository.findByOrderId(id);

        //then
        Assertions.assertThat(itemListPS.get(0).getId()).isEqualTo(1);
        Assertions.assertThat(itemListPS.get(0).getPrice()).isEqualTo(10000);
        Assertions.assertThat(itemListPS.get(0).getQuantity()).isEqualTo(1);
        Assertions.assertThat(itemListPS.get(0).getOrder().getId()).isEqualTo(1);

    }
}

 

itemJPARepository 에 새로운 주문 아이템들을 넣어두고 주문 내역이 데이터와 맞는지 비교한다.