Gradle plugin: Fix circular task dependency with Quarkus plugin #1344

snazy · 2023-01-09T11:50:40Z

The Smallrye Gradle plugin adds the generated OpenAPI schema files (YAML + JSON) to the generated jar file. This was achieved using via the processResources task, which unfortunately is not "compatible" with the Quarkus plugin (see below output). The fix is to add the generated schema files directly to the jar task.

Tests have been added to verify interopability with the Quarkus plugin, also reproducers for #1335 (without the production code changes of course):

Circular dependency between the following tasks:
:compileJava
+--- :quarkusGenerateCode
|    \--- :processResources
|         \--- :generateOpenApiSpec
|              +--- :compileJava (*)
|              +--- :quarkusGenerateCode (*)
|              \--- :quarkusGenerateCodeDev
|                   \--- :processResources (*)
\--- :quarkusGenerateCodeDev (*)

Fixes #1335

The Smallrye Gradle plugin adds the generated OpenAPI schema files (YAML + JSON) to the generated jar file. This was achieved using via the `processResources` task, which unfortunately is not "compatible" with the Quarkus plugin (see below output). The fix is to add the generated schema files directly to the `jar` task. Tests have been added to verify interopability with the Quarkus plugin, also reproducers for smallrye#1335 (without the production code changes of course): ``` Circular dependency between the following tasks: :compileJava +--- :quarkusGenerateCode | \--- :processResources | \--- :generateOpenApiSpec | +--- :compileJava (*) | +--- :quarkusGenerateCode (*) | \--- :quarkusGenerateCodeDev | \--- :processResources (*) \--- :quarkusGenerateCodeDev (*) ``` Fixes smallrye#1335

snazy · 2023-01-09T11:51:40Z

tools/gradle-plugin/build.gradle.kts

@@ -46,4 +46,8 @@ tasks.named<Test>("test") {
    useJUnitPlatform()
 }

+tasks.named("pluginUnderTestMetadata") {
+    dependsOn("processJandexIndex")


Not really related to this PR, fixes this build warning:

> Task :pluginUnderTestMetadata Execution optimizations have been disabled for task ':pluginUnderTestMetadata' to ensure correctness due to the following reasons: - Gradle detected a problem with the following location: '/home/snazy/devel/misc/smallrye-open-api/tools/gradle-plugin/build/resources/main'. Reason: Task ':pluginUnderTestMetadata' uses this output of task ':processJandexIndex' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed. Please refer to https://docs.gradle.org/7.6/userguide/validation_problems.html#implicit_dependency for more details about this problem.

snazy · 2023-01-09T11:51:54Z

tools/gradle-plugin/src/main/java/io/smallrye/openapi/gradleplugin/SmallryeOpenApiPlugin.java

-                    t.dependsOn(genTaskName);
-                    t.from(project.getTasks().getByName(genTaskName).getOutputs().getFiles());
-                });
+        project.getTasks().named(sourceSet.getJarTaskName(), Jar.class)
