Remove calls to deprecated Project.getBuildDir()

Closes gh-42728

Author: mhalbritter

buildSrc/src/main/java/org/springframework/boot/build/AsciidoctorConventions.java

@@ -147,10 +147,14 @@ private void configureOptions(AbstractAsciidoctorTask asciidoctorTask) {
 		asciidoctorTask.options(Collections.singletonMap("doctype", "book"));
 	}
 
-	private Sync createSyncDocumentationSourceTask(Project project, AbstractAsciidoctorTask asciidoctorTask) {
+	private void 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());
+		File syncedSource = project.getLayout()
+			.getBuildDirectory()
+			.dir("docs/src/" + asciidoctorTask.getName())
+			.get()
+			.getAsFile();
 		syncDocumentationSource.setDestinationDir(syncedSource);
 		syncDocumentationSource.from("src/docs/");
 		asciidoctorTask.dependsOn(syncDocumentationSource);
@@ -159,7 +163,6 @@ private Sync createSyncDocumentationSourceTask(Project project, AbstractAsciidoc
 			.withPathSensitivity(PathSensitivity.RELATIVE)
 			.withPropertyName("synced source");
 		asciidoctorTask.setSourceDir(project.relativePath(new File(syncedSource, "asciidoc/")));
-		return syncDocumentationSource;
 	}
 
 }

buildSrc/src/main/java/org/springframework/boot/build/MavenRepositoryPlugin.java

@@ -58,7 +58,7 @@ public class MavenRepositoryPlugin implements Plugin<Project> {
 	public void apply(Project project) {
 		project.getPlugins().apply(MavenPublishPlugin.class);
 		PublishingExtension publishing = project.getExtensions().getByType(PublishingExtension.class);
-		File repositoryLocation = new File(project.getBuildDir(), "maven-repository");
+		File repositoryLocation = project.getLayout().getBuildDirectory().dir("maven-repository").get().getAsFile();
 		publishing.getRepositories().maven((mavenRepository) -> {
 			mavenRepository.setName("project");
 			mavenRepository.setUrl(repositoryLocation.toURI());

buildSrc/src/main/java/org/springframework/boot/build/architecture/ArchitectureCheck.java

@@ -82,7 +82,8 @@ public ArchitectureCheck() {
 				noClassesShouldCallStepVerifierStepVerifyComplete(),
 				noClassesShouldConfigureDefaultStepVerifierTimeout(), noClassesShouldCallCollectorsToList(),
 				noClassesShouldCallURLEncoderWithStringEncoding(), noClassesShouldCallURLDecoderWithStringEncoding(),
-				noClassesShouldCallStringToUpperCaseWithoutLocale(), noClassesShouldCallStringToLowerCaseWithoutLocale());
+				noClassesShouldCallStringToUpperCaseWithoutLocale(),
+				noClassesShouldCallStringToLowerCaseWithoutLocale());
 		getRules().addAll(getProhibitObjectsRequireNonNull()
 			.map((prohibit) -> prohibit ? noClassesShouldCallObjectsRequireNonNull() : Collections.emptyList()));
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));

buildSrc/src/main/java/org/springframework/boot/build/autoconfigure/AutoConfigurationPlugin.java

@@ -93,7 +93,8 @@ public void apply(Project project) {
 					.getByName(SourceSet.MAIN_SOURCE_SET_NAME);
 				task.setSourceSet(main);
 				task.dependsOn(main.getClassesTaskName());
-				task.getOutputFile().set(new File(project.getBuildDir(), "auto-configuration-metadata.properties"));
+				task.getOutputFile()
+					.set(project.getLayout().getBuildDirectory().file("auto-configuration-metadata.properties"));
 				project.getArtifacts()
 					.add(AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME, task.getOutputFile(),
 							(artifact) -> artifact.builtBy(task));

buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java

@@ -130,7 +130,11 @@ public void effectiveBomArtifact() {
 			.all((task) -> {
 				Sync syncBom = this.project.getTasks().create("syncBom", Sync.class);
 				syncBom.dependsOn(task);
-				File generatedBomDir = new File(this.project.getBuildDir(), "generated/bom");
+				File generatedBomDir = this.project.getLayout()
+					.getBuildDirectory()
+					.dir("generated/bom")
+					.get()
+					.getAsFile();
 				syncBom.setDestinationDir(generatedBomDir);
 				syncBom.from(((GenerateMavenPom) task).getDestination(), (pom) -> pom.rename((name) -> "pom.xml"));
 				try {
@@ -139,7 +143,12 @@ public void effectiveBomArtifact() {
 								getClass().getClassLoader().getResourceAsStream("effective-bom-settings.xml"),
 								StandardCharsets.UTF_8))
 						.replace("localRepositoryPath",
-								new File(this.project.getBuildDir(), "local-m2-repository").getAbsolutePath());
+								this.project.getLayout()
+									.getBuildDirectory()
+									.dir("local-m2-repository")
+									.get()
+									.getAsFile()
+									.getAbsolutePath());
 					syncBom.from(this.project.getResources().getText().fromString(settingsXmlContent),
 							(settingsXml) -> settingsXml.rename((name) -> "settings.xml"));
 				}
@@ -149,8 +158,11 @@ public void effectiveBomArtifact() {
 				MavenExec generateEffectiveBom = this.project.getTasks()
 					.create("generateEffectiveBom", MavenExec.class);
 				generateEffectiveBom.getProjectDir().set(generatedBomDir);
-				File effectiveBom = new File(this.project.getBuildDir(),
-						"generated/effective-bom/" + this.project.getName() + "-effective-bom.xml");
+				File effectiveBom = this.project.getLayout()
+					.getBuildDirectory()
+					.file("generated/effective-bom/" + this.project.getName() + "-effective-bom.xml")
+					.get()
+					.getAsFile();
 				generateEffectiveBom.args("--settings", "settings.xml", "help:effective-pom",
 						"-Doutput=" + effectiveBom);
 				generateEffectiveBom.dependsOn(syncBom);

buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/MavenPluginPlugin.java

@@ -58,13 +58,15 @@
 import org.gradle.api.component.ConfigurationVariantDetails;
 import org.gradle.api.component.SoftwareComponent;
 import org.gradle.api.file.CopySpec;
+import org.gradle.api.file.Directory;
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.RegularFileProperty;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.JavaLibraryPlugin;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.provider.Provider;
 import org.gradle.api.publish.PublishingExtension;
 import org.gradle.api.publish.maven.MavenPublication;
 import org.gradle.api.publish.maven.plugins.MavenPublishPlugin;
@@ -170,11 +172,11 @@ private void addPopulateIntTestMavenRepositoryTask(Project project) {
 		RuntimeClasspathMavenRepository runtimeClasspathMavenRepository = project.getTasks()
 			.create("runtimeClasspathMavenRepository", RuntimeClasspathMavenRepository.class);
 		runtimeClasspathMavenRepository.getOutputDir()
-			.set(new File(project.getBuildDir(), "runtime-classpath-repository"));
+			.set(project.getLayout().getBuildDirectory().dir("runtime-classpath-repository"));
 		project.getDependencies()
 			.components((components) -> components.all(MavenRepositoryComponentMetadataRule.class));
 		Sync task = project.getTasks().create("populateTestMavenRepository", Sync.class);
-		task.setDestinationDir(new File(project.getBuildDir(), "test-maven-repository"));
+		task.setDestinationDir(project.getLayout().getBuildDirectory().dir("test-maven-repository").get().getAsFile());
 		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);
@@ -188,7 +190,7 @@ private CopySpec copyIntTestMavenRepositoryFiles(Project project,
 			RuntimeClasspathMavenRepository runtimeClasspathMavenRepository) {
 		CopySpec copySpec = project.copySpec();
 		copySpec.from(project.getConfigurations().getByName(MavenRepositoryPlugin.MAVEN_REPOSITORY_CONFIGURATION_NAME));
-		copySpec.from(new File(project.getBuildDir(), "maven-repository"));
+		copySpec.from(project.getLayout().getBuildDirectory().dir("maven-repository"));
 		copySpec.from(runtimeClasspathMavenRepository);
 		return copySpec;
 	}
@@ -197,29 +199,29 @@ private void addDocumentPluginGoalsTask(Project project, MavenExec generatePlugi
 		DocumentPluginGoals task = project.getTasks().create("documentPluginGoals", DocumentPluginGoals.class);
 		File pluginXml = new File(generatePluginDescriptorTask.getOutputs().getFiles().getSingleFile(), "plugin.xml");
 		task.getPluginXml().set(pluginXml);
-		task.getOutputDir().set(new File(project.getBuildDir(), "docs/generated/goals/"));
+		task.getOutputDir().set(project.getLayout().getBuildDirectory().dir("docs/generated/goals/"));
 		task.dependsOn(generatePluginDescriptorTask);
 	}
 
 	private MavenExec addGenerateHelpMojoTask(Project project, Jar jarTask) {
-		File helpMojoDir = new File(project.getBuildDir(), "help-mojo");
+		Provider<Directory> helpMojoDir = project.getLayout().getBuildDirectory().dir("help-mojo");
 		MavenExec task = createGenerateHelpMojoTask(project, helpMojoDir);
 		task.dependsOn(createSyncHelpMojoInputsTask(project, helpMojoDir));
 		includeHelpMojoInJar(jarTask, task);
 		return task;
 	}
 
-	private MavenExec createGenerateHelpMojoTask(Project project, File helpMojoDir) {
+	private MavenExec createGenerateHelpMojoTask(Project project, Provider<Directory> helpMojoDir) {
 		MavenExec task = project.getTasks().create("generateHelpMojo", MavenExec.class);
 		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"));
+		task.getOutputs().dir(helpMojoDir.map((directory) -> directory.dir("target/generated-sources/plugin")));
 		return task;
 	}
 
-	private Sync createSyncHelpMojoInputsTask(Project project, File helpMojoDir) {
+	private Sync createSyncHelpMojoInputsTask(Project project, Provider<Directory> helpMojoDir) {
 		Sync task = project.getTasks().create("syncHelpMojoInputs", Sync.class);
-		task.setDestinationDir(helpMojoDir);
+		task.setDestinationDir(helpMojoDir.get().getAsFile());
 		File pomFile = new File(project.getProjectDir(), "src/maven/resources/pom.xml");
 		task.from(pomFile, (copy) -> replaceVersionPlaceholder(copy, project));
 		return task;
@@ -231,8 +233,10 @@ private void includeHelpMojoInJar(Jar jarTask, JavaExec generateHelpMojoTask) {
 	}
 
 	private MavenExec addGeneratePluginDescriptorTask(Project project, Jar jarTask, MavenExec generateHelpMojoTask) {
-		File pluginDescriptorDir = new File(project.getBuildDir(), "plugin-descriptor");
-		File generatedHelpMojoDir = new File(project.getBuildDir(), "generated/sources/helpMojo");
+		Provider<Directory> pluginDescriptorDir = project.getLayout().getBuildDirectory().dir("plugin-descriptor");
+		Provider<Directory> generatedHelpMojoDir = project.getLayout()
+			.getBuildDirectory()
+			.dir("generated/sources/helpMojo");
 		SourceSet mainSourceSet = getMainSourceSet(project);
 		project.getTasks().withType(Javadoc.class, this::setJavadocOptions);
 		FormatHelpMojoSource formattedHelpMojoSource = createFormatHelpMojoSource(project, generateHelpMojoTask,
@@ -258,17 +262,18 @@ private void setJavadocOptions(Javadoc javadoc) {
 	}
 
 	private FormatHelpMojoSource createFormatHelpMojoSource(Project project, MavenExec generateHelpMojoTask,
-			File generatedHelpMojoDir) {
+			Provider<Directory> generatedHelpMojoDir) {
 		FormatHelpMojoSource formatHelpMojoSource = project.getTasks()
 			.create("formatHelpMojoSource", FormatHelpMojoSource.class);
 		formatHelpMojoSource.setGenerator(generateHelpMojoTask);
 		formatHelpMojoSource.getOutputDir().set(generatedHelpMojoDir);
 		return formatHelpMojoSource;
 	}
 
-	private Sync createSyncPluginDescriptorInputs(Project project, File destination, SourceSet sourceSet) {
+	private Sync createSyncPluginDescriptorInputs(Project project, Provider<Directory> destination,
+			SourceSet sourceSet) {
 		Sync pluginDescriptorInputs = project.getTasks().create("syncPluginDescriptorInputs", Sync.class);
-		pluginDescriptorInputs.setDestinationDir(destination);
+		pluginDescriptorInputs.setDestinationDir(destination.get().getAsFile());
 		File pomFile = new File(project.getProjectDir(), "src/maven/resources/pom.xml");
 		pluginDescriptorInputs.from(pomFile, (copy) -> replaceVersionPlaceholder(copy, project));
 		pluginDescriptorInputs.from(sourceSet.getOutput().getClassesDirs(), (sync) -> sync.into("target/classes"));
@@ -277,12 +282,13 @@ private Sync createSyncPluginDescriptorInputs(Project project, File destination,
 		return pluginDescriptorInputs;
 	}
 
-	private MavenExec createGeneratePluginDescriptorTask(Project project, File mavenDir) {
+	private MavenExec createGeneratePluginDescriptorTask(Project project, Provider<Directory> mavenDir) {
 		MavenExec generatePluginDescriptor = project.getTasks().create("generatePluginDescriptor", MavenExec.class);
 		generatePluginDescriptor.args("org.apache.maven.plugins:maven-plugin-plugin:3.6.1:descriptor");
-		generatePluginDescriptor.getOutputs().dir(new File(mavenDir, "target/classes/META-INF/maven"));
+		generatePluginDescriptor.getOutputs()
+			.dir(mavenDir.map((directory) -> directory.dir("target/classes/META-INF/maven")));
 		generatePluginDescriptor.getInputs()
-			.dir(new File(mavenDir, "target/classes/org"))
+			.dir(mavenDir.map((directory) -> directory.dir("target/classes/org")))
 			.withPathSensitivity(PathSensitivity.RELATIVE)
 			.withPropertyName("plugin classes");
 		generatePluginDescriptor.getProjectDir().set(mavenDir);
@@ -298,7 +304,7 @@ private void addPrepareMavenBinariesTask(Project project) {
 		TaskProvider<PrepareMavenBinaries> task = project.getTasks()
 			.register("prepareMavenBinaries", PrepareMavenBinaries.class,
 					(prepareMavenBinaries) -> prepareMavenBinaries.getOutputDir()
-						.set(new File(project.getBuildDir(), "maven-binaries")));
+						.set(project.getLayout().getBuildDirectory().dir("maven-binaries")));
 		project.getTasks()
 			.getByName(IntegrationTestPlugin.INT_TEST_TASK_NAME)
 			.getInputs()

buildSrc/src/main/java/org/springframework/boot/build/starters/StarterPlugin.java

@@ -16,18 +16,19 @@
 
 package org.springframework.boot.build.starters;
 
-import java.io.File;
 import java.util.Map;
 import java.util.TreeMap;
 
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.ConfigurationContainer;
+import org.gradle.api.file.RegularFile;
 import org.gradle.api.plugins.JavaBasePlugin;
 import org.gradle.api.plugins.JavaLibraryPlugin;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.PluginContainer;
+import org.gradle.api.provider.Provider;
 import org.gradle.api.tasks.bundling.Jar;
 
 import org.springframework.boot.build.ConventionsPlugin;
@@ -56,7 +57,7 @@ public void apply(Project project) {
 		ConfigurationContainer configurations = project.getConfigurations();
 		Configuration runtimeClasspath = configurations.getByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
 		starterMetadata.setDependencies(runtimeClasspath);
-		File destination = new File(project.getBuildDir(), "starter-metadata.properties");
+		Provider<RegularFile> destination = project.getLayout().getBuildDirectory().file("starter-metadata.properties");
 		starterMetadata.getDestination().set(destination);
 		configurations.create("starterMetadata");
 		project.getArtifacts()

buildSrc/src/test/java/org/springframework/boot/build/architecture/ArchitectureCheckTests.java

@@ -60,7 +60,12 @@ void whenPackagesAreNotTangledTaskSucceedsAndWritesAnEmptyReport() throws Except
 	}
 
 	File failureReport(ArchitectureCheck architectureCheck) {
-		return new File(architectureCheck.getProject().getBuildDir(), "checkArchitecture/failure-report.txt");
+		return architectureCheck.getProject()
+			.getLayout()
+			.getBuildDirectory()
+			.file("checkArchitecture/failure-report.txt")
+			.get()
+			.getAsFile();
 	}
 
 	@Test