Files
clean-architecture-backend-…/scripts/verify-feature-scaffold.sh
T
DongHyeonka 6a792b8144 refactor(layout)!: 옮긴 경로를 부르는 곳을 모두 새 배치에 맞춘다
문제: 앞 커밋이 Gradle 루트를 저장소 루트로 옮기고 계층 폴더를 묶었다.
빌드 스크립트·build-logic·시험·workflow·스크립트·문서가 아직 옛 배치
(Gradle 루트 = src/)를 가정해 빌드가 되지 않는다.

고른 방법:
- Gradle 경로와 registry id는 그대로 둔다(:app-bootstrap, :application-core,
  :composition:*). registry의 source_path만 새 폴더를 가리킨다. 폴더에 맞춘
  이름(:domain:core, :application:core)은 프로젝트 이름 core가 둘이 되어
  boot jar의 BOOT-INF/lib와 기본 capability가 겹치고, 파생 서비스의 모든
  project(':…') 줄을 바꾸게 한다.
- registry는 gradle/modules.json, 시험 이미지 목록은
  gradle/container-images.properties: 버전 카탈로그 옆, 빌드가 고정하는 것.
  config/는 코드 검사 도구 설정만 둔다.
- build-logic: settings·architecture 플러그인의 저장소 루트를 Gradle 루트로
  (getParentFile 제거). config contract의 파일 트리는 src/만 훑는다(루트를
  훑으면 docs·.claude/worktrees까지 줍는다).
- 빌드 스크립트: rootProject.projectDir.parentFile → rootProject.projectDir,
  rootProject.file('../…') → rootProject.file('…'), 옛 src 기준 include에
  src/를 붙인다. notification API surface의 application-notification 소스
  루트를 새 폴더로(놓치면 272개 타입이 surface에서 말없이 빠진다).
- 시험: 옛 src 기준 모듈 목록과 ../ 개수를 고친다. 없는 폴더를 말없이
  건너뛰던 목록(MessagingAuthority, NotificationPayloadAtRest 등)을 새
  폴더로, FileserverDocumentationCoverageTest는 Gradle 경로 → 폴더를
  registry로 찾는다. Docker 계약은 WORKDIR /build, 새 jar 경로.
- Docker: 빌드 context를 저장소 루트로, .dockerignore는 허용 목록으로 다시
  써서 전에 context였던 것만 들어가게 한다. compose의 build.context는 .,
  env_file은 ./.env.
- workflow: working-directory: src 기본값과 그것을 되돌리던 줄을 지운다.
- scripts: verify.sh, ci/*, bootstrap-local, new-feature,
  verify-feature-scaffold, mongo 검증, hooks, check-repo-layout 허용 목록.
  check-docs의 경로 검사는 build-logic/·gradle/로 시작하는 경로도 본다.
- 문서: AGENTS.md 지도, README 구조 표, leaf AGENTS.md의 cd src, gates·
  operate·결정 색인, src/bootstrap/AGENTS.md를 조립 계층 family 규칙으로
  다시 쓴다. 기록 문서(docs/design·history·reviews, 지난 upgrade 안내,
  capability-status 제거 표)는 머리 블록만 고친다. 파생 서비스용 안내
  docs/upgrade/2026-11-relayout.md를 더한다.

위험: bootRun working dir가 저장소 루트가 되어 .env와 상대 경로 설정이
루트 기준이다. 루트 .env는 compose 보간에도 읽힌다(upgrade 안내 5절).
파생 서비스는 태그 pre-relayout-2026-11까지 받은 뒤 이 묶음을 받는다.

검증: desktop에서 캐시 없이 scripts/verify.sh docs·pr·main·release,
compose smoke 18 lane, 빠른 시작(scripts/verify.sh app). 결과는 PR 본문.
구조 리뷰(arch-reviewer) 지적 5건을 반영했다.

BREAKING CHANGE: Gradle은 저장소 루트에서 돈다(cd src 없음). registry는
gradle/modules.json, 이미지 빌드 context는 저장소 루트다. 옛 경로 → 새 경로
표는 docs/upgrade/2026-11-relayout.md.
Refs: design-docs repo-structure/01-backend-layout.md 6.1절 가-2·가-3
2026-11-11 22:15:42 +09:00

163 lines
7.8 KiB
Bash
Executable File

#!/usr/bin/env bash
# 생성 명령 왕복 검사: 새 기능을 만들면 그 결과가 손대지 않고 PR 게이트를 통과하는가.
#
# scripts/verify-feature-scaffold.sh [FeatureName ...]
#
# 작업 트리(추적 파일 + 무시되지 않은 새 파일)를 임시 디렉터리로 복사하고, 거기서
# scripts/new-feature.sh를 이름마다 실행한 뒤, 생성물이 닿는 leaf의 check와 architectureCheck를
# 돌린다. 작업 트리는 건드리지 않고, 임시 디렉터리는 끝나면 지운다(KEEP_SCAFFOLD_COPY=1이면 남긴다).
#
# 기본 이름 두 개: 한 단어(Invoice)와 여러 단어(PurchaseOrder). 여러 단어 이름은 패키지·경로·
# 오류 코드·권한 이름이 서로 다른 모양으로 갈리고 Javadoc 줄바꿈이 달라지는 경우다.
# 그 전에 템플릿 패키지 이름(Operation, Notification, Common)을 넣어 거절되는지와 아무것도 쓰지
# 않는지 확인한다.
#
# 생성물의 테스트가 모두 실제로 돌았는지 템플릿 목록으로 확인하고, 생성된 저장소 계약을 호출자
# 트랜잭션을 요구하는 저장소로 한 번 더 돌린다(scripts/feature-scaffold/probes, 기능에는 생성되지 않는다).
#
# 루트 Gradle 태스크 `verifyFeatureScaffold`가 이 스크립트를 부르고 mainCheck에 들어 있다.
set -euo pipefail
repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
names=("$@")
[ "${#names[@]}" -gt 0 ] || names=(Invoice PurchaseOrder)
parent="${TMPDIR:-/tmp}"
copy="$(mktemp -d "$parent/feature-scaffold.XXXXXX")"
cleanup() {
if [ "${KEEP_SCAFFOLD_COPY:-0}" = "1" ]; then
echo "복사본을 남겼다: $copy"
else
rm -rf "$copy"
fi
}
trap cleanup EXIT
# 작업 트리 그대로(커밋하지 않은 변경 포함). build 산출물은 .gitignore라 빠진다.
# 지웠지만 아직 커밋하지 않은 추적 파일은 목록에서 뺀다(`-d`로 받은 경로를 거른다). 그대로 두면
# tar가 없는 파일을 만나 실패한다.
(cd "$repo_root" && git ls-files -co --exclude-standard -z \
| grep -zvxF -f <(git ls-files -d -z | tr '\0' '\n' | sed '/^$/d'; echo '/dev/null/none')) \
| (cd "$repo_root" && tar --null -T - -cf -) \
| tar -xf - -C "$copy"
# architectureCheck의 Git-carryable 검사와 sourceRevision은 Git 저장소를 읽는다.
(
cd "$copy"
git init -q
git add -A
GIT_AUTHOR_NAME=scaffold GIT_AUTHOR_EMAIL=scaffold@invalid \
GIT_COMMITTER_NAME=scaffold GIT_COMMITTER_EMAIL=scaffold@invalid \
git commit -q -m "feature scaffold round trip baseline"
)
# 템플릿 패키지 이름은 거절하고 아무것도 쓰지 않는다(review 2026-11-01 01-10). application-core 패키지,
# 다른 leaf가 같은 루트에 둔 패키지, bootstrap autoconfigure 패키지를 하나씩. `Common`은 예전 이름
# 목록이 놓쳐서 템플릿의 autoconfigure.common 패키지에 기능을 만들던 이름이다.
for rejected in Operation Notification Common; do
status=0
output="$("$copy/scripts/new-feature.sh" "$rejected" --no-format 2>&1)" || status=$?
if [ "$status" -ne 2 ]; then
echo "템플릿 패키지 이름을 거절하지 않았다(종료 코드 $status): $rejected" >&2
printf '%s\n' "$output" >&2
exit 1
fi
if [ -n "$(cd "$copy" && git status --porcelain)" ]; then
echo "거절했는데 파일을 바꿨다: $rejected" >&2
(cd "$copy" && git status --porcelain) >&2
exit 1
fi
echo "거절: $rejected"
done
for name in "${names[@]}"; do
"$copy/scripts/new-feature.sh" "$name" > "$copy/new-feature-$name.log"
echo "생성: $name"
done
# 생성 명령이 정말로 무언가를 만들었는지(빈 왕복이 녹색이 되지 않게).
for name in "${names[@]}"; do
package_name="$(printf '%s' "$name" | tr '[:upper:]' '[:lower:]')"
for required in \
"src/domain/core/src/main/java/dev/caskeleton/domain/$package_name/${name}.java" \
"src/application/core/src/main/java/dev/caskeleton/application/$package_name/Create${name}UseCase.java" \
"src/adapter/inbound/web/src/main/java/dev/caskeleton/adapter/inbound/web/$package_name/${name}Controller.java" \
"src/bootstrap/app/src/main/java/dev/caskeleton/bootstrap/autoconfigure/$package_name/${name}Config.java"; do
[ -f "$copy/$required" ] || { echo "생성되지 않았다: $required" >&2; exit 1; }
done
done
cd "$copy"
./gradlew --console=plain --continue \
:domain-core:check \
:application-core:check \
:adapter:outbound:identifier:check \
:adapter:inbound:web:check \
:app-bootstrap:check \
architectureCheck
# 생성된 테스트가 실제로 실행되었는지: 템플릿의 테스트 클래스 하나하나가 자기 leaf의 결과 XML을
# 남겨야 한다. 목록을 손으로 적지 않고 템플릿에서 만든다 — 손으로 적은 목록은 8개 중 4개만 보았고,
# 필터·태그가 바뀌어 나머지가 실행되지 않아도 녹색이었다(review 2026-11-03 RR-01-10).
scaffold_templates="$copy/scripts/feature-scaffold/templates/src"
mapfile -t test_templates < <(cd "$scaffold_templates" && find . -path '*/src/test/java/*' -name '*Test.java.tmpl' | sort)
[ "${#test_templates[@]}" -gt 0 ] || { echo "템플릿에 테스트가 없다: $scaffold_templates" >&2; exit 1; }
# 결과 XML 하나를 확인한다: 있고, 한 건 이상 돌았고, 실패·오류가 없다.
require_test_result() {
local result="$1" what="$2"
[ -f "$result" ] || { echo "$what 실행되지 않았다: $result" >&2; exit 1; }
if grep -q 'tests="0"' "$result"; then
echo "$what 한 건도 돌지 않았다: $result" >&2
exit 1
fi
if grep -q '<failure\|<error' "$result"; then
echo "$what 실패했다: $result" >&2
exit 1
fi
}
# 템플릿 경로(<leaf>/src/test/java/<패키지 경로>/<클래스>.java.tmpl, src/ 기준)를 그 leaf의 결과 XML 경로(저장소 루트 기준)로.
result_of() {
local template="${1#./}" name="$2" package_name="$3"
local leaf="${template%%/src/test/java/*}"
local class_path="${template#*/src/test/java/}"
class_path="${class_path%.java.tmpl}"
local fqcn
fqcn="$(printf '%s' "$class_path" | sed -e "s/__Feature__/$name/g" -e "s/__feature__/$package_name/g" | tr '/' '.')"
printf 'src/%s/build/test-results/test/TEST-%s.xml' "$leaf" "$fqcn"
}
for name in "${names[@]}"; do
package_name="$(printf '%s' "$name" | tr '[:upper:]' '[:lower:]')"
for template in "${test_templates[@]}"; do
require_test_result "$(result_of "$template" "$name" "$package_name")" "생성된 테스트가"
done
done
# 생성된 저장소 계약은 실제 adapter가 상속할 수 있어야 한다. 매뉴얼 04장의 adapter는 호출자
# 트랜잭션 밖의 호출을 거부하므로, 그렇게 하는 저장소로 계약을 돌려 본다(review 2026-11-03 RR-01-01).
# 탐침은 기능에 생성되지 않는 테스트라 PR 게이트(check)와 따로 test 태스크만 돌린다.
probe_templates="$copy/scripts/feature-scaffold/probes/src"
mapfile -t probes < <(cd "$probe_templates" && find . -type f -name '*.java.tmpl' | sort)
probe_filters=()
for name in "${names[@]}"; do
package_name="$(printf '%s' "$name" | tr '[:upper:]' '[:lower:]')"
for probe in "${probes[@]}"; do
target="$(printf '%s' "${probe#./}" | sed -e "s/__Feature__/$name/g" -e "s/__feature__/$package_name/g")"
target="${target%.tmpl}"
mkdir -p "$(dirname "$copy/src/$target")"
sed -e "s/__Feature__/$name/g" -e "s/__feature__/$package_name/g" \
"$probe_templates/${probe#./}" > "$copy/src/$target"
class_path="${target#*/src/test/java/}"
probe_filters+=(--tests "$(printf '%s' "${class_path%.java}" | tr '/' '.')")
done
done
./gradlew --console=plain :domain-core:test "${probe_filters[@]}"
for name in "${names[@]}"; do
package_name="$(printf '%s' "$name" | tr '[:upper:]' '[:lower:]')"
for probe in "${probes[@]}"; do
require_test_result "$(result_of "$probe" "$name" "$package_name")" "저장소 계약 탐침이"
done
done
echo "feature scaffold 왕복 통과: ${names[*]}"