Add constructor with required parameter for Spring (#14822) (fix #9789)

* Add constructor with required parameter for spring Fix #9789 * [Java][Spring] constructor with required args --------- Co-authored-by: Oleh Kurpiak <[email protected]>
OpenAPITools · Mar 1, 2023 · e1ab25c · defaultbranch · Jul 10, 2023 · e1ab25c
1 parent c70a412
commit e1ab25c
Show file tree

Hide file tree

Showing 328 changed files with 4,790 additions and 7,562 deletions.
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java
@@ -75,6 +75,7 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
     public List<CodegenProperty> readOnlyVars = new ArrayList<>(); // a list of read-only properties
     public List<CodegenProperty> readWriteVars = new ArrayList<>(); // a list of properties for read, write
     public List<CodegenProperty> parentVars = new ArrayList<>();
+    public List<CodegenProperty> parentRequiredVars = new ArrayList<>();
     public List<CodegenProperty> nonNullableVars = new ArrayList<>(); // a list of non-nullable properties
     public Map<String, Object> allowableValues;
 

diff --git a/...les/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java b/...les/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@@ -1078,6 +1078,10 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
                                     codegenModel.getImports().add(imp);
                                 }
                             }
+
+                            if (property.required) {
+                                codegenModel.parentRequiredVars.add(parentVar.clone());
+                            }
                         }
                     }
                     parentCodegenModel = parentCodegenModel.getParentModel();

diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
@@ -80,6 +80,36 @@ public class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}{{^parent}}
   {{/openApiNullable}}
   {{/isContainer}}
   {{/vars}}
+  {{#hasRequired}}
+
+  /**
+   * Default constructor
+   * @deprecated Use {@link {{classname}}#{{classname}}({{#requiredVars}}{{{datatypeWithEnum}}}{{^-last}}, {{/-last}}{{/requiredVars}})}
+   */
+  @Deprecated
+  public {{classname}}() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public {{classname}}({{#requiredVars}}{{{datatypeWithEnum}}} {{name}}{{^-last}}, {{/-last}}{{/requiredVars}}) {
+    {{#parent}}
+    super({{#parentRequiredVars}}{{name}}{{^-last}}, {{/-last}}{{/parentRequiredVars}});
+    {{/parent}}
+    {{#vars}}
+    {{#required}}
+    {{#openApiNullable}}
+    this.{{name}} = {{#isNullable}}JsonNullable.of({{name}}){{/isNullable}}{{^isNullable}}{{name}}{{/isNullable}};
+    {{/openApiNullable}}
+    {{^openApiNullable}}
+    this.{{name}} = {{name}};
+    {{/openApiNullable}}
+    {{/required}}
+    {{/vars}}
+  }
+  {{/hasRequired}}
   {{#vars}}
 
   {{! begin feature: fluent setter methods }}

diff --git a/...napi-generator/src/test/java/org/openapitools/codegen/java/assertions/JavaFileAssert.java b/...napi-generator/src/test/java/org/openapitools/codegen/java/assertions/JavaFileAssert.java
@@ -95,6 +95,15 @@ public ConstructorAssert assertConstructor(final String... paramTypes) {
         return new ConstructorAssert(this, constructorDeclaration.get());
     }
 
+    public JavaFileAssert assertNoConstructor(final String... paramTypes) {
+        Optional<ConstructorDeclaration> constructorDeclaration = actual.getType(0).getConstructorByParameterTypes(paramTypes);
+        Assertions.assertThat(constructorDeclaration)
+                .withFailMessage("Found constructor with parameter(s) %s", Arrays.toString(paramTypes))
+                .isEmpty();
+
+        return this;
+    }
+
     public PropertyAssert hasProperty(final String propertyName) {
         Optional<FieldDeclaration> fieldOptional = actual.getType(0).getMembers().stream()
             .filter(FieldDeclaration.class::isInstance)

diff --git a/...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java b/...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
@@ -27,7 +27,6 @@
 import static org.testng.Assert.assertEquals;
 import static org.testng.Assert.fail;
 
-import com.github.javaparser.ast.nodeTypes.NodeWithName;
 import io.swagger.parser.OpenAPIParser;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
@@ -45,8 +44,6 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-import javax.validation.Valid;
-
 import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.java.assertions.JavaFileAssert;
 import org.openapitools.codegen.CliOption;
@@ -2041,6 +2038,25 @@ public void shouldUseTheSameTagNameForTheInterfaceAndTheMethod_issue11570() thro
         assertFileContains(output.get("PersonApi.java").toPath(), interfaceTag, methodTag);
     }
 
+    @Test
+    public void shouldGenerateConstructorWithOnlyRequiredParameters() throws IOException {
+        final Map<String, File> output = generateFromContract("src/test/resources/3_0/spring/issue_9789.yml", SPRING_BOOT);
+
+        JavaFileAssert.assertThat(output.get("ObjectWithNoRequiredParameter.java")).assertNoConstructor("String");
+
+        JavaFileAssert.assertThat(output.get("ObjectWithRequiredParameter.java")).assertConstructor();
+        JavaFileAssert.assertThat(output.get("ObjectWithRequiredParameter.java")).assertConstructor("String", "String")
+                .hasParameter("param2").toConstructor()
+                .hasParameter("param3");
+
+        JavaFileAssert.assertThat(output.get("ObjectWithInheritedRequiredParameter.java")).assertConstructor();
+        JavaFileAssert.assertThat(output.get("ObjectWithInheritedRequiredParameter.java")).assertConstructor("Integer", "String", "String")
+                .hasParameter("param2").toConstructor()
+                .hasParameter("param3").toConstructor()
+                .hasParameter("param6").toConstructor()
+                .bodyContainsLines("super(param2, param3)", "this.param6 = param6");
+    }
+
     private Map<String, File> generateFromContract(String url, String library) throws IOException {
         return generateFromContract(url, library, new HashMap<>());
     }

diff --git a/modules/openapi-generator/src/test/resources/3_0/spring/issue_9789.yml b/modules/openapi-generator/src/test/resources/3_0/spring/issue_9789.yml
@@ -0,0 +1,52 @@
+openapi: 3.0.1
+info:
+  title: Test Issue #9789
+  version: v1
+paths:
+  /test:
+    get:
+      responses:
+        '200':
+          description: default response
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ObjectWithNoRequiredParameter'
+components:
+  schemas:
+    ObjectWithNoRequiredParameter:
+      type: object
+      properties:
+        param1:
+          type: string
+    ObjectWithRequiredParameter:
+      type: object
+      properties:
+        param1:
+          type: string
+        param2:
+          type: string
+        param3:
+          type: string
+          nullable: true
+        param4:
+          type: string
+      required:
+        - param2
+        - param3
+      discriminator:
+        propertyName: param1
+    ObjectWithInheritedRequiredParameter:
+      allOf:
+        - $ref: '#/components/schemas/ObjectWithRequiredParameter'
+        - type: object
+          properties:
+            param5:
+              type: boolean
+            param6:
+              type: integer
+            param7:
+              type: number
+          required:
+            - param6
+
diff --git a/samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/model/Pet.java b/samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/model/Pet.java
@@ -85,6 +85,23 @@ public static StatusEnum fromValue(String value) {
   @JsonProperty("status")
   private StatusEnum status;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Pet#Pet(String, List<String>)}
+   */
+  @Deprecated
+  public Pet() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Pet(String name, List<String> photoUrls) {
+    this.name = name;
+    this.photoUrls = photoUrls;
+  }
+
   public Pet id(Long id) {
     this.id = id;
     return this;

diff --git a/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java b/samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java
@@ -46,6 +46,22 @@ public class Pet {
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
   private LocalDate dateOfBirth = LocalDate.parse("2021-01-01");
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Pet#Pet(String)}
+   */
+  @Deprecated
+  public Pet() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Pet(String atType) {
+    this.atType = atType;
+  }
+
   public Pet atType(String atType) {
     this.atType = atType;
     return this;

diff --git a/...ent/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/model/Pet.java b/...ent/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/model/Pet.java
@@ -85,6 +85,23 @@ public static StatusEnum fromValue(String value) {
   @JsonProperty("status")
   private StatusEnum status;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Pet#Pet(String, List<String>)}
+   */
+  @Deprecated
+  public Pet() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Pet(String name, List<String> photoUrls) {
+    this.name = name;
+    this.photoUrls = photoUrls;
+  }
+
   public Pet id(Long id) {
     this.id = id;
     return this;

diff --git a/...lient/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/model/Pet.java b/...lient/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/model/Pet.java
@@ -85,6 +85,23 @@ public static StatusEnum fromValue(String value) {
   @JsonProperty("status")
   private StatusEnum status;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Pet#Pet(String, List<String>)}
+   */
+  @Deprecated
+  public Pet() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Pet(String name, List<String> photoUrls) {
+    this.name = name;
+    this.photoUrls = photoUrls;
+  }
+
   public Pet id(Long id) {
     this.id = id;
     return this;

diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/model/Pet.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/model/Pet.java
@@ -85,6 +85,23 @@ public static StatusEnum fromValue(String value) {
   @JsonProperty("status")
   private StatusEnum status;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Pet#Pet(String, List<String>)}
+   */
+  @Deprecated
+  public Pet() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Pet(String name, List<String> photoUrls) {
+    this.name = name;
+    this.photoUrls = photoUrls;
+  }
+
   public Pet id(Long id) {
     this.id = id;
     return this;

diff --git a/.../petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Animal.java b/.../petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Animal.java
@@ -42,6 +42,22 @@ public class Animal {
   @JsonProperty("color")
   private String color = "red";
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Animal#Animal(String)}
+   */
+  @Deprecated
+  public Animal() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Animal(String className) {
+    this.className = className;
+  }
+
   public Animal className(String className) {
     this.className = className;
     return this;

diff --git a/.../petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/BigCat.java b/.../petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/BigCat.java
@@ -67,6 +67,22 @@ public static KindEnum fromValue(String value) {
   @JsonProperty("kind")
   private KindEnum kind;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link BigCat#BigCat(String)}
+   */
+  @Deprecated
+  public BigCat() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public BigCat(String className) {
+    super(className);
+  }
+
   public BigCat kind(KindEnum kind) {
     this.kind = kind;
     return this;

diff --git a/...ent/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Cat.java b/...ent/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Cat.java
@@ -36,6 +36,22 @@ public class Cat extends Animal {
   @JsonProperty("declawed")
   private Boolean declawed;
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Cat#Cat(String)}
+   */
+  @Deprecated
+  public Cat() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Cat(String className) {
+    super(className);
+  }
+
   public Cat declawed(Boolean declawed) {
     this.declawed = declawed;
     return this;

diff --git a/...etstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Category.java b/...etstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/Category.java
@@ -25,6 +25,22 @@ public class Category {
   @JsonProperty("name")
   private String name = "default-name";
 
+  /**
+   * Default constructor
+   * @deprecated Use {@link Category#Category(String)}
+   */
+  @Deprecated
+  public Category() {
+    super();
+  }
+
+  /**
+   * Constructor with only required parameters
+   */
+  public Category(String name) {
+    this.name = name;
+  }
+
   public Category id(Long id) {
     this.id = id;
     return this;