build: 템플릿 밖에서 혼자 빌드·배포되는 Gradle 루트를 만든다
옮겨 온 메시징 19개 모듈은 템플릿의 src/settings.gradle·build-logic· 카탈로그·registry에 기대고 있어 이 repo만으로는 빌드되지 않는다. repo 루트를 Gradle 루트로 하는 단독 빌드를 만든다. - build-logic/: grpc-library main 2e880c7의 줄인 사본(템플릿 22df3525에서 복사, 템플릿 2959eff0까지의 변경도 같은 내용)에서 gRPC BOM 규칙(ca.grpc-platform-module)만 뺐다. 배포 플러그인 ca.library-publishing과 서명 키 해석(SigningKeys)은 그대로다. 출처·뺀 것·고친 것은 build-logic/UPSTREAM.md. - settings.gradle·build.gradle·gradle.properties: group dev.cakit.messaging, 단계 태스크 ci·mainCheck·releaseCheck와 배포(release·releaseRehearsal·verifySigningKey)는 grpc-library와 같은 모양이다. 메시징만 다른 점: Buf가 없고, 성능 lane이 없고, mainCheck와 releaseCheck가 브로커 인증 증거 게이트 (verifyMessagingCertificationEvidence)를 부른다. 템플릿은 이 게이트를 따로 messaging-certification.yml로 돌렸다. 그 workflow는 지운다. - config/: registry 19행(source_path만 messaging/<leaf>로), 메시징 클래스만 남긴 SpotBugs 제외 목록, 이미지 셋(postgres-16, kafka, toxiproxy, 모두 digest 고정), checkstyle 사본. - gradle/libs.versions.toml: 메시징이 쓰는 항목만(avro, cloudevents, protobuf 4.33.2, toxiproxy, jmh)과 kafka-clients가 끌고 오는 취약 버전을 덮는 pinned-lz4-java·pinned-snappy-java. - 저장소 계약 테스트: MessagingPublicSurfaceContractTest(템플릿 app-bootstrap에서 이력째 옮김)와 새 MessagingSettingsOwnerContractTest (app.messaging 주인은 starter 하나)를 messaging-testkit의 repositoryContractTest lane에 둔다. check에 들어가 PR 단계에서 돈다. - messaging-kafka: 인증 manifest 경로를 새 배치로 고친다. 버린 대안: 계약 테스트를 build-logic 테스트로 두는 안. 빌드 플러그인 시험과 모듈 계약이 섞이고, 소스·build.gradle을 입력으로 선언하는 기존 lane 장치를 쓸 수 없다. 위험: 이 커밋 단독으로는 lockfile을 다시 쓰지 않았다(뒤 커밋에서 desktop에서 쓴다). 패키지는 아직 dev.caskeleton.messaging이다. 검증: desktop ./gradlew projects rc=0(19개 모듈 포함). Refs: design-docs repo-structure/05-library-repos.md 4·10.3·13.1절
This commit is contained in:
+201
@@ -0,0 +1,201 @@
|
||||
package dev.caskeleton.buildlogic.architecture;
|
||||
|
||||
import dev.caskeleton.buildlogic.ModuleRegistry;
|
||||
import java.io.File;
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.TreeSet;
|
||||
import org.gradle.api.Plugin;
|
||||
import org.gradle.api.Project;
|
||||
import org.gradle.api.artifacts.Configuration;
|
||||
import org.gradle.api.artifacts.ProjectDependency;
|
||||
import org.gradle.api.artifacts.result.ResolvedComponentResult;
|
||||
import org.gradle.api.provider.Provider;
|
||||
import org.gradle.api.tasks.SourceSet;
|
||||
import org.gradle.api.tasks.SourceSetContainer;
|
||||
|
||||
public final class ArchitecturePlugin implements Plugin<Project> {
|
||||
private static final List<String> PRODUCTION_DECLARATIONS =
|
||||
List.of("api", "implementation", "compileOnly", "runtimeOnly");
|
||||
/** The registry, relative to the repository root. */
|
||||
public static final String REGISTRY = "config/architecture/modules.json";
|
||||
|
||||
@Override
|
||||
public void apply(Project project) {
|
||||
// One build, rooted at the repository root: the registry is the root's, and every source_path
|
||||
// is relative to it (the template's main build sits in src/, which is why its copy reads the
|
||||
// registry relative to the parent).
|
||||
Project root = project.getRootProject();
|
||||
File repositoryRoot = root.getProjectDir();
|
||||
File registryFile = new File(repositoryRoot, REGISTRY);
|
||||
ModuleRegistry registry = ModuleRegistry.read(registryFile, repositoryRoot);
|
||||
List<ModuleRegistry.Module> modules = registry.modulesForBuild("main");
|
||||
List<String> registryViolations = registryViolations(registry, modules);
|
||||
|
||||
var clean =
|
||||
project
|
||||
.getTasks()
|
||||
.register(
|
||||
"verifyCleanArchitectureDependencies",
|
||||
VerifyCleanArchitectureDependenciesTask.class,
|
||||
task -> {
|
||||
task.setGroup("verification");
|
||||
task.setDescription("Verifies Clean Architecture project dependency direction.");
|
||||
task.getRegistryFile().fileValue(registryFile);
|
||||
task.getRegistryViolations().set(registryViolations);
|
||||
task.getUnregisteredBuildScripts()
|
||||
.set(registry.unregisteredBuildScripts(root.getProjectDir()));
|
||||
});
|
||||
var ignoredSources =
|
||||
project
|
||||
.getTasks()
|
||||
.register(
|
||||
"verifyNoIgnoredSourcePackages",
|
||||
VerifyNoIgnoredSourcePackagesTask.class,
|
||||
task -> {
|
||||
task.setGroup("verification");
|
||||
task.setDescription(
|
||||
"Fails when a Java source file lives in a package that Git ignores or would"
|
||||
+ " ignore.");
|
||||
task.getBuildRoot().set(root.getLayout().getProjectDirectory());
|
||||
});
|
||||
|
||||
project
|
||||
.getGradle()
|
||||
.projectsEvaluated(
|
||||
ignored -> {
|
||||
Set<String> declaredModules = new HashSet<>();
|
||||
root.getSubprojects().stream()
|
||||
.filter(sub -> sub.getChildProjects().isEmpty())
|
||||
.forEach(sub -> declaredModules.add(sub.getPath().replaceFirst("^:", "")));
|
||||
// One task per module, registered in the project that owns the configurations. The
|
||||
// root task used to walk every other project and resolve its `compileClasspath`,
|
||||
// which asks Gradle for state another project holds the lock on — with
|
||||
// `org.gradle.parallel=true` that is a hard failure, and it is why the flag was
|
||||
// turned off instead of the verification moved.
|
||||
List<String> moduleTaskPaths = new ArrayList<>();
|
||||
for (ModuleRegistry.Module module : modules) {
|
||||
Project owner = root.project(module.gradlePath());
|
||||
Set<String> allowed = new HashSet<>();
|
||||
for (String dependencyId : module.allowedDependencies()) {
|
||||
ModuleRegistry.Module dependency = registry.byId(dependencyId);
|
||||
if (dependency != null) {
|
||||
allowed.add(dependency.gradlePath().replaceFirst("^:", ""));
|
||||
}
|
||||
}
|
||||
Set<String> declaredEdges = declaredProjectEdges(owner);
|
||||
Provider<ResolvedComponentResult> compileClasspathRoot =
|
||||
owner
|
||||
.getConfigurations()
|
||||
.getByName("compileClasspath")
|
||||
.getIncoming()
|
||||
.getResolutionResult()
|
||||
.getRootComponent();
|
||||
String moduleName = module.gradlePath().replaceFirst("^:", "");
|
||||
owner
|
||||
.getTasks()
|
||||
.register(
|
||||
"verifyModuleDependencyDirection",
|
||||
VerifyModuleDependencyDirectionTask.class,
|
||||
task -> {
|
||||
task.setGroup("verification");
|
||||
task.setDescription(
|
||||
"Verifies this module's declared and compile-visible project edges"
|
||||
+ " against the architecture registry.");
|
||||
task.getModuleName().set(moduleName);
|
||||
task.getAllowedDependencies().set(allowed);
|
||||
task.getDeclaredProjectEdges().set(declaredEdges);
|
||||
task.getCompileClasspathRoot().set(compileClasspathRoot);
|
||||
});
|
||||
moduleTaskPaths.add(module.gradlePath() + ":verifyModuleDependencyDirection");
|
||||
}
|
||||
clean.configure(
|
||||
task -> {
|
||||
task.getDeclaredModules().set(declaredModules);
|
||||
task.getGovernedModules()
|
||||
.set(
|
||||
modules.stream()
|
||||
.map(module -> module.gradlePath().replaceFirst("^:", ""))
|
||||
.toList());
|
||||
task.dependsOn(moduleTaskPaths);
|
||||
});
|
||||
|
||||
// Every source set of every project — testFixtures, integrationTest, systemTest and
|
||||
// the sample included — because a file Git drops is lost whichever lane owns it.
|
||||
// Directories under a build directory are generated and never committed.
|
||||
List<File> sourceRoots = new ArrayList<>();
|
||||
for (Project sub : root.getSubprojects()) {
|
||||
SourceSetContainer sourceSets =
|
||||
sub.getExtensions().findByType(SourceSetContainer.class);
|
||||
if (sourceSets == null) {
|
||||
continue;
|
||||
}
|
||||
Path buildDirectory = sub.getLayout().getBuildDirectory().get().getAsFile().toPath();
|
||||
for (SourceSet sourceSet : sourceSets) {
|
||||
for (File sourceRoot : sourceSet.getJava().getSrcDirs()) {
|
||||
if (!sourceRoot.toPath().startsWith(buildDirectory)) {
|
||||
sourceRoots.add(sourceRoot);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
ignoredSources.configure(task -> task.getSourceRoots().from(sourceRoots));
|
||||
});
|
||||
|
||||
project
|
||||
.getTasks()
|
||||
.register(
|
||||
"architectureCheck",
|
||||
task -> {
|
||||
task.setGroup("verification");
|
||||
task.setDescription("Runs the build's architecture invariants.");
|
||||
task.dependsOn(clean, ignoredSources);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* This module's declared {@code project(...)} edges, read while the owning project is configured.
|
||||
*
|
||||
* <p>Read here rather than in the task action: a {@link Configuration} cannot be stored in the
|
||||
* configuration cache, and every declaration this reads is final by {@code projectsEvaluated}.
|
||||
*/
|
||||
private static Set<String> declaredProjectEdges(Project owner) {
|
||||
Set<String> edges = new TreeSet<>();
|
||||
for (String name : PRODUCTION_DECLARATIONS) {
|
||||
Configuration configuration = owner.getConfigurations().findByName(name);
|
||||
if (configuration == null) {
|
||||
continue;
|
||||
}
|
||||
configuration
|
||||
.getDependencies()
|
||||
.withType(ProjectDependency.class)
|
||||
.forEach(dependency -> edges.add(dependency.getPath().replaceFirst("^:", "")));
|
||||
}
|
||||
return edges;
|
||||
}
|
||||
|
||||
private static List<String> registryViolations(
|
||||
ModuleRegistry registry, List<ModuleRegistry.Module> modules) {
|
||||
List<String> violations = new ArrayList<>();
|
||||
for (ModuleRegistry.Module module : modules) {
|
||||
for (String dependencyId : module.allowedDependencies()) {
|
||||
if (dependencyId.equals(module.id())) {
|
||||
violations.add("'" + module.id() + "' declares itself as an allowed dependency");
|
||||
continue;
|
||||
}
|
||||
ModuleRegistry.Module dependency = registry.byId(dependencyId);
|
||||
if (dependency == null) {
|
||||
violations.add(
|
||||
"'" + module.id() + "' allows unknown dependency id '" + dependencyId + "'");
|
||||
} else if (!dependency.buildName().equals(module.buildName())) {
|
||||
violations.add(
|
||||
"'" + module.id() + "' allows cross-build dependency id '" + dependencyId + "'");
|
||||
}
|
||||
}
|
||||
}
|
||||
return List.copyOf(violations);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user