Allow lint task to be configured after Buf v1.31.0 while using protob…

…uf-gradle-plugin (#256)

Gets custom linting working again with new versions of Buf.

src/main/kotlin/build/buf/gradle/DirectorySpecificBufExecutionSupport.kt

@@ -16,35 +16,20 @@ package build.buf.gradle
 
 import java.io.File
 
-internal fun AbstractBufExecTask.execBufInSpecificDirectory(
-    vararg bufCommand: String,
-    customErrorMessage: ((String) -> String)? = null,
-) {
-    execBufInSpecificDirectory(bufCommand.asList(), emptyList(), customErrorMessage)
-}
-
 internal fun AbstractBufExecTask.execBufInSpecificDirectory(
     bufCommand: String,
-    extraArgs: Iterable<String>,
-    customErrorMessage: (String) -> String,
-) {
-    execBufInSpecificDirectory(listOf(bufCommand), extraArgs, customErrorMessage)
-}
-
-private fun AbstractBufExecTask.execBufInSpecificDirectory(
-    bufCommand: Iterable<String>,
-    extraArgs: Iterable<String>,
+    args: Iterable<String>,
     customErrorMessage: ((String) -> String)? = null,
 ) {
-    fun runWithArgs(file: File? = null) = bufCommand + listOfNotNull(file?.let { makeMangledRelativizedPathStr(it) }) + extraArgs
+    fun runWithArgs(file: File? = null) = listOf(bufCommand) + listOfNotNull(file?.let { makeMangledRelativizedPathStr(it) }) + args
 
     when {
         hasProtobufGradlePlugin.get() ->
             candidateProtoDirs
                 .filter { anyProtos(it) }
                 .forEach { execBuf(runWithArgs(it), customErrorMessage) }
         hasWorkspace.get() ->
-            execBuf(bufCommand, customErrorMessage)
+            execBuf(listOf(bufCommand) + args, customErrorMessage)
         else ->
             execBuf(runWithArgs(), customErrorMessage)
     }

src/main/kotlin/build/buf/gradle/FormatApplyTask.kt

@@ -30,6 +30,6 @@ abstract class FormatApplyTask : AbstractBufExecTask() {
 
     @TaskAction
     fun bufFormatApply() {
-        execBufInSpecificDirectory("format", "-w")
+        execBufInSpecificDirectory("format", listOf("-w"))
     }
 }

src/main/kotlin/build/buf/gradle/FormatCheckTask.kt

@@ -25,7 +25,7 @@ abstract class FormatCheckTask : AbstractBufExecTask() {
 
     @TaskAction
     fun bufFormatCheck() {
-        execBufInSpecificDirectory("format", "-d", "--exit-code") {
+        execBufInSpecificDirectory("format", listOf("-d", "--exit-code")) {
             """
                  |Some Protobuf files had format violations:
                  |$it

src/main/kotlin/build/buf/gradle/LintConfiguration.kt

@@ -27,6 +27,7 @@ internal fun Project.configureLint() {
 
         bufConfigFile.set(project.bufConfigFile())
         inputFiles.setFrom(obtainDefaultProtoFileSet())
+        v1SyntaxOnly.set(bufV1SyntaxOnly())
     }
 
     tasks.named(CHECK_TASK_NAME).dependsOn(BUF_LINT_TASK_NAME)

src/main/kotlin/build/buf/gradle/LintTask.kt

@@ -16,6 +16,7 @@ package build.buf.gradle
 
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.InputFiles
 import org.gradle.api.tasks.Optional
@@ -34,11 +35,18 @@ abstract class LintTask : AbstractBufExecTask() {
     @get:Optional
     internal abstract val bufConfigFile: Property<File>
 
+    @get:Input
+    internal abstract val v1SyntaxOnly: Property<Boolean>
+
     @TaskAction
     fun bufLint() {
         execBufInSpecificDirectory(
             "lint",
-            bufConfigFile.orNull?.let { listOf("--config", it.readAndStripComments()) }.orEmpty(),
+            if (noWorkspaceAndV1Syntax() || noWorkspaceAndNoProtobufGradlePlugin()) {
+                bufConfigFile.orNull?.let { listOf("--config", it.readAndStripComments()) }
+            } else {
+                null
+            }.orEmpty(),
         ) {
             """
                  |Some Protobuf files had lint violations:
@@ -47,6 +55,10 @@ abstract class LintTask : AbstractBufExecTask() {
         }
     }
 
+    private fun noWorkspaceAndV1Syntax() = !hasWorkspace.get() && v1SyntaxOnly.get()
+
+    private fun noWorkspaceAndNoProtobufGradlePlugin() = !hasWorkspace.get() && !hasProtobufGradlePlugin.get()
+
     private fun File.readAndStripComments() =
         lines(toPath()).use { lines ->
             lines.asSequence()

src/test/kotlin/build/buf/gradle/LintWithProtobufGradleTest.kt

@@ -43,7 +43,17 @@ class LintWithProtobufGradleTest : ConfigOverrideableLintTests, AbstractLintTest
     }
 
     @Test
-    fun `lint a file with an implementation dependency and a lint config with the protobuf-gradle-plugin`() {
+    fun `lint a file with an implementation dependency and a lint config with the protobuf-gradle-plugin pre 1_32_0`() {
+        assertSuccess()
+    }
+
+    @Test
+    fun `lint a file with an implementation dependency and a lint config with the protobuf-gradle-plugin v1`() {
+        assertSuccess()
+    }
+
+    @Test
+    fun `lint a file with an implementation dependency and a lint config with the protobuf-gradle-plugin v2`() {
         assertSuccess()
     }
 }

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v1/buf.yaml

@@ -0,0 +1,9 @@
+version: v1
+lint:
+  ignore:
+    - google
+    - protokt
+  use:
+    - STANDARD
+  except:
+    - ENUM_ZERO_VALUE_SUFFIX

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v1/build.gradle

@@ -0,0 +1,22 @@
+plugins {
+  id 'java'
+  id 'com.google.protobuf' version "$protobufGradleVersion"
+  id 'build.buf'
+}
+
+repositories {
+  mavenCentral()
+}
+
+protobuf {
+  protoc {
+    artifact = "com.google.protobuf:protoc:$protobufVersion"
+  }
+}
+
+compileJava.enabled = false
+
+dependencies {
+  implementation "com.google.protobuf:protobuf-java:$protobufVersion"
+  implementation "com.toasttab.protokt:protokt-runtime:0.6.5"
+}

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v1/src/main/proto/buf/test/v1/test.proto

@@ -0,0 +1,27 @@
+// Copyright 2024 Buf Technologies, Inc.
+//
+// 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
+//
+//      http://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.
+
+syntax = "proto3";
+
+package buf.test.v1;
+
+import "protokt/protokt.proto";
+
+message BasicMessage {
+  protokt.ProtoktFileOptions protokt_file_options = 1;
+
+  enum BrokenEnum {
+    BROKEN_ENUM_NONSPECIFIED = 0; // should be _UNSPECIFIED
+  }
+}

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v2/buf.yaml

@@ -0,0 +1,9 @@
+version: v2
+lint:
+  ignore:
+    - google
+    - protokt
+  use:
+    - STANDARD
+  except:
+    - ENUM_ZERO_VALUE_SUFFIX

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v2/build.gradle

@@ -0,0 +1,22 @@
+plugins {
+  id 'java'
+  id 'com.google.protobuf' version "$protobufGradleVersion"
+  id 'build.buf'
+}
+
+repositories {
+  mavenCentral()
+}
+
+protobuf {
+  protoc {
+    artifact = "com.google.protobuf:protoc:$protobufVersion"
+  }
+}
+
+compileJava.enabled = false
+
+dependencies {
+  implementation "com.google.protobuf:protobuf-java:$protobufVersion"
+  implementation "com.toasttab.protokt:protokt-runtime:0.6.5"
+}

src/test/resources/LintWithProtobufGradleTest/lint_a_file_with_an_implementation_dependency_and_a_lint_config_with_the_protobuf_gradle_plugin_v2/src/main/proto/buf/test/v1/test.proto

@@ -0,0 +1,27 @@
+// Copyright 2024 Buf Technologies, Inc.
+//
+// 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
+//
+//      http://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.
+
+syntax = "proto3";
+
+package buf.test.v1;
+
+import "protokt/protokt.proto";
+
+message BasicMessage {
+  protokt.ProtoktFileOptions protokt_file_options = 1;
+
+  enum BrokenEnum {
+    BROKEN_ENUM_NONSPECIFIED = 0; // should be _UNSPECIFIED
+  }
+}