[#1369] Add @SuppressWarnings to generated client classes (#1370)

ameerabdallah · web-flow · commit 1b2c08169a9d · 2025-11-07T14:18:50.000-05:00
* [#1369] Add @SuppressWarnings to generated client classes * Fix openapi file extension
diff --git a/client/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java b/client/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java
@@ -13,6 +13,7 @@ public class QuteTemplatingEngineAdapter extends AbstractTemplatingEngineAdapter
 
     private static final String IDENTIFIER = "qute";
     private static final String[] DEFAULT_TEMPLATES = {
+            "suppressWarnings.qute",
             "additionalEnumTypeAnnotations.qute",
             "additionalEnumTypeUnexpectedMember.qute",
             "additionalModelTypeAnnotations.qute",
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/api.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/api.qute
@@ -28,6 +28,7 @@ import {imp.import};
 {#for apiAnnotation in additionalApiTypeAnnotations.orEmpty}
 {apiAnnotation}
 {/for}
+{#include suppressWarnings.qute/}
 public interface {classname} {
 
     {#for op in operations.operation}
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/auth/compositeAuthenticationProvider.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/auth/compositeAuthenticationProvider.qute
@@ -22,6 +22,7 @@ package {apiPackage}.auth;
 @io.quarkiverse.openapi.generator.markers.ApiKeyAuthenticationMarker(name="{auth.name}", openApiSpecId="{quarkus-generator.openApiSpecId}", apiKeyIn=io.quarkiverse.openapi.generator.providers.ApiKeyIn.cookie, apiKeyName="{auth.keyParamName}")
 {/if}
 {/for}
+{#include suppressWarnings.qute/}
 public class CompositeAuthenticationProvider implements jakarta.ws.rs.client.ClientRequestFilter {
 
     @jakarta.inject.Inject
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/auth/headersFactory.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/auth/headersFactory.qute
@@ -1,5 +1,6 @@
 package {apiPackage}.auth;
 
+{#include suppressWarnings.qute/}
 public class AuthenticationPropagationHeadersFactory extends io.quarkiverse.openapi.generator.providers.AbstractAuthenticationPropagationHeadersFactory {
 
     @jakarta.inject.Inject
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/multipartFormdataPojo.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/multipartFormdataPojo.qute
@@ -1,3 +1,4 @@
+    {#include suppressWarnings.qute/}
     public static class {op.operationIdCamelCase}MultipartForm {
     {#for p in op.formParams}
         @jakarta.ws.rs.FormParam("{p.baseName}")
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/pojo.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/pojo.qute
@@ -21,6 +21,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 {#else}
 @com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)
 {/if}
+{#include suppressWarnings.qute/}
 public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if serializableModel} implements java.io.Serializable{/if} {
 
     {#for v in m.vars}
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/pojoQueryParam.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/pojoQueryParam.qute
@@ -5,6 +5,7 @@
     {/if}
     @com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)
     {#include additionalModelTypeAnnotations.qute m=m/}
+    {#include suppressWarnings.qute/}
     public static class {m.classname}QueryParam {#if m.parent}extends {m.parent}{/if}{#if serializableModel} implements java.io.Serializable{/if} {
 
         {#for v in m.vars}
diff --git a/client/deployment/src/main/resources/templates/libraries/microprofile/suppressWarnings.qute b/client/deployment/src/main/resources/templates/libraries/microprofile/suppressWarnings.qute
@@ -0,0 +1 @@
+@SuppressWarnings({ "all", "unchecked", "rawtypes", "this-escape" })
diff --git a/client/integration-tests/jsonproperty-getter-and-setter/src/main/openapi/jsonproperty-openapi.json b/client/integration-tests/jsonproperty-getter-and-setter/src/main/openapi/jsonproperty-openapi.json
diff --git a/client/integration-tests/jsonproperty-getter-and-setter/src/main/resources/application.properties b/client/integration-tests/jsonproperty-getter-and-setter/src/main/resources/application.properties
@@ -1 +1 @@
-quarkus.openapi-generator.codegen.spec.jsonproperty_openapi_yaml.base-package=org.acme.jsonproperty.gettersetter
+quarkus.openapi-generator.codegen.spec.jsonproperty_openapi_json.base-package=org.acme.jsonproperty.gettersetter
diff --git a/client/integration-tests/pom.xml b/client/integration-tests/pom.xml
@@ -51,6 +51,7 @@
     <module>equals-hashcode</module>
     <module>override-credential-provider</module>
     <module>jsonproperty-getter-and-setter</module>
+    <module>suppress-warnings</module>
   </modules>
   <dependencyManagement>
     <dependencies>
diff --git a/client/integration-tests/suppress-warnings/pom.xml b/client/integration-tests/suppress-warnings/pom.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>quarkus-openapi-generator-integration-tests</artifactId>
+        <groupId>io.quarkiverse.openapi.generator</groupId>
+        <version>3.0.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>quarkus-openapi-generator-it-suppress-warnings</artifactId>
+    <name>Quarkus - OpenAPI Generator - Integration Tests - Client - Suppress Warnings Test</name>
+    <description>Ensures that generated classes have the @SuppressWarnings annotation</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.quarkiverse.openapi.generator</groupId>
+            <artifactId>quarkus-openapi-generator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-junit5</artifactId>
+            <scope>test</scope>
+        </dependency><dependency>
+            <groupId>com.github.javaparser</groupId>
+            <artifactId>javaparser-symbol-solver-core</artifactId>
+            <version>3.27.1</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>
+                <extensions>true</extensions>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build</goal>
+                            <goal>generate-code</goal>
+                            <goal>generate-code-tests</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <profiles>
+        <profile>
+            <id>native-image</id>
+            <activation>
+                <property>
+                    <name>native</name>
+                </property>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <artifactId>maven-surefire-plugin</artifactId>
+                        <configuration>
+                            <skipTests>${native.surefire.skip}</skipTests>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <artifactId>maven-failsafe-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>integration-test</goal>
+                                    <goal>verify</goal>
+                                </goals>
+                                <configuration>
+                                    <systemPropertyVariables>
+                                        <native.image.path>
+                                            ${project.build.directory}/${project.build.finalName}-runner
+                                        </native.image.path>
+                                        <java.util.logging.manager>org.jboss.logmanager.LogManager
+                                        </java.util.logging.manager>
+                                        <maven.home>${maven.home}</maven.home>
+                                    </systemPropertyVariables>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+            <properties>
+                <quarkus.package.type>native</quarkus.package.type>
+            </properties>
+        </profile>
+    </profiles>
+
+</project>
diff --git a/client/integration-tests/suppress-warnings/src/main/openapi/suppresswarnings-openapi.json b/client/integration-tests/suppress-warnings/src/main/openapi/suppresswarnings-openapi.json
diff --git a/client/integration-tests/suppress-warnings/src/main/resources/application.properties b/client/integration-tests/suppress-warnings/src/main/resources/application.properties
diff --git a/client/integration-tests/suppress-warnings/src/test/java/io/quarkiverse/openapi/generator/it/SuppressWarningsTest.java b/client/integration-tests/suppress-warnings/src/test/java/io/quarkiverse/openapi/generator/it/SuppressWarningsTest.java
diff --git a/client/integration-tests/suppress-warnings/src/test/java/io/quarkiverse/openapi/generator/it/classwithoutsuppresswarningsexample/ClassWithoutSuppressWarningsExample.java b/client/integration-tests/suppress-warnings/src/test/java/io/quarkiverse/openapi/generator/it/classwithoutsuppresswarningsexample/ClassWithoutSuppressWarningsExample.java

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+ {#include suppressWarnings.qute/}`
`1`	`2`	`public static class {op.operationIdCamelCase}MultipartForm {`
`2`	`3`	`{#for p in op.formParams}`
`3`	`4`	`@jakarta.ws.rs.FormParam("{p.baseName}")`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+@SuppressWarnings({ "all", "unchecked", "rawtypes", "this-escape" })`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-quarkus.openapi-generator.codegen.spec.jsonproperty_openapi_yaml.base-package=org.acme.jsonproperty.gettersetter`
	`1`	`+quarkus.openapi-generator.codegen.spec.jsonproperty_openapi_json.base-package=org.acme.jsonproperty.gettersetter`