The version of AsciidoctorJ is upgraded to 2.4.3.
- *
An {@code asciidoctorExtensions} configuration is created.
- *
For each {@link AsciidoctorTask} (HTML only):
- *
- *
A task is created to sync the documentation resources to its output directory.
- *
{@code doctype} {@link AsciidoctorTask#options(Map) option} is configured.
- *
The {@code backend} is configured.
- *
- *
For each {@link AbstractAsciidoctorTask} (HTML and PDF):
- *
- *
{@link AsciidoctorTask#attributes(Map) Attributes} are configured to enable
- * warnings for references to missing attributes, the GitHub tag, the Artifactory repo for
- * the current version, etc.
- *
{@link AbstractAsciidoctorTask#baseDirFollowsSourceDir() baseDirFollowsSourceDir()}
- * is enabled.
- *
{@code asciidoctorExtensions} is added to the task's configurations.
- *
- *
- *
- * @author Andy Wilkinson
- * @author Scott Frederick
- */
-class AsciidoctorConventions {
-
- private static final String ASCIIDOCTORJ_VERSION = "2.4.3";
-
- private static final String EXTENSIONS_CONFIGURATION_NAME = "asciidoctorExtensions";
-
- void apply(Project project) {
- project.getPlugins().withType(AsciidoctorJPlugin.class, (asciidoctorPlugin) -> {
- makeAllWarningsFatal(project);
- upgradeAsciidoctorJVersion(project);
- createAsciidoctorExtensionsConfiguration(project);
- project.getTasks()
- .withType(AbstractAsciidoctorTask.class,
- (asciidoctorTask) -> configureAsciidoctorTask(project, asciidoctorTask));
- });
- }
-
- private void makeAllWarningsFatal(Project project) {
- project.getExtensions().getByType(AsciidoctorJExtension.class).fatalWarnings(".*");
- }
-
- private void upgradeAsciidoctorJVersion(Project project) {
- project.getExtensions().getByType(AsciidoctorJExtension.class).setVersion(ASCIIDOCTORJ_VERSION);
- }
-
- private void createAsciidoctorExtensionsConfiguration(Project project) {
- project.getConfigurations().create(EXTENSIONS_CONFIGURATION_NAME, (configuration) -> {
- project.getConfigurations()
- .matching((candidate) -> "dependencyManagement".equals(candidate.getName()))
- .all(configuration::extendsFrom);
- configuration.getDependencies()
- .add(project.getDependencies()
- .create("io.spring.asciidoctor.backends:spring-asciidoctor-backends:0.0.5"));
- configuration.getDependencies()
- .add(project.getDependencies().create("org.asciidoctor:asciidoctorj-pdf:1.5.3"));
- });
- }
-
- private void configureAsciidoctorTask(Project project, AbstractAsciidoctorTask asciidoctorTask) {
- asciidoctorTask.configurations(EXTENSIONS_CONFIGURATION_NAME);
- configureCommonAttributes(project, asciidoctorTask);
- configureOptions(asciidoctorTask);
- configureForkOptions(asciidoctorTask);
- asciidoctorTask.baseDirFollowsSourceDir();
- createSyncDocumentationSourceTask(project, asciidoctorTask);
- if (asciidoctorTask instanceof AsciidoctorTask task) {
- boolean pdf = task.getName().toLowerCase().contains("pdf");
- String backend = (!pdf) ? "spring-html" : "spring-pdf";
- task.outputOptions((outputOptions) -> outputOptions.backends(backend));
- }
- }
-
- private void configureCommonAttributes(Project project, AbstractAsciidoctorTask asciidoctorTask) {
- ArtifactRelease artifacts = ArtifactRelease.forProject(project);
- Map attributes = new HashMap<>();
- attributes.put("attribute-missing", "warn");
- attributes.put("github-tag", determineGitHubTag(project));
- attributes.put("artifact-release-type", artifacts.getType());
- attributes.put("artifact-download-repo", artifacts.getDownloadRepo());
- attributes.put("revnumber", null);
- asciidoctorTask.attributes(attributes);
- }
-
- // See https://github.com/asciidoctor/asciidoctor-gradle-plugin/issues/597
- private void configureForkOptions(AbstractAsciidoctorTask asciidoctorTask) {
- if (JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16)) {
- asciidoctorTask.forkOptions((options) -> options.jvmArgs("--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED",
- "--add-opens", "java.base/java.io=ALL-UNNAMED"));
- }
- }
-
- private String determineGitHubTag(Project project) {
- String version = "v" + project.getVersion();
- return (version.endsWith("-SNAPSHOT")) ? "3.1.x" : version;
- }
-
- private void configureOptions(AbstractAsciidoctorTask asciidoctorTask) {
- asciidoctorTask.options(Collections.singletonMap("doctype", "book"));
- }
-
- private Sync createSyncDocumentationSourceTask(Project project, AbstractAsciidoctorTask asciidoctorTask) {
- Sync syncDocumentationSource = project.getTasks()
- .create("syncDocumentationSourceFor" + StringUtils.capitalize(asciidoctorTask.getName()), Sync.class);
- File syncedSource = new File(project.getBuildDir(), "docs/src/" + asciidoctorTask.getName());
- syncDocumentationSource.setDestinationDir(syncedSource);
- syncDocumentationSource.from("src/docs/");
- asciidoctorTask.dependsOn(syncDocumentationSource);
- asciidoctorTask.getInputs()
- .dir(syncedSource)
- .withPathSensitivity(PathSensitivity.RELATIVE)
- .withPropertyName("synced source");
- asciidoctorTask.setSourceDir(project.relativePath(new File(syncedSource, "asciidoc/")));
- return syncDocumentationSource;
- }
-
-}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java
index 8a50535a4365..8b4769be00e0 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/ConventionsPlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -16,7 +16,7 @@
package org.springframework.boot.build;
-import org.asciidoctor.gradle.jvm.AsciidoctorJPlugin;
+import org.antora.gradle.AntoraPlugin;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.plugins.JavaBasePlugin;
@@ -32,8 +32,8 @@
* When the {@link MavenPublishPlugin} is applied, the conventions in
* {@link MavenPublishingConventions} are applied.
*
- * When the {@link AsciidoctorJPlugin} is applied, the conventions in
- * {@link AsciidoctorConventions} are applied.
+ * When the {@link AntoraPlugin} is applied, the conventions in {@link AntoraConventions}
+ * are applied.
*
* @author Andy Wilkinson
* @author Christoph Dreis
@@ -43,9 +43,10 @@ public class ConventionsPlugin implements Plugin {
@Override
public void apply(Project project) {
+ new NoHttpConventions().apply(project);
new JavaConventions().apply(project);
new MavenPublishingConventions().apply(project);
- new AsciidoctorConventions().apply(project);
+ new AntoraConventions().apply(project);
new KotlinConventions().apply(project);
new WarConventions().apply(project);
new EclipseConventions().apply(project);
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/ExtractResources.java b/buildSrc/src/main/java/org/springframework/boot/build/ExtractResources.java
index 78473cec471f..35e295b4aaf2 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/ExtractResources.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/ExtractResources.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -21,15 +21,13 @@
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
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.provider.ListProperty;
+import org.gradle.api.provider.MapProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
@@ -42,54 +40,30 @@
*
* @author Andy Wilkinson
*/
-public class ExtractResources extends DefaultTask {
+public abstract class ExtractResources extends DefaultTask {
private final PropertyPlaceholderHelper propertyPlaceholderHelper = new PropertyPlaceholderHelper("${", "}");
- private final Map properties = new HashMap<>();
-
- private final DirectoryProperty destinationDirectory;
-
- private List resourceNames = new ArrayList<>();
-
- public ExtractResources() {
- this.destinationDirectory = getProject().getObjects().directoryProperty();
- }
-
@Input
- public List getResourceNames() {
- return this.resourceNames;
- }
-
- public void setResourcesNames(List resourceNames) {
- this.resourceNames = resourceNames;
- }
+ public abstract ListProperty getResourceNames();
@OutputDirectory
- public DirectoryProperty getDestinationDirectory() {
- return this.destinationDirectory;
- }
-
- public void property(String name, String value) {
- this.properties.put(name, value);
- }
+ public abstract DirectoryProperty getDestinationDirectory();
@Input
- public Map getProperties() {
- return this.properties;
- }
+ public abstract MapProperty getProperties();
@TaskAction
void extractResources() throws IOException {
- for (String resourceName : this.resourceNames) {
+ for (String resourceName : getResourceNames().get()) {
InputStream resourceStream = getClass().getClassLoader().getResourceAsStream(resourceName);
if (resourceStream == null) {
throw new GradleException("Resource '" + resourceName + "' does not exist");
}
String resource = FileCopyUtils.copyToString(new InputStreamReader(resourceStream, StandardCharsets.UTF_8));
- resource = this.propertyPlaceholderHelper.replacePlaceholders(resource, this.properties::get);
+ resource = this.propertyPlaceholderHelper.replacePlaceholders(resource, getProperties().get()::get);
FileCopyUtils.copy(resource,
- new FileWriter(this.destinationDirectory.file(resourceName).get().getAsFile()));
+ new FileWriter(getDestinationDirectory().file(resourceName).get().getAsFile()));
}
}
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 fc59efaec9b2..e5ce6df4244f 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
@@ -129,8 +129,8 @@ private void configureJarManifestConventions(Project project) {
ExtractResources extractLegalResources = project.getTasks()
.create("extractLegalResources", ExtractResources.class);
extractLegalResources.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("legal"));
- extractLegalResources.setResourcesNames(Arrays.asList("LICENSE.txt", "NOTICE.txt"));
- extractLegalResources.property("version", project.getVersion().toString());
+ extractLegalResources.getResourceNames().set(Arrays.asList("LICENSE.txt", "NOTICE.txt"));
+ extractLegalResources.getProperties().put("version", project.getVersion().toString());
SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
Set sourceJarTaskNames = sourceSets.stream()
.map(SourceSet::getSourcesJarTaskName)
@@ -261,8 +261,9 @@ private void configureDependencyManagement(Project project) {
configuration.setCanBeResolved(false);
});
configurations
- .matching((configuration) -> configuration.getName().endsWith("Classpath")
+ .matching((configuration) -> (configuration.getName().endsWith("Classpath")
|| JavaPlugin.ANNOTATION_PROCESSOR_CONFIGURATION_NAME.equals(configuration.getName()))
+ && (!configuration.getName().contains("dokkatoo")))
.all((configuration) -> configuration.extendsFrom(dependencyManagement));
Dependency springBootParent = project.getDependencies()
.enforcedPlatform(project.getDependencies()
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java b/buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java
index c5e896160b47..9975dcfca550 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -16,10 +16,15 @@
package org.springframework.boot.build;
+import java.net.URI;
import java.util.ArrayList;
import java.util.List;
+import dev.adamko.dokkatoo.DokkatooExtension;
+import dev.adamko.dokkatoo.formats.DokkatooHtmlPlugin;
import org.gradle.api.Project;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
import org.jetbrains.kotlin.gradle.dsl.KotlinJvmOptions;
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile;
@@ -44,9 +49,10 @@
class KotlinConventions {
void apply(Project project) {
- project.getPlugins()
- .withId("org.jetbrains.kotlin.jvm",
- (plugin) -> project.getTasks().withType(KotlinCompile.class, this::configure));
+ project.getPlugins().withId("org.jetbrains.kotlin.jvm", (plugin) -> {
+ project.getTasks().withType(KotlinCompile.class, this::configure);
+ configureDokkatoo(project);
+ });
}
private void configure(KotlinCompile compile) {
@@ -60,4 +66,27 @@ private void configure(KotlinCompile compile) {
compile.getKotlinOptions().setFreeCompilerArgs(freeCompilerArgs);
}
+ private void configureDokkatoo(Project project) {
+ project.getPlugins().apply(DokkatooHtmlPlugin.class);
+ DokkatooExtension dokkatoo = project.getExtensions().getByType(DokkatooExtension.class);
+ dokkatoo.getDokkatooSourceSets().named(SourceSet.MAIN_SOURCE_SET_NAME).configure((sourceSet) -> {
+ sourceSet.getSourceRoots().setFrom(project.file("src/main/kotlin"));
+ sourceSet.getClasspath()
+ .from(project.getExtensions()
+ .getByType(SourceSetContainer.class)
+ .getByName(SourceSet.MAIN_SOURCE_SET_NAME)
+ .getOutput());
+ sourceSet.getExternalDocumentationLinks().create("spring-boot-javadoc", (link) -> {
+ link.getUrl().set(URI.create("https://docs.spring.io/spring-boot/api/java/"));
+ link.getPackageListUrl().set(URI.create("https://docs.spring.io/spring-boot/api/java/element-list"));
+ });
+ sourceSet.getExternalDocumentationLinks().create("spring-framework-javadoc", (link) -> {
+ String url = "https://docs.spring.io/spring-framework/docs/%s/javadoc-api/"
+ .formatted(project.property("springFrameworkVersion"));
+ link.getUrl().set(URI.create(url));
+ link.getPackageListUrl().set(URI.create(url + "/element-list"));
+ });
+ });
+ }
+
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/MavenPublishingConventions.java b/buildSrc/src/main/java/org/springframework/boot/build/MavenPublishingConventions.java
index fc1f5cb357dc..53ddea4f2edf 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/MavenPublishingConventions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/MavenPublishingConventions.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -19,8 +19,6 @@
import org.apache.maven.artifact.repository.MavenArtifactRepository;
import org.gradle.api.Project;
import org.gradle.api.attributes.Usage;
-import org.gradle.api.component.AdhocComponentWithVariants;
-import org.gradle.api.component.ConfigurationVariantDetails;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginExtension;
import org.gradle.api.publish.PublishingExtension;
@@ -83,7 +81,6 @@ private void customizeMavenPublication(MavenPublication publication, Project pro
project.getPlugins()
.withType(JavaPlugin.class)
.all((javaPlugin) -> customizeJavaMavenPublication(publication, project));
- suppressMavenOptionalFeatureWarnings(publication);
}
private void customizePom(MavenPom pom, Project project) {
@@ -102,34 +99,12 @@ private void customizePom(MavenPom pom, Project project) {
}
private void customizeJavaMavenPublication(MavenPublication publication, Project project) {
- addMavenOptionalFeature(project);
publication.versionMapping((strategy) -> strategy.usage(Usage.JAVA_API, (mappingStrategy) -> mappingStrategy
.fromResolutionOf(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME)));
publication.versionMapping(
(strategy) -> strategy.usage(Usage.JAVA_RUNTIME, VariantVersionMappingStrategy::fromResolutionResult));
}
- /**
- * Add a feature that allows maven plugins to declare optional dependencies that
- * appear in the POM. This is required to make m2e in Eclipse happy.
- * @param project the project to add the feature to
- */
- private void addMavenOptionalFeature(Project project) {
- JavaPluginExtension extension = project.getExtensions().getByType(JavaPluginExtension.class);
- extension.registerFeature("mavenOptional",
- (feature) -> feature.usingSourceSet(extension.getSourceSets().getByName("main")));
- AdhocComponentWithVariants javaComponent = (AdhocComponentWithVariants) project.getComponents()
- .findByName("java");
- javaComponent.addVariantsFromConfiguration(
- project.getConfigurations().findByName("mavenOptionalRuntimeElements"),
- ConfigurationVariantDetails::mapToOptional);
- }
-
- private void suppressMavenOptionalFeatureWarnings(MavenPublication publication) {
- publication.suppressPomMetadataWarningsFor("mavenOptionalApiElements");
- publication.suppressPomMetadataWarningsFor("mavenOptionalRuntimeElements");
- }
-
private void customizeOrganization(MavenPomOrganization organization) {
organization.getName().set("VMware, Inc.");
organization.getUrl().set("https://spring.io");
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/NoHttpConventions.java b/buildSrc/src/main/java/org/springframework/boot/build/NoHttpConventions.java
new file mode 100644
index 000000000000..7b4847ff2aec
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/NoHttpConventions.java
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2012-2024 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;
+
+import io.spring.nohttp.gradle.NoHttpCheckstylePlugin;
+import io.spring.nohttp.gradle.NoHttpExtension;
+import org.gradle.api.Project;
+import org.gradle.api.file.ConfigurableFileTree;
+import org.gradle.api.plugins.quality.Checkstyle;
+
+/**
+ * Conventions that are applied to enforce that no HTTP urls are used.
+ *
+ * @author Phillip Webb
+ */
+public class NoHttpConventions {
+
+ void apply(Project project) {
+ project.getPluginManager().apply(NoHttpCheckstylePlugin.class);
+ configureNoHttpExtension(project, project.getExtensions().getByType(NoHttpExtension.class));
+ project.getTasks()
+ .named(NoHttpCheckstylePlugin.CHECKSTYLE_NOHTTP_TASK_NAME, Checkstyle.class)
+ .configure((task) -> task.getConfigDirectory().set(project.getRootProject().file("src/nohttp")));
+ }
+
+ private void configureNoHttpExtension(Project project, NoHttpExtension extension) {
+ extension.setAllowlistFile(project.getRootProject().file("src/nohttp/allowlist.lines"));
+ ConfigurableFileTree source = extension.getSource();
+ source.exclude("bin/**");
+ source.exclude("build/**");
+ source.exclude("out/**");
+ source.exclude("target/**");
+ source.exclude(".settings/**");
+ source.exclude(".classpath");
+ source.exclude(".project");
+ source.exclude(".gradle");
+ source.exclude("**/docker/export.tar");
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java b/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java
index 5a863d221a74..ae318adf0f84 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2021-2023 the original author or authors.
+ * Copyright 2021-2024 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.
@@ -18,7 +18,6 @@
import org.gradle.api.DefaultTask;
import org.gradle.api.file.DirectoryProperty;
-import org.gradle.api.model.ObjectFactory;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputDirectory;
@@ -31,45 +30,29 @@
*
* @author Andy Wilkinson
*/
-public class SyncAppSource extends DefaultTask {
+public abstract class SyncAppSource extends DefaultTask {
- private final DirectoryProperty sourceDirectory;
+ public SyncAppSource() {
+ getPluginVersion().convention(getProject().provider(() -> getProject().getVersion().toString()));
+ }
- private final DirectoryProperty destinationDirectory;
+ @InputDirectory
+ public abstract DirectoryProperty getSourceDirectory();
- private final Property pluginVersion;
+ @OutputDirectory
+ public abstract DirectoryProperty getDestinationDirectory();
- public SyncAppSource() {
- ObjectFactory objects = getProject().getObjects();
- this.sourceDirectory = objects.directoryProperty();
- this.destinationDirectory = objects.directoryProperty();
- this.pluginVersion = objects.property(String.class)
- .convention(getProject().provider(() -> getProject().getVersion().toString()));
- }
+ @Input
+ public abstract Property getPluginVersion();
@TaskAction
void syncAppSources() {
getProject().sync((copySpec) -> {
- copySpec.from(this.sourceDirectory);
- copySpec.into(this.destinationDirectory);
+ copySpec.from(getSourceDirectory());
+ copySpec.into(getDestinationDirectory());
copySpec.filter((line) -> line.replace("id \"org.springframework.boot\"",
"id \"org.springframework.boot\" version \"" + getProject().getVersion() + "\""));
});
}
- @InputDirectory
- public DirectoryProperty getSourceDirectory() {
- return this.sourceDirectory;
- }
-
- @OutputDirectory
- public DirectoryProperty getDestinationDirectory() {
- return this.destinationDirectory;
- }
-
- @Input
- public Property getPluginVersion() {
- return this.pluginVersion;
- }
-
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java
new file mode 100644
index 000000000000..3d5bec724ae7
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java
@@ -0,0 +1,162 @@
+/*
+ * Copyright 2012-2024 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.antora;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+
+import org.gradle.api.Project;
+
+import org.springframework.boot.build.artifacts.ArtifactRelease;
+import org.springframework.boot.build.bom.BomExtension;
+import org.springframework.boot.build.bom.Library;
+import org.springframework.util.Assert;
+
+/**
+ * Generates Asciidoctor attributes for use with Antora.
+ *
+ * @author Phillip Webb
+ */
+public class AntoraAsciidocAttributes {
+
+ private static final String DASH_SNAPSHOT = "-SNAPSHOT";
+
+ private final String version;
+
+ private final boolean latestVersion;
+
+ private final ArtifactRelease artifactRelease;
+
+ private final List libraries;
+
+ private final Map dependencyVersions;
+
+ private final Map projectProperties;
+
+ public AntoraAsciidocAttributes(Project project, BomExtension dependencyBom,
+ Map dependencyVersions) {
+ this.version = String.valueOf(project.getVersion());
+ this.latestVersion = Boolean.parseBoolean(String.valueOf(project.findProperty("latestVersion")));
+ this.artifactRelease = ArtifactRelease.forProject(project);
+ this.libraries = dependencyBom.getLibraries();
+ this.dependencyVersions = dependencyVersions;
+ this.projectProperties = project.getProperties();
+ }
+
+ AntoraAsciidocAttributes(String version, boolean latestVersion, List libraries,
+ Map dependencyVersions, Map projectProperties) {
+ this.version = version;
+ this.latestVersion = latestVersion;
+ this.artifactRelease = ArtifactRelease.forVersion(version);
+ this.libraries = (libraries != null) ? libraries : Collections.emptyList();
+ this.dependencyVersions = (dependencyVersions != null) ? dependencyVersions : Collections.emptyMap();
+ this.projectProperties = (projectProperties != null) ? projectProperties : Collections.emptyMap();
+ }
+
+ public Map get() {
+ Map attributes = new LinkedHashMap<>();
+ addGitHubAttributes(attributes);
+ addVersionAttributes(attributes);
+ addUrlArtifactRepository(attributes);
+ addUrlLibraryLinkAttributes(attributes);
+ addPropertyAttributes(attributes);
+ return attributes;
+ }
+
+ private void addGitHubAttributes(Map attributes) {
+ attributes.put("github-repo", "spring-projects/spring-boot");
+ attributes.put("github-ref", determineGitHubRef());
+ }
+
+ private String determineGitHubRef() {
+ int snapshotIndex = this.version.lastIndexOf(DASH_SNAPSHOT);
+ if (snapshotIndex == -1) {
+ return "v" + this.version;
+ }
+ if (this.latestVersion) {
+ return "main";
+ }
+ String versionRoot = this.version.substring(0, snapshotIndex);
+ int lastDot = versionRoot.lastIndexOf('.');
+ return versionRoot.substring(0, lastDot) + ".x";
+ }
+
+ private void addVersionAttributes(Map attributes) {
+ this.libraries.forEach((library) -> {
+ String name = "version-" + library.getLinkRootName();
+ String value = library.getVersion().toString();
+ attributes.put(name, value);
+ });
+ attributes.put("version-native-build-tools", (String) this.projectProperties.get("nativeBuildToolsVersion"));
+ attributes.put("version-graal", (String) this.projectProperties.get("graalVersion"));
+ addSpringDataDependencyVersion(attributes, "spring-data-commons");
+ addSpringDataDependencyVersion(attributes, "spring-data-couchbase");
+ addSpringDataDependencyVersion(attributes, "spring-data-elasticsearch");
+ addSpringDataDependencyVersion(attributes, "spring-data-jdbc");
+ addSpringDataDependencyVersion(attributes, "spring-data-jpa");
+ addSpringDataDependencyVersion(attributes, "spring-data-mongodb");
+ addSpringDataDependencyVersion(attributes, "spring-data-neo4j");
+ addSpringDataDependencyVersion(attributes, "spring-data-r2dbc");
+ addSpringDataDependencyVersion(attributes, "spring-data-rest", "spring-data-rest-core");
+ }
+
+ private void addSpringDataDependencyVersion(Map attributes, String artifactId) {
+ addSpringDataDependencyVersion(attributes, artifactId, artifactId);
+ }
+
+ private void addSpringDataDependencyVersion(Map attributes, String name, String artifactId) {
+ String version = this.dependencyVersions.get("org.springframework.data:" + artifactId);
+ Assert.notNull(version, () -> "No version found for Spring Data artifact " + artifactId);
+ attributes.put("version-" + name, version);
+ }
+
+ private void addUrlArtifactRepository(Map attributes) {
+ attributes.put("url-artifact-repository", this.artifactRelease.getDownloadRepo());
+ }
+
+ private void addUrlLibraryLinkAttributes(Map attributes) {
+ this.libraries.forEach((library) -> {
+ String prefix = "url-" + library.getLinkRootName() + "-";
+ library.getLinks().forEach((name, link) -> attributes.put(prefix + name, link));
+ });
+ }
+
+ private void addPropertyAttributes(Map attributes) {
+ Properties properties = new Properties() {
+
+ @Override
+ public synchronized Object put(Object key, Object value) {
+ // Put directly because order is important for us
+ return attributes.put(key.toString(), value.toString());
+ }
+
+ };
+ try (InputStream in = getClass().getResourceAsStream("antora-asciidoc-attributes.properties")) {
+ properties.load(in);
+ }
+ catch (IOException ex) {
+ throw new UncheckedIOException(ex);
+ }
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java
new file mode 100644
index 000000000000..8234edfea98a
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/Extensions.java
@@ -0,0 +1,190 @@
+/*
+ * Copyright 2012-2024 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.antora;
+
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.function.Consumer;
+import java.util.stream.Stream;
+
+/**
+ * Antora and Asciidoc extensions used by Spring Boot.
+ *
+ * @author Phillip Webb
+ */
+public final class Extensions {
+
+ private static final String ROOT_COMPONENT_EXTENSION = "@springio/antora-extensions/root-component-extension";
+
+ private static final List antora;
+ static {
+ List extensions = new ArrayList<>();
+ extensions.add(new Extension("@springio/antora-extensions", ROOT_COMPONENT_EXTENSION,
+ "@springio/antora-extensions/static-page-extension",
+ "@springio/antora-extensions/override-navigation-builder-extension"));
+ extensions.add(new Extension("@springio/antora-xref-extension"));
+ extensions.add(new Extension("@springio/antora-zip-contents-collector-extension"));
+ antora = List.copyOf(extensions);
+ }
+
+ private static final List asciidoc;
+ static {
+ List extensions = new ArrayList<>();
+ extensions.add(new Extension("@asciidoctor/tabs"));
+ extensions.add(new Extension("@springio/asciidoctor-extensions", "@springio/asciidoctor-extensions",
+ "@springio/asciidoctor-extensions/configuration-properties-extension",
+ "@springio/asciidoctor-extensions/section-ids-extension"));
+ asciidoc = List.copyOf(extensions);
+ }
+
+ private static final Map localOverrides = Collections.emptyMap();
+
+ private Extensions() {
+ }
+
+ static List> antora(Consumer extensions) {
+ AntoraExtensionsConfiguration result = new AntoraExtensionsConfiguration(
+ antora.stream().flatMap(Extension::names).sorted().toList());
+ extensions.accept(result);
+ return result.config();
+ }
+
+ static List asciidoc() {
+ return asciidoc.stream().flatMap(Extension::names).sorted().toList();
+ }
+
+ private record Extension(String name, String... includeNames) {
+
+ Stream names() {
+ return (this.includeNames.length != 0) ? Arrays.stream(this.includeNames) : Stream.of(this.name);
+ }
+
+ }
+
+ static final class AntoraExtensionsConfiguration {
+
+ private Map> extensions = new TreeMap<>();
+
+ private AntoraExtensionsConfiguration(List names) {
+ names.forEach((name) -> this.extensions.put(name, null));
+ }
+
+ void xref(Consumer xref) {
+ xref.accept(new Xref());
+ }
+
+ void zipContentsCollector(Consumer zipContentsCollector) {
+ zipContentsCollector.accept(new ZipContentsCollector());
+ }
+
+ void rootComponent(Consumer rootComponent) {
+ rootComponent.accept(new RootComponent());
+ }
+
+ List> config() {
+ List> config = new ArrayList<>();
+ Map> orderedExtensions = new LinkedHashMap<>(this.extensions);
+ // The root component extension must be last
+ Map rootComponentConfig = orderedExtensions.remove(ROOT_COMPONENT_EXTENSION);
+ orderedExtensions.put(ROOT_COMPONENT_EXTENSION, rootComponentConfig);
+ orderedExtensions.forEach((name, customizations) -> {
+ Map extensionConfig = new LinkedHashMap<>();
+ extensionConfig.put("require", localOverrides.getOrDefault(name, name));
+ if (customizations != null) {
+ extensionConfig.putAll(customizations);
+ }
+ config.add(extensionConfig);
+ });
+ return List.copyOf(config);
+ }
+
+ abstract class Customizer {
+
+ private final String name;
+
+ Customizer(String name) {
+ this.name = name;
+ }
+
+ protected void customize(String key, Object value) {
+ AntoraExtensionsConfiguration.this.extensions.computeIfAbsent(this.name, (name) -> new TreeMap<>())
+ .put(key, value);
+ }
+
+ }
+
+ class Xref extends Customizer {
+
+ Xref() {
+ super("@springio/antora-xref-extension");
+ }
+
+ void stub(List stub) {
+ if (stub != null && !stub.isEmpty()) {
+ customize("stub", stub);
+ }
+ }
+
+ }
+
+ class ZipContentsCollector extends Customizer {
+
+ ZipContentsCollector() {
+ super("@springio/antora-zip-contents-collector-extension");
+ }
+
+ void versionFile(String versionFile) {
+ customize("version_file", versionFile);
+ }
+
+ void locations(Path... locations) {
+ locations(Arrays.stream(locations).map(Path::toString).toList());
+ }
+
+ private void locations(List locations) {
+ customize("locations", locations);
+ }
+
+ void alwaysInclude(Map alwaysInclude) {
+ if (alwaysInclude != null && !alwaysInclude.isEmpty()) {
+ customize("always_include", List.of(new TreeMap<>(alwaysInclude)));
+ }
+ }
+
+ }
+
+ class RootComponent extends Customizer {
+
+ RootComponent() {
+ super(ROOT_COMPONENT_EXTENSION);
+ }
+
+ void name(String name) {
+ customize("root_component_name", name);
+ }
+
+ }
+
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java
new file mode 100644
index 000000000000..f5dd4d80936e
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/GenerateAntoraPlaybook.java
@@ -0,0 +1,209 @@
+/*
+ * Copyright 2012-2024 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.antora;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.gradle.api.DefaultTask;
+import org.gradle.api.Project;
+import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.artifacts.ProjectDependency;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.Optional;
+import org.gradle.api.tasks.OutputFile;
+import org.gradle.api.tasks.TaskAction;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.Yaml;
+
+/**
+ * Task to generate a local Antora playbook.
+ *
+ * @author Phillip Webb
+ */
+public abstract class GenerateAntoraPlaybook extends DefaultTask {
+
+ private static final String ANTORA_SOURCE_DIR = "src/docs/antora";
+
+ private static final String GENERATED_DOCS = "build/generated/docs/";
+
+ @OutputFile
+ public abstract RegularFileProperty getOutputFile();
+
+ @Input
+ public abstract Property getContentSourceConfiguration();
+
+ @Input
+ @Optional
+ public abstract ListProperty getXrefStubs();
+
+ @Input
+ @Optional
+ public abstract MapProperty getAlwaysInclude();
+
+ public GenerateAntoraPlaybook() {
+ setGroup("Documentation");
+ setDescription("Generates an Antora playbook.yml file for local use");
+ getOutputFile().convention(getProject().getLayout()
+ .getBuildDirectory()
+ .file("generated/docs/antora-playbook/antora-playbook.yml"));
+ getContentSourceConfiguration().convention("antoraContent");
+ }
+
+ @TaskAction
+ public void writePlaybookYml() throws IOException {
+ File file = getOutputFile().get().getAsFile();
+ file.getParentFile().mkdirs();
+ try (FileWriter out = new FileWriter(file)) {
+ createYaml().dump(getData(), out);
+ }
+ }
+
+ @Input
+ final Map getData() throws IOException {
+ Map data = loadPlaybookTemplate();
+ addExtensions(data);
+ addSources(data);
+ addDir(data);
+ return data;
+ }
+
+ @SuppressWarnings("unchecked")
+ private Map loadPlaybookTemplate() throws IOException {
+ try (InputStream resource = getClass().getResourceAsStream("antora-playbook-template.yml")) {
+ return createYaml().loadAs(resource, LinkedHashMap.class);
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private void addExtensions(Map data) {
+ Map antora = (Map) data.get("antora");
+ antora.put("extensions", Extensions.antora((extensions) -> {
+ extensions.xref((xref) -> xref.stub(getXrefStubs().getOrElse(Collections.emptyList())));
+ extensions.zipContentsCollector((zipContentsCollector) -> {
+ zipContentsCollector.versionFile("gradle.properties");
+ String locationName = getProject().getName() + "-${version}-${name}-${classifier}.zip";
+ Path antoraContent = getRelativeProjectPath()
+ .resolve(GENERATED_DOCS + "antora-content/" + locationName);
+ Path antoraDependencies = getRelativeProjectPath()
+ .resolve(GENERATED_DOCS + "antora-dependencies-content/" + locationName);
+ zipContentsCollector.locations(antoraContent, antoraDependencies);
+ zipContentsCollector.alwaysInclude(getAlwaysInclude().getOrNull());
+ });
+ extensions.rootComponent((rootComponent) -> rootComponent.name("boot"));
+ }));
+ Map asciidoc = (Map) data.get("asciidoc");
+ asciidoc.put("extensions", Extensions.asciidoc());
+ }
+
+ private void addSources(Map data) {
+ List> contentSources = getList(data, "content.sources");
+ contentSources.add(createContentSource());
+ }
+
+ private Map createContentSource() {
+ Map source = new LinkedHashMap<>();
+ Path playbookPath = getOutputFile().get().getAsFile().toPath().getParent();
+ Path antoraSrc = getProjectPath(getProject()).resolve(ANTORA_SOURCE_DIR);
+ StringBuilder url = new StringBuilder(".");
+ relativizeFromRootProject(playbookPath).normalize().forEach((path) -> url.append(File.separator).append(".."));
+ source.put("url", url.toString());
+ source.put("branches", "HEAD");
+ source.put("version", getProject().getVersion().toString());
+ Set startPaths = new LinkedHashSet<>();
+ addAntoraContentStartPaths(startPaths);
+ startPaths.add(relativizeFromRootProject(antoraSrc).toString());
+ source.put("start_paths", startPaths.stream().toList());
+ return source;
+ }
+
+ private void addAntoraContentStartPaths(Set startPaths) {
+ Configuration configuration = getProject().getConfigurations().findByName("antoraContent");
+ if (configuration != null) {
+ for (ProjectDependency dependency : configuration.getAllDependencies().withType(ProjectDependency.class)) {
+ Path path = dependency.getDependencyProject().getProjectDir().toPath();
+ startPaths.add(relativizeFromRootProject(path).resolve(ANTORA_SOURCE_DIR).toString());
+ }
+ }
+ }
+
+ private void addDir(Map data) {
+ Path playbookDir = toRealPath(getOutputFile().get().getAsFile().toPath()).getParent();
+ Path outputDir = toRealPath(getProject().getBuildDir().toPath().resolve("site"));
+ data.put("output", Map.of("dir", "." + File.separator + playbookDir.relativize(outputDir).toString()));
+ }
+
+ @SuppressWarnings("unchecked")
+ private List getList(Map data, String location) {
+ return (List) get(data, location);
+ }
+
+ @SuppressWarnings("unchecked")
+ private Object get(Map data, String location) {
+ Object result = data;
+ String[] keys = location.split("\\.");
+ for (String key : keys) {
+ result = ((Map) result).get(key);
+ }
+ return result;
+ }
+
+ private Yaml createYaml() {
+ DumperOptions options = new DumperOptions();
+ options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
+ options.setPrettyFlow(true);
+ return new Yaml(options);
+ }
+
+ private Path getRelativeProjectPath() {
+ return relativizeFromRootProject(getProjectPath(getProject()));
+ }
+
+ private Path relativizeFromRootProject(Path subPath) {
+ Path rootProjectPath = getProjectPath(getProject().getRootProject());
+ return rootProjectPath.relativize(subPath).normalize();
+ }
+
+ private Path getProjectPath(Project project) {
+ return toRealPath(project.getProjectDir().toPath());
+ }
+
+ private Path toRealPath(Path path) {
+ try {
+ return Files.exists(path) ? path.toRealPath() : path;
+ }
+ catch (IOException ex) {
+ throw new UncheckedIOException(ex);
+ }
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java b/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java
index d671304708db..c36d46a67502 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2022-2023 the original author or authors.
+ * Copyright 2022-2024 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.
@@ -26,12 +26,16 @@
import java.util.stream.Collectors;
import com.tngtech.archunit.base.DescribedPredicate;
+import com.tngtech.archunit.core.domain.JavaCall;
import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.core.domain.JavaClass.Predicates;
import com.tngtech.archunit.core.domain.JavaClasses;
import com.tngtech.archunit.core.domain.JavaMethod;
import com.tngtech.archunit.core.domain.JavaParameter;
import com.tngtech.archunit.core.domain.properties.CanBeAnnotated;
+import com.tngtech.archunit.core.domain.properties.HasName;
+import com.tngtech.archunit.core.domain.properties.HasOwner.Predicates.With;
+import com.tngtech.archunit.core.domain.properties.HasParameterTypes;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.lang.ArchCondition;
import com.tngtech.archunit.lang.ArchRule;
@@ -58,11 +62,14 @@
import org.gradle.api.tasks.SkipWhenEmpty;
import org.gradle.api.tasks.TaskAction;
+import org.springframework.util.ResourceUtils;
+
/**
* {@link Task} that checks for architecture problems.
*
* @author Andy Wilkinson
* @author Yanming Zhou
+ * @author Scott Frederick
*/
public abstract class ArchitectureCheck extends DefaultTask {
@@ -75,7 +82,8 @@ public ArchitectureCheck() {
allBeanFactoryPostProcessorBeanMethodsShouldBeStaticAndHaveNoParameters(),
noClassesShouldCallStepVerifierStepVerifyComplete(),
noClassesShouldConfigureDefaultStepVerifierTimeout(), noClassesShouldCallCollectorsToList(),
- noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding());
+ noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding(),
+ noClassesShouldLoadResourcesUsingResourceUtils());
getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
}
@@ -208,6 +216,18 @@ private ArchRule noClassesShouldCallURLDecoderWithStringEncoding() {
.because("java.net.URLDecoder.decode(String s, Charset charset) should be used instead");
}
+ private ArchRule noClassesShouldLoadResourcesUsingResourceUtils() {
+ return ArchRuleDefinition.noClasses()
+ .should()
+ .callMethodWhere(JavaCall.Predicates.target(With.owner(Predicates.type(ResourceUtils.class)))
+ .and(JavaCall.Predicates.target(HasName.Predicates.name("getURL")))
+ .and(JavaCall.Predicates.target(HasParameterTypes.Predicates.rawParameterTypes(String.class)))
+ .or(JavaCall.Predicates.target(With.owner(Predicates.type(ResourceUtils.class)))
+ .and(JavaCall.Predicates.target(HasName.Predicates.name("getFile")))
+ .and(JavaCall.Predicates.target(HasParameterTypes.Predicates.rawParameterTypes(String.class)))))
+ .because("org.springframework.boot.io.ApplicationResourceLoader should be used instead");
+ }
+
public void setClasses(FileCollection classes) {
this.classes = classes;
}
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
index afeaf6311700..4c73e021df27 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitecturePlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitecturePlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -51,6 +51,7 @@ private void registerTasks(Project project) {
(task) -> {
task.setClasses(sourceSet.getOutput().getClassesDirs());
task.getResourcesDirectory().set(sourceSet.getOutput().getResourcesDir());
+ task.dependsOn(sourceSet.getProcessResourcesTaskName());
task.setDescription("Checks the architecture of the classes of the " + sourceSet.getName()
+ " source set.");
task.setGroup(LifecycleBasePlugin.VERIFICATION_GROUP);
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/artifacts/ArtifactRelease.java b/buildSrc/src/main/java/org/springframework/boot/build/artifacts/ArtifactRelease.java
index 3cf861543b0b..a0def21d15e5 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/artifacts/ArtifactRelease.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/artifacts/ArtifactRelease.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -26,24 +26,18 @@
*/
public final class ArtifactRelease {
- private static final String SNAPSHOT = "snapshot";
-
- private static final String MILESTONE = "milestone";
-
- private static final String RELEASE = "release";
-
private static final String SPRING_REPO = "https://repo.spring.io/%s";
private static final String MAVEN_REPO = "https://repo.maven.apache.org/maven2";
- private final String type;
+ private final Type type;
- private ArtifactRelease(String type) {
+ private ArtifactRelease(Type type) {
this.type = type;
}
public String getType() {
- return this.type;
+ return this.type.toString().toLowerCase();
}
public String getDownloadRepo() {
@@ -51,24 +45,34 @@ public String getDownloadRepo() {
}
public boolean isRelease() {
- return RELEASE.equals(this.type);
+ return this.type == Type.RELEASE;
}
public static ArtifactRelease forProject(Project project) {
- return new ArtifactRelease(determineReleaseType(project));
+ return forVersion(project.getVersion().toString());
}
- private static String determineReleaseType(Project project) {
- String version = project.getVersion().toString();
- int modifierIndex = version.lastIndexOf('-');
- if (modifierIndex == -1) {
- return RELEASE;
- }
- String type = version.substring(modifierIndex + 1);
- if (type.startsWith("M") || type.startsWith("RC")) {
- return MILESTONE;
+ public static ArtifactRelease forVersion(String version) {
+ return new ArtifactRelease(Type.forVersion(version));
+ }
+
+ enum Type {
+
+ SNAPSHOT, MILESTONE, RELEASE;
+
+ static Type forVersion(String version) {
+ int modifierIndex = version.lastIndexOf('-');
+ if (modifierIndex == -1) {
+ return RELEASE;
+ }
+ String type = version.substring(modifierIndex + 1);
+ if (type.startsWith("M") || type.startsWith("RC")) {
+ return MILESTONE;
+ }
+ return SNAPSHOT;
+
}
- return SNAPSHOT;
+
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationMetadata.java b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationMetadata.java
index 751ca0b87521..bf24d219dd25 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationMetadata.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationMetadata.java
@@ -28,11 +28,15 @@
import java.util.List;
import java.util.Properties;
import java.util.Set;
-import java.util.concurrent.Callable;
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
+import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.tasks.Classpath;
+import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.OutputFile;
+import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.TaskAction;
@@ -48,47 +52,45 @@
* @author Andy Wilkinson
* @author Scott Frederick
*/
-public class AutoConfigurationMetadata extends DefaultTask {
+public abstract class AutoConfigurationMetadata extends DefaultTask {
private static final String COMMENT_START = "#";
private final String moduleName;
- private SourceSet sourceSet;
-
- private File outputFile;
+ private FileCollection classesDirectories;
public AutoConfigurationMetadata() {
- getInputs()
- .file((Callable) () -> new File(this.sourceSet.getOutput().getResourcesDir(),
- "META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"))
- .withPathSensitivity(PathSensitivity.RELATIVE)
- .withPropertyName("org.springframework.boot.autoconfigure.AutoConfiguration");
-
- dependsOn((Callable) () -> this.sourceSet.getProcessResourcesTaskName());
getProject().getConfigurations()
.maybeCreate(AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME);
this.moduleName = getProject().getName();
}
public void setSourceSet(SourceSet sourceSet) {
- this.sourceSet = sourceSet;
+ getAutoConfigurationImports().set(new File(sourceSet.getOutput().getResourcesDir(),
+ "META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports"));
+ this.classesDirectories = sourceSet.getOutput().getClassesDirs();
+ dependsOn(sourceSet.getOutput());
}
+ @InputFile
+ @PathSensitive(PathSensitivity.RELATIVE)
+ abstract RegularFileProperty getAutoConfigurationImports();
+
@OutputFile
- public File getOutputFile() {
- return this.outputFile;
- }
+ public abstract RegularFileProperty getOutputFile();
- public void setOutputFile(File outputFile) {
- this.outputFile = outputFile;
+ @Classpath
+ FileCollection getClassesDirectories() {
+ return this.classesDirectories;
}
@TaskAction
void documentAutoConfiguration() throws IOException {
Properties autoConfiguration = readAutoConfiguration();
- getOutputFile().getParentFile().mkdirs();
- try (FileWriter writer = new FileWriter(getOutputFile())) {
+ File outputFile = getOutputFile().get().getAsFile();
+ outputFile.getParentFile().mkdirs();
+ try (FileWriter writer = new FileWriter(outputFile)) {
autoConfiguration.store(writer, null);
}
}
@@ -120,8 +122,7 @@ private Properties readAutoConfiguration() throws IOException {
* @return auto-configurations
*/
private List readAutoConfigurationsFile() throws IOException {
- File file = new File(this.sourceSet.getOutput().getResourcesDir(),
- "META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports");
+ File file = getAutoConfigurationImports().getAsFile().get();
if (!file.exists()) {
return Collections.emptyList();
}
@@ -140,7 +141,7 @@ private String stripComment(String line) {
private File findClassFile(String className) {
String classFileName = className.replace(".", "/") + ".class";
- for (File classesDir : this.sourceSet.getOutput().getClassesDirs()) {
+ for (File classesDir : this.classesDirectories) {
File classFile = new File(classesDir, classFileName);
if (classFile.isFile()) {
return classFile;
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationPlugin.java
index eaaadf3b9474..97f36eb2c46c 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationPlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationPlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -22,7 +22,6 @@
import java.nio.file.Path;
import java.util.Collections;
import java.util.List;
-import java.util.concurrent.Callable;
import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.lang.ArchCondition;
@@ -94,10 +93,9 @@ public void apply(Project project) {
.getByName(SourceSet.MAIN_SOURCE_SET_NAME);
task.setSourceSet(main);
task.dependsOn(main.getClassesTaskName());
- task.setOutputFile(new File(project.getBuildDir(), "auto-configuration-metadata.properties"));
+ task.getOutputFile().set(new File(project.getBuildDir(), "auto-configuration-metadata.properties"));
project.getArtifacts()
- .add(AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME,
- project.provider((Callable) task::getOutputFile),
+ .add(AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME, task.getOutputFile(),
(artifact) -> artifact.builtBy(task));
});
project.getPlugins().withType(ArchitecturePlugin.class, (architecturePlugin) -> {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/DocumentAutoConfigurationClasses.java b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/DocumentAutoConfigurationClasses.java
index ce8fbc414619..3eb1a4b36c1b 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/DocumentAutoConfigurationClasses.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/DocumentAutoConfigurationClasses.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -31,6 +31,7 @@
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
@@ -42,12 +43,10 @@
*
* @author Andy Wilkinson
*/
-public class DocumentAutoConfigurationClasses extends DefaultTask {
+public abstract class DocumentAutoConfigurationClasses extends DefaultTask {
private FileCollection autoConfiguration;
- private File outputDir;
-
@InputFiles
public FileCollection getAutoConfiguration() {
return this.autoConfiguration;
@@ -58,13 +57,7 @@ public void setAutoConfiguration(FileCollection autoConfiguration) {
}
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract RegularFileProperty getOutputDir();
@TaskAction
void documentAutoConfigurationClasses() throws IOException {
@@ -80,18 +73,19 @@ void documentAutoConfigurationClasses() throws IOException {
}
private void writeTable(AutoConfiguration autoConfigurationClasses) throws IOException {
- this.outputDir.mkdirs();
+ File outputDir = getOutputDir().getAsFile().get();
+ outputDir.mkdirs();
try (PrintWriter writer = new PrintWriter(
- new FileWriter(new File(this.outputDir, autoConfigurationClasses.module + ".adoc")))) {
+ new FileWriter(new File(outputDir, autoConfigurationClasses.module + ".adoc")))) {
writer.println("[cols=\"4,1\"]");
writer.println("|===");
writer.println("| Configuration Class | Links");
for (AutoConfigurationClass autoConfigurationClass : autoConfigurationClasses.classes) {
writer.println();
- writer.printf("| {spring-boot-code}/spring-boot-project/%s/src/main/java/%s.java[`%s`]%n",
+ writer.printf("| {code-spring-boot}/spring-boot-project/%s/src/main/java/%s.java[`%s`]%n",
autoConfigurationClasses.module, autoConfigurationClass.path, autoConfigurationClass.name);
- writer.printf("| {spring-boot-api}/%s.html[javadoc]%n", autoConfigurationClass.path);
+ writer.printf("| xref:api:java/%s.html[javadoc]%n", autoConfigurationClass.path);
}
writer.println("|===");
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java
index 57d0935c52db..59bc52845431 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java
@@ -26,6 +26,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
+import java.util.function.Function;
import javax.inject.Inject;
import javax.xml.parsers.DocumentBuilderFactory;
@@ -66,11 +67,14 @@
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
import org.springframework.boot.build.mavenplugin.MavenExec;
import org.springframework.util.FileCopyUtils;
+import org.springframework.util.PropertyPlaceholderHelper;
+import org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver;
/**
* DSL extensions for {@link BomPlugin}.
*
* @author Andy Wilkinson
+ * @author Phillip Webb
*/
public class BomExtension {
@@ -121,7 +125,8 @@ public void library(String name, String version, Action action)
: null;
addLibrary(new Library(name, libraryHandler.calendarName, libraryVersion, libraryHandler.groups,
libraryHandler.prohibitedVersions, libraryHandler.considerSnapshots, versionAlignment,
- libraryHandler.alignWith.dependencyManagementDeclaredIn));
+ libraryHandler.alignWith.dependencyManagementDeclaredIn, libraryHandler.linkRootName,
+ libraryHandler.links));
}
public void effectiveBomArtifact() {
@@ -149,7 +154,7 @@ public void effectiveBomArtifact() {
}
MavenExec generateEffectiveBom = this.project.getTasks()
.create("generateEffectiveBom", MavenExec.class);
- generateEffectiveBom.setProjectDir(generatedBomDir);
+ generateEffectiveBom.getProjectDir().set(generatedBomDir);
File effectiveBom = new File(this.project.getBuildDir(),
"generated/effective-bom/" + this.project.getName() + "-effective-bom.xml");
generateEffectiveBom.args("--settings", "settings.xml", "help:effective-pom",
@@ -229,6 +234,10 @@ public static class LibraryHandler {
private String calendarName;
+ private String linkRootName;
+
+ private final Map> links = new HashMap<>();
+
@Inject
public LibraryHandler(Project project, String version) {
this.version = version;
@@ -265,6 +274,17 @@ public void alignWith(Action action) {
action.execute(this.alignWith);
}
+ public void links(Action action) {
+ links(null, action);
+ }
+
+ public void links(String linkRootName, Action action) {
+ LinksHandler handler = new LinksHandler();
+ action.execute(handler);
+ this.linkRootName = linkRootName;
+ this.links.putAll(handler.links);
+ }
+
public static class ProhibitedHandler {
private String reason;
@@ -417,6 +437,67 @@ public void managedBy(String managedBy) {
}
+ public static class LinksHandler {
+
+ private final Map> links = new HashMap<>();
+
+ public void site(String linkTemplate) {
+ site(asFactory(linkTemplate));
+ }
+
+ public void site(Function linkFactory) {
+ add("site", linkFactory);
+ }
+
+ public void github(String linkTemplate) {
+ github(asFactory(linkTemplate));
+ }
+
+ public void github(Function linkFactory) {
+ add("github", linkFactory);
+ }
+
+ public void docs(String linkTemplate) {
+ docs(asFactory(linkTemplate));
+ }
+
+ public void docs(Function linkFactory) {
+ add("docs", linkFactory);
+ }
+
+ public void javadoc(String linkTemplate) {
+ javadoc(asFactory(linkTemplate));
+ }
+
+ public void javadoc(Function linkFactory) {
+ add("javadoc", linkFactory);
+ }
+
+ public void releaseNotes(String linkTemplate) {
+ releaseNotes(asFactory(linkTemplate));
+ }
+
+ public void releaseNotes(Function linkFactory) {
+ add("releaseNotes", linkFactory);
+ }
+
+ public void add(String name, String linkTemplate) {
+ add(name, asFactory(linkTemplate));
+ }
+
+ public void add(String name, Function linkFactory) {
+ this.links.put(name, linkFactory);
+ }
+
+ private Function asFactory(String linkTemplate) {
+ return (version) -> {
+ PlaceholderResolver resolver = (name) -> "version".equals(name) ? version.toString() : null;
+ return new PropertyPlaceholderHelper("{", "}").replacePlaceholders(linkTemplate, resolver);
+ };
+ }
+
+ }
+
public static class UpgradeHandler {
private UpgradePolicy upgradePolicy;
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/BomPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/BomPlugin.java
index 6cbd5ae787b5..07474bd79b79 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/BomPlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/BomPlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -66,8 +66,8 @@ public void apply(Project project) {
project.getTasks().named("check").configure((check) -> check.dependsOn(checkBom));
project.getTasks().create("bomrUpgrade", UpgradeBom.class, bom);
project.getTasks().create("moveToSnapshots", MoveToSnapshots.class, bom);
+ project.getTasks().register("checkLinks", CheckLinks.class, bom);
new PublishingCustomizer(project, bom).customize();
-
}
private void createApiEnforcedConfiguration(Project project) {
@@ -291,9 +291,7 @@ private boolean isNodeWithName(Object candidate, String name) {
if ((node.name() instanceof QName qname) && name.equals(qname.getLocalPart())) {
return true;
}
- if (name.equals(node.name())) {
- return true;
- }
+ return name.equals(node.name());
}
return false;
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckBom.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckBom.java
index f600097b3d52..fb3f6e962215 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckBom.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckBom.java
@@ -45,7 +45,7 @@
*
* @author Andy Wilkinson
*/
-public class CheckBom extends DefaultTask {
+public abstract class CheckBom extends DefaultTask {
private final BomExtension bom;
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckLinks.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckLinks.java
new file mode 100644
index 000000000000..ca5a71b187d9
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/CheckLinks.java
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2012-2024 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.bom;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+
+import javax.inject.Inject;
+
+import org.apache.hc.client5.http.config.RequestConfig;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.client5.http.impl.classic.HttpClients;
+import org.gradle.api.DefaultTask;
+import org.gradle.api.tasks.TaskAction;
+import org.gradle.internal.impldep.org.apache.http.client.config.CookieSpecs;
+
+import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.client.ClientHttpResponse;
+import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
+import org.springframework.web.client.DefaultResponseErrorHandler;
+import org.springframework.web.client.RestTemplate;
+
+/**
+ * Task to check that links are working.
+ *
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ */
+public abstract class CheckLinks extends DefaultTask {
+
+ private final BomExtension bom;
+
+ @Inject
+ public CheckLinks(BomExtension bom) {
+ this.bom = bom;
+ }
+
+ @TaskAction
+ void releaseNotes() {
+ RequestConfig config = RequestConfig.custom().setCookieSpec(CookieSpecs.IGNORE_COOKIES).build();
+ CloseableHttpClient httpClient = HttpClients.custom().setDefaultRequestConfig(config).build();
+ HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
+ RestTemplate restTemplate = new RestTemplate(requestFactory);
+ restTemplate.setErrorHandler(new IgnoringErrorHandler());
+ for (Library library : this.bom.getLibraries()) {
+ library.getLinks().forEach((name, link) -> {
+ URI uri;
+ try {
+ uri = new URI(link);
+ ResponseEntity response = restTemplate.exchange(uri, HttpMethod.HEAD, null, String.class);
+ System.out.println("[%3d] %s - %s (%s)".formatted(response.getStatusCode().value(),
+ library.getName(), name, uri));
+ }
+ catch (URISyntaxException ex) {
+ throw new RuntimeException(ex);
+ }
+ });
+ }
+ }
+
+ static class IgnoringErrorHandler extends DefaultResponseErrorHandler {
+
+ @Override
+ public void handleError(ClientHttpResponse response) throws IOException {
+ }
+
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/Library.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/Library.java
index b1f66f2b1d19..4a0928c0c997 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/Library.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/Library.java
@@ -17,6 +17,7 @@
package org.springframework.boot.build.bom;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
@@ -24,13 +25,14 @@
import java.util.Locale;
import java.util.Map;
import java.util.Set;
+import java.util.TreeMap;
+import java.util.function.Function;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.artifact.versioning.VersionRange;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.Dependency;
-import org.gradle.api.artifacts.dsl.DependencyHandler;
import org.gradle.api.artifacts.result.DependencyResult;
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
@@ -61,6 +63,10 @@ public class Library {
private final String alignsWithBom;
+ private final String linkRootName;
+
+ private final Map> links;
+
/**
* Create a new {@code Library} with the given {@code name}, {@code version}, and
* {@code groups}.
@@ -73,11 +79,14 @@ public class Library {
* @param considerSnapshots whether to consider snapshots
* @param versionAlignment version alignment, if any, for the library
* @param alignsWithBom the coordinates of the bom, if any, that this library should
- * inline
+ * align with
+ * @param linkRootName the root name to use when generating link variable or
+ * {@code null} to generate one based on the library {@code name}
+ * @param links a list of HTTP links relevant to the library
*/
public Library(String name, String calendarName, LibraryVersion version, List groups,
List prohibitedVersions, boolean considerSnapshots, VersionAlignment versionAlignment,
- String alignsWithBom) {
+ String alignsWithBom, String linkRootName, Map> links) {
this.name = name;
this.calendarName = (calendarName != null) ? calendarName : name;
this.version = version;
@@ -88,6 +97,12 @@ public Library(String name, String calendarName, LibraryVersion version, List getLinks() {
+ Map links = new TreeMap<>();
+ this.links.forEach((name, linkFactory) -> links.put(name, linkFactory.apply(this.version)));
+ return Collections.unmodifiableMap(links);
+ }
+
/**
* A version or range of versions that are prohibited from being used in a bom.
*/
@@ -194,6 +219,44 @@ public DependencyVersion getVersion() {
return this.version;
}
+ public int[] componentInts() {
+ return Arrays.stream(parts()).mapToInt(Integer::parseInt).toArray();
+ }
+
+ public String major() {
+ return parts()[0];
+ }
+
+ public String minor() {
+ return parts()[1];
+ }
+
+ public String patch() {
+ return parts()[2];
+ }
+
+ @Override
+ public String toString() {
+ return this.version.toString();
+ }
+
+ public String toString(String separator) {
+ return this.version.toString().replace(".", separator);
+ }
+
+ public String forAntora() {
+ String[] parts = parts();
+ String result = parts[0] + "." + parts[1];
+ if (toString().endsWith("SNAPSHOT")) {
+ result += "-SNAPSHOT";
+ }
+ return result;
+ }
+
+ private String[] parts() {
+ return toString().split("[.-]");
+ }
+
}
/**
@@ -334,17 +397,10 @@ public static class VersionAlignment {
}
public Set resolve() {
- if (this.managedBy == null) {
- throw new IllegalStateException("Version alignment without managedBy is not supported");
- }
if (this.alignedVersions != null) {
return this.alignedVersions;
}
- Library managingLibrary = this.libraries.stream()
- .filter((candidate) -> this.managedBy.equals(candidate.getName()))
- .findFirst()
- .orElseThrow(() -> new IllegalStateException("Managing library '" + this.managedBy + "' not found."));
- Map versions = resolveAligningDependencies(managingLibrary);
+ Map versions = resolveAligningDependencies();
Set versionsInLibrary = new HashSet<>();
for (Group group : this.groups) {
for (Module module : group.getModules()) {
@@ -364,18 +420,8 @@ public Set resolve() {
return this.alignedVersions;
}
- private Map resolveAligningDependencies(Library manager) {
- DependencyHandler dependencyHandler = this.project.getDependencies();
- List boms = manager.getGroups()
- .stream()
- .flatMap((group) -> group.getBoms()
- .stream()
- .map((bom) -> dependencyHandler
- .platform(group.getId() + ":" + bom + ":" + manager.getVersion().getVersion())))
- .toList();
- List dependencies = new ArrayList<>();
- dependencies.addAll(boms);
- dependencies.add(dependencyHandler.create(this.from));
+ private Map resolveAligningDependencies() {
+ List dependencies = getAligningDependencies();
Configuration alignmentConfiguration = this.project.getConfigurations()
.detachedConfiguration(dependencies.toArray(new Dependency[0]));
Map versions = new HashMap<>();
@@ -388,6 +434,58 @@ private Map resolveAligningDependencies(Library manager) {
return versions;
}
+ private List getAligningDependencies() {
+ if (this.managedBy == null) {
+ Library fromLibrary = findFromLibrary();
+ return List
+ .of(this.project.getDependencies().create(this.from + ":" + fromLibrary.getVersion().getVersion()));
+ }
+ else {
+ Library managingLibrary = findManagingLibrary();
+ List boms = getBomDependencies(managingLibrary);
+ List dependencies = new ArrayList<>();
+ dependencies.addAll(boms);
+ dependencies.add(this.project.getDependencies().create(this.from));
+ return dependencies;
+ }
+ }
+
+ private Library findFromLibrary() {
+ for (Library library : this.libraries) {
+ for (Group group : library.getGroups()) {
+ for (Module module : group.getModules()) {
+ if (this.from.equals(group.getId() + ":" + module.getName())) {
+ return library;
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ private Library findManagingLibrary() {
+ if (this.managedBy == null) {
+ return null;
+ }
+ return this.libraries.stream()
+ .filter((candidate) -> this.managedBy.equals(candidate.getName()))
+ .findFirst()
+ .orElseThrow(() -> new IllegalStateException("Managing library '" + this.managedBy + "' not found."));
+ }
+
+ private List getBomDependencies(Library manager) {
+ if (manager == null) {
+ return Collections.emptyList();
+ }
+ return manager.getGroups()
+ .stream()
+ .flatMap((group) -> group.getBoms()
+ .stream()
+ .map((bom) -> this.project.getDependencies()
+ .platform(group.getId() + ":" + bom + ":" + manager.getVersion().getVersion())))
+ .toList();
+ }
+
String getFrom() {
return this.from;
}
@@ -398,7 +496,11 @@ String getManagedBy() {
@Override
public String toString() {
- return "version from dependencies of " + this.from + " that is managed by " + this.managedBy;
+ String result = "version from dependencies of " + this.from;
+ if (this.managedBy != null) {
+ result += " that is managed by " + this.managedBy;
+ }
+ return result;
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/UpgradePolicy.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/UpgradePolicy.java
index e9d72393965f..340c29a7a1c6 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/UpgradePolicy.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/UpgradePolicy.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -35,12 +35,12 @@ public enum UpgradePolicy implements BiPredicate candidate.isSameMajor(current)),
+ SAME_MAJOR_VERSION(DependencyVersion::isSameMajor),
/**
* Patch versions of the current minor version.
*/
- SAME_MINOR_VERSION((candidate, current) -> candidate.isSameMinor(current));
+ SAME_MINOR_VERSION(DependencyVersion::isSameMinor);
private final BiPredicate delegate;
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/StandardLibraryUpdateResolver.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/StandardLibraryUpdateResolver.java
index 517bf262a3a9..f5ffd02cac42 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/StandardLibraryUpdateResolver.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/StandardLibraryUpdateResolver.java
@@ -19,14 +19,12 @@
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
-import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.function.BiPredicate;
-import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -113,19 +111,14 @@ private List determineResolvedVersionOptions(Library library) {
getLaterVersionsForModule(group.getId(), plugin, library));
}
}
- List allVersions = moduleVersions.values()
+ return moduleVersions.values()
.stream()
.flatMap(SortedSet::stream)
.distinct()
.filter((dependencyVersion) -> this.predicate.test(library, dependencyVersion))
- .toList();
- if (allVersions.isEmpty()) {
- return Collections.emptyList();
- }
- return allVersions.stream()
- .map((version) -> new VersionOption.ResolvedVersionOption(version,
+ .map((version) -> (VersionOption) new VersionOption.ResolvedVersionOption(version,
getMissingModules(moduleVersions, version)))
- .collect(Collectors.toList());
+ .toList();
}
private List getMissingModules(Map> moduleVersions,
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/UpgradeDependencies.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/UpgradeDependencies.java
index 04934445cd87..19e897cb823d 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/UpgradeDependencies.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/UpgradeDependencies.java
@@ -169,8 +169,9 @@ private List verifyLabels(GitHubRepository repository) {
if (!availableLabels.containsAll(issueLabels)) {
List unknownLabels = new ArrayList<>(issueLabels);
unknownLabels.removeAll(availableLabels);
+ String suffix = (unknownLabels.size() == 1) ? "" : "s";
throw new InvalidUserDataException(
- "Unknown label(s): " + StringUtils.collectionToCommaDelimitedString(unknownLabels));
+ "Unknown label" + suffix + ": " + StringUtils.collectionToCommaDelimitedString(unknownLabels));
}
return issueLabels;
}
@@ -193,7 +194,7 @@ private Milestone determineMilestone(GitHubRepository repository) {
java.util.Optional matchingMilestone = milestones.stream()
.filter((milestone) -> milestone.getName().equals(getMilestone().get()))
.findFirst();
- if (!matchingMilestone.isPresent()) {
+ if (matchingMilestone.isEmpty()) {
throw new InvalidUserDataException("Unknown milestone: " + getMilestone().get());
}
return matchingMilestone.get();
@@ -241,9 +242,9 @@ private boolean isAnUpgrade(Library library, DependencyVersion candidate) {
}
private boolean isNotProhibited(Library library, DependencyVersion candidate) {
- return !library.getProhibitedVersions()
+ return library.getProhibitedVersions()
.stream()
- .anyMatch((prohibited) -> prohibited.isProhibited(candidate.toString()));
+ .noneMatch((prohibited) -> prohibited.isProhibited(candidate.toString()));
}
private List matchingLibraries() {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/AbstractDependencyVersion.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/AbstractDependencyVersion.java
index ffb119efa9cc..c602347ef97c 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/AbstractDependencyVersion.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/AbstractDependencyVersion.java
@@ -57,10 +57,7 @@ public boolean equals(Object obj) {
return false;
}
AbstractDependencyVersion other = (AbstractDependencyVersion) obj;
- if (!this.comparableVersion.equals(other.comparableVersion)) {
- return false;
- }
- return true;
+ return this.comparableVersion.equals(other.comparableVersion);
}
@Override
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ArtifactVersionDependencyVersion.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ArtifactVersionDependencyVersion.java
index 61e1d761e201..9986c12add4c 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ArtifactVersionDependencyVersion.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ArtifactVersionDependencyVersion.java
@@ -81,6 +81,9 @@ private boolean isSameMinor(ArtifactVersionDependencyVersion other) {
@Override
public boolean isUpgrade(DependencyVersion candidate, boolean movingToSnapshots) {
+ if (candidate instanceof MultipleComponentsDependencyVersion) {
+ return super.isUpgrade(candidate, movingToSnapshots);
+ }
if (!(candidate instanceof ArtifactVersionDependencyVersion)) {
return false;
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/DependencyVersion.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/DependencyVersion.java
index f4b9b897a1ba..d82d5b8a50f5 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/DependencyVersion.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/DependencyVersion.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -48,7 +48,7 @@ public interface DependencyVersion extends Comparable {
* Returns whether the given {@code candidate} is an upgrade of this version.
* @param candidate the version to consider
* @param movingToSnapshots whether the upgrade is to be considered as part of moving
- * to snaphots
+ * to snapshots
* @return {@code true} if the candidate is an upgrade, otherwise false
*/
boolean isUpgrade(DependencyVersion candidate, boolean movingToSnapshots);
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ReleaseTrainDependencyVersion.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ReleaseTrainDependencyVersion.java
index c9c79bcdc69b..e43c1b05d9de 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ReleaseTrainDependencyVersion.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/version/ReleaseTrainDependencyVersion.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -64,22 +64,25 @@ public int compareTo(DependencyVersion other) {
@Override
public boolean isUpgrade(DependencyVersion candidate, boolean movingToSnapshots) {
- if (!(candidate instanceof ReleaseTrainDependencyVersion)) {
- return true;
+ if (candidate instanceof ReleaseTrainDependencyVersion candidateReleaseTrain) {
+ return isUpgrade(candidateReleaseTrain, movingToSnapshots);
}
- ReleaseTrainDependencyVersion candidateReleaseTrain = (ReleaseTrainDependencyVersion) candidate;
- int comparison = this.releaseTrain.compareTo(candidateReleaseTrain.releaseTrain);
+ return true;
+ }
+
+ private boolean isUpgrade(ReleaseTrainDependencyVersion candidate, boolean movingToSnapshots) {
+ int comparison = this.releaseTrain.compareTo(candidate.releaseTrain);
if (comparison != 0) {
return comparison < 0;
}
- if (movingToSnapshots && !isSnapshot() && candidateReleaseTrain.isSnapshot()) {
+ if (movingToSnapshots && !isSnapshot() && candidate.isSnapshot()) {
return true;
}
- comparison = this.type.compareTo(candidateReleaseTrain.type);
+ comparison = this.type.compareTo(candidate.type);
if (comparison != 0) {
return comparison < 0;
}
- return Integer.compare(this.version, candidateReleaseTrain.version) < 0;
+ return Integer.compare(this.version, candidate.version) < 0;
}
private boolean isSnapshot() {
@@ -88,10 +91,9 @@ private boolean isSnapshot() {
@Override
public boolean isSnapshotFor(DependencyVersion candidate) {
- if (!isSnapshot() || !(candidate instanceof ReleaseTrainDependencyVersion)) {
+ if (!isSnapshot() || !(candidate instanceof ReleaseTrainDependencyVersion candidateReleaseTrain)) {
return false;
}
- ReleaseTrainDependencyVersion candidateReleaseTrain = (ReleaseTrainDependencyVersion) candidate;
return this.releaseTrain.equals(candidateReleaseTrain.releaseTrain);
}
@@ -127,10 +129,7 @@ public boolean equals(Object obj) {
return false;
}
ReleaseTrainDependencyVersion other = (ReleaseTrainDependencyVersion) obj;
- if (!this.original.equals(other.original)) {
- return false;
- }
- return true;
+ return this.original.equals(other.original);
}
@Override
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForConflicts.java b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForConflicts.java
index 72cdc0946129..3f30319aa362 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForConflicts.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForConflicts.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -48,7 +48,7 @@
*
* @author Andy Wilkinson
*/
-public class CheckClasspathForConflicts extends DefaultTask {
+public abstract class CheckClasspathForConflicts extends DefaultTask {
private final List> ignores = new ArrayList<>();
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForProhibitedDependencies.java b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForProhibitedDependencies.java
index 548344b731fd..70d39f019462 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForProhibitedDependencies.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForProhibitedDependencies.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -16,6 +16,7 @@
package org.springframework.boot.build.classpath;
+import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
@@ -33,7 +34,12 @@
*
* @author Andy Wilkinson
*/
-public class CheckClasspathForProhibitedDependencies extends DefaultTask {
+public abstract class CheckClasspathForProhibitedDependencies extends DefaultTask {
+
+ private static final Set PROHIBITED_GROUPS = Set.of("org.codehaus.groovy", "org.eclipse.jetty.toolchain",
+ "commons-logging", "org.apache.geronimo.specs", "com.sun.activation");
+
+ private static final Set PERMITTED_JAVAX_GROUPS = Set.of("javax.batch", "javax.cache", "javax.money");
private Configuration classpath;
@@ -69,41 +75,20 @@ public void checkForProhibitedDependencies() {
}
private boolean prohibited(ModuleVersionIdentifier id) {
- String group = id.getGroup();
- if (group.equals("javax.batch")) {
- return false;
- }
- if (group.equals("javax.cache")) {
- return false;
- }
- if (group.equals("javax.money")) {
- return false;
- }
- if (group.equals("org.codehaus.groovy")) {
- return true;
- }
- if (group.equals("org.eclipse.jetty.toolchain")) {
- return true;
- }
- if (group.startsWith("javax")) {
- return true;
- }
- if (group.equals("commons-logging")) {
- return true;
- }
- if (group.equals("org.slf4j") && id.getName().equals("jcl-over-slf4j")) {
- return true;
- }
- if (group.startsWith("org.jboss.spec")) {
- return true;
- }
- if (group.equals("org.apache.geronimo.specs")) {
- return true;
- }
- if (group.equals("com.sun.activation")) {
- return true;
- }
- return false;
+ return PROHIBITED_GROUPS.contains(id.getGroup()) || prohibitedJavax(id) || prohibitedSlf4j(id)
+ || prohibitedJbossSpec(id);
+ }
+
+ private boolean prohibitedSlf4j(ModuleVersionIdentifier id) {
+ return id.getGroup().equals("org.slf4j") && id.getName().equals("jcl-over-slf4j");
+ }
+
+ private boolean prohibitedJbossSpec(ModuleVersionIdentifier id) {
+ return id.getGroup().startsWith("org.jboss.spec");
+ }
+
+ private boolean prohibitedJavax(ModuleVersionIdentifier id) {
+ return id.getGroup().startsWith("javax.") && !PERMITTED_JAVAX_GROUPS.contains(id.getGroup());
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnconstrainedDirectDependencies.java b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnconstrainedDirectDependencies.java
index 543a33b772a1..6a846c2a7c70 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnconstrainedDirectDependencies.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnconstrainedDirectDependencies.java
@@ -34,7 +34,7 @@
*
* @author Andy Wilkinson
*/
-public class CheckClasspathForUnconstrainedDirectDependencies extends DefaultTask {
+public abstract class CheckClasspathForUnconstrainedDirectDependencies extends DefaultTask {
private Configuration classpath;
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnnecessaryExclusions.java b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnnecessaryExclusions.java
index 511898299957..3fa6522cbb59 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnnecessaryExclusions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/classpath/CheckClasspathForUnnecessaryExclusions.java
@@ -48,7 +48,7 @@
*
* @author Andy Wilkinson
*/
-public class CheckClasspathForUnnecessaryExclusions extends DefaultTask {
+public abstract class CheckClasspathForUnnecessaryExclusions extends DefaultTask {
private static final Map SPRING_BOOT_DEPENDENCIES_PROJECT = Collections.singletonMap("path",
":spring-boot-project:spring-boot-dependencies");
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/cli/HomebrewFormula.java b/buildSrc/src/main/java/org/springframework/boot/build/cli/HomebrewFormula.java
index 62e790a31c06..8dc5dd709ce7 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/cli/HomebrewFormula.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/cli/HomebrewFormula.java
@@ -18,16 +18,15 @@
import java.io.File;
import java.security.MessageDigest;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
import org.apache.commons.codec.digest.DigestUtils;
import org.gradle.api.DefaultTask;
import org.gradle.api.Project;
import org.gradle.api.Task;
-import org.gradle.api.file.RegularFile;
-import org.gradle.api.provider.Provider;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.PathSensitive;
@@ -42,62 +41,14 @@
*
* @author Andy Wilkinson
*/
-public class HomebrewFormula extends DefaultTask {
-
- private Provider archive;
-
- private File template;
-
- private File outputDir;
+public abstract class HomebrewFormula extends DefaultTask {
public HomebrewFormula() {
- getInputs().property("version", getProject().provider(getProject()::getVersion));
- }
-
- @InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
- public RegularFile getArchive() {
- return this.archive.get();
- }
-
- public void setArchive(Provider archive) {
- this.archive = archive;
- }
-
- @InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
- public File getTemplate() {
- return this.template;
- }
-
- public void setTemplate(File template) {
- this.template = template;
- }
-
- @OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
-
- protected void createDescriptor(Map additionalProperties) {
- getProject().copy((copy) -> {
- copy.from(this.template);
- copy.into(this.outputDir);
- copy.expand(getProperties(additionalProperties));
- });
- }
-
- private Map getProperties(Map additionalProperties) {
- Map properties = new HashMap<>(additionalProperties);
Project project = getProject();
- properties.put("hash", sha256(this.archive.get().getAsFile()));
- properties.put("repo", ArtifactRelease.forProject(project).getDownloadRepo());
- properties.put("project", project);
- return properties;
+ MapProperty properties = getProperties();
+ properties.put("hash", getArchive().map((archive) -> sha256(archive.getAsFile())));
+ getProperties().put("repo", ArtifactRelease.forProject(project).getDownloadRepo());
+ getProperties().put("version", project.getVersion().toString());
}
private String sha256(File file) {
@@ -110,9 +61,27 @@ private String sha256(File file) {
}
}
+ @InputFile
+ @PathSensitive(PathSensitivity.RELATIVE)
+ public abstract RegularFileProperty getArchive();
+
+ @InputFile
+ @PathSensitive(PathSensitivity.RELATIVE)
+ public abstract RegularFileProperty getTemplate();
+
+ @OutputDirectory
+ public abstract DirectoryProperty getOutputDir();
+
+ @Input
+ abstract MapProperty getProperties();
+
@TaskAction
void createFormula() {
- createDescriptor(Collections.emptyMap());
+ getProject().copy((copy) -> {
+ copy.from(getTemplate());
+ copy.into(getOutputDir());
+ copy.expand(getProperties().get());
+ });
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentConstrainedVersions.java b/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentConstrainedVersions.java
index c4d9e05f59ea..e70502f785fc 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentConstrainedVersions.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentConstrainedVersions.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -21,10 +21,8 @@
import java.io.IOException;
import java.io.PrintWriter;
-import javax.inject.Inject;
-
import org.gradle.api.DefaultTask;
-import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.provider.SetProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputFile;
@@ -37,38 +35,22 @@
*
* @author Andy Wilkinson
*/
-public class DocumentConstrainedVersions extends DefaultTask {
-
- private final SetProperty constrainedVersions;
-
- private File outputFile;
-
- @Inject
- public DocumentConstrainedVersions(ObjectFactory objectFactory) {
- this.constrainedVersions = objectFactory.setProperty(ConstrainedVersion.class);
- }
+public abstract class DocumentConstrainedVersions extends DefaultTask {
@Input
- public SetProperty getConstrainedVersions() {
- return this.constrainedVersions;
- }
+ public abstract SetProperty getConstrainedVersions();
@OutputFile
- public File getOutputFile() {
- return this.outputFile;
- }
-
- public void setOutputFile(File outputFile) {
- this.outputFile = outputFile;
- }
+ public abstract RegularFileProperty getOutputFile();
@TaskAction
public void documentConstrainedVersions() throws IOException {
- this.outputFile.getParentFile().mkdirs();
- try (PrintWriter writer = new PrintWriter(new FileWriter(this.outputFile))) {
+ File outputFile = getOutputFile().get().getAsFile();
+ outputFile.getParentFile().mkdirs();
+ try (PrintWriter writer = new PrintWriter(new FileWriter(outputFile))) {
writer.println("|===");
writer.println("| Group ID | Artifact ID | Version");
- for (ConstrainedVersion constrainedVersion : this.constrainedVersions.get()) {
+ for (ConstrainedVersion constrainedVersion : getConstrainedVersions().get()) {
writer.println();
writer.printf("| `%s`%n", constrainedVersion.getGroup());
writer.printf("| `%s`%n", constrainedVersion.getArtifact());
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentVersionProperties.java b/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentVersionProperties.java
index e083b01277db..ef1c7c8647ad 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentVersionProperties.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/constraints/DocumentVersionProperties.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -21,10 +21,8 @@
import java.io.IOException;
import java.io.PrintWriter;
-import javax.inject.Inject;
-
import org.gradle.api.DefaultTask;
-import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.provider.SetProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputFile;
@@ -37,38 +35,22 @@
*
* @author Christoph Dreis
*/
-public class DocumentVersionProperties extends DefaultTask {
-
- private final SetProperty versionProperties;
-
- private File outputFile;
-
- @Inject
- public DocumentVersionProperties(ObjectFactory objectFactory) {
- this.versionProperties = objectFactory.setProperty(VersionProperty.class);
- }
+public abstract class DocumentVersionProperties extends DefaultTask {
@Input
- public SetProperty getVersionProperties() {
- return this.versionProperties;
- }
+ public abstract SetProperty getVersionProperties();
@OutputFile
- public File getOutputFile() {
- return this.outputFile;
- }
-
- public void setOutputFile(File outputFile) {
- this.outputFile = outputFile;
- }
+ public abstract RegularFileProperty getOutputFile();
@TaskAction
public void documentVersionProperties() throws IOException {
- this.outputFile.getParentFile().mkdirs();
- try (PrintWriter writer = new PrintWriter(new FileWriter(this.outputFile))) {
+ File outputFile = getOutputFile().getAsFile().get();
+ outputFile.getParentFile().mkdirs();
+ try (PrintWriter writer = new PrintWriter(new FileWriter(outputFile))) {
writer.println("|===");
writer.println("| Library | Version Property");
- for (VersionProperty versionProperty : this.versionProperties.get()) {
+ for (VersionProperty versionProperty : getVersionProperties().get()) {
writer.println();
writer.printf("| `%s`%n", versionProperty.getLibraryName());
writer.printf("| `%s`%n", versionProperty.getVersionProperty());
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/constraints/ExtractVersionConstraints.java b/buildSrc/src/main/java/org/springframework/boot/build/constraints/ExtractVersionConstraints.java
index 4d14b2977d4e..bd6a57d11d55 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/constraints/ExtractVersionConstraints.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/constraints/ExtractVersionConstraints.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -26,17 +26,20 @@
import java.util.TreeSet;
import org.gradle.api.DefaultTask;
+import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.artifacts.ComponentMetadataDetails;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.DependencyConstraint;
import org.gradle.api.artifacts.DependencyConstraintMetadata;
+import org.gradle.api.artifacts.DependencyConstraintSet;
import org.gradle.api.artifacts.dsl.DependencyHandler;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.TaskAction;
import org.gradle.platform.base.Platform;
import org.springframework.boot.build.bom.BomExtension;
+import org.springframework.boot.build.bom.BomPlugin;
import org.springframework.boot.build.bom.Library;
/**
@@ -45,7 +48,7 @@
*
* @author Andy Wilkinson
*/
-public class ExtractVersionConstraints extends DefaultTask {
+public abstract class ExtractVersionConstraints extends DefaultTask {
private final Configuration configuration;
@@ -55,7 +58,9 @@ public class ExtractVersionConstraints extends DefaultTask {
private final Set versionProperties = new TreeSet<>();
- private final List projectPaths = new ArrayList<>();
+ private final List dependencyConstraintSets = new ArrayList<>();
+
+ private final List boms = new ArrayList<>();
public ExtractVersionConstraints() {
DependencyHandler dependencies = getProject().getDependencies();
@@ -68,7 +73,12 @@ public void enforcedPlatform(String projectPath) {
.add(getProject().getDependencies()
.enforcedPlatform(
getProject().getDependencies().project(Collections.singletonMap("path", projectPath))));
- this.projectPaths.add(projectPath);
+ Project project = getProject().project(projectPath);
+ project.getPlugins().withType(BomPlugin.class).all((plugin) -> {
+ this.boms.add(project.getExtensions().getByType(BomExtension.class));
+ this.dependencyConstraintSets
+ .add(project.getConfigurations().getByName("apiElements").getAllDependencyConstraints());
+ });
}
@Internal
@@ -89,12 +99,9 @@ public Set getVersionProperties() {
@TaskAction
void extractVersionConstraints() {
this.configuration.resolve();
- for (String projectPath : this.projectPaths) {
- extractVersionProperties(projectPath);
- for (DependencyConstraint constraint : getProject().project(projectPath)
- .getConfigurations()
- .getByName("apiElements")
- .getAllDependencyConstraints()) {
+ this.boms.forEach(this::extractVersionProperties);
+ for (DependencyConstraintSet constraints : this.dependencyConstraintSets) {
+ for (DependencyConstraint constraint : constraints) {
this.versionConstraints.put(constraint.getGroup() + ":" + constraint.getName(),
constraint.getVersionConstraint().toString());
this.constrainedVersions.add(new ConstrainedVersion(constraint.getGroup(), constraint.getName(),
@@ -103,9 +110,7 @@ void extractVersionConstraints() {
}
}
- private void extractVersionProperties(String projectPath) {
- Object bom = getProject().project(projectPath).getExtensions().getByName("bom");
- BomExtension bomExtension = (BomExtension) bom;
+ private void extractVersionProperties(BomExtension bomExtension) {
for (Library lib : bomExtension.getLibraries()) {
String versionProperty = lib.getVersionProperty();
if (versionProperty != null) {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java
index a4c927e8b3cc..8405dc445f08 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java
@@ -46,21 +46,16 @@
*
* @author Andy Wilkinson
*/
-public class CheckAdditionalSpringConfigurationMetadata extends SourceTask {
+public abstract class CheckAdditionalSpringConfigurationMetadata extends SourceTask {
private final File projectDir;
- private final RegularFileProperty reportLocation;
-
public CheckAdditionalSpringConfigurationMetadata() {
this.projectDir = getProject().getProjectDir();
- this.reportLocation = getProject().getObjects().fileProperty();
}
@OutputFile
- public RegularFileProperty getReportLocation() {
- return this.reportLocation;
- }
+ public abstract RegularFileProperty getReportLocation();
@Override
@InputFiles
@@ -96,7 +91,7 @@ private Report createReport() throws IOException, JsonParseException, JsonMappin
@SuppressWarnings("unchecked")
private void check(String key, Map json, Analysis analysis) {
- List> groups = (List>) json.get(key);
+ List> groups = (List>) json.getOrDefault(key, Collections.emptyList());
List names = groups.stream().map((group) -> (String) group.get("name")).toList();
List sortedNames = sortedCopy(names);
for (int i = 0; i < names.size(); i++) {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckSpringConfigurationMetadata.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckSpringConfigurationMetadata.java
index 048de4e9f5cc..f1bff685cd86 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckSpringConfigurationMetadata.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckSpringConfigurationMetadata.java
@@ -32,6 +32,7 @@
import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.ListProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.OutputFile;
@@ -45,41 +46,23 @@
*
* @author Andy Wilkinson
*/
-public class CheckSpringConfigurationMetadata extends DefaultTask {
+public abstract class CheckSpringConfigurationMetadata extends DefaultTask {
- private List exclusions = new ArrayList<>();
-
- private final File projectDir;
-
- private final RegularFileProperty reportLocation;
-
- private final RegularFileProperty metadataLocation;
+ private final Path projectRoot;
public CheckSpringConfigurationMetadata() {
- this.projectDir = getProject().getProjectDir();
- this.metadataLocation = getProject().getObjects().fileProperty();
- this.reportLocation = getProject().getObjects().fileProperty();
+ this.projectRoot = getProject().getProjectDir().toPath();
}
@OutputFile
- public RegularFileProperty getReportLocation() {
- return this.reportLocation;
- }
+ public abstract RegularFileProperty getReportLocation();
@InputFile
@PathSensitive(PathSensitivity.RELATIVE)
- public RegularFileProperty getMetadataLocation() {
- return this.metadataLocation;
- }
-
- public void setExclusions(List exclusions) {
- this.exclusions = exclusions;
- }
+ public abstract RegularFileProperty getMetadataLocation();
@Input
- public List getExclusions() {
- return this.exclusions;
- }
+ public abstract ListProperty getExclusions();
@TaskAction
void check() throws JsonParseException, IOException {
@@ -95,8 +78,8 @@ void check() throws JsonParseException, IOException {
@SuppressWarnings("unchecked")
private Report createReport() throws IOException, JsonParseException, JsonMappingException {
ObjectMapper objectMapper = new ObjectMapper();
- File file = this.metadataLocation.get().getAsFile();
- Report report = new Report(this.projectDir.toPath().relativize(file.toPath()));
+ File file = getMetadataLocation().get().getAsFile();
+ Report report = new Report(this.projectRoot.relativize(file.toPath()));
Map json = objectMapper.readValue(file, Map.class);
List> properties = (List>) json.get("properties");
for (Map property : properties) {
@@ -109,7 +92,7 @@ private Report createReport() throws IOException, JsonParseException, JsonMappin
}
private boolean isExcluded(String propertyName) {
- for (String exclusion : this.exclusions) {
+ for (String exclusion : getExclusions().get()) {
if (propertyName.equals(exclusion)) {
return true;
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CompoundRow.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CompoundRow.java
index d322ce106290..ffa9f5687b5f 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CompoundRow.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CompoundRow.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -24,6 +24,7 @@
*
* @author Brian Clozel
* @author Phillip Webb
+ * @author Moritz Halbritter
*/
class CompoundRow extends Row {
@@ -45,9 +46,9 @@ void addProperty(ConfigurationProperty property) {
void write(Asciidoc asciidoc) {
asciidoc.append("|");
asciidoc.append("[[" + getAnchor() + "]]");
- asciidoc.append("<<" + getAnchor() + ",");
+ asciidoc.append("xref:#" + getAnchor() + "[");
this.propertyNames.forEach(asciidoc::appendWithHardLineBreaks);
- asciidoc.appendln(">>");
+ asciidoc.appendln("]");
asciidoc.appendln("|+++", this.description, "+++");
asciidoc.appendln("|");
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java
index d7c8710e2cb4..a7ac94f60ced 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -16,11 +16,11 @@
package org.springframework.boot.build.context.properties;
-import java.io.File;
import java.io.IOException;
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
+import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputDirectory;
@@ -36,12 +36,10 @@
* @author Andy Wilkinson
* @author Phillip Webb
*/
-public class DocumentConfigurationProperties extends DefaultTask {
+public abstract class DocumentConfigurationProperties extends DefaultTask {
private FileCollection configurationPropertyMetadata;
- private File outputDir;
-
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
public FileCollection getConfigurationPropertyMetadata() {
@@ -53,13 +51,7 @@ public void setConfigurationPropertyMetadata(FileCollection configurationPropert
}
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract DirectoryProperty getOutputDir();
@TaskAction
void documentConfigurationProperties() throws IOException {
@@ -78,10 +70,12 @@ void documentConfigurationProperties() throws IOException {
snippets.add("application-properties.security", "Security Properties", this::securityPrefixes);
snippets.add("application-properties.rsocket", "RSocket Properties", this::rsocketPrefixes);
snippets.add("application-properties.actuator", "Actuator Properties", this::actuatorPrefixes);
- snippets.add("application-properties.docker-compose", "Docker Compose Properties", this::dockerComposePrefixes);
snippets.add("application-properties.devtools", "Devtools Properties", this::devtoolsPrefixes);
+ snippets.add("application-properties.docker-compose", "Docker Compose Properties", this::dockerComposePrefixes);
+ snippets.add("application-properties.testcontainers", "Testcontainers Properties",
+ this::testcontainersPrefixes);
snippets.add("application-properties.testing", "Testing Properties", this::testingPrefixes);
- snippets.writeTo(this.outputDir.toPath());
+ snippets.writeTo(getOutputDir().getAsFile().get().toPath());
}
private void corePrefixes(Config config) {
@@ -106,6 +100,7 @@ private void corePrefixes(Config config) {
config.accept("spring.reactor");
config.accept("spring.ssl");
config.accept("spring.task");
+ config.accept("spring.threads");
config.accept("spring.mandatory-file-encoding");
config.accept("info");
config.accept("spring.output.ansi.enabled");
@@ -170,6 +165,7 @@ private void integrationPrefixes(Config prefix) {
prefix.accept("spring.integration");
prefix.accept("spring.jms");
prefix.accept("spring.kafka");
+ prefix.accept("spring.pulsar");
prefix.accept("spring.rabbitmq");
prefix.accept("spring.hazelcast");
prefix.accept("spring.webservices");
@@ -211,6 +207,7 @@ private void rsocketPrefixes(Config prefix) {
private void actuatorPrefixes(Config prefix) {
prefix.accept("management");
+ prefix.accept("micrometer");
}
private void dockerComposePrefixes(Config prefix) {
@@ -222,7 +219,11 @@ private void devtoolsPrefixes(Config prefix) {
}
private void testingPrefixes(Config prefix) {
- prefix.accept("spring.test");
+ prefix.accept("spring.test.");
+ }
+
+ private void testcontainersPrefixes(Config prefix) {
+ prefix.accept("spring.testcontainers.");
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/SingleRow.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/SingleRow.java
index 65f6bb3625fa..c81f57c9f4e2 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/SingleRow.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/SingleRow.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -24,6 +24,7 @@
*
* @author Brian Clozel
* @author Phillip Webb
+ * @author Moritz Halbritter
*/
class SingleRow extends Row {
@@ -56,7 +57,7 @@ private String getDefaultValue(Object defaultValue) {
void write(Asciidoc asciidoc) {
asciidoc.append("|");
asciidoc.append("[[" + getAnchor() + "]]");
- asciidoc.appendln("<<" + getAnchor() + ",`+", this.displayName, "+`>>");
+ asciidoc.appendln("xref:#" + getAnchor() + "[`+", this.displayName, "+`]");
writeDescription(asciidoc);
writeDefaultValue(asciidoc);
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/Snippets.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/Snippets.java
index 3e7d7ebf199e..a86560c2d6a7 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/Snippets.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/Snippets.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -102,11 +102,7 @@ private Asciidoc getAsciidoc(Snippet snippet, Table table) {
private void writeAsciidoc(Path outputDirectory, Snippet snippet, Asciidoc asciidoc) throws IOException {
String[] parts = (snippet.getAnchor()).split("\\.");
- Path path = outputDirectory;
- for (int i = 0; i < parts.length; i++) {
- String name = (i < parts.length - 1) ? parts[i] : parts[i] + ".adoc";
- path = path.resolve(name);
- }
+ Path path = outputDirectory.resolve(parts[parts.length - 1] + ".adoc");
createDirectory(path.getParent());
Files.deleteIfExists(path);
try (OutputStream outputStream = Files.newOutputStream(path)) {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/devtools/DocumentDevtoolsPropertyDefaults.java b/buildSrc/src/main/java/org/springframework/boot/build/devtools/DocumentDevtoolsPropertyDefaults.java
index 515228ce70ab..106e53465743 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/devtools/DocumentDevtoolsPropertyDefaults.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/devtools/DocumentDevtoolsPropertyDefaults.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -39,18 +39,15 @@
*
* @author Andy Wilkinson
*/
-public class DocumentDevtoolsPropertyDefaults extends DefaultTask {
+public abstract class DocumentDevtoolsPropertyDefaults extends DefaultTask {
private final Configuration devtools;
- private final RegularFileProperty outputFile;
-
public DocumentDevtoolsPropertyDefaults() {
this.devtools = getProject().getConfigurations().create("devtools");
- this.outputFile = getProject().getObjects().fileProperty();
- this.outputFile.convention(getProject().getLayout()
+ getOutputFile().convention(getProject().getLayout()
.getBuildDirectory()
- .file("docs/generated/using/devtools-property-defaults.adoc"));
+ .file("generated/docs/using/devtools-property-defaults.adoc"));
Map dependency = new HashMap<>();
dependency.put("path", ":spring-boot-project:spring-boot-devtools");
dependency.put("configuration", "propertyDefaults");
@@ -63,9 +60,7 @@ public FileCollection getDevtools() {
}
@OutputFile
- public RegularFileProperty getOutputFile() {
- return this.outputFile;
- }
+ public abstract RegularFileProperty getOutputFile();
@TaskAction
void documentPropertyDefaults() throws IOException {
@@ -86,7 +81,7 @@ private Map loadProperties() throws IOException, FileNotFoundExc
}
private void documentProperties(Map properties) throws IOException {
- try (PrintWriter writer = new PrintWriter(new FileWriter(this.outputFile.getAsFile().get()))) {
+ try (PrintWriter writer = new PrintWriter(new FileWriter(getOutputFile().getAsFile().get()))) {
writer.println("[cols=\"3,1\"]");
writer.println("|===");
writer.println("| Name | Default Value");
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/docs/ApplicationRunner.java b/buildSrc/src/main/java/org/springframework/boot/build/docs/ApplicationRunner.java
index 0f95d55d3d67..9f43c059d50e 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/docs/ApplicationRunner.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/docs/ApplicationRunner.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -34,6 +34,7 @@
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Classpath;
import org.gradle.api.tasks.Input;
@@ -47,29 +48,17 @@
*
* @author Andy Wilkinson
*/
-public class ApplicationRunner extends DefaultTask {
-
- private final RegularFileProperty output = getProject().getObjects().fileProperty();
-
- private final ListProperty args = getProject().getObjects().listProperty(String.class);
-
- private final Property mainClass = getProject().getObjects().property(String.class);
-
- private final Property expectedLogging = getProject().getObjects().property(String.class);
-
- private final Property applicationJar = getProject().getObjects()
- .property(String.class)
- .convention("/opt/apps/myapp.jar");
-
- private final Map normalizations = new HashMap<>();
+public abstract class ApplicationRunner extends DefaultTask {
private FileCollection classpath;
- @OutputFile
- public RegularFileProperty getOutput() {
- return this.output;
+ public ApplicationRunner() {
+ getApplicationJar().convention("/opt/apps/myapp.jar");
}
+ @OutputFile
+ public abstract RegularFileProperty getOutput();
+
@Classpath
public FileCollection getClasspath() {
return this.classpath;
@@ -80,37 +69,27 @@ public void setClasspath(FileCollection classpath) {
}
@Input
- public ListProperty getArgs() {
- return this.args;
- }
+ public abstract ListProperty getArgs();
@Input
- public Property getMainClass() {
- return this.mainClass;
- }
+ public abstract Property getMainClass();
@Input
- public Property getExpectedLogging() {
- return this.expectedLogging;
- }
+ public abstract Property getExpectedLogging();
@Input
- Map getNormalizations() {
- return this.normalizations;
- }
+ abstract MapProperty getNormalizations();
@Input
- public Property getApplicationJar() {
- return this.applicationJar;
- }
+ abstract Property getApplicationJar();
public void normalizeTomcatPort() {
- this.normalizations.put("(Tomcat started on port\\(s\\): )[\\d]+( \\(http\\))", "$18080$2");
- this.normalizations.put("(Tomcat initialized with port\\(s\\): )[\\d]+( \\(http\\))", "$18080$2");
+ getNormalizations().put("(Tomcat started on port )[\\d]+( \\(http\\))", "$18080$2");
+ getNormalizations().put("(Tomcat initialized with port )[\\d]+( \\(http\\))", "$18080$2");
}
public void normalizeLiveReloadPort() {
- this.normalizations.put("(LiveReload server is running on port )[\\d]+", "$135729");
+ getNormalizations().put("(LiveReload server is running on port )[\\d]+", "$135729");
}
@TaskAction
@@ -123,9 +102,9 @@ void runApplication() throws IOException {
.stream()
.map(File::getAbsolutePath)
.collect(Collectors.joining(File.pathSeparator)));
- command.add(this.mainClass.get());
- command.addAll(this.args.get());
- File outputFile = this.output.getAsFile().get();
+ command.add(getMainClass().get());
+ command.addAll(getArgs().get());
+ File outputFile = getOutput().getAsFile().get();
Process process = new ProcessBuilder().redirectOutput(outputFile)
.redirectError(outputFile)
.command(command)
@@ -137,7 +116,7 @@ void runApplication() throws IOException {
private void awaitLogging(Process process) {
long end = System.currentTimeMillis() + 60000;
- String expectedLogging = this.expectedLogging.get();
+ String expectedLogging = getExpectedLogging().get();
while (System.currentTimeMillis() < end) {
for (String line : outputLines()) {
if (line.contains(expectedLogging)) {
@@ -152,7 +131,7 @@ private void awaitLogging(Process process) {
}
private List outputLines() {
- Path outputPath = this.output.get().getAsFile().toPath();
+ Path outputPath = getOutput().get().getAsFile().toPath();
try {
return Files.readAllLines(outputPath);
}
@@ -164,7 +143,7 @@ private List outputLines() {
private void normalizeLogging() {
List outputLines = outputLines();
List normalizedLines = normalize(outputLines);
- Path outputPath = this.output.get().getAsFile().toPath();
+ Path outputPath = getOutput().get().getAsFile().toPath();
try {
Files.write(outputPath, normalizedLines);
}
@@ -175,9 +154,9 @@ private void normalizeLogging() {
private List normalize(List lines) {
List normalizedLines = lines;
- Map normalizations = new HashMap<>(this.normalizations);
+ Map normalizations = new HashMap<>(getNormalizations().get());
normalizations.put("(Starting .* using Java .* with PID [\\d]+ \\().*( started by ).*( in ).*(\\))",
- "$1" + this.applicationJar.get() + "$2myuser$3/opt/apps/$4");
+ "$1" + getApplicationJar().get() + "$2myuser$3/opt/apps/$4");
for (Entry normalization : normalizations.entrySet()) {
Pattern pattern = Pattern.compile(normalization.getKey());
normalizedLines = normalize(normalizedLines, pattern, normalization.getValue());
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java
index f5256fc17c80..414ae1457007 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -21,10 +21,12 @@
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
-import java.util.Map;
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.MapProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.OutputDirectory;
@@ -39,46 +41,22 @@
*
* @author Andy Wilkinson
*/
-public class DocumentPluginGoals extends DefaultTask {
+public abstract class DocumentPluginGoals extends DefaultTask {
private final PluginXmlParser parser = new PluginXmlParser();
- private File pluginXml;
-
- private File outputDir;
-
- private Map goalSections;
-
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract DirectoryProperty getOutputDir();
@Input
- public Map getGoalSections() {
- return this.goalSections;
- }
-
- public void setGoalSections(Map goalSections) {
- this.goalSections = goalSections;
- }
+ public abstract MapProperty getGoalSections();
@InputFile
- public File getPluginXml() {
- return this.pluginXml;
- }
-
- public void setPluginXml(File pluginXml) {
- this.pluginXml = pluginXml;
- }
+ public abstract RegularFileProperty getPluginXml();
@TaskAction
public void documentPluginGoals() throws IOException {
- Plugin plugin = this.parser.parse(this.pluginXml);
+ Plugin plugin = this.parser.parse(getPluginXml().getAsFile().get());
writeOverview(plugin);
for (Mojo mojo : plugin.getMojos()) {
documentMojo(plugin, mojo);
@@ -86,13 +64,14 @@ public void documentPluginGoals() throws IOException {
}
private void writeOverview(Plugin plugin) throws IOException {
- try (PrintWriter writer = new PrintWriter(new FileWriter(new File(this.outputDir, "overview.adoc")))) {
+ try (PrintWriter writer = new PrintWriter(
+ new FileWriter(new File(getOutputDir().getAsFile().get(), "overview.adoc")))) {
writer.println("[cols=\"1,3\"]");
writer.println("|===");
writer.println("| Goal | Description");
writer.println();
for (Mojo mojo : plugin.getMojos()) {
- writer.printf("| <<%s,%s:%s>>%n", goalSectionId(mojo), plugin.getGoalPrefix(), mojo.getGoal());
+ writer.printf("| xref:%s[%s:%s]%n", goalSectionId(mojo, false), plugin.getGoalPrefix(), mojo.getGoal());
writer.printf("| %s%n", mojo.getDescription());
writer.println();
}
@@ -101,12 +80,11 @@ private void writeOverview(Plugin plugin) throws IOException {
}
private void documentMojo(Plugin plugin, Mojo mojo) throws IOException {
- try (PrintWriter writer = new PrintWriter(new FileWriter(new File(this.outputDir, mojo.getGoal() + ".adoc")))) {
- String sectionId = goalSectionId(mojo);
- writer.println();
- writer.println();
+ try (PrintWriter writer = new PrintWriter(
+ new FileWriter(new File(getOutputDir().getAsFile().get(), mojo.getGoal() + ".adoc")))) {
+ String sectionId = goalSectionId(mojo, true);
writer.printf("[[%s]]%n", sectionId);
- writer.printf("= `%s:%s`%n", plugin.getGoalPrefix(), mojo.getGoal());
+ writer.printf("= `%s:%s`%n%n", plugin.getGoalPrefix(), mojo.getGoal());
writer.printf("`%s:%s:%s`%n", plugin.getGroupId(), plugin.getArtifactId(), plugin.getVersion());
writer.println();
writer.println(mojo.getDescription());
@@ -114,37 +92,43 @@ private void documentMojo(Plugin plugin, Mojo mojo) throws IOException {
List requiredParameters = parameters.stream().filter(Parameter::isRequired).toList();
String detailsSectionId = sectionId + ".parameter-details";
if (!requiredParameters.isEmpty()) {
+ writer.println();
writer.println();
writer.println();
writer.printf("[[%s.required-parameters]]%n", sectionId);
writer.println("== Required parameters");
+ writer.println();
writeParametersTable(writer, detailsSectionId, requiredParameters);
}
List optionalParameters = parameters.stream()
.filter((parameter) -> !parameter.isRequired())
.toList();
if (!optionalParameters.isEmpty()) {
+ writer.println();
writer.println();
writer.println();
writer.printf("[[%s.optional-parameters]]%n", sectionId);
writer.println("== Optional parameters");
+ writer.println();
writeParametersTable(writer, detailsSectionId, optionalParameters);
}
writer.println();
writer.println();
+ writer.println();
writer.printf("[[%s]]%n", detailsSectionId);
writer.println("== Parameter details");
+ writer.println();
writeParameterDetails(writer, parameters, detailsSectionId);
}
}
- private String goalSectionId(Mojo mojo) {
- String goalSection = this.goalSections.get(mojo.getGoal());
+ private String goalSectionId(Mojo mojo, boolean innerReference) {
+ String goalSection = getGoalSections().getting(mojo.getGoal()).get();
if (goalSection == null) {
throw new IllegalStateException("Goal '" + mojo.getGoal() + "' has not be assigned to a section");
}
String sectionId = goalSection + "." + mojo.getGoal() + "-goal";
- return sectionId;
+ return (!innerReference) ? goalSection + "#" + sectionId : sectionId;
}
private void writeParametersTable(PrintWriter writer, String detailsSectionId, List parameters) {
@@ -154,7 +138,7 @@ private void writeParametersTable(PrintWriter writer, String detailsSectionId, L
writer.println();
for (Parameter parameter : parameters) {
String name = parameter.getName();
- writer.printf("| <<%s.%s,%s>>%n", detailsSectionId, parameterId(name), name);
+ writer.printf("| xref:#%s.%s[%s]%n", detailsSectionId, parameterId(name), name);
writer.printf("| `%s`%n", typeNameToJavadocLink(shortTypeName(parameter.getType()), parameter.getType()));
String defaultValue = parameter.getDefaultValue();
if (defaultValue != null) {
@@ -236,10 +220,10 @@ private String typeNameToJavadocLink(String name) {
private String typeNameToJavadocLink(String shortName, String name) {
if (name.startsWith("org.springframework.boot.maven")) {
- return "{spring-boot-docs}/maven-plugin/api/" + typeNameToJavadocPath(name) + ".html[" + shortName + "]";
+ return "xref:maven-plugin:api/java/" + typeNameToJavadocPath(name) + ".html[" + shortName + "]";
}
if (name.startsWith("org.springframework.boot")) {
- return "{spring-boot-docs}/api/" + typeNameToJavadocPath(name) + ".html[" + shortName + "]";
+ return "xref:api:java/" + typeNameToJavadocPath(name) + ".html[" + shortName + "]";
}
return shortName;
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenExec.java b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenExec.java
index fbbe5d651f6b..73ef436429ac 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenExec.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenExec.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -24,8 +24,12 @@
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.JavaExec;
+import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.TaskExecutionException;
import org.gradle.process.internal.ExecException;
@@ -37,29 +41,29 @@
*
* @author Andy Wilkinson
*/
-public class MavenExec extends JavaExec {
+public abstract class MavenExec extends JavaExec {
private final Logger log = LoggerFactory.getLogger(MavenExec.class);
- private File projectDir;
-
public MavenExec() {
setClasspath(mavenConfiguration(getProject()));
args("--batch-mode");
getMainClass().set("org.apache.maven.cli.MavenCli");
+ getPom().set(getProjectDir().file("pom.xml"));
}
- public void setProjectDir(File projectDir) {
- this.projectDir = projectDir;
- getInputs().file(new File(projectDir, "pom.xml"))
- .withPathSensitivity(PathSensitivity.RELATIVE)
- .withPropertyName("pom");
- }
+ @Internal
+ public abstract DirectoryProperty getProjectDir();
+
+ @InputFile
+ @PathSensitive(PathSensitivity.RELATIVE)
+ abstract RegularFileProperty getPom();
@Override
public void exec() {
- workingDir(this.projectDir);
- systemProperty("maven.multiModuleProjectDirectory", this.projectDir.getAbsolutePath());
+ File workingDir = getProjectDir().getAsFile().get();
+ workingDir(workingDir);
+ systemProperty("maven.multiModuleProjectDirectory", workingDir.getAbsolutePath());
try {
Path logFile = Files.createTempFile(getName(), ".log");
try {
@@ -97,9 +101,4 @@ private Configuration mavenConfiguration(Project project) {
});
}
- @Internal
- public File getProjectDir() {
- return this.projectDir;
- }
-
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenPluginPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenPluginPlugin.java
index 6301deb2b4b1..09eb5d333d45 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenPluginPlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenPluginPlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -54,6 +54,8 @@
import org.gradle.api.artifacts.result.ResolvedArtifactResult;
import org.gradle.api.attributes.DocsType;
import org.gradle.api.attributes.Usage;
+import org.gradle.api.component.AdhocComponentWithVariants;
+import org.gradle.api.component.SoftwareComponent;
import org.gradle.api.file.CopySpec;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.FileCollection;
@@ -65,6 +67,7 @@
import org.gradle.api.publish.PublishingExtension;
import org.gradle.api.publish.maven.MavenPublication;
import org.gradle.api.publish.maven.plugins.MavenPublishPlugin;
+import org.gradle.api.publish.tasks.GenerateModuleMetadata;
import org.gradle.api.tasks.Classpath;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.JavaExec;
@@ -82,11 +85,15 @@
import org.gradle.api.tasks.javadoc.Javadoc;
import org.gradle.external.javadoc.StandardJavadocDocletOptions;
import org.w3c.dom.Document;
+import org.w3c.dom.Element;
import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
import org.springframework.boot.build.DeployedPlugin;
import org.springframework.boot.build.MavenRepositoryPlugin;
+import org.springframework.boot.build.optional.OptionalDependenciesPlugin;
+import org.springframework.boot.build.test.DockerTestPlugin;
import org.springframework.boot.build.test.IntegrationTestPlugin;
import org.springframework.core.CollectionFactory;
import org.springframework.util.Assert;
@@ -115,6 +122,33 @@ public void apply(Project project) {
addDocumentPluginGoalsTask(project, generatePluginDescriptorTask);
addPrepareMavenBinariesTask(project);
addExtractVersionPropertiesTask(project);
+ publishOptionalDependenciesInPom(project);
+ project.getTasks().withType(GenerateModuleMetadata.class).configureEach((task) -> task.setEnabled(false));
+ }
+
+ private void publishOptionalDependenciesInPom(Project project) {
+ project.getPlugins().withType(OptionalDependenciesPlugin.class, (optionalDependencies) -> {
+ SoftwareComponent component = project.getComponents().findByName("java");
+ if (component instanceof AdhocComponentWithVariants componentWithVariants) {
+ componentWithVariants.addVariantsFromConfiguration(
+ project.getConfigurations().getByName(OptionalDependenciesPlugin.OPTIONAL_CONFIGURATION_NAME),
+ (variant) -> variant.mapToOptional());
+ }
+ });
+ MavenPublication publication = (MavenPublication) project.getExtensions()
+ .getByType(PublishingExtension.class)
+ .getPublications()
+ .getByName("maven");
+ publication.getPom().withXml((xml) -> {
+ Element root = xml.asElement();
+ NodeList children = root.getChildNodes();
+ for (int i = 0; i < children.getLength(); i++) {
+ Node child = children.item(i);
+ if ("dependencyManagement".equals(child.getNodeName())) {
+ root.removeChild(child);
+ }
+ }
+ });
}
private void configurePomPackaging(Project project) {
@@ -134,15 +168,19 @@ private void addPopulateIntTestMavenRepositoryTask(Project project) {
project.getObjects().named(DocsType.class, "maven-repository")));
RuntimeClasspathMavenRepository runtimeClasspathMavenRepository = project.getTasks()
.create("runtimeClasspathMavenRepository", RuntimeClasspathMavenRepository.class);
- runtimeClasspathMavenRepository.getOutputDirectory()
+ runtimeClasspathMavenRepository.getOutputDir()
.set(new File(project.getBuildDir(), "runtime-classpath-repository"));
project.getDependencies()
.components((components) -> components.all(MavenRepositoryComponentMetadataRule.class));
- Sync task = project.getTasks().create("populateIntTestMavenRepository", Sync.class);
- task.setDestinationDir(new File(project.getBuildDir(), "int-test-maven-repository"));
+ Sync task = project.getTasks().create("populateTestMavenRepository", Sync.class);
+ task.setDestinationDir(new File(project.getBuildDir(), "test-maven-repository"));
task.with(copyIntTestMavenRepositoryFiles(project, runtimeClasspathMavenRepository));
task.dependsOn(project.getTasks().getByName(MavenRepositoryPlugin.PUBLISH_TO_PROJECT_REPOSITORY_TASK_NAME));
project.getTasks().getByName(IntegrationTestPlugin.INT_TEST_TASK_NAME).dependsOn(task);
+ project.getPlugins()
+ .withType(DockerTestPlugin.class)
+ .all((dockerTestPlugin) -> project.getTasks()
+ .named(DockerTestPlugin.DOCKER_TEST_TASK_NAME, (dockerTest) -> dockerTest.dependsOn(task)));
}
private CopySpec copyIntTestMavenRepositoryFiles(Project project,
@@ -157,8 +195,8 @@ private CopySpec copyIntTestMavenRepositoryFiles(Project project,
private void addDocumentPluginGoalsTask(Project project, MavenExec generatePluginDescriptorTask) {
DocumentPluginGoals task = project.getTasks().create("documentPluginGoals", DocumentPluginGoals.class);
File pluginXml = new File(generatePluginDescriptorTask.getOutputs().getFiles().getSingleFile(), "plugin.xml");
- task.setPluginXml(pluginXml);
- task.setOutputDir(new File(project.getBuildDir(), "docs/generated/goals/"));
+ task.getPluginXml().set(pluginXml);
+ task.getOutputDir().set(new File(project.getBuildDir(), "generated/docs/maven-plugin-goals/"));
task.dependsOn(generatePluginDescriptorTask);
}
@@ -172,7 +210,7 @@ private MavenExec addGenerateHelpMojoTask(Project project, Jar jarTask) {
private MavenExec createGenerateHelpMojoTask(Project project, File helpMojoDir) {
MavenExec task = project.getTasks().create("generateHelpMojo", MavenExec.class);
- task.setProjectDir(helpMojoDir);
+ task.getProjectDir().set(helpMojoDir);
task.args("org.apache.maven.plugins:maven-plugin-plugin:3.6.1:helpmojo");
task.getOutputs().dir(new File(helpMojoDir, "target/generated-sources/plugin"));
return task;
@@ -223,7 +261,7 @@ private FormatHelpMojoSource createFormatHelpMojoSource(Project project, MavenEx
FormatHelpMojoSource formatHelpMojoSource = project.getTasks()
.create("formatHelpMojoSource", FormatHelpMojoSource.class);
formatHelpMojoSource.setGenerator(generateHelpMojoTask);
- formatHelpMojoSource.setOutputDir(generatedHelpMojoDir);
+ formatHelpMojoSource.getOutputDir().set(generatedHelpMojoDir);
return formatHelpMojoSource;
}
@@ -246,7 +284,7 @@ private MavenExec createGeneratePluginDescriptorTask(Project project, File maven
.dir(new File(mavenDir, "target/classes/org"))
.withPathSensitivity(PathSensitivity.RELATIVE)
.withPropertyName("plugin classes");
- generatePluginDescriptor.setProjectDir(mavenDir);
+ generatePluginDescriptor.getProjectDir().set(mavenDir);
return generatePluginDescriptor;
}
@@ -257,8 +295,9 @@ private void includeDescriptorInJar(Jar jar, JavaExec generatePluginDescriptorTa
private void addPrepareMavenBinariesTask(Project project) {
TaskProvider task = project.getTasks()
- .register("prepareMavenBinaries", PrepareMavenBinaries.class, (prepareMavenBinaries) -> prepareMavenBinaries
- .setOutputDir(new File(project.getBuildDir(), "maven-binaries")));
+ .register("prepareMavenBinaries", PrepareMavenBinaries.class,
+ (prepareMavenBinaries) -> prepareMavenBinaries.getOutputDir()
+ .set(new File(project.getBuildDir(), "maven-binaries")));
project.getTasks()
.getByName(IntegrationTestPlugin.INT_TEST_TASK_NAME)
.getInputs()
@@ -286,12 +325,10 @@ private void addExtractVersionPropertiesTask(Project project) {
.map((dir) -> dir.file("extracted-versions.properties")));
}
- public static class FormatHelpMojoSource extends DefaultTask {
+ public abstract static class FormatHelpMojoSource extends DefaultTask {
private Task generator;
- private File outputDir;
-
void setGenerator(Task generator) {
this.generator = generator;
getInputs().files(this.generator)
@@ -300,13 +337,7 @@ void setGenerator(Task generator) {
}
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract DirectoryProperty getOutputDir();
@TaskAction
void syncAndFormat() {
@@ -319,7 +350,7 @@ void syncAndFormat() {
private void save(File output, FileEdit edit) {
Path relativePath = output.toPath().relativize(edit.getFile().toPath());
- Path outputLocation = this.outputDir.toPath().resolve(relativePath);
+ Path outputLocation = getOutputDir().getAsFile().get().toPath().resolve(relativePath);
try {
Files.createDirectories(outputLocation.getParent());
Files.writeString(outputLocation, edit.getFormattedContent());
@@ -363,21 +394,16 @@ private void configureVariant(ComponentMetadataContext context, VariantMetadata
}
- public static class RuntimeClasspathMavenRepository extends DefaultTask {
+ public abstract static class RuntimeClasspathMavenRepository extends DefaultTask {
private final Configuration runtimeClasspath;
- private final DirectoryProperty outputDirectory;
-
public RuntimeClasspathMavenRepository() {
this.runtimeClasspath = getProject().getConfigurations().getByName("runtimeClasspathWithMetadata");
- this.outputDirectory = getProject().getObjects().directoryProperty();
}
@OutputDirectory
- public DirectoryProperty getOutputDirectory() {
- return this.outputDirectory;
- }
+ public abstract DirectoryProperty getOutputDir();
@Classpath
public Configuration getRuntimeClasspath() {
@@ -391,7 +417,7 @@ public void createRepository() {
String fileName = result.getFile()
.getName()
.replace(identifier.getVersion() + "-" + identifier.getVersion(), identifier.getVersion());
- File repositoryLocation = this.outputDirectory
+ File repositoryLocation = getOutputDir()
.dir(identifier.getGroup().replace('.', '/') + "/" + identifier.getModule() + "/"
+ identifier.getVersion() + "/" + fileName)
.get()
@@ -410,16 +436,10 @@ public void createRepository() {
}
- public static class ExtractVersionProperties extends DefaultTask {
-
- private final RegularFileProperty destination;
+ public abstract static class ExtractVersionProperties extends DefaultTask {
private FileCollection effectiveBoms;
- public ExtractVersionProperties() {
- this.destination = getProject().getObjects().fileProperty();
- }
-
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
public FileCollection getEffectiveBoms() {
@@ -431,9 +451,7 @@ public void setEffectiveBoms(FileCollection effectiveBoms) {
}
@OutputFile
- public RegularFileProperty getDestination() {
- return this.destination;
- }
+ public abstract RegularFileProperty getDestination();
@TaskAction
public void extractVersionProperties() {
@@ -443,7 +461,7 @@ public void extractVersionProperties() {
}
private void writeProperties(Properties versions) {
- File outputFile = this.destination.getAsFile().get();
+ File outputFile = getDestination().getAsFile().get();
outputFile.getParentFile().mkdirs();
try (Writer writer = new FileWriter(outputFile)) {
versions.store(writer, null);
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/PrepareMavenBinaries.java b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/PrepareMavenBinaries.java
index 3ebc30a4e95e..69c741739d8b 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/PrepareMavenBinaries.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/PrepareMavenBinaries.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -16,14 +16,11 @@
package org.springframework.boot.build.mavenplugin;
-import java.io.File;
-import java.util.Arrays;
-import java.util.LinkedHashSet;
-import java.util.Set;
-
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.provider.SetProperty;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
@@ -33,38 +30,22 @@
*
* @author Andy Wilkinson
*/
-public class PrepareMavenBinaries extends DefaultTask {
-
- private final Set versions = new LinkedHashSet<>();
-
- private File outputDir;
+public abstract class PrepareMavenBinaries extends DefaultTask {
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract DirectoryProperty getOutputDir();
@Input
- public Set getVersions() {
- return this.versions;
- }
-
- public void versions(String... versions) {
- this.versions.addAll(Arrays.asList(versions));
- }
+ public abstract SetProperty getVersions();
@TaskAction
public void prepareBinaries() {
- for (String version : this.versions) {
+ for (String version : getVersions().get()) {
Configuration configuration = getProject().getConfigurations()
.detachedConfiguration(
getProject().getDependencies().create("org.apache.maven:apache-maven:" + version + ":bin@zip"));
getProject()
- .copy((copy) -> copy.into(this.outputDir).from(getProject().zipTree(configuration.getSingleFile())));
+ .copy((copy) -> copy.into(getOutputDir()).from(getProject().zipTree(configuration.getSingleFile())));
}
}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/starters/DocumentStarters.java b/buildSrc/src/main/java/org/springframework/boot/build/starters/DocumentStarters.java
index 669eeb40a0ba..fabbd7a93aad 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/starters/DocumentStarters.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/starters/DocumentStarters.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -33,6 +33,7 @@
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputDirectory;
@@ -47,12 +48,10 @@
*
* @author Andy Wilkinson
*/
-public class DocumentStarters extends DefaultTask {
+public abstract class DocumentStarters extends DefaultTask {
private final Configuration starters;
- private File outputDir;
-
public DocumentStarters() {
this.starters = getProject().getConfigurations().create("starters");
getProject().getGradle().projectsEvaluated((gradle) -> {
@@ -68,13 +67,7 @@ public DocumentStarters() {
}
@OutputDirectory
- public File getOutputDir() {
- return this.outputDir;
- }
-
- public void setOutputDir(File outputDir) {
- this.outputDir = outputDir;
- }
+ public abstract DirectoryProperty getOutputDir();
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
@@ -106,7 +99,7 @@ private Starter loadStarter(File metadata) {
}
private void writeTable(String name, Stream starters) {
- File output = new File(this.outputDir, name + ".adoc");
+ File output = new File(getOutputDir().getAsFile().get(), name + ".adoc");
output.getParentFile().mkdirs();
try (PrintWriter writer = new PrintWriter(new FileWriter(output))) {
writer.println("|===");
@@ -128,7 +121,7 @@ private String postProcessDescription(String description) {
}
private String addStarterCrossLinks(String input) {
- return input.replaceAll("(spring-boot-starter[A-Za-z-]*)", "<<$1,`$1`>>");
+ return input.replaceAll("(spring-boot-starter[A-Za-z-]*)", "xref:#$1[`$1`]");
}
private static final class Starter implements Comparable {
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestBuildService.java b/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestBuildService.java
new file mode 100644
index 000000000000..2f70a735513c
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestBuildService.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2012-2024 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.test;
+
+import org.gradle.api.Project;
+import org.gradle.api.provider.Provider;
+import org.gradle.api.services.BuildService;
+import org.gradle.api.services.BuildServiceParameters;
+
+/**
+ * Build service for Docker-based tests. Configured to only allow serial execution,
+ * thereby ensuring that Docker-based tests do not run in parallel.
+ *
+ * @author Andy Wilkinson
+ */
+abstract class DockerTestBuildService implements BuildService {
+
+ static Provider registerIfNecessary(Project project) {
+ return project.getGradle()
+ .getSharedServices()
+ .registerIfAbsent("dockerTest", DockerTestBuildService.class, (spec) -> spec.getMaxParallelUsages().set(1));
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestPlugin.java
new file mode 100644
index 000000000000..017ca001a43b
--- /dev/null
+++ b/buildSrc/src/main/java/org/springframework/boot/build/test/DockerTestPlugin.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright 2012-2024 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.test;
+
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.plugins.JavaPlugin;
+import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.provider.Provider;
+import org.gradle.api.services.BuildService;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
+import org.gradle.api.tasks.testing.Test;
+import org.gradle.language.base.plugins.LifecycleBasePlugin;
+import org.gradle.plugins.ide.eclipse.EclipsePlugin;
+import org.gradle.plugins.ide.eclipse.model.EclipseModel;
+
+/**
+ * Plugin for Docker-based tests. Creates a {@link SourceSet source set}, {@link Test
+ * test} task, and {@link BuildService shared service} named {@code dockerTest}. The build
+ * service is configured to only allow serial usage and the {@code dockerTest} task is
+ * configured to use the build service. In a parallel build, this ensures that only a
+ * single {@code dockerTest} task can run at any given time.
+ *
+ * @author Andy Wilkinson
+ */
+public class DockerTestPlugin implements Plugin {
+
+ /**
+ * Name of the {@code dockerTest} task.
+ */
+ public static String DOCKER_TEST_TASK_NAME = "dockerTest";
+
+ /**
+ * Name of the {@code dockerTest} source set.
+ */
+ public static String DOCKER_TEST_SOURCE_SET_NAME = "dockerTest";
+
+ /**
+ * Name of the {@code dockerTest} shared service.
+ */
+ public static String DOCKER_TEST_SERVICE_NAME = "dockerTest";
+
+ @Override
+ public void apply(Project project) {
+ project.getPlugins().withType(JavaPlugin.class, (javaPlugin) -> configureDockerTesting(project));
+ }
+
+ private void configureDockerTesting(Project project) {
+ Provider buildService = DockerTestBuildService.registerIfNecessary(project);
+ SourceSet dockerTestSourceSet = createSourceSet(project);
+ Provider dockerTest = createTestTask(project, dockerTestSourceSet, buildService);
+ project.getTasks().getByName(LifecycleBasePlugin.CHECK_TASK_NAME).dependsOn(dockerTest);
+ project.getPlugins().withType(EclipsePlugin.class, (eclipsePlugin) -> {
+ EclipseModel eclipse = project.getExtensions().getByType(EclipseModel.class);
+ eclipse.classpath((classpath) -> classpath.getPlusConfigurations()
+ .add(project.getConfigurations()
+ .getByName(dockerTestSourceSet.getRuntimeClasspathConfigurationName())));
+ });
+ }
+
+ private SourceSet createSourceSet(Project project) {
+ SourceSetContainer sourceSets = project.getExtensions().getByType(JavaPluginExtension.class).getSourceSets();
+ SourceSet dockerTestSourceSet = sourceSets.create(DOCKER_TEST_SOURCE_SET_NAME);
+ SourceSet main = sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME);
+ SourceSet test = sourceSets.getByName(SourceSet.TEST_SOURCE_SET_NAME);
+ dockerTestSourceSet.setCompileClasspath(dockerTestSourceSet.getCompileClasspath()
+ .plus(main.getOutput())
+ .plus(main.getCompileClasspath())
+ .plus(test.getOutput()));
+ dockerTestSourceSet.setRuntimeClasspath(dockerTestSourceSet.getRuntimeClasspath()
+ .plus(main.getOutput())
+ .plus(main.getRuntimeClasspath())
+ .plus(test.getOutput()));
+ project.getPlugins().withType(IntegrationTestPlugin.class, (integrationTestPlugin) -> {
+ SourceSet intTest = sourceSets.getByName(IntegrationTestPlugin.INT_TEST_SOURCE_SET_NAME);
+ dockerTestSourceSet
+ .setCompileClasspath(dockerTestSourceSet.getCompileClasspath().plus(intTest.getOutput()));
+ dockerTestSourceSet
+ .setRuntimeClasspath(dockerTestSourceSet.getRuntimeClasspath().plus(intTest.getOutput()));
+ });
+ return dockerTestSourceSet;
+ }
+
+ private Provider createTestTask(Project project, SourceSet dockerTestSourceSet,
+ Provider buildService) {
+ Provider dockerTest = project.getTasks().register(DOCKER_TEST_TASK_NAME, Test.class, (task) -> {
+ task.usesService(buildService);
+ task.setGroup(LifecycleBasePlugin.VERIFICATION_GROUP);
+ task.setDescription("Runs Docker-based tests.");
+ task.setTestClassesDirs(dockerTestSourceSet.getOutput().getClassesDirs());
+ task.setClasspath(dockerTestSourceSet.getRuntimeClasspath());
+ task.shouldRunAfter(JavaPlugin.TEST_TASK_NAME);
+ });
+ return dockerTest;
+ }
+
+}
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/DocumentTestSlices.java b/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/DocumentTestSlices.java
index 012790904704..939f425ab4db 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/DocumentTestSlices.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/DocumentTestSlices.java
@@ -32,6 +32,7 @@
import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.PathSensitive;
@@ -46,12 +47,10 @@
*
* @author Andy Wilkinson
*/
-public class DocumentTestSlices extends DefaultTask {
+public abstract class DocumentTestSlices extends DefaultTask {
private FileCollection testSlices;
- private File outputFile;
-
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
public FileCollection getTestSlices() {
@@ -63,13 +62,7 @@ public void setTestSlices(FileCollection testSlices) {
}
@OutputFile
- public File getOutputFile() {
- return this.outputFile;
- }
-
- public void setOutputFile(File outputFile) {
- this.outputFile = outputFile;
- }
+ public abstract RegularFileProperty getOutputFile();
@TaskAction
void documentTestSlices() throws IOException {
@@ -94,8 +87,9 @@ private Set readTestSlices() throws IOException {
}
private void writeTable(Set testSlices) throws IOException {
- this.outputFile.getParentFile().mkdirs();
- try (PrintWriter writer = new PrintWriter(new FileWriter(this.outputFile))) {
+ File outputFile = getOutputFile().getAsFile().get();
+ outputFile.getParentFile().mkdirs();
+ try (PrintWriter writer = new PrintWriter(new FileWriter(outputFile))) {
writer.println("[cols=\"d,a\"]");
writer.println("|===");
writer.println("| Test slice | Imported auto-configuration");
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/TestSliceMetadata.java b/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/TestSliceMetadata.java
index 3c4c8a478d75..60ba288ec4c7 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/TestSliceMetadata.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/test/autoconfigure/TestSliceMetadata.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -32,7 +32,6 @@
import java.util.Properties;
import java.util.SortedSet;
import java.util.TreeSet;
-import java.util.concurrent.Callable;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
@@ -41,7 +40,12 @@
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.file.FileCollection;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.tasks.Classpath;
+import org.gradle.api.tasks.InputFile;
+import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputFile;
+import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.TaskAction;
@@ -59,44 +63,57 @@
*
* @author Andy Wilkinson
*/
-public class TestSliceMetadata extends DefaultTask {
+public abstract class TestSliceMetadata extends DefaultTask {
- private SourceSet sourceSet;
+ private FileCollection classpath;
- private File outputFile;
+ private FileCollection importsFiles;
+
+ private FileCollection classesDirs;
public TestSliceMetadata() {
- getInputs().dir((Callable) () -> this.sourceSet.getOutput().getResourcesDir())
- .withPathSensitivity(PathSensitivity.RELATIVE)
- .withPropertyName("resources");
- dependsOn((Callable) () -> this.sourceSet.getProcessResourcesTaskName());
- getInputs().files((Callable) () -> this.sourceSet.getOutput().getClassesDirs())
- .withPathSensitivity(PathSensitivity.RELATIVE)
- .withPropertyName("classes");
+ Configuration testSliceMetadata = getProject().getConfigurations().maybeCreate("testSliceMetadata");
+ getProject().afterEvaluate((evaluated) -> evaluated.getArtifacts()
+ .add(testSliceMetadata.getName(), getOutputFile(), (artifact) -> artifact.builtBy(this)));
}
public void setSourceSet(SourceSet sourceSet) {
- this.sourceSet = sourceSet;
+ this.classpath = sourceSet.getRuntimeClasspath();
+ this.importsFiles = getProject().fileTree(new File(sourceSet.getOutput().getResourcesDir(), "META-INF/spring"),
+ (tree) -> tree.filter((file) -> file.getName().endsWith(".imports")));
+ getSpringFactories().set(new File(sourceSet.getOutput().getResourcesDir(), "META-INF/spring.factories"));
+ this.classesDirs = sourceSet.getOutput().getClassesDirs();
}
@OutputFile
- public File getOutputFile() {
- return this.outputFile;
+ public abstract RegularFileProperty getOutputFile();
+
+ @InputFile
+ @PathSensitive(PathSensitivity.RELATIVE)
+ abstract RegularFileProperty getSpringFactories();
+
+ @Classpath
+ FileCollection getClasspath() {
+ return this.classpath;
}
- public void setOutputFile(File outputFile) {
- this.outputFile = outputFile;
- Configuration testSliceMetadata = getProject().getConfigurations().maybeCreate("testSliceMetadata");
- getProject().getArtifacts()
- .add(testSliceMetadata.getName(), getProject().provider((Callable) this::getOutputFile),
- (artifact) -> artifact.builtBy(this));
+ @InputFiles
+ @PathSensitive(PathSensitivity.RELATIVE)
+ FileCollection getImportFiles() {
+ return this.importsFiles;
+ }
+
+ @Classpath
+ FileCollection getClassesDirs() {
+ return this.classesDirs;
}
@TaskAction
void documentTestSlices() throws IOException {
Properties testSlices = readTestSlices();
- getOutputFile().getParentFile().mkdirs();
- try (FileWriter writer = new FileWriter(getOutputFile())) {
+ File outputFile = getOutputFile().getAsFile().get();
+ outputFile.getParentFile().mkdirs();
+ try (FileWriter writer = new FileWriter(outputFile)) {
testSlices.store(writer, null);
}
}
@@ -104,15 +121,11 @@ void documentTestSlices() throws IOException {
private Properties readTestSlices() throws IOException {
Properties testSlices = CollectionFactory.createSortedProperties(true);
try (URLClassLoader classLoader = new URLClassLoader(
- StreamSupport.stream(this.sourceSet.getRuntimeClasspath().spliterator(), false)
- .map(this::toURL)
- .toArray(URL[]::new))) {
+ StreamSupport.stream(this.classpath.spliterator(), false).map(this::toURL).toArray(URL[]::new))) {
MetadataReaderFactory metadataReaderFactory = new SimpleMetadataReaderFactory(classLoader);
- Properties springFactories = readSpringFactories(
- new File(this.sourceSet.getOutput().getResourcesDir(), "META-INF/spring.factories"));
- readTestSlicesDirectory(springFactories,
- new File(this.sourceSet.getOutput().getResourcesDir(), "META-INF/spring/"));
- for (File classesDir : this.sourceSet.getOutput().getClassesDirs()) {
+ Properties springFactories = readSpringFactories(getSpringFactories().getAsFile().get());
+ readImportsFiles(springFactories, this.importsFiles);
+ for (File classesDir : this.classesDirs) {
addTestSlices(testSlices, classesDir, metadataReaderFactory, springFactories);
}
}
@@ -120,18 +133,14 @@ private Properties readTestSlices() throws IOException {
}
/**
- * Reads files from the given directory and puts them in springFactories. The key is
- * the file name, the value is the file contents, split by line, delimited with comma.
- * This is done to mimic the spring.factories structure.
+ * Reads the given imports files and puts them in springFactories. The key is the file
+ * name, the value is the file contents, split by line, delimited with a comma. This
+ * is done to mimic the spring.factories structure.
* @param springFactories spring.factories parsed as properties
- * @param directory directory to scan
+ * @param importsFiles the imports files to read
*/
- private void readTestSlicesDirectory(Properties springFactories, File directory) {
- File[] files = directory.listFiles((dir, name) -> name.endsWith(".imports"));
- if (files == null) {
- return;
- }
- for (File file : files) {
+ private void readImportsFiles(Properties springFactories, FileCollection importsFiles) {
+ for (File file : importsFiles.getFiles()) {
try {
List lines = removeComments(Files.readAllLines(file.toPath()));
String fileNameWithoutExtension = file.getName()
diff --git a/buildSrc/src/main/java/org/springframework/boot/build/toolchain/ToolchainPlugin.java b/buildSrc/src/main/java/org/springframework/boot/build/toolchain/ToolchainPlugin.java
index 82abe1cd65d1..b5e602d7fa08 100644
--- a/buildSrc/src/main/java/org/springframework/boot/build/toolchain/ToolchainPlugin.java
+++ b/buildSrc/src/main/java/org/springframework/boot/build/toolchain/ToolchainPlugin.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -71,8 +71,7 @@ private void disableToolchainTasks(Project project) {
}
private void configureTestToolchain(Project project, ToolchainExtension toolchain) {
- List jvmArgs = new ArrayList<>();
- jvmArgs.addAll(toolchain.getTestJvmArgs().getOrElse(Collections.emptyList()));
+ List jvmArgs = new ArrayList<>(toolchain.getTestJvmArgs().getOrElse(Collections.emptyList()));
project.getTasks().withType(Test.class, (test) -> test.jvmArgs(jvmArgs));
}
diff --git a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
new file mode 100644
index 000000000000..023a3473c5d3
--- /dev/null
+++ b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
@@ -0,0 +1,75 @@
+# === INCLUDE-CODE LOCATIONS ===
+
+include-java=ROOT:example$java/org/springframework/boot/docs
+include-kotlin= ROOT:example$kotlin/org/springframework/boot/docs
+
+# === URLs ===
+
+url-ant-docs=https://ant.apache.org/manual
+url-buildpacks-docs=https://buildpacks.io/docs
+url-dynatrace-docs=https://docs.dynatrace.com/docs
+url-dynatrace-docs-shortlink={url-dynatrace-docs}/shortlink
+url-github-raw=https://raw.githubusercontent.com/{github-repo}/{github-ref}
+url-github-issues=https://github.com/{github-repo}/issues
+url-github-wiki=https://github.com/{github-repo}/wiki
+url-github=https://github.com/{github-repo}
+url-graal-docs=https://www.graalvm.org/{version-graal}/reference-manual
+url-graal-docs-native-image={url-graal-docs}/native-image
+url-gradle-docs=https://docs.gradle.org/current/userguide
+url-gradle-docs-application-plugin={url-gradle-docs}/application_plugin.html
+url-gradle-docs-groovy-plugin={url-gradle-docs}/groovy_plugin.html
+url-gradle-docs-java-plugin={url-gradle-docs}/java_plugin.html
+url-gradle-docs-war-plugin={url-gradle-docs}/war_plugin.html
+url-gradle-dsl=https://docs.gradle.org/current/dsl
+url-gradle-javadoc=https://docs.gradle.org/current/javadoc
+url-kotlin-docs-kotlin-plugin={url-kotlin-docs}/using-gradle.html
+url-micrometer-docs-concepts={url-micrometer-docs}/concepts
+url-micrometer-docs-implementations={url-micrometer-docs}/implementations
+url-download-liberica-nik=https://bell-sw.com/pages/downloads/native-image-kit/#/nik-22-17
+url-native-build-tools-docs=https://graalvm.github.io/native-build-tools/{version-native-build-tools}
+url-native-build-tools-docs-gradle-plugin={url-native-build-tools-docs}/gradle-plugin.html
+url-native-build-tools-docs-maven-plugin={url-native-build-tools-docs}/maven-plugin.html
+url-paketo-docs=https://paketo.io/docs
+url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java
+url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5
+url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode
+url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra
+url-spring-data-commons-javadoc=https://docs.spring.io/spring-data/commons/docs/{version-spring-data-commons}/api
+url-spring-data-couchbase-docs=https://docs.spring.io/spring-data/couchbase/reference/{version-spring-data-couchbase}
+url-spring-data-couchbase-site=https://spring.io/projects/spring-data-couchbase
+url-spring-data-elasticsearch-docs=https://docs.spring.io/spring-data/elasticsearch/reference/{version-spring-data-elasticsearch}
+url-spring-data-elasticsearch-site=https://spring.io/projects/spring-data-elasticsearch
+url-spring-data-envers-site=https://spring.io/projects/spring-data-envers
+url-spring-data-gemfire-site=https://spring.io/projects/spring-data-gemfire
+url-spring-data-geode-site=https://spring.io/projects/spring-data-geode
+url-spring-data-jdbc-docs=https://docs.spring.io/spring-data/relational/reference/{version-spring-data-jdbc}
+url-spring-data-jpa-javadoc=https://docs.spring.io/spring-data/jpa/docs/{version-spring-data-jpa}/api
+url-spring-data-jpa-site=https://spring.io/projects/spring-jpa
+url-spring-data-jpa-docs=https://docs.spring.io/spring-data/jpa/reference/{version-spring-data-jpa}
+url-spring-data-ldap-site=https://spring.io/projects/spring-data-ldap
+url-spring-data-mongodb-javadoc=https://docs.spring.io/spring-data/mongodb/docs/{version-spring-data-mongodb}/api
+url-spring-data-mongodb-site=https://spring.io/projects/spring-data-mongodb
+url-spring-data-mongodb-docs=https://docs.spring.io/spring-data/mongodb/reference/{version-spring-data-mongodb}
+url-spring-data-neo4j-docs=https://docs.spring.io/spring-data/neo4j/reference/{version-spring-data-neo4j}
+url-spring-data-neo4j-site=https://spring.io/projects/spring-data-neo4j
+url-spring-data-r2dbc-javadoc=https://docs.spring.io/spring-data/r2dbc/docs/{version-spring-data-r2dbc}/api
+url-spring-data-r2dbc-docs=https://docs.spring.io/spring-data/relational/reference/{version-spring-data-r2dbc}
+url-spring-data-redis-site=https://spring.io/projects/spring-data-redis
+url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{version-spring-data-rest}/api
+url-spring-data-site=https://spring.io/projects/spring-data
+
+# === API References ===
+
+apiref-gradle-plugin-boot-build-image=xref:gradle-plugin:api/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImage.html
+apiref-gradle-plugin-boot-jar=xref:gradle-plugin:api/java/org/springframework/boot/gradle/tasks/bundling/BootJar.html
+apiref-gradle-plugin-boot-run=xref:gradle-plugin:api/java/org/springframework/boot/gradle/tasks/run/BootRun.html
+apiref-gradle-plugin-boot-war=xref:gradle-plugin:api/java/org/springframework/boot/gradle/tasks/bundling/BootWar.html
+apiref-gradle-plugin-boot-build-info=xref:gradle-plugin:api/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html
+apiref-openjdk=https://docs.oracle.com/en/java/javase/17/docs/api
+
+# === Code Links ===
+
+code-spring-boot=https://github.com/{github-repo}/tree/{github-ref}
+code-spring-boot-autoconfigure-src={code-spring-boot}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure
+code-spring-boot-latest=https://github.com/{github-repo}/tree/main
+
diff --git a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-playbook-template.yml b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-playbook-template.yml
new file mode 100644
index 000000000000..6960bc197928
--- /dev/null
+++ b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-playbook-template.yml
@@ -0,0 +1,24 @@
+antora:
+ extensions:
+site:
+ title: Spring Boot
+content:
+ sources: []
+asciidoc:
+ sourcemap: true
+ attributes:
+ chomp: all
+ hide-uri-scheme: '@'
+ page-pagination: ''
+ page-stackoverflow-url: https://stackoverflow.com/tags/spring-boot
+ tabs-sync-option: '@'
+ extensions:
+ - '@asciidoctor/tabs'
+ - '@springio/asciidoctor-extensions'
+ - '@springio/asciidoctor-extensions/configuration-properties-extension'
+ - '@springio/asciidoctor-extensions/section-ids-extension'
+urls:
+ latest_version_segment: ''
+runtime:
+ log:
+ failure_level: warn
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/ConventionsPluginTests.java b/buildSrc/src/test/java/org/springframework/boot/build/ConventionsPluginTests.java
index 15dda0d9336f..539cb3781795 100644
--- a/buildSrc/src/test/java/org/springframework/boot/build/ConventionsPluginTests.java
+++ b/buildSrc/src/test/java/org/springframework/boot/build/ConventionsPluginTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/antora/AntoraAsciidocAttributesTests.java b/buildSrc/src/test/java/org/springframework/boot/build/antora/AntoraAsciidocAttributesTests.java
new file mode 100644
index 000000000000..c197e3cefd40
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/antora/AntoraAsciidocAttributesTests.java
@@ -0,0 +1,172 @@
+/*
+ * Copyright 2012-2024 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.antora;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.build.bom.Library;
+import org.springframework.boot.build.bom.Library.Group;
+import org.springframework.boot.build.bom.Library.LibraryVersion;
+import org.springframework.boot.build.bom.Library.ProhibitedVersion;
+import org.springframework.boot.build.bom.Library.VersionAlignment;
+import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link AntoraAsciidocAttributes}.
+ *
+ * @author Phillip Webb
+ */
+class AntoraAsciidocAttributesTests {
+
+ @Test
+ void githubRefWhenReleasedVersionIsTag() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("github-ref", "v1.2.3");
+ }
+
+ @Test
+ void githubRefWhenLatestSnapshotVersionIsMainBranch() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3-SNAPSHOT", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("github-ref", "main");
+ }
+
+ @Test
+ void githubRefWhenOlderSnapshotVersionIsBranch() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3-SNAPSHOT", false, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("github-ref", "1.2.x");
+ }
+
+ @Test
+ void githubRefWhenOlderSnapshotHotFixVersionIsBranch() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3.1-SNAPSHOT", false, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("github-ref", "1.2.3.x");
+ }
+
+ @Test
+ void versionReferenceFromLibrary() {
+ Library library = mockLibrary(Collections.emptyMap());
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3.1-SNAPSHOT", false, List.of(library),
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("version-spring-framework", "1.2.3");
+ }
+
+ @Test
+ void versionReferenceFromSpringDataDependencyVersion() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("version-spring-data-mongodb", "1.2.3");
+ }
+
+ @Test
+ void versionNativeBuildTools() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3", true, null,
+ mockDependencyVersions(), Map.of("nativeBuildToolsVersion", "3.4.5"));
+ assertThat(attributes.get()).containsEntry("version-native-build-tools", "3.4.5");
+ }
+
+ @Test
+ void urlArtifactRepositoryWhenRelease() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("url-artifact-repository", "https://repo.maven.apache.org/maven2");
+ }
+
+ @Test
+ void urlArtifactRepositoryWhenMilestone() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3-M1", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("url-artifact-repository", "https://repo.spring.io/milestone");
+ }
+
+ @Test
+ void urlArtifactRepositoryWhenSnapshot() {
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3-SNAPSHOT", true, null,
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("url-artifact-repository", "https://repo.spring.io/snapshot");
+ }
+
+ @Test
+ void urlLinksFromLibrary() {
+ Map> links = new LinkedHashMap<>();
+ links.put("site", (version) -> "https://example.com/site/" + version);
+ links.put("docs", (version) -> "https://example.com/docs/" + version);
+ Library library = mockLibrary(links);
+ AntoraAsciidocAttributes attributes = new AntoraAsciidocAttributes("1.2.3.1-SNAPSHOT", false, List.of(library),
+ mockDependencyVersions(), null);
+ assertThat(attributes.get()).containsEntry("url-spring-framework-site", "https://example.com/site/1.2.3")
+ .containsEntry("url-spring-framework-docs", "https://example.com/docs/1.2.3");
+ }
+
+ @Test
+ void linksFromProperties() {
+ Map attributes = new AntoraAsciidocAttributes("1.2.3-SNAPSHOT", true, null,
+ mockDependencyVersions(), null)
+ .get();
+ assertThat(attributes).containsEntry("include-java", "ROOT:example$java/org/springframework/boot/docs");
+ assertThat(attributes).containsEntry("url-spring-data-cassandra-site",
+ "https://spring.io/projects/spring-data-cassandra");
+ List keys = new ArrayList<>(attributes.keySet());
+ assertThat(keys.indexOf("include-java")).isLessThan(keys.indexOf("code-spring-boot-latest"));
+ }
+
+ private Library mockLibrary(Map> links) {
+ String name = "Spring Framework";
+ String calendarName = null;
+ LibraryVersion version = new LibraryVersion(DependencyVersion.parse("1.2.3"));
+ List groups = Collections.emptyList();
+ List prohibitedVersion = Collections.emptyList();
+ boolean considerSnapshots = false;
+ VersionAlignment versionAlignment = null;
+ String alignsWithBom = null;
+ String linkRootName = null;
+ Library library = new Library(name, calendarName, version, groups, prohibitedVersion, considerSnapshots,
+ versionAlignment, alignsWithBom, linkRootName, links);
+ return library;
+ }
+
+ private Map mockDependencyVersions() {
+ Map versions = new LinkedHashMap<>();
+ addMockSpringDataVersion(versions, "spring-data-commons");
+ addMockSpringDataVersion(versions, "spring-data-couchbase");
+ addMockSpringDataVersion(versions, "spring-data-elasticsearch");
+ addMockSpringDataVersion(versions, "spring-data-jdbc");
+ addMockSpringDataVersion(versions, "spring-data-jpa");
+ addMockSpringDataVersion(versions, "spring-data-mongodb");
+ addMockSpringDataVersion(versions, "spring-data-neo4j");
+ addMockSpringDataVersion(versions, "spring-data-r2dbc");
+ addMockSpringDataVersion(versions, "spring-data-rest-core");
+ return versions;
+ }
+
+ private void addMockSpringDataVersion(Map versions, String artifactId) {
+ versions.put("org.springframework.data:" + artifactId, "1.2.3");
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/antora/GenerateAntoraPlaybookTests.java b/buildSrc/src/test/java/org/springframework/boot/build/antora/GenerateAntoraPlaybookTests.java
new file mode 100644
index 000000000000..4bcaed2e2748
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/antora/GenerateAntoraPlaybookTests.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2012-2024 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.antora;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Map;
+
+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.util.function.ThrowingConsumer;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link GenerateAntoraPlaybook}.
+ *
+ * @author Phillip Webb
+ */
+class GenerateAntoraPlaybookTests {
+
+ @TempDir
+ File temp;
+
+ @Test
+ void writePlaybookGeneratesExpectedContent() throws Exception {
+ writePlaybookYml((task) -> {
+ task.getXrefStubs().addAll("appendix:.*", "api:.*", "reference:.*");
+ task.getAlwaysInclude().set(Map.of("name", "test", "classifier", "local-aggregate-content"));
+ });
+ String actual = Files.readString(this.temp.toPath()
+ .resolve("rootproject/project/build/generated/docs/antora-playbook/antora-playbook.yml"));
+ String expected = Files
+ .readString(Path.of("src/test/resources/org/springframework/boot/build/antora/expected-playbook.yml"));
+ System.out.println(actual);
+ assertThat(actual.replace('\\', '/')).isEqualToNormalizingNewlines(expected.replace('\\', '/'));
+ }
+
+ private void writePlaybookYml(ThrowingConsumer customizer) throws Exception {
+ File rootProjectDir = new File(this.temp, "rootproject").getCanonicalFile();
+ rootProjectDir.mkdirs();
+ Project rootProject = ProjectBuilder.builder().withProjectDir(rootProjectDir).build();
+ File projectDir = new File(rootProjectDir, "project");
+ projectDir.mkdirs();
+ Project project = ProjectBuilder.builder().withProjectDir(projectDir).withParent(rootProject).build();
+ GenerateAntoraPlaybook task = project.getTasks().create("generateAntoraPlaybook", GenerateAntoraPlaybook.class);
+ customizer.accept(task);
+ task.writePlaybookYml();
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java
index 1294d6192975..11f15a8ade9c 100644
--- a/buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -36,6 +36,7 @@
* Tests for {@link ArchitectureCheck}.
*
* @author Andy Wilkinson
+ * @author Scott Frederick
*/
class ArchitectureCheckTests {
@@ -121,6 +122,22 @@ void whenBeanFactoryPostProcessorBeanMethodIsStaticAndHasNoParametersTaskSucceed
});
}
+ @Test
+ void whenClassLoadsResourceUsingResourceUtilsTaskFailsAndWritesReport() throws Exception {
+ prepareTask("resources/loads", (architectureCheck) -> {
+ assertThatExceptionOfType(GradleException.class).isThrownBy(architectureCheck::checkArchitecture);
+ assertThat(failureReport(architectureCheck)).isNotEmpty();
+ });
+ }
+
+ @Test
+ void whenClassUsesResourceUtilsWithoutLoadingResourcesTaskSucceedsAndWritesAnEmptyReport() throws Exception {
+ prepareTask("resources/noloads", (architectureCheck) -> {
+ architectureCheck.checkArchitecture();
+ assertThat(failureReport(architectureCheck)).isEmpty();
+ });
+ }
+
private void prepareTask(String classes, Callback callback) throws Exception {
File projectDir = new File(this.temp, "project");
projectDir.mkdirs();
@@ -136,7 +153,6 @@ private void copyClasses(String name, File projectDir) throws IOException {
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 {
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/loads/ResourceUtilsResourceLoader.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/loads/ResourceUtilsResourceLoader.java
new file mode 100644
index 000000000000..ce5ff3f61bd5
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/loads/ResourceUtilsResourceLoader.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2012-2024 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.resources.loads;
+
+import java.io.FileNotFoundException;
+
+import org.springframework.util.ResourceUtils;
+
+public class ResourceUtilsResourceLoader {
+
+ void getResource() throws FileNotFoundException {
+ ResourceUtils.getURL("gradle.properties");
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/noloads/ResourceUtilsWithoutLoading.java b/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/noloads/ResourceUtilsWithoutLoading.java
new file mode 100644
index 000000000000..98d41edad5d2
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/architecture/resources/noloads/ResourceUtilsWithoutLoading.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-2024 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.resources.noloads;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+import org.springframework.util.ResourceUtils;
+
+public class ResourceUtilsWithoutLoading {
+
+ void inspectResourceLocation() throws MalformedURLException {
+ ResourceUtils.isUrl("gradle.properties");
+ ResourceUtils.isFileURL(new URL("gradle.properties"));
+ "test".startsWith(ResourceUtils.FILE_URL_PREFIX);
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/bom/LibraryTests.java b/buildSrc/src/test/java/org/springframework/boot/build/bom/LibraryTests.java
new file mode 100644
index 000000000000..e3af38dc17a4
--- /dev/null
+++ b/buildSrc/src/test/java/org/springframework/boot/build/bom/LibraryTests.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2012-2024 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.bom;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.build.bom.Library.Group;
+import org.springframework.boot.build.bom.Library.LibraryVersion;
+import org.springframework.boot.build.bom.Library.ProhibitedVersion;
+import org.springframework.boot.build.bom.Library.VersionAlignment;
+import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link Library}.
+ *
+ * @author Phillip Webb
+ */
+class LibraryTests {
+
+ @Test
+ void getLinkRootNameWhenNoneSpecified() {
+ String name = "Spring Framework";
+ String calendarName = null;
+ LibraryVersion version = new LibraryVersion(DependencyVersion.parse("1.2.3"));
+ List groups = Collections.emptyList();
+ List prohibitedVersion = Collections.emptyList();
+ boolean considerSnapshots = false;
+ VersionAlignment versionAlignment = null;
+ String alignsWithBom = null;
+ String linkRootName = null;
+ Map> links = Collections.emptyMap();
+ Library library = new Library(name, calendarName, version, groups, prohibitedVersion, considerSnapshots,
+ versionAlignment, alignsWithBom, linkRootName, links);
+ assertThat(library.getLinkRootName()).isEqualTo("spring-framework");
+ }
+
+ @Test
+ void getLinkRootNameWhenSpecified() {
+ String name = "Spring Data BOM";
+ String calendarName = null;
+ LibraryVersion version = new LibraryVersion(DependencyVersion.parse("1.2.3"));
+ List groups = Collections.emptyList();
+ List prohibitedVersion = Collections.emptyList();
+ boolean considerSnapshots = false;
+ VersionAlignment versionAlignment = null;
+ String alignsWithBom = null;
+ String linkRootName = "spring-data";
+ Map> links = Collections.emptyMap();
+ Library library = new Library(name, calendarName, version, groups, prohibitedVersion, considerSnapshots,
+ versionAlignment, alignsWithBom, linkRootName, links);
+ assertThat(library.getLinkRootName()).isEqualTo("spring-data");
+ }
+
+}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/UpgradeApplicatorTests.java b/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/UpgradeApplicatorTests.java
index a074ca858ae0..b83742ad3691 100644
--- a/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/UpgradeApplicatorTests.java
+++ b/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/UpgradeApplicatorTests.java
@@ -21,6 +21,7 @@
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
+import java.util.Collections;
import java.util.Properties;
import org.junit.jupiter.api.Test;
@@ -51,9 +52,11 @@ void whenUpgradeIsAppliedToLibraryWithVersionThenBomIsUpdated() throws IOExcepti
String originalContents = Files.readString(bom.toPath());
File gradleProperties = new File(this.temp, "gradle.properties");
FileCopyUtils.copy(new File("src/test/resources/gradle.properties"), gradleProperties);
- new UpgradeApplicator(bom.toPath(), gradleProperties.toPath())
- .apply(new Upgrade(new Library("ActiveMQ", null, new LibraryVersion(DependencyVersion.parse("5.15.11")),
- null, null, false, null, null), DependencyVersion.parse("5.16")));
+ new UpgradeApplicator(bom.toPath(), gradleProperties.toPath()).apply(
+ new Upgrade(
+ new Library("ActiveMQ", null, new LibraryVersion(DependencyVersion.parse("5.15.11")), null,
+ null, false, null, null, null, Collections.emptyMap()),
+ DependencyVersion.parse("5.16")));
String bomContents = Files.readString(bom.toPath());
assertThat(bomContents).hasSize(originalContents.length() - 3);
}
@@ -66,7 +69,7 @@ void whenUpgradeIsAppliedToLibraryWithVersionPropertyThenGradlePropertiesIsUpdat
FileCopyUtils.copy(new File("src/test/resources/gradle.properties"), gradleProperties);
new UpgradeApplicator(bom.toPath(), gradleProperties.toPath())
.apply(new Upgrade(new Library("Kotlin", null, new LibraryVersion(DependencyVersion.parse("1.3.70")), null,
- null, false, null, null), DependencyVersion.parse("1.4")));
+ null, false, null, null, null, Collections.emptyMap()), DependencyVersion.parse("1.4")));
Properties properties = new Properties();
try (InputStream in = new FileInputStream(gradleProperties)) {
properties.load(in);
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/context/properties/CompoundRowTests.java b/buildSrc/src/test/java/org/springframework/boot/build/context/properties/CompoundRowTests.java
index 887e01bf7557..4e6949e3f6d1 100644
--- a/buildSrc/src/test/java/org/springframework/boot/build/context/properties/CompoundRowTests.java
+++ b/buildSrc/src/test/java/org/springframework/boot/build/context/properties/CompoundRowTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -24,6 +24,7 @@
* Tests for {@link CompoundRow}.
*
* @author Brian Clozel
+ * @author Moritz Halbritter
*/
class CompoundRowTests {
@@ -39,8 +40,8 @@ void simpleProperty() {
row.addProperty(new ConfigurationProperty("spring.test.third", "java.lang.String"));
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test]]<>" + NEWLINE
+ assertThat(asciidoc).hasToString("|[[my.spring.test]]xref:#my.spring.test[`+spring.test.first+` +" + NEWLINE
+ + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +" + NEWLINE + "]" + NEWLINE
+ "|+++This is a description.+++" + NEWLINE + "|" + NEWLINE);
}
diff --git a/buildSrc/src/test/java/org/springframework/boot/build/context/properties/SingleRowTests.java b/buildSrc/src/test/java/org/springframework/boot/build/context/properties/SingleRowTests.java
index b1e48d8dff75..5d046a71efdb 100644
--- a/buildSrc/src/test/java/org/springframework/boot/build/context/properties/SingleRowTests.java
+++ b/buildSrc/src/test/java/org/springframework/boot/build/context/properties/SingleRowTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -24,6 +24,7 @@
* Tests for {@link SingleRow}.
*
* @author Brian Clozel
+ * @author Moritz Halbritter
*/
class SingleRowTests {
@@ -38,7 +39,7 @@ void simpleProperty() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<>"
+ assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]xref:#my.spring.test.prop[`+spring.test.prop+`]"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE + "|`+something+`" + NEWLINE);
}
@@ -49,7 +50,7 @@ void noDefaultValue() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<>"
+ assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]xref:#my.spring.test.prop[`+spring.test.prop+`]"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE + "|" + NEWLINE);
}
@@ -60,7 +61,7 @@ void defaultValueWithPipes() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<>"
+ assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]xref:#my.spring.test.prop[`+spring.test.prop+`]"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE + "|`+first\\|second+`" + NEWLINE);
}
@@ -71,7 +72,7 @@ void defaultValueWithBackslash() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<>"
+ assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]xref:#my.spring.test.prop[`+spring.test.prop+`]"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE + "|`+first\\\\second+`" + NEWLINE);
}
@@ -82,7 +83,7 @@ void descriptionWithPipe() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<>"
+ assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]xref:#my.spring.test.prop[`+spring.test.prop+`]"
+ NEWLINE + "|+++This is a description with a \\| pipe.+++" + NEWLINE + "|" + NEWLINE);
}
@@ -93,7 +94,7 @@ void mapProperty() {
SingleRow row = new SingleRow(SNIPPET, property);
Asciidoc asciidoc = new Asciidoc();
row.write(asciidoc);
- assertThat(asciidoc).hasToString("|[[my.spring.test.prop]]<