Files
clean-architecture-backend-…/docs/design/2026-08-02-verification-purity-refactoring-design.md
T
DongHyeonka 74108497d4 docs(records): 기록과 ADR 맨 위에 한국어 머리 블록을 단다
문제: 설계서·계획서·납품 패키지·증거·학습 문서와 ADR이 기록이라는 표시
없이 지금 문서처럼 읽힌다. 상태 칸이 설계서 72개 중 40개, 계획서는
거의 없고, 있어도 Approved·확정·Accepted.처럼 값이 제각각이며 영어다.

고른 방법: docs/design, docs/history, docs/adr, docs/notification/adr의
.md 246개 맨 위에 같은 모양의 머리 블록을 단다. 칸은 상태·작성일·
요약(한국어 한 문장)·현재 정본, 대체됐으면 대체됨이다. 블록은 표시 줄
두 개로 감싸서 빼면 원문 바이트가 그대로 돌아온다(246개 모두 대조함).
- 종류는 폴더가 정하고 둘째 줄에 적는다(plans/evidence는 증거).
- 상태는 원래 상태 줄을 고정 어휘로 바꾼 값이다. 상태 줄이 없는
  설계서와 체크 상자가 다 표시되지 않은 계획서는 「확인 안 함」.
  capability-status.md 제거 표로 지운 것이 확인된 설계서 다섯은 「폐기」,
  2026-07-20 하네스 설계·계획과 production capability platform 설계는
  「대체됨」이다.
- 현재 정본은 구조 정리로 옮겨질 수 있는 src/messaging·src/grpc 대신
  docs/ 쪽 문서나 옮기지 않는 leaf README를 가리킨다.
docs/README.md에 「문서 수명과 언어」「기록 문서의 머리 블록」「문서와
코드를 같은 변경에서 고친다」를 더하고, 파생 서비스 안내에 머리 블록
충돌 가능성을 적었다.

버린 대안: H1 제목 아래에 블록을 두는 안은 보기에는 낫지만 빼는 규칙이
파일마다 달라져 원문 복원이 기계적이지 않다. 「종류」 칸을 따로 두는
안은 폴더와 같은 정보를 두 번 쓰게 한다.

위험·한계: 「확인 안 함」 설계서 38개, 계획서 51개는 지금 유효한지
아무도 판정하지 않았다. 요약은 제목·목표 줄을 보고 쓴 것이라 본문을
끝까지 읽지 않았다. 납품 패키지 셋의 MANIFEST.sha256는 이제 맞지 않는다
(납품 당시 바이트의 해시이고, 블록을 빼면 다시 맞는다). 리뷰 폴더에는
아직 머리 블록을 달지 않았다.

검증: 머리 블록을 뺀 내용과 HEAD 원본 246개 일치, check-work-docs.py
rc=0, --links docs·README.md·CLAUDE.md·AGENTS.md 깨진 링크 0.
2026-11-07 12:23:32 +09:00

4.5 KiB

기록 · 설계서 본문은 쓴 때의 원문이다. 지금 동작은 「현재 정본」을 읽는다.

  • 상태: 채택
  • 작성일: 2026-08-02
  • 요약: 파일을 고치던 검증 경로(stale JAR, 공개 경로)를 읽기 전용으로 바꾸는 설계다.
  • 현재 정본: docs/work/reference/gates.md

Verification Purity Refactoring Design

Date: 2026-08-02 Status: approved by the user's instruction to apply the P1/P2 review sequentially Scope: stale traceable JAR verification/cleanup and public-path snapshot verification/update

Context

Two root Gradle verification paths currently mutate files while they are expected to be safe gates:

  • every Jar task deletes stale traceable archives in doFirst, and verifyNoStaleTraceableJars depends on cleanStaleTraceableJars;
  • verifyPublicPathSnapshot creates a missing snapshot and updates drift when -PapprovePublicPathChange is supplied.

That makes check capable of hiding the state it is meant to detect. This batch restores the standard contract: verification observes and fails, while explicitly named maintenance tasks own writes.

Considered Approaches

Keep the root build logic in place and inspect source text in tests

This is the smallest diff, but a source assertion cannot prove task side effects. Rejected.

Invoke the entire repository build from a copied checkout

This tests the actual root build but requires copying all 19 leaves and resolving every root plugin for two small contracts. It is slow and couples the tests to unrelated configuration. Rejected.

Extract only the two task concerns into applied Gradle scripts and exercise them with TestKit

Selected. The production root applies the same scripts that an isolated functional fixture uses. The fixture observes exit status and filesystem state, so it proves behavior rather than source shape. This is a bounded extraction required for testability, not the broad P2 root-build rewrite.

Archive Hygiene Contract

gradle/archive-hygiene.gradle owns stale traceable archive discovery and the two root tasks:

  • verifyNoStaleTraceableJars reports every stale archive and fails without deleting anything;
  • cleanStaleTraceableJars deletes only names matching the traceable archive pattern for a known Jar task and never deletes the current archive;
  • normal jar/bootJar execution never performs cleanup.

The existing traceable version naming and manifest metadata remain unchanged.

Public-Path Snapshot Contract

gradle/public-path-snapshot.gradle owns canonicalization and two root tasks:

  • verifyPublicPathSnapshot fails when the env file or committed snapshot is missing, when content drifts, or when the update-only approval property is passed to the verifier. It never creates directories or writes files;
  • updatePublicPathSnapshot requires -PapprovePublicPathChange and writes the canonical snapshot.

A clean-worktree requirement is intentionally not used: the normal update workflow necessarily has an intentional .env change. Explicit task naming, the approval property, and the resulting diff are the review boundary.

The canonical header names updatePublicPathSnapshot, so documentation and the committed snapshot do not instruct users to mutate through a verification task.

Testing

BuildVerificationPurityContractTest runs from an isolated functionalTest source set using Gradle TestKit against temporary projects that apply the production scripts directly. Keeping TestKit off the ordinary testRuntimeClasspath prevents Gradle's SLF4J provider from replacing Logback during Spring tests. It proves:

  1. a normal jar leaves a matching stale archive untouched;
  2. verification fails and preserves the stale archive;
  3. explicit cleanup deletes the stale archive but preserves the current archive;
  4. missing/drifted public-path snapshots cause read-only failure;
  5. the verifier rejects the update approval property;
  6. only the explicit updater with approval creates or changes the snapshot.

Non-Goals

  • no change to archive naming, versions, manifests, production dependency versions, or project edges;
  • only the new isolated functional-test configurations are added to app-bootstrap/gradle.lockfile;
  • no public-path allow-list value change;
  • no broad root Gradle convention-plugin migration;
  • no staging, commit, amend, or push by an agent.