Add missing inputs and outputs to Gradle exec tasks (#456)

Update Gradle exec tasks to declare their inputs and outputs, so that
tasks won't run multiple times (especially those that interact with the
BSR, potentially leading to rate limiting). This is seen in CI runs
where `make generate` and `make build` run the same generation and
export steps.

Author: pkwarren

buf.gen.yaml

@@ -1,5 +1,4 @@
 version: v2
-clean: true
 plugins:
   - remote: buf.build/protocolbuffers/java:$protocJavaPluginVersion
     out: build/generated/sources/bufgen

build.gradle.kts

@@ -1,6 +1,7 @@
 import com.diffplug.gradle.spotless.SpotlessExtension
 import com.vanniktech.maven.publish.JavaLibrary
 import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.SourcesJar
 import net.ltgt.gradle.errorprone.CheckSeverity
 import net.ltgt.gradle.errorprone.errorprone
 
@@ -56,6 +57,7 @@ tasks.register("configureBuf") {
 tasks.register<Exec>("installLicenseHeader") {
     description = "Installs the Buf license-header CLI."
     environment("GOBIN", bufLicenseHeaderCLIFile.parentFile.absolutePath)
+    inputs.property("bufVersion", libs.versions.buf.get())
     outputs.file(bufLicenseHeaderCLIFile)
     commandLine("go", "install", "github.com/bufbuild/buf/private/pkg/licenseheader/cmd/license-header@v${libs.versions.buf.get()}")
 }
@@ -81,8 +83,11 @@ tasks.register<Exec>("licenseHeader") {
 }
 
 tasks.register<Copy>("filterBufGenYaml") {
-    from(".")
-    include("buf.gen.yaml", "src/**/buf*gen*.yaml")
+    from(files("buf.gen.yaml"))
+    from("src/test/resources/proto") {
+        include("buf*gen*.yaml")
+        into("src/test/resources/proto")
+    }
     includeEmptyDirs = false
     into(layout.buildDirectory.dir("buf-gen-templates"))
     expand("protocJavaPluginVersion" to "v${libs.versions.protobuf.get().substringAfter('.')}")
@@ -92,34 +97,50 @@ tasks.register<Copy>("filterBufGenYaml") {
 tasks.register<Exec>("generateTestSourcesImports") {
     dependsOn("exportProtovalidateModule", "filterBufGenYaml")
     description = "Generates code with buf generate --include-imports for unit tests."
+    val template = layout.buildDirectory.file("buf-gen-templates/src/test/resources/proto/buf.gen.imports.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.dir("src/test/resources/proto")
+    outputs.dir(layout.buildDirectory.dir("generated/test-sources/bufgen-imports"))
     commandLine(
         buf.asPath,
         "generate",
         "--template",
-        "${layout.buildDirectory.get()}/buf-gen-templates/src/test/resources/proto/buf.gen.imports.yaml",
+        template.get().asFile.absolutePath,
         "--include-imports",
     )
 }
 
 tasks.register<Exec>("generateTestSourcesNoImports") {
     dependsOn("exportProtovalidateModule", "filterBufGenYaml")
     description = "Generates code with buf generate --include-imports for unit tests."
+    val template = layout.buildDirectory.file("buf-gen-templates/src/test/resources/proto/buf.gen.noimports.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.dir("src/main/resources")
+    inputs.dir("src/test/resources/proto")
+    outputs.dir(layout.buildDirectory.dir("generated/test-sources/bufgen-noimports"))
     commandLine(
         buf.asPath,
         "generate",
         "--template",
-        "${layout.buildDirectory.get()}/buf-gen-templates/src/test/resources/proto/buf.gen.noimports.yaml",
+        template.get().asFile.absolutePath,
     )
 }
 
 tasks.register<Exec>("generateCelConformance") {
     dependsOn("generateCelConformanceTestTypes", "filterBufGenYaml")
     description = "Generates CEL conformance code with buf generate for unit tests."
+    val template = layout.buildDirectory.file("buf-gen-templates/src/test/resources/proto/buf.gen.cel.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.property("celSpecVersion", project.findProperty("cel.spec.version").toString())
+    outputs.dir(layout.buildDirectory.dir("generated/test-sources/bufgen-cel"))
     commandLine(
         buf.asPath,
         "generate",
         "--template",
-        "${layout.buildDirectory.get()}/buf-gen-templates/src/test/resources/proto/buf.gen.cel.yaml",
+        template.get().asFile.absolutePath,
         "buf.build/google/cel-spec:${project.findProperty("cel.spec.version")}",
         "--exclude-path",
         "cel/expr/conformance/proto2",
@@ -136,11 +157,16 @@ tasks.register<Exec>("generateCelConformance") {
 tasks.register<Exec>("generateCelConformanceTestTypes") {
     dependsOn("exportProtovalidateModule", "filterBufGenYaml")
     description = "Generates CEL conformance test types with buf generate for unit tests using a Java package override."
+    val template = layout.buildDirectory.file("buf-gen-templates/src/test/resources/proto/buf.gen.cel.testtypes.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.property("celSpecVersion", project.findProperty("cel.spec.version").toString())
+    outputs.dir(layout.buildDirectory.dir("generated/test-sources/bufgen-cel-testtypes"))
     commandLine(
         buf.asPath,
         "generate",
         "--template",
-        "${layout.buildDirectory.get()}/buf-gen-templates/src/test/resources/proto/buf.gen.cel.testtypes.yaml",
+        template.get().asFile.absolutePath,
         "buf.build/google/cel-spec:${project.findProperty("cel.spec.version")}",
         "--path",
         "cel/expr/conformance/proto3",
@@ -184,6 +210,9 @@ tasks.register<Exec>("exportProtovalidateModule") {
     if (!semverRegex.matches(version)) {
         input = "https://github.com/bufbuild/protovalidate.git#subdir=proto/protovalidate,ref=$version"
     }
+    inputs.files(buf)
+    inputs.property("protovalidateVersion", version)
+    outputs.dir("src/main/resources/buf")
     commandLine(
         buf.asPath,
         "export",
@@ -196,7 +225,12 @@ tasks.register<Exec>("exportProtovalidateModule") {
 tasks.register<Exec>("generateSources") {
     dependsOn("exportProtovalidateModule", "filterBufGenYaml")
     description = "Generates sources for the bufbuild/protovalidate module sources to build/generated/sources/bufgen."
-    commandLine(buf.asPath, "generate", "--template", "${layout.buildDirectory.get()}/buf-gen-templates/buf.gen.yaml", "src/main/resources")
+    val template = layout.buildDirectory.file("buf-gen-templates/buf.gen.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.dir("src/main/resources/buf")
+    outputs.dir(layout.buildDirectory.dir("generated/sources/bufgen"))
+    commandLine(buf.asPath, "generate", "--template", template.get().asFile.absolutePath, "src/main/resources")
 }
 
 tasks.register("generate") {
@@ -205,9 +239,16 @@ tasks.register("generate") {
         "generateTestSources",
         "generateSources",
         "licenseHeader",
+        ":conformance:generateConformance",
     )
 }
 
+// src/main/resources and build/generated/sources/bufgen are generate-task outputs; consumers need explicit ordering.
+tasks.named("processResources") { dependsOn("exportProtovalidateModule") }
+tasks.matching { it.name == "sourcesJar" }.configureEach {
+    dependsOn("exportProtovalidateModule", "generateSources")
+}
+
 tasks.withType<JavaCompile> {
     dependsOn("generate")
     if (JavaVersion.current().isJava9Compatible) {
@@ -251,15 +292,18 @@ sourceSets {
     }
     test {
         java {
-            srcDir(layout.buildDirectory.dir("generated/test-sources/bufgen"))
+            srcDir(layout.buildDirectory.dir("generated/test-sources/bufgen-imports"))
+            srcDir(layout.buildDirectory.dir("generated/test-sources/bufgen-noimports"))
+            srcDir(layout.buildDirectory.dir("generated/test-sources/bufgen-cel"))
+            srcDir(layout.buildDirectory.dir("generated/test-sources/bufgen-cel-testtypes"))
         }
     }
 }
 
 apply(plugin = "com.diffplug.spotless")
 configure<SpotlessExtension> {
     java {
-        targetExclude("build/generated/sources/bufgen/build/buf/validate/**/*.java", "build/generated/test-sources/bufgen/**/*.java")
+        targetExclude("build/generated/sources/bufgen/build/buf/validate/**/*.java", "build/generated/test-sources/bufgen-*/**/*.java")
     }
     kotlinGradle {
         ktlint()
@@ -319,8 +363,7 @@ mavenPublishing {
             // - `JavadocJar.Empty()` publish an empty jar
             // - `JavadocJar.Javadoc()` to publish standard javadocs
             javadocJar = JavadocJar.Javadoc(),
-            // whether to publish a sources jar
-            sourcesJar = true,
+            sourcesJar = SourcesJar.Sources(),
         ),
     )
     pom {

conformance/buf.gen.yaml

@@ -1,5 +1,4 @@
 version: v2
-clean: true
 managed:
   enabled: true
   override:

conformance/build.gradle.kts

@@ -39,6 +39,7 @@ val conformanceArgs = (project.findProperty("protovalidate.conformance.args")?.t
 tasks.register<Exec>("installProtovalidateConformance") {
     description = "Installs the Protovalidate Conformance CLI."
     environment("GOBIN", conformanceCLIFile.parentFile.absolutePath)
+    inputs.property("protovalidateVersion", project.findProperty("protovalidate.version").toString())
     outputs.file(conformanceCLIFile)
     commandLine(
         "go",
@@ -71,11 +72,16 @@ tasks.register<Exec>("generateConformance") {
     if (!semverRegex.matches(version)) {
         input = "https://github.com/bufbuild/protovalidate.git#subdir=proto/protovalidate-testing,ref=$version"
     }
+    val template = layout.buildDirectory.file("buf-gen-templates/buf.gen.yaml")
+    inputs.files(buf)
+    inputs.file(template)
+    inputs.property("protovalidateVersion", version)
+    outputs.dir(layout.buildDirectory.dir("generated/sources/bufgen"))
     commandLine(
         buf.asPath,
         "generate",
         "--template",
-        "${layout.buildDirectory.get()}/buf-gen-templates/buf.gen.yaml",
+        template.get().asFile.absolutePath,
         input,
     )
 }

src/test/resources/proto/buf.gen.cel.testtypes.yaml

@@ -6,4 +6,4 @@ managed:
       value: cel.expr.conformance.proto3
 plugins:
   - remote: buf.build/protocolbuffers/java:$protocJavaPluginVersion
-    out: build/generated/test-sources/bufgen
+    out: build/generated/test-sources/bufgen-cel-testtypes

src/test/resources/proto/buf.gen.cel.yaml

@@ -3,4 +3,4 @@ managed:
   enabled: true
 plugins:
   - remote: buf.build/protocolbuffers/java:$protocJavaPluginVersion
-    out: build/generated/test-sources/bufgen
+    out: build/generated/test-sources/bufgen-cel

src/test/resources/proto/buf.gen.imports.yaml

@@ -6,6 +6,6 @@ managed:
       value: com.example.imports
 plugins:
   - remote: buf.build/protocolbuffers/java:$protocJavaPluginVersion
-    out: build/generated/test-sources/bufgen
+    out: build/generated/test-sources/bufgen-imports
 inputs:
   - directory: src/test/resources/proto

src/test/resources/proto/buf.gen.noimports.yaml

@@ -9,7 +9,7 @@ managed:
       value: com.example.noimports
 plugins:
   - remote: buf.build/protocolbuffers/java:$protocJavaPluginVersion
-    out: build/generated/test-sources/bufgen
+    out: build/generated/test-sources/bufgen-noimports
 inputs:
   - directory: src/main/resources
   - directory: src/test/resources/proto