[TDD Chapter2] TDD 시작

Backend Language/TDD

[TDD Chapter2] TDD 시작

chaerlo127 2023. 1. 12. 01:52

소속된 GDSC MJU에서 TDD 스터디를 시작하여, 다음 책을 정리하는 블로그 포스팅을 진행하고자 한다.

테스트 주도 개발 시작하기 - YES24

TDD(Test-Driven Development)는 테스트부터 시작한다. 구현을 먼저 하고 나중에 테스트하는 것이 아니라 먼저 테스트를 하고 그다음에 구현한다. 구현 코드가 없는데 어떻게 테스트할 수 있을까? 여기

www.yes24.com

🍀 TDD Chapter 1: TDD 개발 준비

간단하기 때문에 build.gradle 설정만 작성하고 넘어간다.

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

	// junit 추가
	testImplementation('org.junit.jupiter:junit-jupiter:5.5.0')
}

🍀 TDD Chapter 2: TDD 시작

👀 TDD란?

테스트란?
기능을 올바르게 동작하는지 검증하는 테스트 코드를 작성한다는 것

테스트 코드를 먼저 작성하고 테스트를 통과시키기 위해 개발을 진행

미리 앞서 조건을 충족하여 개발을 하지 않고,
테스트할 만큼만 코드를 작성

지속적인 코드 정리는 향후 유지 보수 비용을 낮추는데 도움이 됨

TDD 흐름

설계 -> 테스트 -> 코딩 -> 리팩토링 -> 테스트

# Red - Green _Refactor
테스트 코드가 실패 : RED
테스트 코드가 성공: GREEN
리팩토링: REFACTOR
코드를 구현해서 실패하는 테스트를 통과시키는 것 의미

아래는 간단한 덧셈 기능을 구현한 테스트 코드이다

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
/**
 * 기능을 완성하면 test package -> main package로 이동
 * 완성되지 않은 코드가 배포되는 것을 막기 위함
  */

public class CalculatorTest {

    @Test
    void plus(){
        int result = Calculator.plus(1, 2);
        assertEquals(3, result); // 실제 값과 동일 한지 비교
        assertEquals(5, Calculator.plus(4, 1));
    }
}



public class Calculator {
    public static int plus(int a1, int a2){
        return a1+a2;
    }

@Test : 기능을 검증하는 테스트 메소드로 인식
assertEquals(): 인자로 받은 두 값이 동일한지 비교

테스트 코드를 작성하고, 테스트가 끝난 클래스의 경우에는 test Package 에서 main package로 이동한다. 테스트 중인 코드는 아직 완전하지 않아 실제 main package에 있을 경우 배포되어 서비스 장애가 발생할 수 있다.

👀 TDD 예: 암호 검사기

현실적인 암호 검사기를 구현해보자.

암호검사기에서는 다음과 같이 3가지의 규칙이 있을 것이다.

1. 길이가 8글자 이상
2. 0부터 9 사이의 숫자를 포함
3. 대문자 포함
[강함] 세가지 규칙을 모두 충족 [보통] 2개의 규칙 충족 [약함] 1개 이하 규칙 충족

1️⃣ 첫 번째 테스트: 모든 규칙을 충족하는 경우

TDD를 하면서 중요한 부분 중 하나이다.

첫 번재 테스트를 잘 선택하지 않으면 이후 진행 과정이 순탄하게 흘러가지 않는다.

첫 번째의 경우 가장 쉽거나 가장 예외적인 상황을 선택해야 한다.

암호 검사기의 경우 모든 규칙을 충족하거나 모든 규칙을 충족하지 않는 것 중에서 선택하면 되는데, 모든 규칙을 충족하지 않는 경우는 많은 예외 처리가 필요하므로 모든 검사 코드를 구현해야한다. 따라서 모든 규칙을 충족하는 경우를 가장 먼저 살펴볼 예정이다.

// 기본적인 테스트 코드 작성
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class PasswordStrengthMeterTest {

  @Test
  void meetsAllCriteria_Then_Strong() {
    PasswordStrengthMeter meter = new PasswordStrengthMeter();
    PasswordStrength result = meter.meter("123ABCDE456");
    assertEquals(PasswordStrength.STRONG, result);
  }

}
// 테스트에 필요한 코드 작성 클래스
public class PasswordStrengthMeter {

    public PasswordStrength meter(String s) {
      return PasswordStrength.STRONG;
    }

}

// enum class
public enum PasswordStrength {
  STRONG;
}

2️⃣ 두 번째 테스트: 길이만 8글자 미만이고 나머지 조건은 충족하는 경우

패스워드 문자열의 길이가 8글자 미만이고 나머지 조건을 충족하는 경우는 암호의 강도가 보통이어야 한다.

public class PasswordStrengthMeter {
    public PasswordStrength meter(String s) {
        if (s.length() < 8) {
            return PasswordStrength.NORMAL;
        }
        return PasswordStrength.STRONG;
    }
}
// 테스트 코드
@Test
  void meetsOtherCriteria_except_for_Length_Then_Normal() {
    PasswordStrengthMeter meter = new PasswordStrengthMeter();
    PasswordStrength result = meter.meter("ab12!@A");
    assertEquals(PasswordStrength.NORMAL, result);
  }
  
  // enum class
public enum PasswordStrength {
  STRONG, NORMAL;
}

3️⃣ 세 번째 테스트: 숫자를 포함하지 않고 나머지 조건을은 충족하는 경우

숫자를 포함하지 않는 경우이며, 나머지 조건은 충족하는 경우에는 보통 강도의 암호를 갖게 된다.

@Test
  void meetsOtherCriteria_except_for_Number_Then_Normal() {
    PasswordStrengthMeter meter = new PasswordStrengthMeter();
    PasswordStrength result = meter.meter("ab!@ABqwer");
    assertEquals(PasswordStrength.NORMAL, result);
  }
  
  public PasswordStrength meter(String s) {
        if (s.length()) {
            return PasswordStrength.NORMAL;
        }
        boolean containsNum - meetsContainingNumberCriteria(s);
       
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
   private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  }

4️⃣ 코드 리팩토링

테스트 코드도 코드기 때문에 유지보수의 대상이다. 테스트 메소드에서 중복이 발생하면 알맞게 제거하거나 의미가 잘 드러나게 코드를 수정해야 한다.

하지만 코드를 무턱대고 수정하면 안된다.
중복을 제거한 후에도 테스트 코드의 가독성이 떨어지지 않고 수정이 용이한 경우에만 중복을 제거해야 한다.
중복을 제거한 뒤에 오히려 테스트 코드 관리가 어려워지면 제거했던 중복을 되돌려야 한다.

-> 과거, 항상 코드는 간결한 것이 좋다고하여 중복된 것을 모두 extract method로 빼두어서 사용했는데, 오히려 독이될 수도 있다는 것을 알게 되었다.

 private PasswordStrengthMeter meter = new PasswordStrengthMeter();

    private void assertStrength(String password, PasswordStrength expStr){
        PasswordStrength result = meter.meter(password);
        assertEquals(expStr, result);
    }
    ///

    // 빈 테스트 메소드를 실행하는 것 또한 나름대로 의미가 있음
    @Test
    void name(){
    }

    @Test // 모든 규칙을 충족하는 경우
    void meetsAllCriteria_Then_Strong(){
        assertStrength("ab12!@AB", PasswordStrength.STRONG);
        assertStrength("abc!Add", PasswordStrength.STRONG);
    }
    /**
     * assertEquals: 두 값이 같은지 비교하는 단언
     * 단언: 값의 특정 조건이 충족하는지 확인하고 충족하지 않는 경우에 익셉션 발생 -> 테스트 실패
     */

    @Test // 길이만 8글자 미만이고 나머지 조건을 충족하는 경우
    void meetsOtherCriteria_except_for_Length_Then_Normal(){
        assertStrength("ab12!@A", PasswordStrength.NORMAL);
    }

    @Test // 숫자를 포함하지 않고 나머지 조건은 충족하는 경우
    void meetOtherCriteria_except_for_number_Then_Normal(){
        assertStrength("ab!@ABqwer", PasswordStrength.NORMAL);
    }

5️⃣ 네 번째 테스트: 값이 없는 경우

// enum class
public enum PasswordStrength {
  STRONG, NORMAL, INVALID;
}

  public PasswordStrength meter(String s) {
  		if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
        if (s.length()) {
            return PasswordStrength.NORMAL;
        }
        boolean containsNum - meetsContainingNumberCriteria(s);
       
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
   private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  }

6️⃣ 다섯 번째 테스트: 대문자를 포함하지 않고 나머지 조건을 충족하는 경우

@Test // 대문자를 포함하지 않고 나머지 조건을 충족하는 경우
    void meetsOtherCriteria_except_for_Uppercase_Then_Normal(){
        assertStrength("ab12!@df", PasswordStrength.NORMAL);
}

  public PasswordStrength meter(String s) {
  		if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
        if (s.length()) {
            return PasswordStrength.NORMAL;
        }
        boolean containsNum - meetsContainingNumberCriteria(s);
        boolean containsUpp = meetsContainingUppercaseCriteria(s);
        if(!containsUpp) return PasswordStrength.NORMAL;
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
      private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  	}
    private boolean meetsContainingUppercaseCriteria(String s){
    	 for(char ch:s.toCharArray()){
           if(Character.isUpperCase(ch)) return true;
      }
      return false;
      }

7️⃣ 여섯 번째 테스트: 길이가 8글자 이상인 조건만 충족하는 경우

// enum class
public enum PasswordStrength {
  STRONG, NORMAL, WEAK, INVALID;
}

@Test // 길이가 8글자 이상인 조건만 충족하는 경우
    void meetsOnlyLengthCriteria_Then_Weak(){
        assertStrength("abcdefghi", PasswordStrength.WEAK);
    }
  public PasswordStrength meter(String s) {
  		if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
       	boolean lengthEnough = s.length() >=8;
        
        /*if (s.length()) {
            return PasswordStrength.NORMAL;
        } */
        boolean containsNum - meetsContainingNumberCriteria(s);
        boolean containsUpp = meetsContainingUppercaseCriteria(s);
        // 모든 조건에 맞지 않는다면 암호 강도가 가장 낮다
        if(!lengthEnough && !containsUpp && !containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough) return PasswordStrength.NORMAL;
        if(!containsUpp) return PasswordStrength.NORMAL;
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
      private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  	}
    private boolean meetsContainingUppercaseCriteria(String s){
    	 for(char ch:s.toCharArray()){
           if(Character.isUpperCase(ch)) return true;
      }
      return false;
      }

if 절을 아래에 두는 이유는

1. 개별 규칙을 검사하는 로직
2. 규칙을 검사한 결과에 따라 암호 강도를 계산하는 로직

으로 구분하기 위함이다.

8️⃣ 일곱 번째 테스트: 숫자 포함 조건만 충족하는 경우

다른 문자는 작성하지 않고 숫자로만 되어 있는 경우를 의미한다.

// enum class
public enum PasswordStrength {
  STRONG, NORMAL, WEAK, INVALID;
}

    @Test // 숫자 포함 조건만 충족하는 경우 , 숫자만 있는 경우
    void meetsOnlyNumCriteria_Then_Week(){
        assertStrength("12345", PasswordStrength.WEAK);
    }

  public PasswordStrength meter(String s) {
  		if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
       	boolean lengthEnough = s.length() >=8;
        
        /*if (s.length()) {
            return PasswordStrength.NORMAL;
        } */
        boolean containsNum - meetsContainingNumberCriteria(s);
        boolean containsUpp = meetsContainingUppercaseCriteria(s);
        // 모든 조건에 맞지 않는다면 암호 강도가 가장 낮다
        if(!lengthEnough && !containsUpp && !containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough && !containsUpp && containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough) return PasswordStrength.NORMAL;
        if(!containsUpp) return PasswordStrength.NORMAL;
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
      private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  	}
    private boolean meetsContainingUppercaseCriteria(String s){
    	 for(char ch:s.toCharArray()){
           if(Character.isUpperCase(ch)) return true;
      }
      return false;
      }

9️⃣ 여덟 번째 테스트: 대문자 포함 조건만 충족하는 경우

// enum class
public enum PasswordStrength {
  STRONG, NORMAL, WEAK, INVALID;
}

 	@Test // 대문자 포함 조건만 충족하는 경우
    void meetsOnlyUpperCriteria_Then_Week(){
        assertStrength("ABZEF", PasswordStrength.WEAK);
    }

  public PasswordStrength meter(String s) {
  		if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
       	boolean lengthEnough = s.length() >=8;
        
        /*if (s.length()) {
            return PasswordStrength.NORMAL;
        } */
        boolean containsNum - meetsContainingNumberCriteria(s);
        boolean containsUpp = meetsContainingUppercaseCriteria(s);
        // 모든 조건에 맞지 않는다면 암호 강도가 가장 낮다
        if(!lengthEnough && !containsUpp && !containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough && !containsUpp && containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough && containsUpp && !containsNum) return PasswordStrength.WEAK;
        if(!lengthEnough) return PasswordStrength.NORMAL;
        if(!containsUpp) return PasswordStrength.NORMAL;
        if(!containsNum) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
   }
   
      private boolean meetsContainingNumberCriteria(String s){
       for(char ch:s.toCharArray()){
           if(ch>'0' && ch<'9'){
               return true;
           }
      }
      return false;
  	}
    private boolean meetsContainingUppercaseCriteria(String s){
    	 for(char ch:s.toCharArray()){
           if(Character.isUpperCase(ch)) return true;
      }
      return false;
      }

🔟 코드 정리 && 아홉 번째 테스트: 아무 조건도 충족하지 않는 경우 && 코드 정리: 코드 가독성 개선

비슷한 코드가 많기 때문에 간결하게 코드를 정리한다.

public class PasswordStrengthMeter {
    public PasswordStrength meter(String s){
        if(s == null || s.isEmpty()) return PasswordStrength.INVALID;
        int metCounts = getMetCriteriaCounts(s); // extract method -> 가독성을 위해

        // 개별 규칙을 검사하는 로직 + 규칙을 검사한 결과에 따라 암호 강도를 계산하는 로직
        if(metCounts <= 1) return PasswordStrength.WEAK;
        if(metCounts == 2) return PasswordStrength.NORMAL;
        return PasswordStrength.STRONG;
    }

    private int getMetCriteriaCounts(String s) {
        int metCounts = 0;
        if(s.length() >= 8) metCounts++;
        if(meetsContainingNumberCriteria(s)) metCounts++;
        if(meetsContainingUppercaseCriteria(s)) metCounts++;
        return metCounts;
    }

    private boolean meetsContainingNumberCriteria(String s) {
        for(char ch:s.toCharArray()){
            if(ch>='0' && ch<='9'){
                return true;
            }
        }
        return false;
    }

    private boolean meetsContainingUppercaseCriteria(String s){
        for(char ch:s.toCharArray()){
            if(Character.isUpperCase(ch)){
                return true;
            }
        }
        return false;
    }


}

1️⃣1️⃣ 테스트에서 메인으로 코드 이동

모두 다 생성한 코드는 테스트 패키지에서 메인 페키지로 이동한다.

저작자표시