diff --git a/README.md b/README.md index cd6a255f..b49fc279 100644 --- a/README.md +++ b/README.md @@ -116,12 +116,15 @@ DB, Redis, Kafka, 알림, 파일 서버 같은 부가 기능(capability)은 `src 이 저장소를 새 서비스의 출발점으로 쓸 때의 순서다. 이 목록이 템플릿 재사용 체크리스트의 정본이다. 1. `settings.gradle`의 `rootProject.name`을 새 서비스 이름으로 바꾼다. -2. 패키지 루트 `dev.caskeleton`을 서비스 패키지로 바꾼다. Java 소스만이 아니라 `AutoConfiguration.imports`·`spring.factories`·빌드 스크립트·설정 파일·생성 명령 템플릿도 이 이름을 쓴다. 바꿀 파일은 이 명령으로 찾는다. +2. 패키지 루트 `dev.caskeleton`을 서비스 패키지로 바꾼다. Java 소스만이 아니라 `AutoConfiguration.imports`·`spring.factories`·빌드 스크립트·설정 파일·생성 명령 템플릿, SpotBugs 제외 목록(`config/spotbugs/`), 루트 `build.gradle`과 build-logic의 `group`, registry와 공개 API 스냅숏(`docs/registries/`, `docs/architecture/`, `docs/notification/api-surface-snapshot.txt`)도 이 이름을 쓴다. 바꿀 파일은 이 명령으로 찾는다. build-logic 자신의 패키지(`dev.caskeleton.buildlogic`)는 앱 패키지가 아니라 그대로 둬도 된다. ```bash - git grep -l 'dev\.caskeleton' -- src scripts + git grep -l -e 'dev\.caskeleton' -- src scripts config build.gradle docs/registries docs/architecture docs/notification + git grep -l -e '"dev\.caskeleton"' -- build-logic/src/main ``` + SpotBugs 목록을 빼먹으면 `qualityCheck`가, 스냅숏을 빼먹으면 각 leaf `check`의 API surface 검사가 실패한다. + 3. `CaSkeletonApplication`을 새 애플리케이션 이름으로 바꾼다. 4. 새 업무 기능은 `scripts/new-feature.sh `으로 만들고 [docs/manual/README.md](docs/manual/README.md) 순서대로 채운다. 모듈 이름과 경계는 그대로 둔다. 5. 쓰는 capability의 `runtimeOnly` 줄만 켠다. 켜지 않은 capability leaf는 산출물에 들어가지 않으니 지우지 않아도 된다. diff --git a/build-logic/src/main/java/dev/caskeleton/buildlogic/apisurface/ApiSurfacePlugin.java b/build-logic/src/main/java/dev/caskeleton/buildlogic/apisurface/ApiSurfacePlugin.java index a022deaa..9f261c36 100644 --- a/build-logic/src/main/java/dev/caskeleton/buildlogic/apisurface/ApiSurfacePlugin.java +++ b/build-logic/src/main/java/dev/caskeleton/buildlogic/apisurface/ApiSurfacePlugin.java @@ -34,10 +34,22 @@ public final class ApiSurfacePlugin implements Plugin { if (extension.getSourceRoot() != null && !extension.getSourceRoot().isBlank()) { sourcePaths.add(extension.getSourceRoot()); } - extension.getAdditionalSourceRoots().stream() - .filter(path -> path != null && !path.isBlank()) - .forEach(sourcePaths::add); - List roots = sourcePaths.stream().map(project::file).toList(); + List additional = + extension.getAdditionalSourceRoots().stream() + .filter(path -> path != null && !path.isBlank()) + .map(project::file) + .toList(); + // A missing additional root used to be skipped without a word, so an approved update + // recorded a surface with a whole module's types gone (2026-11-12 review). + List missing = additional.stream().filter(root -> !root.isDirectory()).toList(); + if (!missing.isEmpty()) { + throw new GradleException( + project.getPath() + + " apiSurface.additionalSourceRoots names a folder that does not exist: " + + missing); + } + List roots = new ArrayList<>(sourcePaths.stream().map(project::file).toList()); + roots.addAll(additional); String verifyTaskName = "verify" + label + "ApiSurface"; String updateTaskName = "update" + label + "ApiSurface"; String approvalProperty = "approve" + label + "ApiSurfaceChange"; diff --git a/build-logic/src/main/java/dev/caskeleton/buildlogic/convention/SpringLibraryConventionPlugin.java b/build-logic/src/main/java/dev/caskeleton/buildlogic/convention/SpringLibraryConventionPlugin.java index f4757d60..46905c75 100644 --- a/build-logic/src/main/java/dev/caskeleton/buildlogic/convention/SpringLibraryConventionPlugin.java +++ b/build-logic/src/main/java/dev/caskeleton/buildlogic/convention/SpringLibraryConventionPlugin.java @@ -3,6 +3,14 @@ package dev.caskeleton.buildlogic.convention; import org.gradle.api.Plugin; import org.gradle.api.Project; +/** + * Quality conventions plus the Spring Boot test starter for a Spring library leaf. + * + *

Only {@code spring-boot-starter-test}. The web MVC test starter (MockMvc, {@code @WebMvcTest}, + * and an embedded Tomcat with them) used to be added to every leaf here, so thirty leaves resolved + * and locked a servlet container for tests that never start one. A leaf whose tests use MockMvc + * declares {@code spring-boot-starter-webmvc-test} in its own build script (2026-11-12 review). + */ public final class SpringLibraryConventionPlugin implements Plugin { @Override public void apply(Project project) { @@ -10,8 +18,5 @@ public final class SpringLibraryConventionPlugin implements Plugin { project .getDependencies() .add("testImplementation", "org.springframework.boot:spring-boot-starter-test"); - project - .getDependencies() - .add("testImplementation", "org.springframework.boot:spring-boot-starter-webmvc-test"); } } diff --git a/build-logic/src/main/java/dev/caskeleton/buildlogic/java/JavaConventionsPlugin.java b/build-logic/src/main/java/dev/caskeleton/buildlogic/java/JavaConventionsPlugin.java index e3cf9012..7b75200e 100644 --- a/build-logic/src/main/java/dev/caskeleton/buildlogic/java/JavaConventionsPlugin.java +++ b/build-logic/src/main/java/dev/caskeleton/buildlogic/java/JavaConventionsPlugin.java @@ -310,7 +310,14 @@ public final class JavaConventionsPlugin implements Plugin { return catalog; } - private static Map containerImages(File catalog) { + /** + * The catalog, refused when an image is not pinned by digest. + * + *

The catalog's header promises digests: a red lane should mean this repository changed, not + * that a registry moved a tag. Two images were tag-only for weeks with a note to pin them later + * (2026-11-12 review), and nothing noticed, so the promise is checked where the file is read. + */ + static Map containerImages(File catalog) { Properties properties = new Properties(); try (var in = Files.newInputStream(catalog.toPath())) { properties.load(in); @@ -319,6 +326,18 @@ public final class JavaConventionsPlugin implements Plugin { } Map images = new TreeMap<>(); properties.stringPropertyNames().forEach(key -> images.put(key, properties.getProperty(key))); + List unpinned = + images.entrySet().stream() + .filter(entry -> !entry.getValue().contains("@sha256:")) + .map(Map.Entry::getKey) + .toList(); + if (!unpinned.isEmpty()) { + throw new GradleException( + catalog.getName() + + ": pin every image by digest (repository@sha256:...), with its tag in a comment;" + + " not pinned: " + + unpinned); + } return Map.copyOf(images); } } diff --git a/build-logic/src/test/java/dev/caskeleton/buildlogic/apisurface/ApiSurfaceConventionTest.java b/build-logic/src/test/java/dev/caskeleton/buildlogic/apisurface/ApiSurfaceConventionTest.java index 06869bc6..ab4550d8 100644 --- a/build-logic/src/test/java/dev/caskeleton/buildlogic/apisurface/ApiSurfaceConventionTest.java +++ b/build-logic/src/test/java/dev/caskeleton/buildlogic/apisurface/ApiSurfaceConventionTest.java @@ -173,6 +173,27 @@ class ApiSurfaceConventionTest { """); } + @Test + @org.junit.jupiter.api.DisplayName("없는 추가 source root는 건너뛰지 않고 그 경로를 짚어 실패한다") + void aMissingAdditionalSourceRootFailsInsteadOfShrinkingTheSurface() throws Exception { + // given + Files.writeString( + projectDir.resolve("build.gradle"), + Files.readString(projectDir.resolve("build.gradle")) + .replace( + "baseline = file('surface.txt')", + "baseline = file('surface.txt')\n additionalSourceRoots = ['../moved/src/main/java']")); + + // when + BuildResult result = + runner("updateFixtureApiSurface", "-PapproveFixtureApiSurfaceChange").buildAndFail(); + + // then + assertTrue( + result.getOutput().contains("additionalSourceRoots names a folder that does not exist"), + result.getOutput()); + } + private void writeConfiguredBuild(String sourceRoot) throws Exception { Files.writeString( projectDir.resolve("build.gradle"), diff --git a/build-logic/src/test/java/dev/caskeleton/buildlogic/java/ContainerImageCatalogTest.java b/build-logic/src/test/java/dev/caskeleton/buildlogic/java/ContainerImageCatalogTest.java new file mode 100644 index 00000000..2c5035c7 --- /dev/null +++ b/build-logic/src/test/java/dev/caskeleton/buildlogic/java/ContainerImageCatalogTest.java @@ -0,0 +1,50 @@ +package dev.caskeleton.buildlogic.java; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.catchThrowable; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import org.gradle.api.GradleException; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +class ContainerImageCatalogTest { + + @Test + @DisplayName("digest 없이 tag만 적은 이미지는 목록을 읽는 단계에서 그 키를 짚어 실패한다") + void aTagOnlyImageFailsNamingItsKey(@TempDir Path directory) throws IOException { + // given + Path catalog = directory.resolve("container-images.properties"); + Files.writeString( + catalog, + "pinned=postgres@sha256:" + + "0".repeat(64) + + "\nfloating=postgres:17-alpine\n"); + + // when + Throwable failure = catchThrowable(() -> JavaConventionsPlugin.containerImages(catalog.toFile())); + + // then + assertThat(failure) + .isInstanceOf(GradleException.class) + .hasMessageEndingWith("not pinned: [floating]"); + } + + @Test + @DisplayName("모든 이미지가 digest로 고정된 목록은 키와 값을 그대로 돌려준다") + void aDigestPinnedCatalogIsReadAsIs(@TempDir Path directory) throws IOException { + // given + Path catalog = directory.resolve("container-images.properties"); + String image = "postgres@sha256:" + "a".repeat(64); + Files.writeString(catalog, "# postgres:17-alpine\npostgres-17=" + image + "\n"); + + // when + var images = JavaConventionsPlugin.containerImages(catalog.toFile()); + + // then + assertThat(images).containsExactly(java.util.Map.entry("postgres-17", image)); + } +} diff --git a/config/spotbugs/exclude.xml b/config/spotbugs/exclude.xml index 99a0419c..2ee07473 100644 --- a/config/spotbugs/exclude.xml +++ b/config/spotbugs/exclude.xml @@ -59,16 +59,6 @@ - - - - - - -