Upgrade to Develocity Plugin 4.0.2

Closes gh-101

Author: wilkinsona

README.md

@@ -56,6 +56,7 @@ To work around this, an environment variable named `BRANCH` can be set on the ta
 ### Anonymous publication
 
 When using Gradle, build scans can be published anonymously to scans.gradle.com by running the build with `--scan`.
+This requires Gradle 8.8 or later.
 
 ## Authentication
 

develocity-conventions-gradle-plugin/build.gradle

@@ -13,7 +13,7 @@ repositories {
 
 dependencies {
 	implementation(project(":develocity-conventions-core"))
-	implementation("com.gradle:develocity-gradle-plugin:3.19.2")
+	implementation("com.gradle:develocity-gradle-plugin:4.0.2")
 
 	testImplementation("org.assertj:assertj-core:3.27.2")
 	testImplementation("org.junit.jupiter:junit-jupiter:5.13.0")

develocity-conventions-gradle-plugin/src/main/java/io/spring/develocity/conventions/gradle/DevelocityConventionsPlugin.java

@@ -35,6 +35,9 @@
 import org.gradle.api.initialization.Settings;
 import org.gradle.api.internal.ProcessOperations;
 import org.gradle.api.provider.Provider;
+import org.gradle.util.GradleVersion;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * {@link Plugin plugin} for configuring the use of Develocity hosted at
@@ -44,6 +47,8 @@
  */
 public class DevelocityConventionsPlugin implements Plugin<Settings> {
 
+	private final Logger log = LoggerFactory.getLogger(DevelocityConventionsPlugin.class);
+
 	private final ProcessOperations processOperations;
 
 	@Inject
@@ -53,6 +58,11 @@ public DevelocityConventionsPlugin(ProcessOperations processOperations) {
 
 	@Override
 	public void apply(Settings settings) {
+		if (buildScanRequested(settings) && gradleVersionIsLessThanEightEight()) {
+			this.log.warn("Develocity conventions disabled. Using --scan requires Gradle 8.8 or later. "
+					+ "Current Gradle version is " + GradleVersion.current().getVersion());
+			return;
+		}
 		settings.getPlugins().apply(DevelocityPlugin.class);
 		DevelocityConfiguration extension = settings.getExtensions().getByType(DevelocityConfiguration.class);
 		if (!isOssBuild(settings)) {
@@ -69,6 +79,14 @@ public void apply(Settings settings) {
 		}
 	}
 
+	private boolean buildScanRequested(Settings settings) {
+		return settings.getStartParameter().isBuildScan();
+	}
+
+	private boolean gradleVersionIsLessThanEightEight() {
+		return GradleVersion.version("8.8").compareTo(GradleVersion.current()) > 0;
+	}
+
 	private boolean isOssBuild(Settings settings) {
 		Properties properties = new Properties();
 		File propertiesFile = new File(settings.getRootDir(), "gradle.properties");

develocity-conventions-gradle-plugin/src/test/java/io/spring/develocity/conventions/gradle/DevelocityConventionsPluginIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 the original author or authors.
+ * Copyright 2020-2025 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,8 +48,8 @@ class DevelocityConventionsPluginIntegrationTests {
 	void whenThePluginIsAppliedThenBuildScanConventionsAreApplied(@TempDir File projectDir) {
 		prepareProject(projectDir);
 		BuildResult result = build(projectDir, "verifyBuildScanConfig");
-		assertThat(result.getOutput()).contains("Build scan server: https://ge.spring.io");
-		assertThat(result.getOutput()).contains("Capture task input files: true");
+		assertThat(result.getOutput()).contains("Develocity server: https://ge.spring.io");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: true");
 	}
 
 	@Test
@@ -63,8 +63,8 @@ void whenThePluginIsAppliedThenBuildCacheConventionsAreApplied(@TempDir File pro
 	void whenThePluginIsAppliedAndBuildScansAreDisabledThenBuildScanConventionsAreNotApplied(@TempDir File projectDir) {
 		prepareProject(projectDir);
 		BuildResult result = build(projectDir, "verifyBuildScanConfig", "--no-scan");
-		assertThat(result.getOutput()).contains("Build scan server: null");
-		assertThat(result.getOutput()).contains("Capture task input files: false");
+		assertThat(result.getOutput()).contains("Develocity server: null");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: false");
 	}
 
 	@Test
@@ -73,43 +73,53 @@ void whenThePluginIsAppliedAndTheSpringBuildTypeIsNotOssThenBuildScanConventions
 		prepareProject(projectDir);
 		write(new File(projectDir, "gradle.properties"), (writer) -> writer.println("spring.build-type=other"));
 		BuildResult result = build(projectDir, "verifyBuildScanConfig");
-		assertThat(result.getOutput()).contains("Build scan server: null");
-		assertThat(result.getOutput()).contains("Capture task input files: false");
+		assertThat(result.getOutput()).contains("Develocity server: null");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: false");
 	}
 
 	@Test
 	void whenThePluginIsAppliedAndTheSpringBuildTypeIsOssThenBuildScanConventionsAreApplied(@TempDir File projectDir) {
 		prepareProject(projectDir);
 		write(new File(projectDir, "gradle.properties"), (writer) -> writer.println("spring.build-type=oss"));
 		BuildResult result = build(projectDir, "verifyBuildScanConfig");
-		assertThat(result.getOutput()).contains("Build scan server: https://ge.spring.io");
-		assertThat(result.getOutput()).contains("Capture task input files: true");
+		assertThat(result.getOutput()).contains("Develocity server: https://ge.spring.io");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: true");
 	}
 
 	@Test
 	void whenThePluginIsAppliedAndPropertiesTaskIsExecutedThenBuildScanConventionsAreNotApplied(
 			@TempDir File projectDir) {
 		prepareProject(projectDir);
 		BuildResult result = build(projectDir, "properties", "verifyBuildScanConfig", "--no-scan");
-		assertThat(result.getOutput()).contains("Build scan server: null");
-		assertThat(result.getOutput()).contains("Capture task input files: false");
+		assertThat(result.getOutput()).contains("Develocity server: null");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: false");
 	}
 
 	@Test
 	void givenMultiProjectBuildWhenThePluginIsAppliedAndPropertiesTaskIsExecutedThenBuildScanConventionsAreNotApplied(
 			@TempDir File projectDir) {
 		prepareMultiModuleProject(projectDir);
 		BuildResult result = build(projectDir, "sub:properties", "sub:verifyBuildScanConfig", "--no-scan");
-		assertThat(result.getOutput()).contains("Build scan server: null");
-		assertThat(result.getOutput()).contains("Capture task input files: false");
+		assertThat(result.getOutput()).contains("Develocity server: null");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: false");
 	}
 
 	@Test
-	void whenThePluginIsAppliedAndScanIsSpecifiedThenServerIsNotCustomized(@TempDir File projectDir) {
+	void whenThePluginIsAppliedAndScanIsSpecifiedItBacksOff(@TempDir File projectDir) {
 		prepareProject(projectDir);
-		BuildResult result = build(projectDir, "verifyBuildScanConfig", "--scan");
-		assertThat(result.getOutput()).contains("Build scan server: null");
-		assertThat(result.getOutput()).contains("Capture task input files: true");
+		BuildResult result = build(projectDir, "--scan");
+		assertThat(result.getOutput())
+			.contains("Develocity conventions disabled. Using --scan requires Gradle 8.8 or later. "
+					+ "Current Gradle version is 7.4.2");
+	}
+
+	@Test
+	void whenThePluginIsAppliedAndScanIsSpecifiedWithGradleEightEightServerIsNotCustomized(@TempDir File projectDir) {
+		prepareProject(projectDir);
+		BuildResult result = build(
+				prepareBuild(projectDir, "verifyBuildScanConfig", "--scan").withGradleVersion("8.8"));
+		assertThat(result.getOutput()).contains("Develocity server: null");
+		assertThat(result.getOutput()).contains("Capture file fingerprints: true");
 	}
 
 	@Test
@@ -147,8 +157,9 @@ private void prepareProject(File projectDir) {
 		write(new File(projectDir, "build.gradle"), (writer) -> {
 			writer.println("task verifyBuildScanConfig {");
 			writer.println("    doFirst {");
-			writer.println("        println \"Build scan server: ${buildScan.server}\"");
-			writer.println("        println \"Capture task input files: ${buildScan.captureTaskInputFiles}\"");
+			writer.println("        println \"Develocity server: ${develocity.server.getOrElse(null)}\"");
+			writer.println("    	def fileFingerprints = develocity.buildScan.capture.fileFingerprints");
+			writer.println("        println \"Capture file fingerprints: ${fileFingerprints.getOrElse(false)}\"");
 			writer.println("    }");
 			writer.println("}");
 			writer.println("task verifyBuildCacheConfig {");
@@ -172,8 +183,9 @@ private void prepareMultiModuleProject(File projectDir) {
 		write(new File(new File(projectDir, "sub"), "build.gradle"), (writer) -> {
 			writer.println("task verifyBuildScanConfig {");
 			writer.println("    doFirst {");
-			writer.println("        println \"Build scan server: ${buildScan.server}\"");
-			writer.println("        println \"Capture task input files: ${buildScan.captureTaskInputFiles}\"");
+			writer.println("        println \"Develocity server: ${develocity.server.getOrElse(null)}\"");
+			writer.println("    	def fileFingerprints = develocity.buildScan.capture.fileFingerprints");
+			writer.println("        println \"Capture file fingerprints: ${fileFingerprints.getOrElse(false)}\"");
 			writer.println("    }");
 			writer.println("}");
 			writer.println("task verifyBuildCacheConfig {");
@@ -207,6 +219,10 @@ private String version() {
 	}
 
 	private BuildResult build(File projectDir, String... arguments) {
+		return build(prepareBuild(projectDir, arguments));
+	}
+
+	private GradleRunner prepareBuild(File projectDir, String... arguments) {
 		List<File> classpath = Arrays.asList(new File("bin/main"), new File("build/classes/java/main"),
 				new File("build/resources/main"),
 				new File(DevelocityPlugin.class.getProtectionDomain().getCodeSource().getLocation().getFile()),
@@ -216,8 +232,11 @@ private BuildResult build(File projectDir, String... arguments) {
 		return GradleRunner.create()
 			.withProjectDir(projectDir)
 			.withPluginClasspath(classpath)
-			.withArguments(augmentedArguments)
-			.build();
+			.withArguments(augmentedArguments);
+	}
+
+	private BuildResult build(GradleRunner runner) {
+		return runner.build();
 	}
 
 }

develocity-conventions-gradle-plugin/src/test/java/io/spring/develocity/conventions/gradle/TestDevelocityConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 the original author or authors.
+ * Copyright 2020-2025 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,6 +18,7 @@
 
 import com.gradle.develocity.agent.gradle.DevelocityConfiguration;
 import com.gradle.develocity.agent.gradle.buildcache.DevelocityBuildCache;
+import com.gradle.develocity.agent.gradle.integration.DevelocityIntegrationConfiguration;
 import com.gradle.develocity.agent.gradle.scan.BuildScanConfiguration;
 import org.gradle.api.Action;
 import org.gradle.api.provider.Property;
@@ -72,4 +73,9 @@ public Property<Boolean> getEdgeDiscovery() {
 		throw new UnsupportedOperationException();
 	}
 
+	@Override
+	public DevelocityIntegrationConfiguration getIntegration() {
+		throw new UnsupportedOperationException();
+	}
+
 }