Files
clean-architecture-backend-…/docs/manual/08-testing.md
T
DongHyeonka ab5982e955 refactor(repo)!: 샘플 모듈과 그 참조를 지운다
문제: src/sample-portfolio(311파일)와 src/Dockerfile.sample이 빌드 8곳,
registry, PR job, spotbugs 제외, 매뉴얼·leaf 문서 수십 곳에 얽혀 있다.
매뉴얼과 생성 명령이 예시를 맡게 된 뒤로 샘플은 유지 비용만 남았고,
문서 일부는 이미 없는 태스크(sampleOffTest)와 ArchUnit 규칙을 가리킨다.

고른 방법: 소유자 결정(2026-11-07)대로 샘플을 폴더째 지우고 역할은
옮기지 않는다. 샘플을 가리키던 것도 같은 변경에서 지운다.
- 빌드: registry 행, 루트 build.gradle의 샘플 태스크·의존·단계
  (sampleWebContractCheck, :sample-portfolio:*, strict lane 단계),
  app-bootstrap architectureTestRuntimeOnly, spotbugs 제외 3곳
- CI: ci-quality-gates.yml의 sample-portfolio job과 release-gate 칸
- 테스트: SampleRuntimeDefaultsContractTest, Dockerfile.sample 비교 테스트,
  ArchUnit 규칙의 죽은 sample 패키지 제외. build-logic 테스트와
  application-core 테스트의 가짜 이름은 example-app으로 바꾼다
- 문서: 매뉴얼 예시를 실제 코드(durable operation, identifier,
  ErrorCodeRegistryMappingTest)로 바꾸고, 템플릿에 예가 없는 기법
  (유일 제약 → 같은 409)은 규칙과 확인 방법만 적는다. 결정 색인의
  샘플 전용 행은 "샘플과 함께 사라짐"으로 표시한다
버린 대안: 설계서 권장안(OpenAPI 스냅숏·웹 계약을 옮긴 뒤 삭제)은
소유자가 고르지 않았다.

위험·한계:
- 샘플 안에만 있던 검사(OpenAPI 스냅숏, Date 헤더, 가상 스레드 MDC
  전파, 요청당 SQL 수 단언)가 함께 사라진다. 소유자가 남기라 하면
  총괄이 따로 맡긴다.
- APP_CACHE_REDIS_ENABLED는 샘플이 읽지 않는 키라(설계서 가정과 다름)
  지우지 않고 src/README.md 문장만 고쳤다. 제거 기한 2026-11-30은 그대로.
- docs/capability-status.md 「제거된 코드」 표와 docs/work/evidence.md의
  샘플 경로는 이력이라 두었다.

검증(desktop, 트리 0525e14e, ~/t1-layout-logs/):
- ./gradlew :ci --warning-mode=fail rc=0 (502 executed, 83 from cache)
- :verifyStrictLaneStages --dry-run rc=0
- :app-bootstrap:documentContractTest rc=0
- -p build-logic check rc=0
- :verifyDependencyLocks rc=0
- python3 scripts/check-work-docs.py, 상대 링크 검사 rc=0

Refs: design-docs repo-structure/README.md 3.1, repo-structure/01-backend-layout.md 6.2
BREAKING CHANGE: src/sample-portfolio, src/Dockerfile.sample, 샘플 태스크와 job이 없어진다. 샘플을 고쳐 쓰던 파생 서비스는 병합 때 수정 대 삭제 충돌이 난다. docs/upgrade/2026-11-maturity-review.md B-49.
2026-11-07 12:21:03 +09:00

5.1 KiB

08. 테스트 작성 규칙

핵심

테스트 규칙의 정본은 AGENTS.md 「테스트 전략」이다. 이 장은 새 기능을 만들 때 그 규칙이 어떤 파일 배치가 되는지와 어느 단계(PR/main/integration)에서 도는지를 적는다.

포트 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는 계약 밖에 있어 실제와 갈라진다(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에서 막힌다.