Enabling custom data and datetime mappings (#182)

Orbifoldt · web-flow · commit e7087a1bfdda · 2022-11-23T16:04:23.000-03:00
* Enabling custom datetime mappings, removing default java8 datelibrary

* Fixing formatting and spelling

* Updating readme
diff --git a/README.md b/README.md
@@ -615,14 +615,20 @@ Use the property key `quarkus.openapi-generator.codegen.validateSpec=false` to d
 
 It's possible to remap types in the generated files. For example, instead of a `File` you can configure the code generator to use `InputStream` for all file upload parts of multipart request, or you could change all `UUID` types to `String`. You can configure this in your `application.properties` using the following configuration keys:
 
-| Description    | Property Key                                                                   | Example                                                                                                                                                                        |
-|----------------|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Type Mapping   | `quarkus.openapi-generator.codegen.spec.[filename].type-mappings.[oas_type]`   | `quarkus.openapi-generator.codegen.spec.my_spec_yml.type-mappings.File=InputStream` will use `InputStream` as type for all objects of the OAS File type.                       |
-| Import Mapping | `quarkus.openapi-generator.codegen.spec.[filename].import-mappings.[oas_type]` | `quarkus.openapi-generator.codegen.spec.my_spec_yml.import-mappings.File=java.io.InputStream` will replace the default `import java.io.File` with `import java.io.InputStream` |
+| Description    | Property Key                                                                 | Example                                                                                                                                                                        |
+|----------------|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Type Mapping   | `quarkus.openapi-generator.codegen.spec.[filename].type-mappings.[oas_type]` | `quarkus.openapi-generator.codegen.spec.my_spec_yml.type-mappings.File=InputStream` will use `InputStream` as type for all objects of the OAS File type.                       |
+| Import Mapping | `quarkus.openapi-generator.codegen.spec.[filename].import-mappings.[type]`   | `quarkus.openapi-generator.codegen.spec.my_spec_yml.import-mappings.File=java.io.InputStream` will replace the default `import java.io.File` with `import java.io.InputStream` |
 
-Note that these configuration properties are maps where the keys are OAS data types and the values are Java types. 
+Note that these configuration properties are maps. For the type-mapping the keys are OAS data types and the values are Java types. 
 
-It's also possible to only use a type mapping with a fully qualified name, for instance `quarkus.openapi-generator.codegen.spec.my_spec_yml.type-mappings.File=java.io.InputStream`. For more information and a list of all types see the OpenAPI generator documentation on [Type Mappings and Import Mappings](https://openapi-generator.tech/docs/usage/#type-mappings-and-import-mappings). (Note that you won't be able to change all types as some are hardcoded in the generator, e.g. the OAS type DateTime.)
+Another common example is needing `java.time.Instant` as type for date-time fields in your POJO classes. You can achieve with these settings:
+```properties
+quarkus.openapi-generator.codegen.spec.my_spec_yml.type-mappings.DateTime=Instant
+quarkus.openapi-generator.codegen.spec.my_spec_yml.import-mappings.Instant=java.time.Instant
+```
+
+It's also possible to only use a type mapping with a fully qualified name, for instance `quarkus.openapi-generator.codegen.spec.my_spec_yml.type-mappings.File=java.io.InputStream`. For more information and a list of all types see the OpenAPI generator documentation on [Type Mappings and Import Mappings](https://openapi-generator.tech/docs/usage/#type-mappings-and-import-mappings). 
 
 See the module [type-mapping](integration-tests/type-mapping) for an example of how to use this feature.
 
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java
@@ -33,6 +33,12 @@ public class OpenApiClientGeneratorWrapper {
      * Security scheme for which to apply security constraints even if the OpenAPI definition has no security definition
      */
     public static final String DEFAULT_SECURITY_SCHEME = "defaultSecurityScheme";
+    private static final Map<String, String> defaultTypeMappings = Map.of(
+            "date", "LocalDate",
+            "DateTime", "OffsetDateTime");
+    private static final Map<String, String> defaultImportMappings = Map.of(
+            "LocalDate", "java.time.LocalDate",
+            "OffsetDateTime", "java.time.OffsetDateTime");
     private final QuarkusCodegenConfigurator configurator;
     private final DefaultGenerator generator;
 
@@ -62,6 +68,9 @@ public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputD
                 Collections.singletonMap("openApiSpecId", getSanitizedFileName(specFilePath)));
         this.configurator.addAdditionalProperty("openApiNullable", false);
         this.configurator.setValidateSpec(validateSpec);
+        defaultTypeMappings.forEach(this.configurator::addTypeMapping);
+        defaultImportMappings.forEach(this.configurator::addImportMapping);
+
         this.generator = new DefaultGenerator();
     }
 
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/QuarkusJavaClientCodegen.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/QuarkusJavaClientCodegen.java
@@ -25,7 +25,6 @@ public class QuarkusJavaClientCodegen extends JavaClientCodegen {
 
     public QuarkusJavaClientCodegen() {
         // immutable properties
-        this.setDateLibrary(JavaClientCodegen.JAVA8_MODE);
         this.setSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
         this.setTemplateDir("templates");
     }
diff --git a/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java b/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java
@@ -24,6 +24,7 @@
 import com.github.javaparser.StaticJavaParser;
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.ImportDeclaration;
+import com.github.javaparser.ast.Node;
 import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
 import com.github.javaparser.ast.body.EnumConstantDeclaration;
 import com.github.javaparser.ast.body.FieldDeclaration;
@@ -32,6 +33,8 @@
 import com.github.javaparser.ast.body.VariableDeclarator;
 import com.github.javaparser.ast.expr.AnnotationExpr;
 import com.github.javaparser.ast.expr.SingleMemberAnnotationExpr;
+import com.github.javaparser.ast.nodeTypes.NodeWithName;
+import com.github.javaparser.ast.type.Type;
 
 import io.quarkiverse.openapi.generator.annotations.GeneratedClass;
 import io.quarkiverse.openapi.generator.annotations.GeneratedMethod;
@@ -353,6 +356,87 @@ void shouldReplaceFileImportWithInputStream() throws URISyntaxException, FileNot
         assertThat(imports).doesNotContain("java.io.File");
     }
 
+    @Test
+    void withoutAnyTypeOrImportMappingsItShouldGenerateUsingJava8DatesAndTimes()
+            throws URISyntaxException, FileNotFoundException {
+        List<File> generatedFiles = createGeneratorWrapper("datetime-regression.yml")
+                .generate("org.datetime.regression");
+
+        Optional<File> file = generatedFiles.stream()
+                .filter(f -> f.getName().endsWith("SomeName.java"))
+                .findAny();
+        assertThat(file).isNotEmpty();
+        CompilationUnit compilationUnit = StaticJavaParser.parse(file.orElseThrow());
+        List<ClassOrInterfaceDeclaration> classes = compilationUnit.findAll(ClassOrInterfaceDeclaration.class);
+        assertThat(classes).hasSize(1);
+        ClassOrInterfaceDeclaration generatedPojoClass = classes.get(0);
+
+        verifyGeneratedDateAndTimeTypes(
+                generatedPojoClass,
+                Map.of(
+                        "someDate", "LocalDate",
+                        "someDateTime", "OffsetDateTime",
+                        "dateArray", "List<LocalDate>",
+                        "dateTimeArray", "List<OffsetDateTime>",
+                        "dateSet", "Set<LocalDate>",
+                        "dateTimeSet", "Set<OffsetDateTime>",
+                        "dateMap", "Map<String,LocalDate>",
+                        "dateTimeMap", "Map<String,OffsetDateTime>"));
+        assertThat(compilationUnit.getImports().stream().map(NodeWithName::getNameAsString))
+                .contains("java.time.LocalDate", "java.time.OffsetDateTime");
+    }
+
+    @Test
+    void shouldBeAbleToAddCustomDateAndTimeMappings() throws URISyntaxException, FileNotFoundException {
+        List<File> generatedFiles = createGeneratorWrapper("datetime-regression.yml")
+                .withTypeMappings(Map.of(
+                        "date", "ThaiBuddhistDate",
+                        "DateTime", "Instant"))
+                .withImportMappings(Map.of(
+                        "ThaiBuddhistDate", "java.time.chrono.ThaiBuddhistDate",
+                        "Instant", "java.time.Instant"))
+                .generate("org.datetime.mappings");
+        Optional<File> file = generatedFiles.stream()
+                .filter(f -> f.getName().endsWith("SomeName.java"))
+                .findAny();
+        assertThat(file).isNotEmpty();
+        CompilationUnit compilationUnit = StaticJavaParser.parse(file.orElseThrow());
+        List<ClassOrInterfaceDeclaration> classes = compilationUnit.findAll(ClassOrInterfaceDeclaration.class);
+        assertThat(classes).hasSize(1);
+        ClassOrInterfaceDeclaration generatedPojoClass = classes.get(0);
+
+        verifyGeneratedDateAndTimeTypes(
+                generatedPojoClass,
+                Map.of(
+                        "someDate", "ThaiBuddhistDate",
+                        "someDateTime", "Instant",
+                        "dateArray", "List<ThaiBuddhistDate>",
+                        "dateTimeArray", "List<Instant>",
+                        "dateSet", "Set<ThaiBuddhistDate>",
+                        "dateTimeSet", "Set<Instant>",
+                        "dateMap", "Map<String,ThaiBuddhistDate>",
+                        "dateTimeMap", "Map<String,Instant>"));
+        assertThat(compilationUnit.getImports().stream().map(NodeWithName::getNameAsString))
+                .contains("java.time.chrono.ThaiBuddhistDate", "java.time.Instant");
+    }
+
+    private void verifyGeneratedDateAndTimeTypes(
+            ClassOrInterfaceDeclaration classDeclaration,
+            Map<String, String> expectedFieldsAndTypes) {
+        expectedFieldsAndTypes.forEach((fieldName, expectedFieldType) -> {
+            Optional<FieldDeclaration> fieldDeclaration = classDeclaration.getFieldByName(fieldName);
+            assertThat(fieldDeclaration).isPresent();
+
+            Optional<Node> fieldVariableDeclaration = fieldDeclaration.orElseThrow().getChildNodes().stream()
+                    .filter(it -> it instanceof VariableDeclarator)
+                    .findFirst();
+            assertThat(fieldVariableDeclaration).isPresent();
+
+            Type fieldType = ((VariableDeclarator) fieldVariableDeclaration.orElseThrow()).getType();
+            assertThat(fieldType.asString()).isEqualTo(expectedFieldType);
+        });
+    }
+
     @Test
     void verifyAdditionalModelTypeAnnotations() throws URISyntaxException {
         List<File> generatedFiles = createGeneratorWrapper("petstore-openapi.json")
diff --git a/deployment/src/test/resources/openapi/datetime-regression.yml b/deployment/src/test/resources/openapi/datetime-regression.yml
@@ -0,0 +1,64 @@
+openapi: 3.0.3
+info:
+  title: "Multipart form data API"
+  version: 1.0.0
+
+servers:
+  - url: "http://my.endpoint.com/api/v1"
+
+paths:
+  /dates-and-times:
+    get:
+      responses:
+        "200":
+          description: The response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SomeName'
+
+components:
+  schemas:
+    SomeName:
+      type: object
+      properties:
+        someDate:
+          type: string
+          format: date
+        someDateTime:
+          type: string
+          format: date-time
+        dateArray:
+          type: array
+          items:
+            type: string
+            format: date
+        dateTimeArray:
+          type: array
+          items:
+            type: string
+            format: date-time
+        dateSet:
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            format: date
+        dateTimeSet:
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            format: date-time
+        dateMap:
+          type: object
+          additionalProperties:
+            type: string
+            format: date
+        dateTimeMap:
+          type: object
+          additionalProperties:
+            type: string
+            format: date-time
+
+

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,6 @@ public class QuarkusJavaClientCodegen extends JavaClientCodegen {`
`25`	`25`
`26`	`26`	`public QuarkusJavaClientCodegen() {`
`27`	`27`	`// immutable properties`
`28`		`- this.setDateLibrary(JavaClientCodegen.JAVA8_MODE);`
`29`	`28`	`this.setSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);`
`30`	`29`	`this.setTemplateDir("templates");`
`31`	`30`	`}`