From 8c3820f87ed955fb61c6d3ecd815727cecab8d8b Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 5 Oct 2021 11:08:22 +0100 Subject: [PATCH] Fix up-to-date checking of syncAppSource tasks Previously, the project version was used while filtering the apps source during syncing but it was not considered as an input to the task. This could result in the syncing being skipped even though the project's version had changed. This commit introduces a new custom task to make the configuration more declarative and to allow the necessary input configuration to be done in a single place. Closes gh-28197 --- .../boot/build/SyncAppSource.java | 75 +++++++++++++++++++ .../build.gradle | 9 +-- .../spring-boot-loader-tests/build.gradle | 9 +-- .../spring-boot-server-tests/build.gradle | 9 +-- 4 files changed, 84 insertions(+), 18 deletions(-) create mode 100644 buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java diff --git a/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java b/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java new file mode 100644 index 00000000000..1a8204805c5 --- /dev/null +++ b/buildSrc/src/main/java/org/springframework/boot/build/SyncAppSource.java @@ -0,0 +1,75 @@ +/* + * Copyright 2021 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 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; +import org.gradle.api.tasks.OutputDirectory; +import org.gradle.api.tasks.TaskAction; + +/** + * Tasks for syncing the source code of a Spring Boot application, filtering its + * {@code build.gradle} to set the version of its {@code org.springframework.boot} plugin. + * + * @author Andy Wilkinson + */ +public class SyncAppSource extends DefaultTask { + + private final DirectoryProperty sourceDirectory; + + private final DirectoryProperty destinationDirectory; + + private final Property pluginVersion; + + 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())); + } + + @TaskAction + void syncAppSources() { + getProject().sync((copySpec) -> { + copySpec.from(this.sourceDirectory); + copySpec.into(this.destinationDirectory); + 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/spring-boot-tests/spring-boot-integration-tests/spring-boot-launch-script-tests/build.gradle b/spring-boot-tests/spring-boot-integration-tests/spring-boot-launch-script-tests/build.gradle index b94084dc0a7..d337336121b 100644 --- a/spring-boot-tests/spring-boot-integration-tests/spring-boot-launch-script-tests/build.gradle +++ b/spring-boot-tests/spring-boot-integration-tests/spring-boot-launch-script-tests/build.gradle @@ -30,12 +30,9 @@ task syncMavenRepository(type: Sync) { into "${buildDir}/int-test-maven-repository" } -task syncAppSource(type: Sync) { - from "spring-boot-launch-script-tests-app" - into "${buildDir}/spring-boot-launch-script-tests-app" - filter { line -> - line.replace("id \"org.springframework.boot\"", "id \"org.springframework.boot\" version \"${project.version}\"") - } +task syncAppSource(type: org.springframework.boot.build.SyncAppSource) { + sourceDirectory = file("spring-boot-launch-script-tests-app") + destinationDirectory = file("${buildDir}/spring-boot-launch-script-tests-app") } task buildApp(type: GradleBuild) { diff --git a/spring-boot-tests/spring-boot-integration-tests/spring-boot-loader-tests/build.gradle b/spring-boot-tests/spring-boot-integration-tests/spring-boot-loader-tests/build.gradle index 9e81e00251d..2c2792249d8 100644 --- a/spring-boot-tests/spring-boot-integration-tests/spring-boot-loader-tests/build.gradle +++ b/spring-boot-tests/spring-boot-integration-tests/spring-boot-loader-tests/build.gradle @@ -31,12 +31,9 @@ task syncMavenRepository(type: Sync) { into "${buildDir}/int-test-maven-repository" } -task syncAppSource(type: Sync) { - from "spring-boot-loader-tests-app" - into "${buildDir}/spring-boot-loader-tests-app" - filter { line -> - line.replace("id \"org.springframework.boot\"", "id \"org.springframework.boot\" version \"${project.version}\"") - } +task syncAppSource(type: org.springframework.boot.build.SyncAppSource) { + sourceDirectory = file("spring-boot-loader-tests-app") + destinationDirectory = file("${buildDir}/spring-boot-loader-tests-app") } task buildApp(type: GradleBuild) { diff --git a/spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/build.gradle b/spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/build.gradle index 5a3e9cf0aff..f04fa853a14 100644 --- a/spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/build.gradle +++ b/spring-boot-tests/spring-boot-integration-tests/spring-boot-server-tests/build.gradle @@ -40,12 +40,9 @@ task syncTestRepository(type: Sync) { } } -task syncAppSource(type: Sync) { - from "spring-boot-server-tests-app" - into "${buildDir}/spring-boot-server-tests-app" - filter { line -> - line.replace("id \"org.springframework.boot\"", "id \"org.springframework.boot\" version \"${project.version}\"") - } +task syncAppSource(type: org.springframework.boot.build.SyncAppSource) { + sourceDirectory = file("spring-boot-server-tests-app") + destinationDirectory = file("${buildDir}/spring-boot-server-tests-app") } task buildApps(type: GradleBuild) {