docs/manual/ 본문 9줄에 리뷰 ID(RR-, RR3-, RR5-, RR6-), 설계 결정 번호(D4),
번호만 쓴 소유자 결정("소유자 결정 5")이 있었다. 지난 리뷰를 모르는
독자는 이 괄호를 따라갈 수 없고, docs-writing.md 4절 6단계가 금지한다.
괄호 안의 ID만 걷어내고 문장의 뜻은 바꾸지 않았다. 지난 일을 근거로 든
곳은 날짜와 내용으로 바꿨다(2026-11-05 확인 리뷰, 2026-09-25 소유자 결정).
D4는 규칙 이름 대신 "쓰기 유스케이스의 권한 선언 검사"로 풀었다. 걷어낸
ID와 원래 괄호, 원래 리뷰 문서는 docs/work/evidence.md 8절에 모았다.
리뷰 문서로 링크를 거는 안은 본문이 다시 이력을 가리키게 되어 버렸다.
검사 스크립트 패턴이 못 잡는 "리뷰 NN-NN", "1라운드 NN-NN" 꼴의 ID는
이 커밋 범위 밖이라 남겼다.
검증: python3 scripts/check-work-docs.py --history docs/manual
(lines with history IDs: 0, rc=0), check-work-docs.py 전체 rc=0,
--links docs 깨진 링크 0. document-contract lane은 desktop에서 돌린다.
81 lines
4.9 KiB
Markdown
81 lines
4.9 KiB
Markdown
# 08. 테스트 작성 규칙
|
|
|
|
## 핵심
|
|
|
|
테스트 규칙의 정본은 `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` |
|
|
|
|
## 작성 규칙 요약 (정본은 AGENTS.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는 계약 밖에 있어 실제와 갈라진다(리뷰 01-05의 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/sample-portfolio/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`이 실패한다
|
|
(1라운드 08-01). 단계는 집계 태스크(`integrationCheck` 등)를 통해 붙고, workflow 파일을 고치지 않는다.
|
|
|
|
## 지금 이해하면 되는 것
|
|
|
|
- fake와 계약은 포트 주인 testFixtures에, adapter는 같은 계약을 실제 저장소로.
|
|
- `@DisplayName`은 꼭 필요할 때만, 한국어로.
|
|
- Docker가 필요한 테스트는 strict lane + 단계 지정. 단계 없는 lane은 PR에서 막힌다.
|