loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-04 14:40:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Java][Spring] Fix #13365 Adjusted pojo.mustache to handle required fields when beanValidation false (#13580)

Browse Source 
* Adjusted pojo.mustache to handle required fields

* Updated tests and config to cover more scenarios

* Removing unused imports

* Resolved conflicts
This commit is contained in:
DeaneOC 2022-10-07 16:05:51 +01:00 committed by GitHub
parent 4ee0cfa1ad
commit 0060dfd195
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 120 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache vendored
View File

@ -146,6 +146,9 @@ public class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}{{^parent}}
{{#useBeanValidation}} {{#useBeanValidation}}
{{>beanValidation}} {{>beanValidation}}
{{/useBeanValidation}} {{/useBeanValidation}}
{{^useBeanValidation}}
{{#required}}@NotNull{{/required}}
{{/useBeanValidation}}
{{#swagger2AnnotationLibrary}} {{#swagger2AnnotationLibrary}}
@Schema(name = "{{{baseName}}}", {{#isReadOnly}}accessMode = Schema.AccessMode.READ_ONLY, {{/isReadOnly}}{{#example}}example = "{{{.}}}", {{/example}}{{#description}}description = "{{{.}}}", {{/description}}required = {{{required}}}) @Schema(name = "{{{baseName}}}", {{#isReadOnly}}accessMode = Schema.AccessMode.READ_ONLY, {{/isReadOnly}}{{#example}}example = "{{{.}}}", {{/example}}{{#description}}description = "{{{.}}}", {{/description}}required = {{{required}}})
{{/swagger2AnnotationLibrary}} {{/swagger2AnnotationLibrary}}

79
modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
View File

@ -38,8 +38,7 @@ import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.nio.file.Files; import java.nio.file.Files;
import java.nio.file.Paths; import java.nio.file.Paths;
import java.util.List; import java.util.*;
import java.util.Map;
import java.util.function.Consumer; import java.util.function.Consumer;
import java.util.function.Function; import java.util.function.Function;
import java.util.stream.Collectors; import java.util.stream.Collectors;
@ -1562,6 +1561,82 @@ public class SpringCodegenTest {
} }
@Test @Test
public void requiredFieldShouldIncludeNotNullAnnotation_issue13365() throws IOException {
SpringCodegen codegen = new SpringCodegen();
codegen.setLibrary(SPRING_BOOT);
codegen.additionalProperties().put(SpringCodegen.INTERFACE_ONLY, "true");
codegen.additionalProperties().put(SpringCodegen.USE_BEANVALIDATION, "false");
codegen.additionalProperties().put(SpringCodegen.PERFORM_BEANVALIDATION, "false");
codegen.additionalProperties().put(SpringCodegen.OPENAPI_NULLABLE, "false");
codegen.additionalProperties().put(SpringCodegen.UNHANDLED_EXCEPTION_HANDLING, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_MODEL_PROPERTIES_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SERIALIZATION_LIBRARY, "jackson");
codegen.additionalProperties().put(CodegenConstants.ENUM_PROPERTY_NAMING, "PascalCase");
codegen.additionalProperties().put(SpringCodegen.USE_TAGS, "true");
DefaultGenerator generator = new DefaultGenerator();
Map<String, File> files = generateFiles(codegen, "src/test/resources/bugs/issue_13365.yml");
//Assert that NotNull annotation exists alone with no other BeanValidation annotations
JavaFileAssert.assertThat(files.get("Person.java"))
.printFileContent().assertMethod("getName").assertMethodAnnotations()
.containsWithName("NotNull").anyMatch(annotation ->
!annotation.getNameAsString().equals("Valid") ||
!annotation.getNameAsString().equals("Pattern") ||
!annotation.getNameAsString().equals("Email") ||
!annotation.getNameAsString().equals("Size"));
}
@Test
public void nonRequiredFieldShouldNotIncludeNotNullAnnotation_issue13365() throws IOException {
SpringCodegen codegen = new SpringCodegen();
codegen.setLibrary(SPRING_BOOT);
codegen.additionalProperties().put(SpringCodegen.INTERFACE_ONLY, "true");
codegen.additionalProperties().put(SpringCodegen.USE_BEANVALIDATION, "false");
codegen.additionalProperties().put(SpringCodegen.PERFORM_BEANVALIDATION, "false");
codegen.additionalProperties().put(SpringCodegen.OPENAPI_NULLABLE, "false");
codegen.additionalProperties().put(SpringCodegen.UNHANDLED_EXCEPTION_HANDLING, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_MODEL_PROPERTIES_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SERIALIZATION_LIBRARY, "jackson");
codegen.additionalProperties().put(CodegenConstants.ENUM_PROPERTY_NAMING, "PascalCase");
codegen.additionalProperties().put(SpringCodegen.USE_TAGS, "true");
Map<String, File> files = generateFiles(codegen, "src/test/resources/bugs/issue_13365.yml");
JavaFileAssert.assertThat(files.get("Alien.java"))
.printFileContent().assertMethod("getName")
.assertMethodAnnotations().anyMatch(annotation -> !annotation.getNameAsString().equals("NotNull"));
}
@Test
public void requiredFieldShouldIncludeNotNullAnnotationWithBeanValidationTrue_issue13365() throws IOException {
SpringCodegen codegen = new SpringCodegen();
codegen.setLibrary(SPRING_BOOT);
codegen.additionalProperties().put(SpringCodegen.INTERFACE_ONLY, "true");
codegen.additionalProperties().put(SpringCodegen.USE_BEANVALIDATION, "true");
codegen.additionalProperties().put(SpringCodegen.PERFORM_BEANVALIDATION, "false");
codegen.additionalProperties().put(SpringCodegen.OPENAPI_NULLABLE, "false");
codegen.additionalProperties().put(SpringCodegen.UNHANDLED_EXCEPTION_HANDLING, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_MODEL_PROPERTIES_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, "false");
codegen.additionalProperties().put(CodegenConstants.SERIALIZATION_LIBRARY, "jackson");
codegen.additionalProperties().put(CodegenConstants.ENUM_PROPERTY_NAMING, "PascalCase");
codegen.additionalProperties().put(SpringCodegen.USE_TAGS, "true");
Map<String, File> files = generateFiles(codegen, "src/test/resources/bugs/issue_13365.yml");
JavaFileAssert.assertThat(files.get("Person.java"))
.printFileContent().assertMethod("getName").assertMethodAnnotations()
.containsWithName("NotNull").containsWithName("Size").containsWithName("Email");
}
public void shouldUseEqualsNullableForArrayWhenSetInConfig_issue13385() throws IOException { public void shouldUseEqualsNullableForArrayWhenSetInConfig_issue13385() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile(); File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit(); output.deleteOnExit();

40
modules/openapi-generator/src/test/resources/bugs/issue_13365.yml Normal file
View File

@ -0,0 +1,40 @@
openapi: 3.0.0
info:
description: Specification to reproduce nullable issue with Array
title: Required Api
paths:
'/person':
post:
summary: Inserts a person
operationId: postPerson
tags:
- person
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
responses: ...
components:
schemas:
Person:
type: object
required:
- name
properties:
name:
type: string
maxLength: 50
format: email
id:
type: integer
Alien:
type: object
properties:
name:
type: string
id:
type: integer