[JAVA-SPRING] - 22859 - spring http interface library should support 'useBeanValidation'

.github/workflows/samples-jdk17.yaml

@@ -7,6 +7,8 @@ on:
       - samples/client/petstore/java-helidon-client/v3/mp/**
       - samples/client/petstore/java-helidon-client/v3/se/**
       - samples/client/petstore/spring-http-interface-reactive/**
+      - samples/client/petstore/spring-http-interface-reactive-bean-validation/**
+      - samples/client/petstore/spring-http-interface-bean-validation/**
       - samples/client/petstore/spring-http-interface/**
       - samples/client/petstore/spring-http-interface-reactive-noResponseEntity/**
       - samples/client/petstore/spring-http-interface-noResponseEntity/**
@@ -27,6 +29,8 @@ on:
       - samples/client/petstore/java-helidon-client/v3/mp/**
       - samples/client/petstore/java-helidon-client/v3/se/**
       - samples/client/petstore/spring-http-interface-reactive/**
+      - samples/client/petstore/spring-http-interface-reactive-bean-validation/**
+      - samples/client/petstore/spring-http-interface-bean-validation/**
       - samples/client/petstore/spring-http-interface/**
       - samples/client/petstore/spring-http-interface-reactive-noResponseEntity/**
       - samples/client/petstore/spring-http-interface-noResponseEntity/**
@@ -53,6 +57,8 @@ jobs:
           - samples/client/petstore/java-helidon-client/v3/mp/
           - samples/client/petstore/java-helidon-client/v3/se
           - samples/client/petstore/spring-http-interface-reactive
+          - samples/client/petstore/spring-http-interface-reactive-bean-validation
+          - samples/client/petstore/spring-http-interface-bean-validation
           - samples/client/petstore/spring-http-interface
           - samples/client/petstore/spring-http-interface-reactive-noResponseEntity
           - samples/client/petstore/spring-http-interface-noResponseEntity

bin/configs/spring-http-interface-bean-validation.yaml

@@ -0,0 +1,18 @@
+generatorName: spring
+library: spring-http-interface
+outputDir: samples/client/petstore/spring-http-interface-bean-validation
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: spring-http-interface
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  modelNameSuffix: 'Dto'
+  generatedConstructorWithRequiredArgs: "false"
+  # validation should be respected
+  useBeanValidation: "true"
+  # documentation provider should be ignored
+  documentationProvider: "springdoc"
+  # annotation provider should be ignored
+  annotationLibrary: "swagger2"
+  useSpringBoot3: "true"

bin/configs/spring-http-interface-noResponseEntity.yaml

@@ -13,8 +13,7 @@ additionalProperties:
   documentationProvider: "springdoc"
   # annotation provider should be ignored
   annotationLibrary: "swagger2"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useResponseEntity: "false"
   useSpringBoot3: "true"

bin/configs/spring-http-interface-reactive-bean-validation.yaml

@@ -0,0 +1,17 @@
+generatorName: spring
+library: spring-http-interface
+outputDir: samples/client/petstore/spring-http-interface-reactive-bean-validation
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: spring-http-interface-reactive
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  reactive: "true"
+  # validation should be respected
+  useBeanValidation: "true"
+  # documentation provider should be ignored
+  documentationProvider: "springfox"
+  # annotation provider should be ignored
+  annotationLibrary: "swagger1"
+  useSpringBoot3: "true"

bin/configs/spring-http-interface-reactive-noResponseEntity.yaml

@@ -12,9 +12,8 @@ additionalProperties:
   documentationProvider: "springfox"
   # annotation provider should be ignored
   annotationLibrary: "swagger1"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useResponseEntity: "false"
   useSpringBoot3: "true"
 

bin/configs/spring-http-interface-reactive.yaml

@@ -12,8 +12,7 @@ additionalProperties:
   documentationProvider: "springfox"
   # annotation provider should be ignored
   annotationLibrary: "swagger1"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useSpringBoot3: "true"
 

bin/configs/spring-http-interface-springboot-4.yaml

@@ -13,7 +13,6 @@ additionalProperties:
   documentationProvider: "springdoc"
   # annotation provider should be ignored
   annotationLibrary: "swagger2"
-  # validation should be ignored
   useBeanValidation: "true"
   performBeanValidation: "true"
   useSpringBoot4: "true"

bin/configs/spring-http-interface.yaml

@@ -13,7 +13,6 @@ additionalProperties:
   documentationProvider: "springdoc"
   # annotation provider should be ignored
   annotationLibrary: "swagger2"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useSpringBoot3: "true"

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

@@ -71,6 +71,7 @@
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
+import static org.openapitools.codegen.CodegenConstants.X_DISCRIMINATOR_VALUE;
 import static org.openapitools.codegen.CodegenConstants.X_IMPLEMENTS;
 import static org.openapitools.codegen.utils.CamelizeOption.*;
 import static org.openapitools.codegen.utils.ModelUtils.getSchemaItems;
@@ -802,6 +803,23 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
             }
         }
 
+        // Propagate the parent's discriminator mapping key to each child model's vendorExtensions
+        // as x-discriminator-value, so that @JsonTypeName on the child matches the parent's
+        // @JsonSubTypes name when an explicit discriminator mapping renames the key
+        // (e.g. "child_a" instead of the schema name "ChildWithMappingA").
+        // putIfAbsent preserves any value the user has already set explicitly in the spec.
+        for (CodegenModel cm : allModels.values()) {
+            if (cm.getParentModel() == null || cm.getParentModel().getDiscriminator() == null) {
+                continue;
+            }
+            for (CodegenDiscriminator.MappedModel mm : cm.getParentModel().getDiscriminator().getMappedModels()) {
+                if (mm.getModelName().equals(cm.classname)) {
+                    cm.vendorExtensions.putIfAbsent(X_DISCRIMINATOR_VALUE, mm.getMappingName());
+                    break;
+                }
+            }
+        }
+
         return objs;
     }
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

@@ -430,8 +430,18 @@ public void processOpts() {
             documentationProvider = DocumentationProvider.NONE;
             annotationLibrary = AnnotationLibrary.NONE;
             useJakartaEe = true;
-            useBeanValidation = false;
-            performBeanValidation = false;
+            if(additionalProperties.containsKey(USE_BEANVALIDATION)) {
+                useBeanValidation = convertPropertyToBoolean(USE_BEANVALIDATION);
+            } else {
+                //default to false if not specified
+                useBeanValidation = false;
+            }
+            if(additionalProperties.containsKey(PERFORM_BEANVALIDATION)) {
+                performBeanValidation = convertPropertyToBoolean(PERFORM_BEANVALIDATION);
+            } else {
+                //default to false if not specified
+                performBeanValidation = false;
+            }
 
             additionalProperties.put(USE_JAKARTA_EE, useJakartaEe);
             additionalProperties.put(USE_BEANVALIDATION, useBeanValidation);
@@ -443,8 +453,7 @@ public void processOpts() {
 
             applyJakartaPackage();
 
-            LOGGER.warn("For Spring HTTP Interface following options are disabled: documentProvider, annotationLibrary, useBeanValidation, performBeanValidation. "
-                    + "useJakartaEe defaulted to 'true'");
+            LOGGER.warn("For Spring HTTP Interface following options are disabled: documentProvider, annotationLibrary. useJakartaEe defaulted to 'true'");
         }
 
         if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
@@ -654,7 +663,6 @@ public void processOpts() {
 
                 supportingFiles.add(new SupportingFile(httpInterfacesAbstractConfiguratorFile,
                         (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "HttpInterfacesAbstractConfigurator.java"));
-                writePropertyBack(USE_BEANVALIDATION, false);
 
                 writePropertyBack(HTTP_INTERFACES_CONFIGURATOR_DEPENDENCY,
                     useHttpServiceProxyFactoryInterfacesConfigurator ?

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-http-interface/api.mustache

@@ -16,6 +16,11 @@ import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 import org.springframework.web.service.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
+{{#useBeanValidation}}
+import {{javaxPackage}}.validation.Valid;
+import {{javaxPackage}}.validation.constraints.*;
+{{^useSpringBuiltInValidation}}import org.springframework.validation.annotation.Validated;{{/useSpringBuiltInValidation}}
+{{/useBeanValidation}}
 {{#reactive}}
 
 import org.springframework.http.codec.multipart.Part;
@@ -29,6 +34,7 @@ import java.util.Optional;
 import {{javaxPackage}}.annotation.Generated;
 
 
+{{#useBeanValidation}}{{^useSpringBuiltInValidation}}@Validated{{/useSpringBuiltInValidation}}{{/useBeanValidation}}
 {{>generatedAnnotation}}
 
 {{#operations}}

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-http-interface/pom-sb3.mustache

@@ -96,6 +96,18 @@
                 <optional>true</optional>
             </dependency>
         {{/lombok}}
+        {{#useBeanValidation}}
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        {{/useBeanValidation}}
+        {{^useBeanValidation}}{{#performBeanValidation}}
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        {{/performBeanValidation}}{{/useBeanValidation}}
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-http-interface/pom-sb4.mustache

@@ -98,6 +98,18 @@
                 <optional>true</optional>
             </dependency>
         {{/lombok}}
+        {{#useBeanValidation}}
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        {{/useBeanValidation}}
+        {{^useBeanValidation}}{{#performBeanValidation}}
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        {{/performBeanValidation}}{{/useBeanValidation}}
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-{{#reactive}}web{{/reactive}}{{^reactive}}rest{{/reactive}}client-test</artifactId>

modules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache

@@ -21,9 +21,14 @@
 {{/discriminator}}
 {{#jackson}}
 {{#isClassnameSanitized}}
+{{#parent}}
+@JsonTypeName("{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}{{^vendorExtensions.x-discriminator-value}}{{name}}{{/vendorExtensions.x-discriminator-value}}")
+{{/parent}}
+{{^parent}}
 {{^hasDiscriminatorWithNonEmptyMapping}}
 @JsonTypeName("{{name}}")
 {{/hasDiscriminatorWithNonEmptyMapping}}
+{{/parent}}
 {{/isClassnameSanitized}}
 {{/jackson}}
 {{#withXml}}
@@ -65,7 +70,6 @@ public {{>sealed}}class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}
   @Deprecated
   {{/deprecated}}
   {{#isContainer}}
-  {{#useBeanValidation}}@Valid{{/useBeanValidation}}
   {{#openApiNullable}}
   private {{>nullableAnnotation}}{{#isNullable}}{{>nullableDataTypeBeanValidation}} {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>undefined();{{/isNullable}}{{^required}}{{^isNullable}}{{>nullableDataTypeBeanValidation}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/isNullable}}{{/required}}{{#required}}{{^isNullable}}{{>nullableDataTypeBeanValidation}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/isNullable}}{{/required}}
   {{/openApiNullable}}
@@ -157,7 +161,7 @@ public {{>sealed}}class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}
 
   public {{classname}} add{{nameInPascalCase}}Item({{{items.datatypeWithEnum}}} {{name}}Item) {
     {{#openApiNullable}}
-    if (this.{{name}} == null{{#isNullable}} || !this.{{name}}.isPresent(){{/isNullable}}) {
+    if (this.{{name}} == null{{#isNullable}} || !this.{{name}}.isPresent() || this.{{name}}.get() == null{{/isNullable}}) {
       this.{{name}} = {{#isNullable}}JsonNullable.of({{/isNullable}}{{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}ArrayList{{/uniqueItems}}<>(){{/defaultValue}}{{#isNullable}}){{/isNullable}};
     }
     this.{{name}}{{#isNullable}}.get(){{/isNullable}}.add({{name}}Item);
@@ -175,7 +179,7 @@ public {{>sealed}}class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}
 
   public {{classname}} put{{nameInPascalCase}}Item(String key, {{{items.datatypeWithEnum}}} {{name}}Item) {
     {{#openApiNullable}}
-    if (this.{{name}} == null{{#isNullable}} || !this.{{name}}.isPresent(){{/isNullable}}) {
+    if (this.{{name}} == null{{#isNullable}} || !this.{{name}}.isPresent() || this.{{name}}.get() == null{{/isNullable}}) {
       this.{{name}} = {{#isNullable}}JsonNullable.of({{/isNullable}}{{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}HashMap{{/uniqueItems}}<>(){{/defaultValue}}{{#isNullable}}){{/isNullable}};
     }
     this.{{name}}{{#isNullable}}.get(){{/isNullable}}.put(key, {{name}}Item);