build with workspaces (#54)

Author: andrewparmet

src/main/kotlin/com/parmet/buf/gradle/BufPlugin.kt

@@ -28,16 +28,16 @@ class BufPlugin : Plugin<Project> {
         project.configurations.create(BUF_CONFIGURATION_NAME)
 
         if (project.hasProtobufGradlePlugin()) {
-            project.failForWorkspacesAndPlugin()
+            project.failForWorkspaceAndPlugin()
             project.afterEvaluate { configureBufWithProtobufGradle(ext) }
         } else {
-            project.withProtobufGradlePlugin { project.failForWorkspacesAndPlugin() }
+            project.withProtobufGradlePlugin { project.failForWorkspaceAndPlugin() }
             project.configureBuf(ext)
         }
     }
 
-    private fun Project.failForWorkspacesAndPlugin() {
-        check(!project.usesWorkspaces(), ::WORKSPACES_AND_PROTOBUF_PLUGIN_FAILURE_MESSAGE)
+    private fun Project.failForWorkspaceAndPlugin() {
+        check(!project.usesWorkspaces(), ::WORKSPACE_AND_PROTOBUF_PLUGIN_FAILURE_MESSAGE)
     }
 
     private fun Project.configureBufWithProtobufGradle(ext: BufExtension) {
@@ -64,9 +64,9 @@ class BufPlugin : Plugin<Project> {
     }
 }
 
-private val WORKSPACES_AND_PROTOBUF_PLUGIN_FAILURE_MESSAGE =
+private val WORKSPACE_AND_PROTOBUF_PLUGIN_FAILURE_MESSAGE =
     """
-        A project cannot use both the protobuf-gradle-plugin and Buf workspaces.
+        A project cannot use both the protobuf-gradle-plugin and a Buf workspace.
         If you have multiple protobuf source directories and you would like to
         use the protobuf-gradle-plugin, configure the protobuf-gradle-plugin to use
         those directories as source directories in the appropriate source set. If you

src/test/kotlin/com/parmet/buf/gradle/BuildWithWorkspaceTest.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2022 Andrew Parmet
+ *
+ * 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.
+ */
+
+package com.parmet.buf.gradle
+
+class BuildWithWorkspaceTest : AbstractBuildTest()

src/test/kotlin/com/parmet/buf/gradle/ConfigOverrideableLintTests.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (c) 2022 Andrew Parmet
+ *
+ * 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.
+ */
+
 package com.parmet.buf.gradle
 
 import com.google.common.truth.Truth.assertThat

src/test/kotlin/com/parmet/buf/gradle/ConfigurationTest.kt

@@ -16,6 +16,6 @@ class ConfigurationTest : AbstractBufIntegrationTest() {
 
     private fun assertFailure() {
         val result = gradleRunner().withArguments(":tasks").buildAndFail()
-        assertThat(result.output).contains("cannot use both the protobuf-gradle-plugin and Buf workspaces")
+        assertThat(result.output).contains("cannot use both the protobuf-gradle-plugin and a Buf workspace")
     }
 }

src/test/resources/BuildTest/build image with two publications should succeed if details are provided explicitly/src/main/proto/parmet/buf/test/v1/test.proto renamed to src/test/resources/BuildTest/build image with two publications should succeed if details are provided explicitly/parmet/buf/test/v1/test.proto

@@ -0,0 +1,16 @@
+# Copyright (c) 2022 Andrew Parmet
+#
+# 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.
+
+version: v1
+directories:
+  - workspace

src/test/resources/BuildWithWorkspaceTest/build image with explicit artifact details/buf.work.yaml

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2022 Andrew Parmet
+ *
+ * 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.
+ */
+
+plugins {
+  id 'java'
+  id 'com.parmet.buf'
+  id 'maven-publish'
+}
+
+buf {
+  publishSchema = true
+  imageArtifact {
+    groupId = 'foo'
+    artifactId = 'bar'
+    version = '2319'
+  }
+}

src/test/resources/BuildWithWorkspaceTest/build image with explicit artifact details/build.gradle

@@ -0,0 +1,18 @@
+// Copyright (c) 2022 Andrew Parmet
+//
+// 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 parmet.buf.test.v1;
+
+message BasicMessage {}

src/test/resources/BuildWithWorkspaceTest/build image with explicit artifact details/workspace/parmet/buf/test/v1/test.proto

@@ -0,0 +1,16 @@
+# Copyright (c) 2022 Andrew Parmet
+#
+# 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.
+
+version: v1
+directories:
+  - workspace

src/test/resources/BuildWithWorkspaceTest/build image with inferred artifact details/buf.work.yaml

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2022 Andrew Parmet
+ *
+ * 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.
+ */
+
+plugins {
+  id 'java'
+  id 'com.parmet.buf'
+  id 'maven-publish'
+}
+
+buf {
+  publishSchema = true
+}
+
+publishing {
+  publications {
+    maven(MavenPublication) {
+      groupId = 'foo'
+      artifactId = 'bar'
+      version = '2319'
+      from components.java
+    }
+  }
+}