feat: add javaPackageSuffix gradle plugin parameter (#442)

Signed-off-by: Anthony Petrov <anthony@swirldslabs.com>
Signed-off-by: anthony-swirldslabs <152534762+anthony-swirldslabs@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>

Author: anthony-swirldslabs

pbj-core/pbj-compiler/src/main/java/com/hedera/pbj/compiler/PbjCompilerPlugin.java

@@ -29,6 +29,9 @@ public abstract class PbjCompilerPlugin implements Plugin<Project> {
      */
     @Override
     public void apply(Project project) {
+        // Register the PbjExtension to fetch optional parameters from Gradle files
+        final PbjExtension pbj = project.getExtensions().create("pbj", PbjExtension.class);
+
         // get reference to java plugin
         final var javaPlugin = project.getExtensions().getByType(JavaPluginExtension.class);
         // get java src sets
@@ -61,6 +64,7 @@ public void apply(Project project) {
                     pbjTask.setSource(pbjSourceSet);
                     pbjTask.getJavaMainOutputDirectory().set(outputDirectoryMain);
                     pbjTask.getJavaTestOutputDirectory().set(outputDirectoryTest);
+                    pbjTask.getJavaPackageSuffix().set(pbj.getJavaPackageSuffix());
                 });
 
         // 5) register fact that pbj should be run before compiling  by informing the 'java' part

pbj-core/pbj-compiler/src/main/java/com/hedera/pbj/compiler/PbjCompilerTask.java

@@ -4,6 +4,9 @@
 import javax.inject.Inject;
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.internal.file.FileOperations;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.Optional;
 import org.gradle.api.tasks.OutputDirectory;
 import org.gradle.api.tasks.SourceTask;
 import org.gradle.api.tasks.TaskAction;
@@ -33,6 +36,11 @@ public abstract class PbjCompilerTask extends SourceTask {
     @Inject
     protected abstract FileOperations getFileOperations();
 
+    /** An optional Java package suffix for PBJ-generated classes when `pbj.java_package` is missing. */
+    @Optional
+    @Input
+    public abstract Property<String> getJavaPackageSuffix();
+
     /**
      * Perform task action - Generates all the PBJ java source files
      *
@@ -46,6 +54,6 @@ public void perform() throws Exception {
                 getSource(),
                 getJavaMainOutputDirectory().get().getAsFile(),
                 getJavaTestOutputDirectory().get().getAsFile(),
-                null);
+                getJavaPackageSuffix().getOrNull());
     }
 }

pbj-core/pbj-compiler/src/main/java/com/hedera/pbj/compiler/PbjExtension.java

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+package com.hedera.pbj.compiler;
+
+import org.gradle.api.provider.Property;
+
+/** A Gradle extension to pass parameters to the PbjCompilerPlugin. */
+public interface PbjExtension {
+    /**
+     * An optional suffix to append to Java package names of PBJ-generated classes
+     * when the Protobuf model is missing an explicit `pbj.java_package` option and PBJ has to
+     * derive the Java package name from the standard `java_package` option or otherwise.
+     * @return the suffix property
+     */
+    Property<String> getJavaPackageSuffix();
+}

pbj-core/version.txt

@@ -1 +1 @@
-0.10.0-SNAPSHOT
+0.10.1-SNAPSHOT

pbj-integration-tests/build.gradle.kts

@@ -61,6 +61,9 @@ dependencyAnalysis { issues { all { onAny { exclude("com.hedera.pbj:pbj-compiler
 // IMPROVE: JMH code should not depend on test code
 jmh { includeTests = true }
 
+// Avoid a clash with Google protoc models when .proto files don't specify `pbj.java_package`:
+pbj { javaPackageSuffix = ".pbj.integration.tests" }
+
 // Add downloaded HAPI repo protobuf files into build directory and add to sources to build them
 val cloneHederaProtobufs =
     tasks.register<GitClone>("cloneHederaProtobufs") {

pbj-integration-tests/src/main/proto/package.proto

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+syntax = "proto3";
+
+package proto;
+
+// Test when only the java_package is specified. Do not specify the pbj.java_package option.
+option java_package = "com.hedera.pbj.test.proto";
+option java_multiple_files = true;
+
+/**
+ * Sample protobuf.
+ */
+message MessageInAPackage {
+  bytes bytesField = 1;
+}