Quarkus source set naming not aligned with the Gradle convention?

[jmini]

When checking at the source set added to a gradle project when the quarkus plugin is used, I see this:



• integrationTest
• main
• native-test
• quarkus-generated-sources
• quarkus-test-generated-sources
• test

I have the feeling the gradle ecosystem is more using camelCase notation and not dash-case

---

Use case:



My concrete issue comes from the need to integrate the com.google.protobuf plugin.

The idea would be to keep proto generation is handled by Quarkus itself (as indicated by @cescoffier in #27388 (comment) or #36074 (comment)) but add an other protobuf generation with the protoc-gen-doc plugin to generate documentation.

The generation with a command line works great:

protoc --plugin=__path-to__/protoc-gen-doc \
    --doc_out=./doc \
    --doc_opt=html,documentation.html \
    --proto_path=src/main/proto \
    src/main/proto/**/*.proto





But I wanted to use the gradle variant which rely on the com.google.protobuf plugin to have something integrated in the build.

Issue:

Currently the build is failing with:




FAILURE: Build failed with an exception.

* Where:
Build file '__path-to__/build.gradle' line: 4

* What went wrong:
An exception occurred applying plugin request [id: 'com.google.protobuf', version: '0.9.5']
> Failed to apply plugin 'com.google.protobuf'.
   > Configuration with name 'native-testCompileOnly' not found.

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.
> Get more help at https://help.gradle.org.


I think it would make sense for quarkus to adhere to the convention used in the gradle ecosystem and use following source set:



• nativeTest instead of native-test
• quarkusGeneratedSources instead of quarkus-generated-sources
• quarkusTestGeneratedSources instead of quarkus-test-generated-sources

This would also aligned with the configurations you already have:

• nativeTestAnnotationProcessor
• nativeTestCompileClasspath
• nativeTestCompileOnly
• nativeTestImplementation
• nativeTestRuntimeClasspath
• nativeTestRuntimeOnly
• quarkusGeneratedSourcesAnnotationProcessor
• quarkusGeneratedSourcesCompileClasspath
• quarkusGeneratedSourcesCompileOnly
• quarkusGeneratedSourcesImplementation
• quarkusGeneratedSourcesRuntimeClasspath
• quarkusGeneratedSourcesRuntimeOnly
• quarkusTestGeneratedSourcesAnnotationProcessor
• quarkusTestGeneratedSourcesCompileClasspath
• quarkusTestGeneratedSourcesCompileOnly
• quarkusTestGeneratedSourcesImplementation
• quarkusTestGeneratedSourcesRuntimeClasspath
• quarkusTestGeneratedSourcesRuntimeOnly

---



I analyzed it and in my opinion the way the com.google.protobuf is trying to find the configuration associated with a sourceSet by just guessing the name is wrong:

https://github.com/google/protobuf-gradle-plugin/blob/6dedfa7c67322ba36a2362085ffed9742cefdcdb/src/main/groovy/com/google/protobuf/gradle/ProtobufPlugin.groovy#L194-L199

using this Utils:
https://github.com/google/protobuf-gradle-plugin/blob/6dedfa7c67322ba36a2362085ffed9742cefdcdb/src/main/groovy/com/google/protobuf/gradle/Utils.groovy#L49-L53



There is a gradle API to retrieve the configuration associated with a sourceSet:

https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/SourceSet.html




* getCompileOnlyConfigurationName()

* getImplementationConfigurationName()


I have opened google/protobuf-gradle-plugin#777 to see if there is a reaction on their side.

---

Nevertheless, even if my problem might be fixable in the protobuf-gradle-plugin, I think that Quarkus should be closer to what the rest of the gradle ecosystem is doing and use camelCase instead of dash-case for the sourceSets it adds to the gradle project.

---

Maybe related?

• Gradle Plugin - Introduce integration test source set #22035
• gRPC: Cannot seem to use the protobuf-maven-plugin instead of quarkus-maven #36074
• Add ability to include extra protoc plugins when using Gradle #27388

[jmini]

For now have a solution working where I have a gradle module where I run the gradle plugin com.google.protobuf and I do not run io.quarkus to generate the GRPc code.

➡ #27388 (comment)

Of course I think that not using the usual gradle conventions inside quarkus remains open for discussion…