Add documentation, tests, and clean up resolver

Signed-off-by: Ricardo Zanini <[email protected]>

Author: ricardozanini

README.md

@@ -277,21 +277,29 @@ org.acme.openapi.simple.api.DefaultApi/byeGet/CircuitBreaker/successThreshold=22
 ````
 
 ## Sending multipart/form-data
-The rest client also supports request with mime-type multipart/form-data and, if the schema of the request body is known in advance, we can also automatically generate the models of the request bodies. 
+
+The rest client also supports request with mime-type multipart/form-data and, if the schema of the request body is known in advance, we can also automatically generate the models of the request
+bodies.
 
 You need to add the following additional dependency to your `pom.xml`:
+
 ```xml
+
 <dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-resteasy-multipart</artifactId>
 </dependency>
 ```
+
 For any multipart/form-data operation a model for the request body will be generated. Each part of the multipart is a field in this model that is annotated with the following annotations:
-- `javax.ws.rs.FormParam`, where the value parameter denotes the part name, 
+
+- `javax.ws.rs.FormParam`, where the value parameter denotes the part name,
 - `org.jboss.resteasy.annotations.providers.multipart.PartType`, where the parameter is the jax-rs MediaType of the part (see below for details),
-- and, if the part contains a file, `org.jboss.resteasy.annotations.providers.multipart.PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the Content-Disposition header of the part.
+- and, if the part contains a file, `org.jboss.resteasy.annotations.providers.multipart.PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the
+  Content-Disposition header of the part.
+
+For example, the model for a request that requires a file, a string and some complex object will look like this:
 
-For example, the model for a request that requires a file, a string and some complex object will look like this: 
 ```java
 public class MultipartBody {
 
@@ -311,33 +319,41 @@ public class MultipartBody {
 ```
 
 Then in the client the `org.jboss.resteasy.annotations.providers.multipart.MultipartForm` annotation is added in front of the multipart parameter:
+
 ```java
 @Path("/echo")
 @RegisterRestClient
 public interface MultipartService {
-    
+
     @POST
     @Consumes(MediaType.MULTIPART_FORM_DATA)
     @Produces(MediaType.TEXT_PLAIN)
     String sendMultipartData(@MultipartForm MultipartBody data);
-    
+
 }
 ```
-See [Quarkus - Using the REST Client with Multipart](https://quarkus.io/guides/rest-client-multipart) and the [RESTEasy JAX-RS specifications](https://docs.jboss.org/resteasy/docs/4.7.5.Final/userguide/html_single/index.html) for more details.
 
-Importantly, if some multipart request bodies contain complex objects (i.e. non-primitives) you need to explicitly tell the Open API generator to create models for these objects by setting the `skip-form-model` property corresponding to your spec in the `application.properties` to `false`, e.g.:
+See [Quarkus - Using the REST Client with Multipart](https://quarkus.io/guides/rest-client-multipart) and
+the [RESTEasy JAX-RS specifications](https://docs.jboss.org/resteasy/docs/4.7.5.Final/userguide/html_single/index.html) for more details.
+
+Importantly, if some multipart request bodies contain complex objects (i.e. non-primitives) you need to explicitly tell the Open API generator to create models for these objects by setting
+the `skip-form-model` property corresponding to your spec in the `application.properties` to `false`, e.g.:
+
 ```properties
 quarkus.openapi-generator.codegen.spec."my-multipart-requests.yml".skip-form-model=false
 ```
 
 ### Default content-types according to OpenAPI Specification and limitations
+
 The [OAS 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#special-considerations-for-multipart-content) specifies the following default content-types for a multipart:
+
 - If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain`
 - If the property is complex, or an array of complex values, the default Content-Type is `application/json`
 - If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream`
 
-A different content-type may be defined in your api spec, but this is not yet supported in the code generation. Also, this "annotation-oriented" approach of RestEasy (i.e. using `@MultipartForm` to denote the multipart body parameter) does not seem to properly support the unmarshalling of arrays of the same type (e.g. array of files), in these cases it uses Content-Type equal to `application/json`.
-
+A different content-type may be defined in your api spec, but this is not yet supported in the code generation. Also, this "annotation-oriented" approach of RestEasy (i.e. using `@MultipartForm` to
+denote the multipart body parameter) does not seem to properly support the unmarshalling of arrays of the same type (e.g. array of files), in these cases it uses Content-Type equal
+to `application/json`.
 
 ## Generating files via InputStream
 
@@ -347,6 +363,13 @@ saved locally in your project.
 
 See the example implementation [here](test-utils/src/main/java/io/quarkiverse/openapi/generator/testutils/codegen/ClassPathPetstoreOpenApiSpecInputProvider.java)
 
+## Skip Deprecated Attributes in Model classes
+
+The domain objects are classes generated in the `model` package. These classes might have [deprecated attributes](https://spec.openapis.org/oas/v3.1.0#fixed-fields-9) in the Open API specification
+file. By default, these attributes are generated. You can fine tune this behavior if the deprecated attributes should not be generated.
+
+Use the property key `<base_package>.model.MyClass.generateDeprecated=false` to disable the deprecated attributes in the given model. For example `org.acme.weather.Country.generatedDeprecated=false`.
+
 ## Known Limitations
 
 These are the known limitations of this pre-release version:

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/ModelConfigValueResolver.java

@@ -0,0 +1,59 @@
+package io.quarkiverse.openapi.generator.deployment.template;
+
+import java.util.HashMap;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+import java.util.concurrent.ExecutionException;
+
+import io.quarkus.qute.EvalContext;
+import io.quarkus.qute.Expression;
+import io.quarkus.qute.NamespaceResolver;
+
+/**
+ * Collection of OpenAPI specific methods to use in the templates.
+ * It can be enhanced to have even more methods. See the usage of the method #genDeprecatedModelAttr to understand how to
+ * implement and use them.
+ */
+public class OpenApiNamespaceResolver implements NamespaceResolver {
+    private static final String GENERATE_DEPRECATED_PROP = "generateDeprecated";
+
+    static final OpenApiNamespaceResolver INSTANCE = new OpenApiNamespaceResolver();
+
+    private OpenApiNamespaceResolver() {
+    }
+
+    /**
+     * @param pkg name of the given package
+     * @param classname name of the Model class
+     * @param codegenConfig Map with the model codegen properties
+     * @return true if the given model class should generate the deprecated attributes
+     */
+    public boolean genDeprecatedModelAttr(final String pkg, final String classname,
+            final HashMap<String, Object> codegenConfig) {
+        final String key = String.format("%s.%s.%s", pkg, classname, GENERATE_DEPRECATED_PROP);
+        return Boolean.parseBoolean(codegenConfig.getOrDefault(key, "true").toString());
+    }
+
+    @Override
+    public CompletionStage<Object> resolve(EvalContext context) {
+        try {
+            Class<?>[] classArgs = new Class[context.getParams().size()];
+            Object[] args = new Object[context.getParams().size()];
+            int i = 0;
+            for (Expression expr : context.getParams()) {
+                args[i] = context.evaluate(expr).toCompletableFuture().get();
+                classArgs[i] = args[i].getClass();
+                i++;
+            }
+            return CompletableFuture
+                    .completedFuture(this.getClass().getMethod(context.getName(), classArgs).invoke(this, args));
+        } catch (ReflectiveOperationException | InterruptedException | ExecutionException ex) {
+            return CompletableFuture.failedStage(ex);
+        }
+    }
+
+    @Override
+    public String getNamespace() {
+        return "openapi";
+    }
+}

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/OpenApiNamespaceResolver.java

@@ -37,6 +37,7 @@ public QuteTemplatingEngineAdapter() {
                 .addDefaults()
                 .addValueResolver(new ReflectionValueResolver())
                 .addNamespaceResolver(QuteTemplatingExtension.INSTANCE)
+                .addNamespaceResolver(OpenApiNamespaceResolver.INSTANCE)
                 .removeStandaloneLines(true)
                 .strictRendering(false)
                 .build();

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java

@@ -32,7 +32,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if m.serializableModel} implements Serializable{/if} {
 
     {#for v in m.vars}
-    {#if !v.deprecated || generateModelDeprecated()}
+    {#if !v.deprecated || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
     {#if v.isEnum}
     {#if v.isContainer && v.mostInnerItems}
     {#include enumClass.qute e=v/}
@@ -57,7 +57,7 @@ public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if m.serializa
     {/for}
 
     {#for v in m.vars}
-    {#if !v.deprecated || generateModelDeprecated()}
+    {#if !v.deprecated || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
     /**
     {#if v.description}
     * {v.description}
@@ -127,7 +127,7 @@ public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if m.serializa
         {#if m.parent}
         sb.append("    ").append(toIndentedString(super.toString())).append("\n");{/if}
         {#for v in m.vars}
-        {#if !v.deprecated || generateModelDeprecated()}
+        {#if !v.deprecated || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
         sb.append("    {v.name}: ").append(toIndentedString({v.name})).append("\n");
         {/if}
         {/for}

deployment/src/main/resources/templates/pojo.qute

@@ -104,7 +104,18 @@ void verifyDeprecatedFields() throws URISyntaxException, FileNotFoundException {
                 .flatMap(v -> v.getVariables().stream())
                 .anyMatch(f -> f.getNameAsString().equals("allowUpgrade")))
                         .isFalse();
-        //TODO: add a condition where we know there is a deprecated attribute and verify it's been generated
+
+        // this class has a deprecated attribute, so we check the default behavior
+        final Optional<File> connectorDeploymentStatus = generatedFiles.stream()
+                .filter(f -> f.getName().endsWith("ConnectorDeploymentStatus.java")).findFirst();
+        assertThat(connectorDeploymentStatus).isPresent();
+        final CompilationUnit cu3 = StaticJavaParser.parse(connectorDeploymentStatus.orElseThrow());
+        final List<FieldDeclaration> fields3 = cu3.findAll(FieldDeclaration.class);
+
+        assertThat(fields3.stream()
+                .flatMap(v -> v.getVariables().stream())
+                .anyMatch(f -> f.getNameAsString().equals("availableUpgrades")))
+                        .isTrue();
     }
 
     @Test