Files
clean-architecture-backend-…/.claude/rules/java-tests.md
T
DongHyeonka 3e1c629d1f
pr / done (pull_request) Canceled after 0s
docs(rules): 공유 계약 테스트는 포트가 선언한 것만 단언한다
시험 규칙 5는 예외 메시지까지 단언하라고 했다. fake와 adapter가 함께
상속하는 계약에서는 메시지가 구현마다 달라 그 규칙을 따를 수 없다.
TESTING_STRATEGY 9.4가 이미 그렇게 정했는데 규칙 문서가 가리키지 않아,
다음 작성자가 메시지 단언을 다시 넣을 수 있었다.

Refs: RR9-03-31
2026-11-13 15:02:10 +09:00

29 lines
3.3 KiB
Markdown

---
paths:
- "src/**/src/test/**/*.java"
- "src/**/src/testFixtures/**/*.java"
- "src/**/src/*Test/**/*.java"
- "src/**/src/*Testkit/**/*.java"
---
# Java 테스트 작성 규칙
새로 쓰거나 고치는 테스트에 적용한다. 테스트 분류·배치·source set은 `docs/testing/TESTING_STRATEGY.md`, 계층별로 무엇을 검증하는지는 그 계층의 `AGENTS.md` 「테스트」 절이다.
## 작성 규칙
1. 이름은 lowerCamelCase 행동 문장(`<상황/주체><결과>`)이다. 이름에 적은 성질은 반드시 단언한다.
2. `@DisplayName`은 메서드 이름으로 못 쓰는 내용(숫자, 기호, 이유)이 있을 때만 쓰고, 한국어로 쓴다(2026-09-25 소유자 결정). 기존 영어 `@DisplayName`은 그 테스트 메서드를 고칠 때 한국어로 바꾼다. 같은 클래스의 고치지 않은 메서드는 바꾸지 않아도 되고, 바꾸면 같은 커밋에 넣고 보고에 적는다.
3. 본문 문장이 3개 이상이면 `// given` `// when` `// then` 주석과 구역 사이 빈 줄을 둔다. 준비할 것이 없으면 `// given`은 생략한다. `// when`은 정확히 하나다. 두 번 필요하면 테스트를 나눈다. 예외 테스트는 `catchThrowable`로 when을 분리한다(기존 `assertThatThrownBy`는 손댈 때 `// when & then`까지 허용). 한 줄 테스트와 ArchUnit `.check()`는 주석 없이 쓴다.
4. `@Nested`는 테스트 10개 이상이고 대상 연산이 2개 이상인 클래스에서만, 연산 단위로 한 단계만 쓴다.
5. then은 when의 결과 하나만 단언한다. 여러 필드는 `usingRecursiveComparison()` 또는 `extracting(..).containsExactly(..)`로 한 번에 비교한다. `isNotNull`·`isPresent`·`doesNotThrowAnyException`만으로 끝내지 않는다(이름이 "예외 없음" 자체를 말할 때만 예외). 예외는 타입과 reason·message를 함께 단언한다. 다만 fake와 adapter가 함께 상속하는 계약 테스트(`XxxContract`)는 포트가 선언한 것만 단언한다. 포트 Javadoc이 메시지를 정하지 않으면 타입만 본다. 표 형태 입력은 `@ParameterizedTest`로 쓴다.
6. 포트 대역은 hand-rolled fake를 포트당 하나, 포트 소유 모듈 testFixtures에 둔다. adapter가 있는 포트는 fake와 adapter가 같은 추상 계약 테스트(`XxxContract`)를 통과한다. Mockito는 프레임워크 경계(Spring Data repository, SDK client)와 장애 주입에만 쓴다.
GWT 주석을 검사하는 자동 게이트는 만들지 않는다. 주석은 bytecode에 없어 ArchUnit이 볼 수 없고, 실질적인 강제 수단은 fake와 adapter가 같은 계약 테스트를 상속하는 구조다.
## 코드만 보고는 헷갈리는 것
- 저장소 파일을 읽는 테스트는 태그가 있어야 한다. 문서와 대조하면 `document-contract`(main 단계 `mainCheck`), 빌드 스크립트·workflow·Compose를 읽으면 `repository-contract`(PR)다. 태그 없이 저장소를 읽으면 `test`에서 실패한다. 이유는 `build-logic/AGENTS.md` 「저장소 파일을 읽는 테스트」다.
- 성능 lane에는 단언을 끄는 스위치가 없다. `performance.assertions.enabled`에 `true` 아닌 값이 들어오거나 skip이 하나라도 있으면 테스트 전에 실패한다.
- 테스트는 노트북에서 돌리지 않는다. desktop에서 돌린다(`docs/work/operate.md` 4.1절).