Merge pull request #45 from quarkiverse/issue-38

Fix #38 - Add option to skip generation of deprecated attributes

Author: fjtirado

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/SpecConfig.java

@@ -11,6 +11,14 @@ public class SpecConfig {
     private static final String BASE_PACKAGE_PROP_FORMAT = "%s.base-package";
     private static final String SKIP_FORM_MODEL_PROP_FORMAT = "%s.skip-form-model";
 
+    public static String resolveApiPackage(final String basePackage) {
+        return String.format("%s%s", basePackage, API_PKG_SUFFIX);
+    }
+
+    public static String resolveModelPackage(final String basePackage) {
+        return String.format("%s%s", basePackage, MODEL_PKG_SUFFIX);
+    }
+
     public static String getResolvedBasePackageProperty(final Path openApiFilePath) {
         return String.format(BASE_PACKAGE_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
     }

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/ModelCodegenConfigParser.java

@@ -0,0 +1,34 @@
+package io.quarkiverse.openapi.generator.deployment.codegen;
+
+import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveModelPackage;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
+
+import org.eclipse.microprofile.config.Config;
+
+/**
+ * Extracts the Model codegen properties from a given {@link Config} reference.
+ * These properties are then injected in the OpenAPI generator to tweak the code generation properties.
+ */
+public final class ModelCodegenConfigParser {
+
+    public static Map<String, Object> parse(final Config config, final String basePackage) {
+        final List<String> modelProperties = filterModelPropertyNames(config.getPropertyNames(),
+                resolveModelPackage(basePackage));
+        final Map<String, Object> modelConfig = new HashMap<>();
+        modelProperties.forEach(m -> {
+            modelConfig.put(m, config.getValue(m, String.class));
+        });
+        return modelConfig;
+    }
+
+    private static List<String> filterModelPropertyNames(final Iterable<String> propertyNames, final String modelPackage) {
+        return StreamSupport.stream(propertyNames.spliterator(), false)
+                .filter(propertyName -> propertyName.startsWith(modelPackage))
+                .collect(Collectors.toList());
+    }
+}

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java

@@ -55,13 +55,16 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
     }
 
     protected void generate(CodeGenContext context, final Path openApiFilePath, final Path outDir) {
-        // TODO: do not generate with the output dir has generated files and the openapi file has the same checksum of the previous runz
+        // TODO: do not generate if the output dir has generated files and the openapi file has the same checksum of the previous run
+        final String basePackage = getResolvedBasePackageProperty(openApiFilePath);
+
         final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
                 openApiFilePath.normalize(), outDir)
+                        .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(context.config(), basePackage))
                         .withCircuitBreakerConfiguration(CircuitBreakerConfigurationParser.parse(
                                 context.config()));
         context.config()
-                .getOptionalValue(getResolvedBasePackageProperty(openApiFilePath), String.class)
+                .getOptionalValue(basePackage, String.class)
                 .ifPresent(generator::withBasePackage);
         context.config()
                 .getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)

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

@@ -1,6 +1,7 @@
 package io.quarkiverse.openapi.generator.deployment.template;
 
 import java.nio.file.Path;
+import java.util.HashMap;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 import java.util.concurrent.ExecutionException;
@@ -9,11 +10,29 @@
 import io.quarkus.qute.Expression;
 import io.quarkus.qute.NamespaceResolver;
 
-public class QuteTemplatingExtension implements 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 QuteTemplatingExtension INSTANCE = new QuteTemplatingExtension();
+    static final OpenApiNamespaceResolver INSTANCE = new OpenApiNamespaceResolver();
 
-    private QuteTemplatingExtension() {
+    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());
     }
 
     public String parseUri(String uri) {

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

@@ -36,7 +36,7 @@ public QuteTemplatingEngineAdapter() {
         this.engine = Engine.builder()
                 .addDefaults()
                 .addValueResolver(new ReflectionValueResolver())
-                .addNamespaceResolver(QuteTemplatingExtension.INSTANCE)
+                .addNamespaceResolver(OpenApiNamespaceResolver.INSTANCE)
                 .removeStandaloneLines(true)
                 .strictRendering(false)
                 .build();

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java

@@ -1,5 +1,7 @@
 package io.quarkiverse.openapi.generator.deployment.wrapper;
 
+import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveApiPackage;
+import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveModelPackage;
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
 
@@ -12,8 +14,6 @@
 import org.openapitools.codegen.DefaultGenerator;
 import org.openapitools.codegen.config.GlobalSettings;
 
-import io.quarkiverse.openapi.generator.deployment.SpecConfig;
-
 /**
  * Wrapper for the OpenAPIGen tool.
  * This is the same as calling the Maven plugin or the CLI.
@@ -76,7 +76,16 @@ public OpenApiClientGeneratorWrapper withBasePackage(final String pkg) {
      * @return this wrapper
      */
     public OpenApiClientGeneratorWrapper withCircuitBreakerConfiguration(final Map<String, List<String>> config) {
-        configurator.addAdditionalProperty("circuit-breaker", config);
+        if (config != null) {
+            configurator.addAdditionalProperty("circuit-breaker", config);
+        }
+        return this;
+    }
+
+    public OpenApiClientGeneratorWrapper withModelCodeGenConfiguration(final Map<String, Object> config) {
+        if (config != null) {
+            configurator.addAdditionalProperty("model-codegen", config);
+        }
         return this;
     }
 
@@ -101,10 +110,10 @@ private void consolidatePackageNames() {
             basePackage = DEFAULT_PACKAGE;
         }
         if (apiPackage.isEmpty()) {
-            this.apiPackage = basePackage.concat(SpecConfig.API_PKG_SUFFIX);
+            this.apiPackage = resolveApiPackage(basePackage);
         }
         if (modelPackage.isEmpty()) {
-            this.modelPackage = basePackage.concat(SpecConfig.MODEL_PKG_SUFFIX);
+            this.modelPackage = resolveModelPackage(basePackage);
         }
         this.configurator.setPackageName(basePackage);
         this.configurator.setApiPackage(apiPackage);

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

@@ -15,5 +15,5 @@ import javax.validation.Valid;
 {/if}
 {#for m in models}
 {#if m.model.isEnum}{#include enumOuterClass.qute e=m.model/}
-{#else}{#include pojo.qute m=m.model withXml=withXml/}{/if}
+{#else}{#include pojo.qute m=m.model withXml=withXml codegen=model-codegen package=modelPackage/}{/if}
 {/for}

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

@@ -32,6 +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 || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
     {#if v.isEnum}
     {#if v.isContainer && v.mostInnerItems}
     {#include enumClass.qute e=v/}
@@ -52,9 +53,11 @@ public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if m.serializa
     {#else}
     private {v.datatypeWithEnum} {v.name}{#if v.defaultValue} = {v.defaultValue}{/if};
     {/if}
+    {/if}
     {/for}
 
     {#for v in m.vars}
+    {#if !v.deprecated || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
     /**
     {#if v.description}
     * {v.description}
@@ -112,6 +115,7 @@ public class {m.classname} {#if m.parent}extends {m.parent}{/if}{#if m.serializa
     {/if}
     {/if}
 
+    {/if}
     {/for}
     /**
      * Create a string representation of this pojo.
@@ -123,7 +127,9 @@ 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 || openapi:genDeprecatedModelAttr(package, m.classname, codegen)}
         sb.append("    {v.name}: ").append(toIndentedString({v.name})).append("\n");
+        {/if}
         {/for}
         sb.append("}");
         return sb.toString();

deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/MockConfigUtils.java

@@ -0,0 +1,37 @@
+package io.quarkiverse.openapi.generator.deployment;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URL;
+import java.util.Objects;
+
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
+
+import io.smallrye.config.PropertiesConfigSource;
+
+public final class MockConfigUtils {
+
+    private MockConfigUtils() {
+    }
+
+    public static Config getTestConfig(String propertiesFile) {
+        PropertiesConfigSource configSource;
+        try {
+            configSource = new PropertiesConfigSource(getResource(propertiesFile));
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
+
+        return ConfigProviderResolver
+                .instance()
+                .getBuilder()
+                .withSources(configSource)
+                .build();
+    }
+
+    private static URL getResource(String resourcePath) {
+        return Objects.requireNonNull(MockConfigUtils.class.getResource(resourcePath));
+    }
+
+}