diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
index 870e0568ff4..08c8a97a3c1 100644
--- a/buildSrc/build.gradle
+++ b/buildSrc/build.gradle
@@ -25,6 +25,7 @@ ext {
dependencies {
checkstyle "io.spring.javaformat:spring-javaformat-checkstyle:${javaFormatVersion}"
implementation(platform("org.springframework:spring-framework-bom:5.3.15"))
+ implementation("com.tngtech.archunit:archunit:1.0.0")
implementation("com.fasterxml.jackson.core:jackson-databind:2.11.4")
implementation("commons-codec:commons-codec:1.13")
implementation("org.apache.maven:maven-embedder:3.6.2")
@@ -51,6 +52,10 @@ gradlePlugin {
id = "org.springframework.boot.annotation-processor"
implementationClass = "org.springframework.boot.build.processors.AnnotationProcessorPlugin"
}
+ architecturePlugin {
+ id = "org.springframework.boot.architecture"
+ implementationClass = "org.springframework.boot.build.architecture.ArchitecturePlugin"
+ }
autoConfigurationPlugin {
id = "org.springframework.boot.auto-configuration"
implementationClass = "org.springframework.boot.build.autoconfigure.AutoConfigurationPlugin"
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java b/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
index decff985cae..e46d2c4180c 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
@@ -48,6 +48,7 @@ import org.gradle.api.tasks.testing.Test;
import org.gradle.testretry.TestRetryPlugin;
import org.gradle.testretry.TestRetryTaskExtension;
+import org.springframework.boot.build.architecture.ArchitecturePlugin;
import org.springframework.boot.build.classpath.CheckClasspathForProhibitedDependencies;
import org.springframework.boot.build.optional.OptionalDependenciesPlugin;
import org.springframework.boot.build.testing.TestFailuresPlugin;
@@ -61,8 +62,8 @@ import org.springframework.util.StringUtils;
*
* - The project is configured with source and target compatibility of 1.8
*
- {@link SpringJavaFormatPlugin Spring Java Format}, {@link CheckstylePlugin
- * Checkstyle}, {@link TestFailuresPlugin Test Failures}, and {@link TestRetryPlugin Test
- * Retry} plugins are applied
+ * Checkstyle}, {@link TestFailuresPlugin Test Failures}, {@link TestRetryPlugin Test
+ * Retry}, and {@link ArchitecturePlugin Architecture} plugins are applied
*
- {@link Test} tasks are configured:
*
* - to use JUnit Platform
@@ -107,6 +108,7 @@ class JavaConventions {
void apply(Project project) {
project.getPlugins().withType(JavaBasePlugin.class, (java) -> {
project.getPlugins().apply(TestFailuresPlugin.class);
+ project.getPlugins().apply(ArchitecturePlugin.class);
configureSpringJavaFormat(project);
configureJavaConventions(project);
configureJavadocConventions(project);
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitecturePlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitecturePlugin.java
new file mode 100644
index 00000000000..dbb2842d540
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitecturePlugin.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.Task;
+import org.gradle.api.plugins.JavaBasePlugin;
+import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.TaskProvider;
+import org.gradle.language.base.plugins.LifecycleBasePlugin;
+
+import org.springframework.util.StringUtils;
+
+/**
+ * {@link Plugin} for verifying a project's architecture.
+ *
+ * @author Andy Wilkinson
+ */
+public class ArchitecturePlugin implements Plugin {
+
+ @Override
+ public void apply(Project project) {
+ project.getPlugins().withType(JavaBasePlugin.class, (javaPlugin) -> registerTasks(project));
+ }
+
+ private void registerTasks(Project project) {
+ JavaPluginExtension javaPluginExtension = project.getExtensions().getByType(JavaPluginExtension.class);
+ List> packageTangleChecks = new ArrayList<>();
+ for (SourceSet sourceSet : javaPluginExtension.getSourceSets()) {
+ TaskProvider checkPackageTangles = project.getTasks().register(
+ "checkForPackageTangles" + StringUtils.capitalize(sourceSet.getName()), PackageTangleCheck.class,
+ (task) -> {
+ task.setClasses(sourceSet.getOutput().getClassesDirs());
+ task.setDescription("Checks the classes of the " + sourceSet.getName()
+ + " source set for package tangles.");
+ task.setGroup(LifecycleBasePlugin.VERIFICATION_GROUP);
+ });
+ packageTangleChecks.add(checkPackageTangles);
+ }
+ if (!packageTangleChecks.isEmpty()) {
+ TaskProvider checkTask = project.getTasks().named(LifecycleBasePlugin.CHECK_TASK_NAME);
+ checkTask.configure((check) -> check.dependsOn(packageTangleChecks));
+ }
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/architecture/PackageTangleCheck.java b/buildSrc/src/main/java/org/springframework/boot/build/architecture/PackageTangleCheck.java
new file mode 100644
index 00000000000..abfff812c08
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/architecture/PackageTangleCheck.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.StandardOpenOption;
+import java.util.stream.Collectors;
+
+import com.tngtech.archunit.core.domain.JavaClasses;
+import com.tngtech.archunit.core.importer.ClassFileImporter;
+import com.tngtech.archunit.lang.EvaluationResult;
+import com.tngtech.archunit.library.dependencies.SliceRule;
+import com.tngtech.archunit.library.dependencies.SlicesRuleDefinition;
+import org.gradle.api.DefaultTask;
+import org.gradle.api.GradleException;
+import org.gradle.api.Task;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.FileTree;
+import org.gradle.api.tasks.IgnoreEmptyDirectories;
+import org.gradle.api.tasks.InputFiles;
+import org.gradle.api.tasks.Internal;
+import org.gradle.api.tasks.OutputDirectory;
+import org.gradle.api.tasks.PathSensitive;
+import org.gradle.api.tasks.PathSensitivity;
+import org.gradle.api.tasks.SkipWhenEmpty;
+import org.gradle.api.tasks.TaskAction;
+
+import org.springframework.util.FileCopyUtils;
+
+/**
+ * {@link Task} that checks for package tangles.
+ *
+ * @author Andy Wilkinson
+ */
+public abstract class PackageTangleCheck extends DefaultTask {
+
+ private FileCollection classes;
+
+ public PackageTangleCheck() {
+ getOutputDirectory().convention(getProject().getLayout().getBuildDirectory().dir(getName()));
+ }
+
+ @TaskAction
+ void checkForPackageTangles() throws IOException {
+ JavaClasses javaClasses = new ClassFileImporter()
+ .importPaths(this.classes.getFiles().stream().map(File::toPath).collect(Collectors.toList()));
+ SliceRule freeOfCycles = SlicesRuleDefinition.slices().matching("(**)").should().beFreeOfCycles();
+ EvaluationResult result = freeOfCycles.evaluate(javaClasses);
+ File outputFile = getOutputDirectory().file("failure-report.txt").get().getAsFile();
+ outputFile.getParentFile().mkdirs();
+ if (result.hasViolation()) {
+ Files.write(outputFile.toPath(), result.getFailureReport().toString().getBytes(StandardCharsets.UTF_8),
+ StandardOpenOption.CREATE);
+ FileWriter writer = new FileWriter(outputFile);
+ FileCopyUtils.copy(result.getFailureReport().toString(), writer);
+ throw new GradleException("Package tangle check failed. See '" + outputFile + "' for details.");
+ }
+ else {
+ outputFile.createNewFile();
+ }
+ }
+
+ public void setClasses(FileCollection classes) {
+ this.classes = classes;
+ }
+
+ @Internal
+ public FileCollection getClasses() {
+ return this.classes;
+ }
+
+ @InputFiles
+ @SkipWhenEmpty
+ @IgnoreEmptyDirectories
+ @PathSensitive(PathSensitivity.RELATIVE)
+ final FileTree getInputClasses() {
+ return this.classes.getAsFileTree();
+ }
+
+ @OutputDirectory
+ public abstract DirectoryProperty getOutputDirectory();
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/PackageTangleCheckTests.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/PackageTangleCheckTests.java
new file mode 100644
index 00000000000..78133c063d9
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/PackageTangleCheckTests.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.gradle.api.GradleException;
+import org.gradle.api.Project;
+import org.gradle.testfixtures.ProjectBuilder;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
+import org.springframework.util.FileSystemUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+
+/**
+ * Tests for {@link PackageTangleCheck}.
+ *
+ * @author Andy Wilkinson
+ */
+class PackageTangleCheckTests {
+
+ @TempDir
+ File temp;
+
+ @Test
+ void whenPackagesAreTangledTaskFailsAndWritesAReport() throws Exception {
+ prepareTask("tangled", (packageTangleCheck) -> {
+ assertThatExceptionOfType(GradleException.class)
+ .isThrownBy(() -> packageTangleCheck.checkForPackageTangles());
+ assertThat(
+ new File(packageTangleCheck.getProject().getBuildDir(), "checkForPackageTangles/failure-report.txt")
+ .length()).isGreaterThan(0);
+ });
+ }
+
+ @Test
+ void whenPackagesAreNotTangledTaskSucceedsAndWritesAnEmptyReport() throws Exception {
+ prepareTask("untangled", (packageTangleCheck) -> {
+ packageTangleCheck.checkForPackageTangles();
+ assertThat(
+ new File(packageTangleCheck.getProject().getBuildDir(), "checkForPackageTangles/failure-report.txt")
+ .length()).isEqualTo(0);
+ });
+ }
+
+ private void prepareTask(String classes, Callback callback) throws Exception {
+ File projectDir = new File(this.temp, "project");
+ projectDir.mkdirs();
+ copyClasses(classes, projectDir);
+ Project project = ProjectBuilder.builder().withProjectDir(projectDir).build();
+ PackageTangleCheck packageTangleCheck = project.getTasks().create("checkForPackageTangles",
+ PackageTangleCheck.class, (task) -> task.setClasses(project.files("classes")));
+ callback.accept(packageTangleCheck);
+ }
+
+ private void copyClasses(String name, File projectDir) throws IOException {
+ PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
+ Resource root = resolver.getResource("classpath:org/springframework/boot/build/architecture/" + name);
+ FileSystemUtils.copyRecursively(root.getFile(),
+ new File(projectDir, "classes/org/springframework/boot/build/architecture/" + name));
+
+ }
+
+ private interface Callback {
+
+ void accept(T item) throws Exception;
+
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/TangledOne.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/TangledOne.java
new file mode 100644
index 00000000000..3b417723fd3
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/TangledOne.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.tangled;
+
+import org.springframework.boot.build.architecture.tangled.sub.TangledTwo;
+
+public final class TangledOne {
+
+ public static final String ID = TangledTwo.class.getName() + "One";
+
+ private TangledOne() {
+
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/sub/TangledTwo.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/sub/TangledTwo.java
new file mode 100644
index 00000000000..172e9b1e818
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/tangled/sub/TangledTwo.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.tangled.sub;
+
+import org.springframework.boot.build.architecture.tangled.TangledOne;
+
+public final class TangledTwo {
+
+ public static final String ID = TangledOne.ID + "-Two";
+
+ private TangledTwo() {
+
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/UntangledOne.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/UntangledOne.java
new file mode 100644
index 00000000000..04bbd463fc7
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/UntangledOne.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.untangled;
+
+import org.springframework.boot.build.architecture.untangled.sub.UntangledTwo;
+
+public final class UntangledOne {
+
+ public static final String ID = UntangledTwo.class.getName() + "One";
+
+ private UntangledOne() {
+
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/sub/UntangledTwo.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/sub/UntangledTwo.java
new file mode 100644
index 00000000000..8b7afd257b0
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/untangled/sub/UntangledTwo.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.build.architecture.untangled.sub;
+
+public final class UntangledTwo {
+
+ public static final String ID = "Two";
+
+ private UntangledTwo() {
+
+ }
+
+}