「스프링 부트와 AW로 혼자 구현하는 웹 서비스」를 보고 공부한 기록입니다. (우당탕탕)

🙌🏻목표

테스트 코드에 대한 개념
만나는 모든 에러 처리하기

테스트 코드

TDD

TDD란 테스트가 주도하는 개발을 뜻한다. 즉 테스트코드를 먼저 작성하는 것부터 개발을 시작한다.

1. Red : 항상 실패하는 테스트를 먼저 작성
2. Green : 테스트가 통과하는 프로덕션 코드를 작성
3. Refactor : 테스트가 통과하면 프로덕션 코드를 리팩토링함

단위 테스트 (Unit Test)

단위 테스트는 TDD의 첫 번째 단계인 기능 단위의 테스트 코드 작성을 의미한다. TDD와 달리 테스트 코드를 먼저 작성할 필요도, 리팩토링을 할 필요도 없다.

장점

• 자동 검증으로 인한 빠른 피드백이 가능하다.
  • 테스트를 위해 톰캣을 계속 재시작 하거나 System.out.println()을 사용해 값을 찍어보지 않아도 된다.
• 개발자가 만든 기능을 안전하게 보호해준다.
  • 새로운 기능을 추가할 때 기존의 기능이 에러가 날 상황을 대비할 수 있다.
• 개발단계 초기에 문제를 발견하게 도와준다.

프레임워크

테스트 코드 작성을 도와주는 프레임워크에는 xUnit가 있다.

• xUnit : 개발환경(x)에 따라 Unit 테스트를 도와주는 도구
  • Java - JUnit
  • DB - DBUnit
  • C++ - CppUniit
  • .net - NUnit
    
    

🔔 groupId 찾기

groupId는 build.gradle 파일 안에 group로 명시되어있ㄸ ㅏ ^^ na noon babo..

1. Junit4로 테스트코드 작성하기

(1) 패키지 생성

• java - package 생성
  • 보통 패키지명은 웹 사이트 주소의 역순으로 한다.
  • 지금은 groupId를 이용해서 생성
    • com.studying.book.springboot

(2) 메인 클래스 생성 (Application.class)

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

• @SpringBootApplication
  • 스프링 부트의 자동 설정, Bean 읽기/생성 자동 설정
  • 이 어노테이션이 있는 위치로부터 설정을 읽기 때문에 항상 프로젝트의 최상단에 위치해야함
• springApplication.run()
  • 내장 WAS인 톰캣을 실행
  • jar파일(실행 가능한 java 패키징 파일)로 실행

왜 내장 WAS를 사용할까?

• 언제나 같은 환경에서 스프링 부트를 배포할 수 있기 때문이다.

(3) 테스트 Controller 생성

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String Hello() {
        return "hello!!";
    }
}

• @RestController

  • JSON을 반환하는 컨트롤러로 설정함
  • 예전에는 @ResponseBody를 각 메소드마다 설정했는데 이제는 한번에 가능!

• @GetMapping

  • HTTP GET 요청을 받을 수 있는 API를 만들어줌

(4) 테스트 코드 작성

• src/test/java 디렉토리에 main에서 생성했던 패키지를 생성
• HelloControllerTest.java 생성

@RunWith(SpringRunner.class)
@WebMvcTest(controllers = HelloController.class)
public class HelloControllerTest {
    @Autowired
    private MockMvc mvc;

    @Test
    public void hello가_리턴된다() throws Exception {
        String hello = "hello";

        mvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string(hello));
    }
}

• @RunWith(SpringRunner.class)

  • 스프링 부트 테스트와 JUnit 사이의 연결자 역할
  • 테스트 진행할 때 JUnit 내장된 실행자 외 SpringRunner이라는 스프링 실행자 사용

• @WebMvcTest

  • Web(Srping MVC)에만 집중할 수 있는 어노테이션
  • 선언시 @Controller @ControllerAdvice 사용 가능
  • @Servce @Component @Repository는 사용 불가능

• @Autowired

  • Java Bean 자동 주입

• private MockMvc mvc

  • 웹 API 테스트시 사용
  • 스프링 MVC 테스트의 시작점
  • HTTP GET, POST에 대한 API 테스트 가능

• mvc.perform(get("/hello"))

  • MockMvc를 통해 /hello 주소로 HTTP GET 요청을 보냄
  • 체이닝이 지원되어 검증 기능을 이어서 수행 가능

• .andExpect(status().isOk())

  • mvc.perform의 결과 검증
  • HTTP Header의 Status 검증
  • 200이면 OK!

• .andExpect(content().string(hello));

  • mvc.perform의 결과 검증
  • Response 본문의 내용 검증
  • Controller의 리턴 값이 hello이면 OK!

(5) 수동 실행

• Application.java 파일 main 메소드 왼쪽의 화살표 버튼을 클릭해 실행해보기

🔔ERROR!

다들 아시는 그 에러입니다. (8080 포트 번호가 이미 사용중)

IntelliJ Spring Boot(Gradle) 포트 번호 변경하는 법

1. Run - Edit Configurations
2. Environment variables 추가
   • Name : server.port
   • value : 5858(원하는 포트번호)

2. 롬복 (Lombok) 추가하기

롬복 라이브러리는 자바 개발할 때 자주 사용하는 코드인 Getter, Setter, 기본 생성자, toString 등을 어노테이션으로 자동 생성해준다.

롬복 플러그인 설치는 한 번만 해도 되지만

롬복 설정은 프로젝트마다 해줘야한다. (build.gradle 추가)

(1) build.gradle에 라이브러리 추가

compile('org.projectlombok:lombok')

• build.gradle에 등록을 해서 라이브러리를 다운받음

(2) Lombok 플러그인 설치

• ctrl+shift+A - plugins
• lombok 다운
• Enable annotation processing 체크

3. 기존 코드 롬복으로 전환

(1) HelloResponseDto.java

package com.studying.book.springboot.web.dto;

@Getter
@RequiredArgsConstructor
public class HelloResponseDto {
    private final String name;
    private final int amount;
}

• @Getter
  • 선언된 모든 필드의 get 메소드 생성
• @RequiredArgsConstructor
  • 선언된 모든 final 필드가 포함된 생성자를 만들어줌
  • final 없으면 포함 X

(2) HelloResponseDtoTest.java

package com.studying.book.springboot.web.dto;
import org.junit.Test;
import static org.assertj.core.api.Assertions.assertThat;

public class HelloResponseDtoTest {
    @Test
    public void 롬복_기능_테스트() {
        //given
        String name="test";
        int amount = 1000;

        //when
        HelloResponseDto dto = new HelloResponseDto(name, amount);

        //then
        assertThat(dto.getName()).isEqualTo(name);
        assertThat(dto.getAmount()).isEqualTo(amount);
    }
}

• assertThat
  • assertj라는 테스트 검증 라이브러리의 검증 메소드
  • 검증하고 싶은 대사를 인자로 받아 메소드 체이닝 지원되어 isEqualTo같은 메소드 사용 가능
• isEqualTo
  • assertj의 비교 메소드
  • 값이 같을 때만 성공
• 테스트 성공을 통해 Getter와 생성자가 롬복을 통해 생성되었음을 확인할 수 있다.

🔔Cannot resolve symbol 'assertThat' ERROR!

출처 : https://aonee.tistory.com/2

• 원인 : junit4의 경우 org.junit.Assert 클래스에서 허용하는 Hamcrest 허용 메소드를 제공하지 않았기 때문

• 해결 : gradle 의존성 추가

  1. build.gradle

     dependencies {
     	testCompile 'junit:junit:4.12'
     }

2. 새로 추가된 Gradle을 적용하기 위해 Gradle-Reimport All Gradle Project (새로고침 이모티콘)을 클릭!

   • 새로 추가된 gradle import 가능

3. More actions ... - import static method - 3번째의 Assertions.assertThat 클릭!

   • import static org.assertj.core.api.Assertions.assertThat;

4. 완료! 쨖쨖쨖

🔔 테스트 실패 에러! 롬복 에러!

는 이 모든 에러가.. Gradle 버전 때문이었다.💩

error: variable name not initialized in the default constructor private final String name;

자잘한 에러들과 함께 위와 같은 에러들이 자꾸 떠서 구글링한 결과 저자님의 이슈에서 해결방법을 찾았다.

책의 예제들은 Gradle 4 기준으로 쓰여져있는 상태이고! 롬복이 Gradle 5로 되면서 많이 변경되었다고한다!

• 원인 : Gradle 버전 문제
• 해결방법 : Gradle 4로 Downgrade하기

Gradle 버전 다운그레이드

1. alt+F12 으로 터미널 열기
2. ./gradlew wrapper --gradle-version 4.10.2 입력
3. gradle - wrapper - gradle-wrapper.properties에서 버전 확인!
   

추가로 환경 설정 하나하나 하기 귀찮으니...

java-resources 폴더 안에 new - file - application.properties 생성해서

server.port=5858

포트번호를 지정해줬다. ㅡ 끝 ㅡ🤢

(3) HelloController.java

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String Hello() {
        return "hello";
    }

    @GetMapping("/hello/dto")
    public HelloResponseDto helloDto(@RequestParam("name") String name,
                                     @RequestParam("amount") int amount) {
        
        return new HelloResponseDto(name, amount);
    }
}

• @RequestParam
  • 외부에서 API로 넘긴 파라미터를 가져오는 어노테이션
  • 외부에서 name으로 넘긴 파라미터를 String name에 저장

(4) HelloControllerTest.java

@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
    @Autowired
    private MockMvc mvc;

    @Test
    public void hello가_리턴된다() throws Exception {
        String hello = "hello";

        mvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string(hello));
    }

    @Test
    public void helloDto가_리턴된다() throws Exception {
        String name = "hello";
        int amount = 1000;

        mvc.perform(get("/hello/dto")
                .param("name", name)
                .param("amount", String.valueOf(amount)))
                    .andExpect(status().isOk())
                    .andExpect(jsonPath("$.name", is(name)))
                    .andExpect(jsonPath("$.amount", is(amount)));
    }
}

• param
  • API 테스트시 요청 파라미터 설정
  • 값은 String만 허용됨!
    • 숫자/날짜 등은 문자열로 변경해서 사용
      • String.valueOf(amount)
• jsonPath
  • JSON 응답값을 필ㄷ별로 검증할 수 있는 메소드
  • $를 기준으로 필드명을 명시
  • $.name $.amount

🔔 테스트 status() 에서 404 에러가 뜬다?

• 예.. 404 에러가 뜬다면 무.조.건 URI를 한번 더 확인합시다.
• 저 같은 경우에는 get ("/hello/dto")가 아닌 ("hello/dto")로 매핑시켜서 404 에러가 나왔습니다....💩
  
  

🔔 non-ascii characters in an identifier intellij

• 커밋할 때 "Non-ascii " 어쩌구 에러시
• ctrl+shift+a + settings - inspections- non-ascii character - 체크박스 해제