Files
clean-architecture-backend-…/build-logic
DongHyeonka bd17bf1f00 fix(env)!: env 계약을 배포 설정 동작에 맞추고 verifyEnvKeys가 그 차이를 잡게 한다
문제: docs/registries/env-keys.yaml·.env.example·배포 설정(profile 밖의
application.yml, config/*.yml, 모듈 module-defaults)이 서로 갈렸고
verifyEnvKeys는 그 차이를 보지 못했다.
- .env.example을 복사하면 기동이 실패하는 값이 있었다:
  APP_DATASOURCE_CONNECTION_TIMEOUT=5s(Hikari long ms, registry 주석이
  "기동 실패"라고 적은 그 값), APP_SECURITY_CORS_MAX_AGE=600s(long 초).
- 기본값과 다른 예시 값: cache·rate-limit Redis command timeout(2s·1s vs
  200ms), APP_LOG_LEVEL_SQL(WARN vs INFO), FORWARD_HEADERS_STRATEGY(native
  vs none — 프록시 없는 배포에서 forwarded 헤더를 믿게 된다),
  POSITIVE_SOFT_TTL(빈 줄 — 빈 문자열이 기본값을 덮는다).
- registry가 폐기(deprecated_orphaned)로 적은 키 셋을 cache-redis 모듈 설정이
  읽는다(COMMAND_TIMEOUT, SEMANTIC_REGION, KEY_HMAC_SECRET 참조).
- 폐기 키 45개가 .env.example에 값과 함께 남아, 복사하면 아무 일도 하지 않는
  값을 켠 것으로 믿는다. 검사가 오히려 registry의 모든 APP_ 행을 예시에
  요구해 폐기 행도 넣게 했다.
- 배포 설정이 읽는 APP_ 밖 placeholder 11개(SECURITY_PUBLIC_PATHS,
  PRESENTATION_API_BASE_PATH, SPRING_JACKSON_DESER_* 등)에 registry 행이
  없었다. 검사가 APP_ 이름만 보고, registry 파서도 APP_ 행만 읽어
  MANAGEMENT_SERVER_ADDRESS 같은 행이 보이지 않았다.
- .env.example 머리말은 "빈 키는 기본값을 쓴다", "Seven values"라고 적었다.

고른 방법: 런타임 동작은 바꾸지 않고 registry와 예시를 배포 설정에 맞춘다.
그리고 verifyEnvKeys가 다섯을 더 본다.
1. registry 행은 접두어와 상관없이 읽는다.
2. 배포 설정의 placeholder는 접두어와 상관없이 행이 있어야 한다.
3. deprecated_orphaned 행은 배포 설정이 읽지 않고 .env.example에 없다.
4. .env.example 값은 registry default(행에 example이 있으면 그 값)와 같다.
   빈 줄은 빈 문자열로 본다.
5. profile 밖 배포 설정의 placeholder 기본값은 registry default와 같다.
registry에 example 칸을 두었다(SMTP 587·timeout처럼 기본값이 아닌 권장값).
APP_ 밖 이름 11개는 지금 이름 그대로 등록했다. 바꾸면 파생 서비스의 배포
env가 소리 없이 무시된다. 이름 변경은 소유자 결정이다. registry 머리말을
실제 규칙(SPRING_·MANAGEMENT_·SERVER_·OTEL_ 이름공간과 옛 이름 둘)으로
고쳤다. gRPC를 켜려면 꼭 두는 APP_GRPC_SERVER_ALLOW_INSECURE_LOCAL과
.env.example의 MANAGEMENT_SERVER_ADDRESS를 더했다.
버린 대안: SECURITY_PUBLIC_PATHS·PRESENTATION_API_BASE_PATH를 APP_로 바꾸고
옛 이름을 fallback으로 두기 — 공개 경로 기본값이 4중 placeholder가 되고
공개 경로 스냅숏 파서까지 바꿔야 한다. 이름 정리는 따로 정한다.

위험·한계: 파생 서비스가 자기 placeholder를 등록하지 않았거나 예시 값이
기본값과 다르면 이제 verifyEnvKeys(mainCheck)가 실패한다(upgrade 안내 5·6).
예시 값이 바뀌어 옛 예시를 복사한 .env는 그대로 둔다 — 안내 1~4가 고칠
값을 적는다.

검증(desktop, --no-build-cache):
- RED: 기준 a7e38c10 + 시험만으로 EnvContractVerifierTest 22건 중 7건 실패
  (새 검사 6건 + 메시지를 바꾼 기존 1건). 새 지킴 시험(example 행 통과)은
  기준에서도 통과.
- GREEN: -p build-logic test, :app-bootstrap:verifyEnvKeys(314 env keys, 6
  required placeholders, 370 rows), :app-bootstrap:test·repositoryContractTest·
  documentContractTest, registry·예시를 읽는 leaf 시험(httpclient env
  manifest, notification mode, redis-runtime required_when, support,
  fileserver·notification platform, graphql registry parity, web CORS)
  682건 실패 0, skip 5. rc=0.

BREAKING CHANGE: verifyEnvKeys가 접두어 밖 placeholder, 폐기 행의 사용,
예시·기본값 차이를 실패로 본다. .env.example에서 폐기 키가 빠지고 값 여덟이
기본값으로 바뀌었다. 할 일은 docs/upgrade/2026-11-round9-env-keys.md.
2026-11-13 01:48:48 +09:00
..

build-logic

이 저장소의 Gradle 규약을 담은 included build다: 아키텍처 핵심, 모든 leaf가 적용하는 규약, 시험 lane 장치 하나. capability 하나에 대한 검사(알림, Mongo, 메시징, GraphQL, JPA)는 여기 없다 — 그것은 그 capability를 가진 leaf의 시험이고, 그 시험이 읽는 파일은 그 시험 태스크의 입력으로 선언한다.

여기 있는 것

플러그인 가지는 것
ca.architecture-registry (settings) 프로젝트 포함, 디렉터리 대응, 다른 모든 읽는 쪽이 같이 쓰는 파싱된 registry
ca.architecture verifyCleanArchitectureDependencies(모듈별 방향), verifyApplicationCoreDependencyPurity(domain-core, shared-contract, application-*), verifyNoIgnoredSourcePackages, architectureCheck
ca.java-conventions Java toolchain·컴파일러 기준, 의존성 잠금, Mockito 시험 agent, leaf별 mainCheck lifecycle, leaf 버전(릴리스 버전만)과 sourceRevision(JavaConventionsPlugin.sourceRevision. 루트 verifyReleaseProvenance가 검사하는 것도 이것이다)
ca.quality-conventions Java leaf가 같이 쓰는 Spotless, Checkstyle, Error Prone, SpotBugs·FindSecBugs 배선
ca.java-library / ca.spring-library / ca.spring-config 평범한 라이브러리와 Spring 라이브러리를 위한 Java·품질 규약의 leaf 단위 조합
ca.platform-module 플랫폼 성격의 Java 라이브러리 leaf(지금 adapter:outbound:httpclient)가 무엇인가: java-library. 이 규약을 쓰던 메시징·gRPC 플랫폼은 2026-11-08에 별도 repo messaging-library·grpc-library로 옮겼다(gRPC BOM 규약 ca.grpc-platform-module도 함께)
ca.strict-test-lane 「이름 댄 시험이 돌았고 건너뛴 것이 없다」를 보는 유일한 장치: tag·이름·자기 source set으로 고른 Test lane이 아무것도 실행하지 않거나, requires 클래스를 빠뜨리거나, (rejectSkipped이면) 무엇이든 건너뛰면 실패한다. performance() lane은 언제나 건너뛰기를 거절하고 performance.assertions.enabled=true로 돈다. 빌드(-P, GRADLE_OPTS)나 lane이 다른 값을 넣으면 시험이 돌기 전에 실패한다. mainStage()는 tag로 고른 lane을 test에서 빼 leaf의 mainCheck로 옮긴다. explicitOnly(reason)는 바깥 입력이 필요한 lane을 모든 묶음 태스크에서 빼고, 묶음 태스크가 그 이유를 출력한다. 시험 source set을 더 두려면 leaf에 Gradle jvm-test-suite suite로 선언한다(testing { suites { … } }). suite 이름을 딴 lane은 그 suite 자신의 Test 태스크를 엄격하게 만들고, ca.java-conventions는 모든 suite에 BOM의 JUnit을 준다
ca.strict-lane-stages (주 빌드의 루트) lane 장치의 나머지 절반: verifyStrictLaneStages --dry-run은 그 빌드의 explicitOnly가 아닌 strict lane이 strictLaneStages에 선언한 단계 태스크 어느 것의 계획에도 없으면 실패한다(계획은 Gradle 자신의 것). 단계마다 그것을 돌리는 workflow job(파일·이벤트·job·옵션·조건)도 선언하고, 그 job이 정해진 한 줄 모양인지 고정 문자열로 본다(build-logic/AGENTS.md 「단계 job의 모양」). 2026-11-08까지 이 자리에 workflow YAML과 bash를 해석하던 판독기(WorkflowGradleInvocations·ShellScript·TaskSelectors)가 있었고, workflow를 셋으로 접으면서 지웠다
ca.redis-topology-lane main.yml의 nightly redis-topology job(scripts/ci/redis-topology.sh)이 돌리는 Redis topology lane(모드 고르기, -P 속성 검증, 모드별 필수 클래스)
ca.api-surface 읽기 전용 공개 API surface 검증과 따로 둔 갱신 태스크. leaf의 check에 배선한다(소유자 결정 20). 다른 leaf의 import를 리뷰한 adopter 부분집합(adopterBaseline)에 묶을 수도 있다
ca.config-contract app-bootstrap의 verifyEnvKeys(지운 build-tools included build에서 옮겼다. 소유자 결정 4가 그 태스크를 app-bootstrap에 둔다)
ca.bootrun-dotenv bootRun의 .env

플러그인이 아니라 평범한 클래스로 둔 것. settings와 project는 플러그인을 서로 다른 방식으로 읽어 들이고, 각각을 부르는 쪽이 둘 이상이기 때문이다:

클래스 가지는 것
dev.caskeleton.buildlogic.ModuleRegistry gradle/modules.json을 읽고 검증하기
dev.caskeleton.buildlogic.RequiredTestExecution 「이 빌드가 이름을 댄 시험은 실제로 돌았어야 한다」는 단 하나의 판정
dev.caskeleton.buildlogic.JavaPublicTypes 공개 최상위 타입. 정규식으로 맞추지 않고 javac로 파싱한다

JMH benchmark는 커뮤니티 플러그인 me.champeau.jmh를 쓴다. ca.quality-conventions는 benchmark와 생성된 코드에서 Error Prone, -Werror, SpotBugs, Checkstyle을 끄기만 한다.

지운 것과 그것을 대신하는 것

지운 것 대신하는 것
ca.runtime-membership 방향 게이트: allowed_dependencies 밖의 것은 조립 루트에 닿을 수 없다
ca.evidence, ca.conditional-transport-qualification, ca.strict-qualification requires + rejectSkipped를 쓴 strictTestLanes lane. 루트 conditionalTransportQualification과 verifyMessagingContracts는 그 lane을 묶기만 한다
ca.dependency-policy leaf 안의 componentSelection 거절 규칙(notification: YAML dataformat, messaging: Jackson 2와 모든 YAML 모듈)과 registry(web-advanced는 허용된 소비자가 없다). rejectAll() 제약도 써 봤지만 실패하지 않는다: Spring의 의존성 관리가 거절한 버전을 덮어쓴다
ca.graphql-platform GraphQL leaf의 graphqlStableTest lane과 GraphQlProductionClassesTest
ca.jpa-test-lanes adapter/outbound/persistence-jpa/build.gradle에 선언한 lane
ca.test-jvm-agents, quarantineTest ca.java-conventions. quarantine 묶음에는 시험이 없었다
ca.jmh-benchmarks me.champeau.jmh
build-tools ca.jpa-evidence, ca.jpa-qualification(+ junit 증거 읽기) 소유자 결정 4: persistence-jpa JpaReadinessRegistryTest, 인용한 시나리오를 모두 요구하고 건너뛰기를 거절하는 readiness lane, src/adapter/outbound/persistence-jpa/release/release-registry.json을 묶는 leaf의 jpaReleaseQualification
build-tools ca.config-contract 바꾸지 않고 여기로 옮겼다
ca.public-path-snapshot app-bootstrap PublicPathSnapshotTest(lane publicPathSnapshotTest, 루트 별칭 verifyPublicPathSnapshot)
ca.archive-hygiene 치울 것이 없다: leaf 버전이 더는 revision을 싣지 않으니 낡은 추적 가능 jar가 생기지 않는다
ca.developer-bootstrap scripts/bootstrap-local.sh
JpaAdopterApiSurfaceTest(persistence-jpa의 정규식 import 검사) ca.api-surface adopterBaseline

규약 시험하기

./gradlew -p build-logic test --console=plain

lane과 registry 규약은 플러그인 소스를 읽는 대신 Gradle TestKit으로 실제 빌드에 대고 시험한다. 중요한 성질 — 아무것도 찾지 못한 lane은 실패한다, lane은 클래스와 lane 정책(rejectSkipped, requires, tag, category)이 바뀌지 않았고 서버를 띄우지 않을 때만 결과를 다시 쓴다, 잘못된 registry는 어떤 프로젝트도 포함하기 전에 거절된다 — 이 스크립트의 글이 아니라 런타임 동작이기 때문이다. 그중 시험 둘은 Gradle 문서를 그대로 읽으면 틀렸기 때문에 있다: tag 필터가 아무것도 맞추지 못할 때 failOnNoDiscoveredTests가 동작하지 않고, 이름을 댄 시험 중 일부만 없을 때 failOnNoMatchingTests가 동작하지 않는다.