Files
clean-architecture-backend-…/scripts/check-repo-layout.py
T
DongHyeonka d904d680af fix(scripts): 검사 스크립트와 smoke wrapper의 빈틈을 닫고 자기 시험을 더한다
문제:
- README 「새 서비스로 시작하기」의 이름 바꾸기 명령(`git grep -l ... -- src
  scripts`)이 루트 build.gradle·build-logic의 group, config/spotbugs 목록, registry·
  API surface 스냅숏을 놓쳐, 따라 하면 qualityCheck와 surface 검사가 실패했다.
- check-repo-layout.py의 HISTORY_PREFIXES가 없는 폴더 셋(superpowers, evidence,
  study)을 담고 docs/history·docs/design을 빠뜨렸다. 검사 스크립트 머리말에 누가
  부르는지 없었고, check-repo-layout·check-review-index·verify-httpclient-docs에
  자기 시험이 없었다. check-docs.py docstring은 「검사 여섯」(여덟),
  check-work-docs.py는 lychee를 PR workflow라 했다(main).
- run-compose-runtime-smoke.sh가 lane마다 정적 계약 전체를 다시 돌려 nightly마다
  compose config를 수백 번 렌더링했다. handoff lane의 --force-recreate가 1단계
  재시작 수를 지웠고, ps가 빈 결과면 restarts.txt가 비어 재시작 검사가 통과했다.

고친 것:
- 이름 바꾸기 명령을 그 범위로 넓히고 build-logic 자기 패키지는 그대로 둬도
  된다고 적었다.
- HISTORY_PREFIXES를 지금 기록 폴더 넷으로, 머리말에 부르는 곳, docstring 숫자·
  workflow를 고쳤다. 자기 시험 셋을 더했다(scripts/tests 통과, 옛 목록이면
  HISTORY_PREFIXES 시험이 실패한다).
- smoke는 정적 계약을 실행마다 한 번(두 모드 공통) 돌린다. 재시작 수는
  record_restarts가 단계(phase1, final)를 붙여 쌓고, 살핀 컨테이너가 없거나
  inspect·기록이 실패하면 실패한다(호출이 `|| return 1`이라 함수 안 set -e가
  꺼진다).
- verify-httpclient-docs 자기 시험은 실제 트리 대조(release workflow의 검사)를 하지
  않고 누락 탐지만 본다. scripts/tests는 PR 단계에서 돈다.

Refs: RR9-04-04, RR9-04-17, RR9-04-18, RR9-04-26, RR9-04-27
2026-11-13 06:34:33 +09:00

206 lines
8.8 KiB
Python
Executable File

#!/usr/bin/env python3
"""저장소 루트와 src/ 최상위에 허용 목록 밖의 항목이 생기면 실패한다.
부르는 곳: PR 단계 `prCheck`의 `verifyRepositoryLayout`(루트 `build.gradle`), `scripts/verify.sh docs`.
왜: src/ 아래 계층이 아닌 폴더가 2026-07-24의 둘에서 두 달 사이 여덟으로 늘었고, 어느 커밋도 최상위
모양을 묻지 않았다. 루트에는 개발 환경·테스트 fixture·운영 인프라가 섞인 compose 파일과 infra/ 폴더가
쌓였다(2026-11-07 저장소 정리, design-docs repo-structure/01-backend-layout.md). 소유자는 배치 규칙을
리뷰 기준에 두고, 이 허용 목록 검사로도 막기로 정했다(같은 날, repo-structure/README.md 3.1절).
무엇을 보나:
1. 저장소 루트의 추적 파일·폴더가 ROOT_ALLOWED 안에 있는가.
2. src/ 바로 아래의 추적 파일·폴더가 SRC_ALLOWED 안에 있는가. src/에는 계층 폴더만 있다(파일 없음).
3. registry(gradle/modules.json)의 모든 source_path가 허용된 src/ 폴더 아래에 있는가.
4. (경고만) 개발 환경·테스트 fixture 파일(compose 파일, 셸 스크립트, compose/ 아래 보조 파일)을 다른
추적 파일이 하나도 가리키지 않으면 이름을 출력한다. 아무도 읽지 않는 파일이 소리 없이 남는 것이
infra/ 12개가 쌓인 방식이다. 경로를 변수로 조립하는 workflow는 이 검사가 따라가지 못하므로 경고로만 둔다.
추적 파일만 본다(git ls-files). build 출력과 IDE 폴더는 처음부터 대상이 아니다.
새 최상위 항목이 정말 필요하면 아래 목록과 루트 AGENTS.md 「지도」의 최상위 줄을 같은
변경에서 고친다. 최상위 폴더를 만들거나 옮기는 일은 파일 하나여도 큰 일이다(docs/work/README.md 2절).
Gradle 밖에 둔다: 빌드는 저장소 배치를 판단하지 않는다(scripts/check-work-docs.py와 같은 자리).
python3 scripts/check-repo-layout.py
"""
from __future__ import annotations
import json
import subprocess
import sys
from pathlib import Path, PurePosixPath
REPO_ROOT = Path(__file__).resolve().parent.parent
REGISTRY = "gradle/modules.json"
# 저장소 루트 = Gradle 루트: 빌드 도구와 빌드 파일, 문서·스크립트·CI·개발 환경, 그리고 코드(src)다.
# 2026-11-11에 Gradle 루트를 src/에서 여기로 옮겼다(design-docs repo-structure/01-backend-layout.md 6.1절 가-3).
ROOT_ALLOWED = {
# 폴더
".claude": "Claude Code 세션 설정(추적: settings.json의 권한·훅, rules·skills·agents)",
".gitea": "Gitea Actions workflow(pr·main·release)와 공용 action",
".github": "CODEOWNERS, PR 템플릿, 의존성 취약점 정책",
"build-logic": "빌드 규칙(included build)",
"compose": "compose.yaml이 마운트하는 보조 파일",
"config": "코드 검사 도구 설정(checkstyle, spotbugs)",
"docs": "문서",
"gradle": "wrapper, 버전 카탈로그, 모듈 registry, 시험 컨테이너 이미지 목록",
"scripts": "Gradle 밖 검사·실행 스크립트",
"src": "계층별 앱 코드",
# 파일
".dockerignore": "이미지 빌드 context(저장소 루트)에서 뺄 것",
".env.example": "env 계약",
".env.local.example": "로컬 env 예",
".gitattributes": "Git 설정",
".gitignore": "Git 설정",
".lycheeignore": "링크 검사(lychee)가 건너뛸 URL. lychee는 저장소 루트의 이 이름만 읽는다",
".tool-versions": "JDK 버전 고정",
".trivyignore.yaml": "취약점 검사 예외",
"AGENTS.md": "규칙 정본이자 작업 지도",
"CLAUDE.md": "Claude Code 진입점(AGENTS.md를 가져온다)",
"README.md": "저장소 소개",
"Dockerfile": "릴리스 이미지",
"build.gradle": "루트 빌드",
"compose.yaml": "개발 환경(하나뿐)",
"gradle.properties": "Gradle 설정",
"gradlew": "wrapper",
"gradlew.bat": "wrapper",
"renovate.json": "의존성 갱신 봇 설정",
"settings-gradle.lockfile": "settings 잠금",
"settings.gradle": "settings",
"testcontainers.properties.example": "Testcontainers 로컬 설정 예",
}
# src/ 바로 아래: 계층 폴더만. 같은 계층의 leaf는 그 계층 폴더 아래에 둔다(application/core, bootstrap/app).
# 빌드 도구와 빌드 파일은 저장소 루트에 있다. 계층이 아닌 라이브러리(메시징·gRPC)는 2026-11-08에 별도 repo로
# 나갔다(docs/work/reference/related-repos.md). 그 자리(platforms)는 다시 두지 않는다.
SRC_ALLOWED = {
"domain": "계층(domain/core)",
"shared-contract": "계층",
"application": "계층(application/core와 capability application leaf)",
"adapter": "계층(adapter leaf 묶음: inbound, outbound)",
"bootstrap": "조립 계층(Clean Architecture의 Main): 조립 루트 app과 조립 leaf",
}
# 아무도 가리키지 않으면 경고할 파일: 개발 환경과 테스트 fixture.
FIXTURE_SUFFIXES = (".sh", ".acl", ".json", ".yaml", ".yml")
FIXTURE_PREFIXES = ("compose/", "scripts/", "src/bootstrap/app/compose-lanes/")
# 기록 문서 폴더(docs/README.md 「문서 수명과 언어」). 기록이 옛 경로를 적은 것은 참조가 아니다.
HISTORY_PREFIXES = (
"docs/reviews/",
"docs/history/",
"docs/design/",
"docs/adr/",
)
def tracked_files() -> list[str]:
result = subprocess.run(
["git", "ls-files", "-z"],
cwd=REPO_ROOT,
check=True,
capture_output=True,
)
return [path for path in result.stdout.decode("utf-8").split("\0") if path]
def top_level(paths: list[str], prefix: str) -> set[str]:
names = set()
for path in paths:
if not path.startswith(prefix):
continue
rest = path[len(prefix):]
names.add(rest.split("/", 1)[0])
return names
def registry_violations() -> list[str]:
modules = json.loads((REPO_ROOT / REGISTRY).read_text(encoding="utf-8"))["modules"]
problems = []
for module in modules:
source = PurePosixPath(module["source_path"])
parts = source.parts
if len(parts) < 2 or parts[0] != "src" or parts[1] not in SRC_ALLOWED:
problems.append(
f"{REGISTRY}: {module['id']} source_path {source} is not under an allowed src/ folder"
)
return problems
def is_fixture(path: str) -> bool:
if path.endswith(("README.md", ".gitignore")):
return False
name = PurePosixPath(path).name
if path.startswith(FIXTURE_PREFIXES) and name.endswith(FIXTURE_SUFFIXES):
return True
return "compose" in name and name.endswith((".yaml", ".yml"))
def unreferenced_fixtures(paths: list[str]) -> list[str]:
this_script = str(Path(__file__).resolve().relative_to(REPO_ROOT))
readable = [
p for p in paths if not p.startswith(HISTORY_PREFIXES) and p != this_script
]
texts = {}
for path in readable:
file = REPO_ROOT / path
try:
if file.stat().st_size > 2_000_000:
continue
texts[path] = file.read_text(encoding="utf-8")
except (UnicodeDecodeError, OSError):
continue
lonely = []
for path in sorted(p for p in paths if is_fixture(p)):
pure = PurePosixPath(path)
# The file's own path or name, or its folder when a compose file mounts the whole folder
# (./compose/redis/acl). A one-segment folder such as compose/ names too much to count.
needles = {path, pure.name}
if len(pure.parent.parts) >= 2:
needles.add(str(pure.parent))
referenced = any(
other != path and any(needle in text for needle in needles)
for other, text in texts.items()
)
if not referenced:
lonely.append(path)
return lonely
def main() -> int:
paths = tracked_files()
failures = []
for name in sorted(top_level(paths, "") - ROOT_ALLOWED.keys()):
failures.append(f"repository root: '{name}' is not in ROOT_ALLOWED")
for name in sorted(top_level(paths, "src/") - SRC_ALLOWED.keys()):
failures.append(f"src/: '{name}' is not in SRC_ALLOWED")
failures.extend(registry_violations())
for path in unreferenced_fixtures(paths):
print(f"warning: no tracked file refers to {path}")
if failures:
for failure in failures:
print(f"FAIL: {failure}", file=sys.stderr)
print(
"check-repo-layout: a new top-level entry changes the repository's shape. If it is "
"wanted, add it to the allow list in scripts/check-repo-layout.py and to the map in "
"AGENTS.md in the same change.",
file=sys.stderr,
)
return 1
print(
f"check-repo-layout: OK — {len(top_level(paths, ''))} root entries, "
f"{len(top_level(paths, 'src/'))} src/ entries, registry paths inside allowed folders"
)
return 0
if __name__ == "__main__":
sys.exit(main())