Files
clean-architecture-backend-…/docs/manual/08-testing.md
T
DongHyeonka 3c73fc333c docs(agents)!: 루트 AGENTS.md를 40줄 정본으로 줄이고 CLAUDE.md가 가져온다
루트에 CLAUDE.md와 AGENTS.md가 둘 다 있으면 Claude Code 기본 설정은
AGENTS.md를 읽지 않는다. 그래서 344줄 정본은 세션이 스스로 열 때만
닿았고, HARD-STOP은 CLAUDE.md 요약으로만 실렸다. 두 문서가 같은
규칙을 아홉 군데 따로 적었다. 소유자가 2026-11-07에 루트 정본은
AGENTS.md 20~40줄, CLAUDE.md는 `@AGENTS.md`로 정했다(design-docs
harness/01-harness-design.md 13절 Q1·Q2·Q3).

- AGENTS.md(37줄): 무엇인가, HARD-STOP 7, 지도, 맡은 일, 검증,
  일하는 방식. CLAUDE.md(6줄): `@AGENTS.md`와 Claude 전용 줄.
- 옛 절의 새 자리: Gradle 정책 권위 → src/build-logic/AGENTS.md(새),
  테스트 작성 규칙 → .claude/rules/java-tests.md(paths: 테스트 소스),
  계층별 테스트 기준·family 책임 → 각 core AGENTS.md와 새
  src/adapter/inbound·outbound/AGENTS.md, composition 조립 규칙 →
  src/composition/AGENTS.md(새), capability 규칙·완료 기준 →
  docs/manual/10-capabilities.md(이제 정본), 설정·Docker 규칙 →
  .claude/rules/settings-and-runtime.md, 문서 편집 규칙 →
  .claude/rules/docs.md, 템플릿 재사용 체크리스트 → README
  「새 서비스로 시작하기」. Superpowers 목록·강제 수준·금지된 지름길·
  작업 보고 규칙은 HARD-STOP과 전역 규칙의 중복이라 지웠다.
- 살아 있는 문서의 옛 절 참조를 새 자리로 바꿨다. 결정 색인은 옛
  행에 취소선을 긋고 「지침 배치」 행을 더했다.
- check-work-docs.py: 지도를 AGENTS.md로, 상한 40(CLAUDE.md 10),
  진입 경로에 CLAUDE.md를 더하고, CLAUDE.md 첫 줄이 가져오기인지,
  .claude/rules·skills·agents 문서의 이력 ID와 링크를 본다.
- DeveloperExperienceContractTest는 루트 안내 명령을 AGENTS.md에서
  읽는다. 단언은 그대로다.

버린 대안: 루트 120줄(설계 권함, 소유자가 자료 쪽으로 정함),
CLAUDE.md만 두기(다른 에이전트가 못 읽음), 심볼릭 링크.

위험: 폴더를 가로지르는 규칙(.claude/rules/)은 Claude Code만 자동으로
읽는다. 다른 에이전트용으로 AGENTS.md 지도에 위치 한 줄을 뒀다.

검증: check-work-docs.py(AGENTS.md 37/40, CLAUDE.md 6/10),
check-docs.py, unittest, check-repo-layout.py 모두 rc=0. Java 테스트
변경은 마지막 트리에서 desktop documentContractTest로 확인한다.

BREAKING CHANGE: 루트 AGENTS.md의 절 이름이 바뀌고 내용이 위 자리로
옮겨 갔다. docs/upgrade/2026-11-harness.md 2절 2·3행.
2026-11-07 21:59:42 +09:00

83 lines
5.2 KiB
Markdown

# 08. 테스트 작성 규칙
## 핵심
테스트 작성 규칙의 정본은 `.claude/rules/java-tests.md`이고, 계층별로 무엇을 검증하는지는 그 계층의 `AGENTS.md` 「테스트」 절이다. 이 장은 새 기능을 만들 때 그 규칙이 **어떤
파일 배치가 되는지**와 **어느 단계(PR/main/integration)에서 도는지**를 적는다.
```text
포트 XRepository (domain-core)
├─ testFixtures: InMemoryXRepository (fake, 포트당 하나)
├─ testFixtures: XRepositoryContract (abstract, 약속 목록)
├─ test: InMemoryXRepositoryContractTest extends XRepositoryContract → ci (leaf test)
└─ 저장 adapter leaf integrationTest:
JpaXRepositoryContractTest extends XRepositoryContract → integrationCheck (실 PostgreSQL)
유스케이스 테스트 = 실제 유스케이스 + InMemoryXRepository + DirectTransactionPort
```
fake와 실제 adapter가 **같은 계약**을 통과해야 fake 위의 유스케이스 테스트가 거짓 녹색이 되지 않는다.
생성 명령은 이 배치를 그대로 만든다(01장).
## 계층별 테스트
| 계층 | 테스트 | 쓰는 대역 | 예 (생성 결과) |
| --- | --- | --- | --- |
| domain | 순수 JUnit. 불변식·id 문법 | 없음 | `<F>Test`, `<F>IdTest` |
| domain 포트 | 공유 계약 | fake | `InMemory<F>RepositoryContractTest` |
| application | 유스케이스 흐름·트랜잭션 경계·오류 코드 | 포트 소유자 testFixtures의 fake, `DirectTransactionPort` | `Create<F>UseCaseTest` |
| outbound adapter | 같은 공유 계약을 실제 저장소로 | Testcontainers(strict lane) | 04장 4번 |
| inbound | HTTP status·Envelope·오류 코드 | 실제 유스케이스 + fake, standalone MockMvc | `<F>ControllerTest` |
| bootstrap | 조립 조건(있을 때 켜짐, 없을 때 없음), imports 등록 | fake bean | `<F>ConfigTest` |
## 작성 규칙 요약 (정본은 `.claude/rules/java-tests.md`)
1. 이름은 lowerCamelCase 행동 문장. 이름이 말한 성질을 단언한다. 예: 이름에 "트랜잭션 전에"를 넣었으면
트랜잭션이 없었다는 것도 단언하거나, 이름에서 뺀다.
2. `@DisplayName`은 메서드 이름으로 못 쓰는 내용(숫자, 기호, 이유)이 있을 때만, **한국어**로
(2026-09-25 소유자 결정). 예: `@DisplayName("이름이 NAME_MAX_LENGTH + 1자이면 거절한다")`.
3. 본문 3문장 이상이면 `// given` `// when` `// then`. `// when`은 하나. 예외는 `catchThrowable`로 분리.
4. then은 when의 결과 하나만. 예외는 타입과 reason/code를 함께.
5. 포트 대역은 hand-rolled fake 하나, **포트 소유 leaf의 testFixtures**에. Mockito는 프레임워크 경계와
장애 주입만.
### 판단: fake가 어디 사나
- **고르는 기준**: 포트 인터페이스가 어느 leaf에 있나.
- **기본값**: 그 leaf의 `src/testFixtures/java/.../<f>/testkit/`. domain 포트면 domain-core,
application 포트면 application-core. 소비 leaf는 `testImplementation testFixtures(project(':<owner>'))`.
- **예외**: 없다. 테스트 안 private fake는 계약 밖에 있어 실제와 갈라진다(2026-11-01 성숙도 리뷰가
분산 lock 포트 계약 테스트 안의 fake에서 찾았다).
## lane과 단계
`ci`(PR)의 leaf `test`는 Docker 없이 빠르게 끝나야 한다. 실 DB·실 서버가 필요한 테스트는 strict
lane으로 선언하고 단계를 지정한다. 선언은 `ca.strict-test-lane`(`src/build-logic/README.md`).
| lane 종류 | 선언 | 도는 단계 |
| --- | --- | --- |
| 단위·slice | 기본 `test` | `ci` |
| 문서 대조·느린 계약 | 태그 lane + `mainStage()` | `mainCheck` |
| 실 DB·컨테이너 | `integration()` + 자기 sourceSet(예: `integrationTest`) | `integrationCheck` |
| 성능·부하 | performance 범주 | `performanceCheck` |
| 외부 입력 필요(자격증명 등) | `explicitOnly(reason)` | 어떤 집계에도 안 들어가고 이유가 출력된다 |
예: `src/app-bootstrap/build.gradle`의 `strictTestLanes { lane('integrationTest') { integration() … } }`,
`src/app-bootstrap/build.gradle`의 `publicPathSnapshotTest`(`mainStage()`).
### 판단: 새 테스트를 어느 lane에
- **고르는 기준**: Docker·네트워크·실 서버가 필요한가, 몇 초 넘게 걸리는가.
- **기본값**: 필요 없으면 `test`(ci). 필요하면 integration lane.
- **예외**: 반드시 실행돼야 하는 소수 테스트(계약 자격 검사)는 `requires(클래스)` + `rejectSkipped = true`로
이름을 박는다. 이름이 바뀌거나 지워지면 lane이 실패한다.
- 새 lane이 어떤 단계에도 속하지 않으면 PR 게이트의 `verifyStrictLaneStages --dry-run`이 실패한다
(2026-11-01부터. 전에는 어떤 workflow도 돌리지 않는 strict lane이 14개 있었다). 단계는 집계
태스크(`integrationCheck` 등)를 통해 붙고, workflow 파일을 고치지 않는다.
## 지금 이해하면 되는 것
- fake와 계약은 포트 주인 testFixtures에, adapter는 같은 계약을 실제 저장소로.
- `@DisplayName`은 꼭 필요할 때만, 한국어로.
- Docker가 필요한 테스트는 strict lane + 단계 지정. 단계 없는 lane은 PR에서 막힌다.