[Gradle] API 문서 build 에러

에러코드

Execution failed for task ':test'.

---

문제

test케이스에대한 문제로 build가 실패한 상황

대표적으로 예상되는 문제는 아래의 세 경우가 있다

1. 테스트 케이스 및 API 문서 작성 중, 오타가 있음

2. 테스트 케이스 실행을 통한 API 스펙 정보 기반의 문서 스니펫 생성을 안한 상태

3. 테스트 경로에 한글이 들어가있는 경우

 

---

해결방법

1. 테스트 케이스 및 API 문서 작성 중, 오타가 있음

: 오타가 있는지 없는지 확인부터 해야한다

  1) asciiDoc 플러그인을 설치 ( 설치 방법 )

  2) 플러그인 적용 후, 빌드를 위해 만들어둔 src.docs.asciidoc 경로의 index.adoc를 연다

  3) IntelliJ 내에서 빌드를 통해 얻는 화면과 같은 API.HTML화면을 확인할 수 있는데, 화면에 제대로 나오지 않는다면

      오타일 가능성이 있다(오타를 찾아보자...)

---

2. 테스트 케이스 실행을 통한 API 스펙 정보 기반의 문서 스니펫 생성을 안한 상태

: 테스트 케이스를 실행한다.

: 간혹 테스트 케이스를 작성 후 실행을 놓치는 경우가 있다.

: 테스트 케이스를 작성하고 실행을 해야만 API 스펙 정보를 기반으로 .adoc 문서 스니펫이 생성된다.

: 실행을 하면 아래 예시사진과 같이 build.generated-snippets에 해당 .adoc문서들이 생성된다.

---

3. 테스트 경로에 한글이 들어가있는 경우

: 이 경우는 두가지 경우로 나뉜다.

 

  1) 테스트케이스 경로 중 루트 디렉터리가 아닌 디렉터리에 한글이 있는 경우

  : 경로상의 한글을 없애준다 (폴더이름 변경, 경로 이동 등)

 

  2) 테스트케이스 경로 중 루트 디렉터리에 한글이 있는 경우

  : 답없음. 포맷합시다. 유저네임 무조건 영어로...

 

* 경로 확인은 실행 로그를 확인해보면 된다.