⭐️ troubleshooting

0️⃣ 기존의 패키지 구조

설명에 앞서 트러블슈팅이 발생했던 기존 패키지 구조를 첨부합니다!

...
└──  src
     └── main/java/racingcar
         ├── Controller
         |	 └── RacingcargameController.java        
         |
         ├── Domain
         |	 ├── Car.java
         |   ├── Cars.java
         |   ├── Game.java
         |   └── Race.java
         |
         ├── Exception
         |   ├── CarNameException.java
         |   └── TryCountNumberException.java
         |
         ├── Service
         |   └── GameFlowManagementService.java
         |
         ├── Util
         |   └── ComputerNumberGenerator.java
         |
         ├── View
         |   ├── InputView.java
         |   └── OutputView.java
         |
         └── Application.java

---

1️⃣ 코드 실행 로직 오류 발생

플레이어가 자동차 이름과 시도 횟수를 입력하면
각 차수별로 "실행결과"와 "최종 우승자 : "가 출력되는 현상

조건에 주어진 원래의 입출력 예시는 다음과 같습니다.
플레이어가 자동차 이름과 시도 횟수를 입력하면 그에 맞게 경주를 모두 실행한 후, 누적된 우승에 따른 최종 우승자가 나와야하는 방식이죠🏆

경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)
pobi,woni,jun
시도할 회수는 몇회인가요?
5

실행 결과
pobi : -
woni : 
jun : -

pobi : --
woni : -
jun : --

pobi : ---
woni : --
jun : ---

pobi : ----
woni : ---
jun : ----

pobi : -----
woni : ----
jun : -----

최종 우승자 : pobi, jun

하지만, 제가 구현한 코드의 현재의 입출력은 각 차수별로 실행결과와 최종 우승자가 각각 출력되는 형태로 진행됩니다😭

경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)
pobi,woni,jun
시도할 회수는 몇회인가요?
5

실행 결과
pobi : ---
woni : ---
jun : ---

최종 우승자: pobi, woni, jun
실행 결과
pobi : ----
woni : --
jun : ---

최종 우승자: pobi
실행 결과
pobi : ---
woni : --
jun : --

최종 우승자: pobi
실행 결과
pobi : --
woni : ----
jun : ----

최종 우승자: woni, jun
실행 결과
pobi : ----
woni : --
jun : -

최종 우승자: pobi

따라서, 원인을 찾기 위해 Car.java 파일의 tryCount를 중심으로 확인했습니다.

Domain/Car.java

    public void playGame(int tryCount) {
        for (int i = 0; i < tryCount; i++) {
            playOneRound();
            List<Car> roundWinners = getWinners();
            roundWinners.addAll(roundWinners);
        }
        roundWinners.addAll(getWinners());
    }

• 해당 부분은 시도 횟수를 입력받은 만큼, 경주를 반복하는 로직입니다.
  addAll을 사용해 게임의 우승자를 누적하고 최종 우승자가 나올 수 있도록 구성했기 때문에 로직 자체는 맞다고 판단했습니다.
  
  

두번째로, Race.java 파일을 확인했습니다.
Domain/Race.java

    public static void start(List<String> carNames, int tryCount) {
        List<Car> cars = createCars(carNames);
        Game game = new Game(cars);
        game.playGame(tryCount);

        List<Car> winners = game.getWinners();
        OutputView.printHead();
        OutputView.printRaceResult(cars);
        OutputView.printWinners(winners);
    }

• 이 부분은 차의 이름 그리고 시도 횟수를 가져와 경주를 진행한 만큼 누적된 우승자를 가져오고, 그에 따라 printHead인 "실행결과"를 출력하고, 실제로 실행된 결과를 보여주며 최종 우승자까지 보여주는 로직입니다.
  이 역시 로직에서의 큰 문제점은 발견하지 못했습니다.
  (제가 파악하지 못한 어딘가에서 생긴 문제인 것 같습니다...💦)

---

2️⃣ 예외 처리가 안된다...?

IllegalArgumentException이 발생되어야 하지만
-> CarNameException의 경우 예외 처리가 아예 발생되지 않는다.
->TryCountException의 경우 NumberFormatException이 발생한다.

한가지만 문제가 생기면 얼마나 좋을까요??
하지만 그럴 수 없죠😩

우선 먼저 CarNameException.java를 가져와볼게요.
Exception/CarNameException.java

package racingcar.Exception;

public class CarNameException extends IllegalArgumentException {
    public CarNameException() {
        super("자동차 이름은 1자 이상, 5자 이하만 가능합니다.");
    }

    public static void validateCarName(String name) {
        if (name == null || name.length() < 1 || name.length() > 5) {
            throw new CarNameException();
        }
    }
}

validateCarName을 통해 이름의 길이가 공백이거나, 1 이하, 5 이상일 때 IllegalArgumentException이 발생되도록 로직을 구성했습니다. 하지만 아예 예외로 처리되지 않았어요😅

따라서 3가지를 한번에 처리하지 않도록 이렇게 수정해봤지만, 여전히 작동하지 않았습니다.

public class CarValidator {
    public static void validateCarName(String name) {
        if (name == null) {
            throw new CarNameNullException();
        }
        if (name.length() < 1 || name.length() > 5) {
            throw new CarNameLengthException();
        }
    }
}

---

3️⃣ 테스트 통과가 되지 않아...😭

기본적으로 주어진 테스트는 2가지인데,
-> 전진_정지()에서 test failed가 발생!
-> 신기하게도 그 다음의 예외 처리는 정상적으로 테스트가 통과한다? 분명 예외로 처리가 안되고 경주가 진행되었는데 말이지🧐

기본 제공된 테스트는 전진 정지() 와 이름에 대한 예외 처리() 의 총 2가지로 이루어져 있습니다.
test/java/racingcar/ApplicationTest.java

@Test
    void 전진_정지() {
        assertRandomNumberInRangeTest(
            () -> {
                run("pobi,woni", "1");
                assertThat(output()).contains("pobi : -", "woni : ", "최종 우승자 : pobi");
            },
            MOVING_FORWARD, STOP
        );
    }

@Test
    void 이름에_대한_예외_처리() {
        assertSimpleTest(() ->
                assertThatThrownBy(() -> runException("pobi,javaji", "1"))
                        .isInstanceOf(IllegalArgumentException.class)
        );
    }

• 경주를 위해 자동차가 잘 전진하는지와 자동차의 이름 예외를 잘 처리하는지 여부를 테스트하는 것이며, 아무래도 "전진_정지()"는 위의 입출력 오류로 인해 이 부분의 테스트가 실패하는 것으로 보입니다.

📣 해결불가 선언

코드 재구성 결정!! 땅땅👩🏻‍⚖️

결국, 코드를 처음부터 다시 짜는 것으로 해결점을 찾았습니다!
뭐 항상 다들 그렇지 않나요...?? 하하하하🤦🏻‍♀️

패키지 구조는 어느정도 유지하되, 아무래도 차의 이름의 예외도 잘 잡지 못하고 전진 정지도 잘 잡지 못하니 Repository 개념을 이용해 패키지에 추가하는 것으로 결정했습니다.

---

Repository? 그거 DB있을때만 쓰는거 아냐?

• Spring을 자주 사용하신 분들에게 조금 더 익숙한 패키지 이름일 수도 있어요!
  저 역시도 매우 익숙합니다😀
  대부분 DB에 접근하기 위한 코드를 이곳에 작성하죠?

• 하지만, 제가 사용하려는 Repository 패키지 사용 목적은 비슷하면서도 조금은 다릅니다.
  실제로 DB에 저장하지는 않지만, 리스트 형태로 값을 저장하기 때문에 DB와 비슷한 역할을 한다고 생각했습니다.

  1. 게임을 시작하면 자동차의 이름을 받아서 저장하고 있어야 하고
  2. 시도 횟수도 저장하고 있어야 하니까요.

• 이렇게 된다면

  1. 사용자가 입력 시에 같은 이름의 자동차를 등록하려 하는 것을 막을 수 있고
  2. 이름의 제한 글자 수도 정확하게 감지할 수 있으며
  3. 시도 횟수를 통해 게임의 종료와 최종 우승자를 뽑아낼 수 있다고 생각합니다.

• 마지막으로, 자동차의 이름 정보를 문자열 자체로 기억하는 것도 좋지만 개인적으로는 고유의 ID값이 있다면 처리가 조금 더 용이하지 않을까?하는 고민도 있어서 결정했답니다😎

  번외로 디렉터리 구조가 궁금하신 분들은 📍Spring Guide - Directory
  패키지 구조 가이드 를 참고하시면 기본적인 형태를 알아보실 수 있어요!

---

또한, Controller와 Servic 역시 이전의 1주차 온보딩 미션이었던 숫자 야구 게임의 사용성과 동일하게 유지하는 것으로 결정했습니다.

사실 Countroller가 코드의 모든 관리를 하고 집합 저장소가 되는 것이 의존도가 과하게 높아지는 것 같아 컨트롤러의 책임을 분산하려는 목적으로, Service 역시 View와의 의존도가 높아 분산하는 것을 목적으로 역할을 다르게 설정했었습니다.

Domain도 파일 자체를 역할에 따라서 4가지로 분산했으나 오히려 오류가 번지는 원인이 되는 것으로 생각하게 되어 이전의 방식을 유지하는 것이 어떨까 고민했습니다.

그러나 너무 많은 시간을 보내고 있다는 생각이 들어 이번 미션에서도 이전의 1주차 미션에서와 같은 목적을 가진 패키지로 구성하기로 결정했습니다🤯

변경된 패키지 구조

...
└──  src
     └── main/java/racingcar
         ├── Controller
         |	 └── RacingcargameController.java        
         |
         ├── Domain
         |	 ├── Car.java
         |   └── Game.java
         |
         ├── Repository
         |	 ├── CarRepository.java
         |   └── GameRepository.java
         |
         ├── Exception
         |   ├── CarNameException.java
         |   └── TryCountNumberException.java
         |
         ├── Service
         |   └── GameFlowManagementService.java
         |
         ├── Util
         |   ├── ComputerNumberGenerator.java
         |   └── StringToList.java
         |
         ├── View
         |   ├── InputView.java
         |   └── OutputView.java
         |
         └── Application.java

---

⭐️Test를 통해 예외 적용 제대로 하기!

CarNameException 테스트

기존의 CarNameException 일부

Exception/CarNameException.java

...
public class CarNameException {
    private final StringToList stringToList = new StringToList();
    private static final int MINIMUM_CARNAME_LENGTH = 1;
    private static final int MAXIMUM_CARNAME_LENGTH = 5;
    private static final String BLANK = "";


    public void validateCarNameInput(String carNameInput) throws IllegalArgumentException {
        List<String> carNameList = stringToList.analysisCarNames(carNameInput);
        checkCarNameIsOutOfRangeAndBlank(carNameList);
        checkCarNameIsDuplication(carNameList);
        
        checkInputIsEmpty(carNameInput);
        checkLastInputIsComma(carNameInput);
    }
...

여기에서, validateCarNameInput의 순서는 다음과 같습니다.

• 리스트 생성
• 범위 초과 및 공백
• 중복

또한, 공백과 쉼표 역시 메서드를 분리해 함께 넣어주었습니다.

이 코드를 통해 Application을 구동하면, 정상적으로 예외를 출력할 것이라 생각하고 문제점을 파악하지 못하고 있는 상태였습니다.

하지만 다음의 테스트를 할 때 문제가 발생했음을 알 수 있었습니다.

테스트 파일 전문을 첨부할게요!
Test/java/racingcar/Exception/CarNameExceptionTest.java

package racingcar.Exception;

import org.junit.jupiter.api.Test;
import racingcar.Exception.CarNameException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class CarNameExceptionTest {

    @Test
    void testValidateCarNameInput_ValidInput_올바른_입력() {
        // given
        CarNameException carNameException = new CarNameException();
        String carNameInput = "a,b,c";

        // when, then
        assertDoesNotThrow(() -> carNameException.validateCarNameInput(carNameInput));
    }
    @Test
    void testValidateCarNameInput_NoInput_입력값_없음() {
        // given
        CarNameException carNameException = aCarNameException();
        String carNameInput = "";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("값을 입력해주세요.");
    }

    @Test
    void testValidateCarNameInput_LastInputComma_입력값_끝_쉼표() {
        // given
        CarNameException carNameException = aCarNameException();
        String carNameInput = "a,b,c,";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("자동차 이름은 1글자 이상이어야 합니다.");
    }

    @Test
    void testValidateCarNameInput_InvalidLength_길이_미만() {
        // given
        CarNameException carNameException = aCarNameException();
        String carNameInput = ",b,c";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("자동차 이름은 1글자 이상이어야 합니다.");
    }

    @Test
    void testValidateCarNameInput_InvalidLength_길이_초과() {
        // given
        CarNameException carNameException = new CarNameException();
        String carNameInput = "a,bcdefgh,b";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("자동차 이름은 5글자 이하여야 합니다.");
    }

    @Test
    void testValidateCarNameInput_CarNameWithSpace_공백이_포함된_이름() {
        // given
        CarNameException carNameException = new CarNameException();
        String carNameInput = "a a,b,c";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("자동차 이름안에는 공백이 있어서는 안됩니다.");
    }


    @Test
    void testValidateCarNameInput_DuplicateCarName_중복된_이름() {
        // given
        CarNameException carNameException = new CarNameException();
        String carNameInput = "a,a,b";

        // when, then
        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
                () -> carNameException.validateCarNameInput(carNameInput));
        assertThat(exception.getMessage()).isEqualTo("같은 이름을 가진 자동차가 있습니다.");
    }


    private CarNameException aCarNameException() {
        return new CarNameException();
    }
}

요렇게 오류가 발생했음을 알 수 있습니다.
그런데 여기에서 이상한 점을 발견했어요.
ApplicationTest의 전진_정지() 에서 오류가 발생한겁니다!

오류를 다시 보자🧐

단순히 테스트 코드에서의 문제가 생겼다고 생각했지만 알고보니 CarNameException 코드 자체의 문제가 있다는 것을 알게 되었어요:)

다시 한번 보겠습니다!
Exception/CarNameException.java

...
public class CarNameException {
    private final StringToList stringToList = new StringToList();
    private static final int MINIMUM_CARNAME_LENGTH = 1;
    private static final int MAXIMUM_CARNAME_LENGTH = 5;
    private static final String BLANK = " ";
...

• String BLANK에서 공백을 잡으려면 ""가 아닌 -> " "가 되어야 겠죠?
  "과 "의 사이에 space 공백이 필요한데, 이 부분을 적용하지 않아 Application을 실행했을 때 맞는 이름을 넣었음에도 fail 되었었습니다!
  
  
  
  

public void validateCarNameInput(String carNameInput) throws IllegalArgumentException {
        checkInputIsEmpty(carNameInput);
        checkLastInputIsComma(carNameInput);
        List<String> carNameList = stringToList.analysisCarNames(carNameInput);
        checkCarNameIsOutOfRangeAndBlank(carNameList);
        checkCarNameIsDuplication(carNameList);
    }

• 이 곳의 순서에 주목해주세요!
  잘 보면, 공백과 콤마 처리를 먼저 하는 것으로 변경되었죠?

java는 코드의 윗부분부터 차례대로 처리해 나가는 특성이 있기 때문에, 우선적으로 작성된 코드가 우선권을 가진다고 생각하면 좋아요!

그럼, 다시 테스트를 진행해보겠습니다.

-> 성공입니다😆