[JAVA]Add additional check for openapiDocketConfig in SpringCodegan.java (#10853)

* updated SpringCodegan

* added test case for SpringCodegen change

* update samples

* updated test Javadoc

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

@@ -449,7 +449,7 @@ public class SpringCodegen extends AbstractJavaCodegen
                 supportingFiles.add(new SupportingFile("homeController.mustache",
                         (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator),
                         "HomeController.java"));
-                if (!reactive && !apiFirst) {
+                if (!reactive && !apiFirst && this.openapiDocketConfig) {
                     supportingFiles.add(new SupportingFile("openapiDocumentationConfig.mustache",
                             (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator),
                             "OpenAPIDocumentationConfig.java"));

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

@@ -43,6 +43,7 @@ import static org.openapitools.codegen.TestUtils.assertFileContains;
 import static org.openapitools.codegen.TestUtils.assertFileNotContains;
 import static org.openapitools.codegen.languages.SpringCodegen.RESPONSE_WRAPPER;
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.fail;
 
 public class SpringCodegenTest {
 
@@ -722,5 +723,45 @@ public class SpringCodegenTest {
         assertFileContains(Paths.get(outputPath + "/src/main/java/org/openapitools/api/GetApi.java"),
             "@RequestParam(value = \"testParameter1\", required = false, defaultValue = \"BAR\")",
             "@RequestParam(value = \"TestParameter2\", required = false, defaultValue = \"BAR\")");
+
+    }
+
+    /**define the destinationFilename*/
+    private final static String DESTINATIONFILE = "OpenAPIDocumentationConfig.java";
+    /**define the templateFile*/
+    private final static String TEMPLATEFILE = "openapiDocumentationConfig.mustache";
+
+    /**
+     * test whether OpenAPIDocumentationConfig.java is generated
+     * fix issue #10287
+     */
+    @Test
+    public void testConfigFileGeneration() {
+
+        final SpringCodegen codegen = new SpringCodegen();
+
+        codegen.additionalProperties().put(SpringCodegen.INTERFACE_ONLY, false);
+        codegen.additionalProperties().put(SpringCodegen.SPRING_CLOUD_LIBRARY, "spring-cloud");
+        codegen.additionalProperties().put(SpringCodegen.OPENAPI_DOCKET_CONFIG, true);
+        codegen.additionalProperties().put(SpringCodegen.REACTIVE, false);
+        codegen.additionalProperties().put(SpringCodegen.API_FIRST, false);
+
+        codegen.processOpts();
+        final List<SupportingFile> supList = codegen.supportingFiles();
+        String tmpFile;
+        String desFile;
+        boolean flag = false;
+        for (final SupportingFile s : supList) {
+            tmpFile = s.getTemplateFile();
+            desFile = s.getDestinationFilename();
+
+            if (TEMPLATEFILE.equals(tmpFile)) {
+                flag = true;
+                assertEquals(desFile, DESTINATIONFILE);
+            }
+        }
+        if(!flag){
+            fail("OpenAPIDocumentationConfig.java not generated");
+        }
     }
 }

samples/server/petstore/spring-mvc-default-value/.openapi-generator/FILES

@@ -8,6 +8,6 @@ src/main/java/org/openapitools/api/TestHeadersApiController.java
 src/main/java/org/openapitools/api/TestQueryParamsApi.java
 src/main/java/org/openapitools/api/TestQueryParamsApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/TestResponse.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/spring-mvc-default-value/src/main/resources/openapi.yaml

@@ -0,0 +1,170 @@
+openapi: 3.0.1
+info:
+  description: desc
+  title: toto
+  version: 1.0.0
+servers:
+- description: /
+  url: /
+tags:
+- description: verify-default-value
+  name: verify-default-value
+paths:
+  /test-headers:
+    get:
+      description: desc
+      operationId: headersTest
+      parameters:
+      - explode: false
+        in: header
+        name: headerNumber
+        required: false
+        schema:
+          default: 11.2
+          type: number
+        style: simple
+      - explode: false
+        in: header
+        name: headerString
+        required: false
+        schema:
+          default: qwerty
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: headerStringWrapped
+        required: false
+        schema:
+          default: qwerty
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: headerStringQuotes
+        required: false
+        schema:
+          default: qwerty"with quotes" test
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: headerStringQuotesWrapped
+        required: false
+        schema:
+          default: qwerty"with quotes" test
+          type: string
+        style: simple
+      - explode: false
+        in: header
+        name: headerBoolean
+        required: false
+        schema:
+          default: true
+          type: boolean
+        style: simple
+      responses:
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TestResponse'
+          description: default response
+      summary: test headers
+      tags:
+      - verify-default-value
+      x-accepts: application/json
+      x-tags:
+      - tag: verify-default-value
+  /test-query-params:
+    get:
+      description: desc
+      operationId: queryParamsTest
+      parameters:
+      - explode: true
+        in: query
+        name: queryNumber
+        required: false
+        schema:
+          default: 11.2
+          type: number
+        style: form
+      - explode: true
+        in: query
+        name: queryString
+        required: false
+        schema:
+          default: qwerty
+          type: string
+        style: form
+      - explode: true
+        in: query
+        name: queryStringWrapped
+        required: false
+        schema:
+          default: qwerty
+          type: string
+        style: form
+      - explode: true
+        in: query
+        name: queryStringQuotes
+        required: false
+        schema:
+          default: qwerty"with quotes" test
+          type: string
+        style: form
+      - explode: true
+        in: query
+        name: queryStringQuotesWrapped
+        required: false
+        schema:
+          default: qwerty"with quotes" test
+          type: string
+        style: form
+      - explode: true
+        in: query
+        name: queryBoolean
+        required: false
+        schema:
+          default: true
+          type: boolean
+        style: form
+      responses:
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TestResponse'
+          description: default response
+      summary: test query params
+      tags:
+      - verify-default-value
+      x-accepts: application/json
+      x-tags:
+      - tag: verify-default-value
+components:
+  schemas:
+    TestResponse:
+      example:
+        numberField: 6.027456183070403
+        booleanField: true
+        id: 0
+        stringField: asd
+      properties:
+        id:
+          type: integer
+        stringField:
+          default: asd
+          type: string
+        numberField:
+          default: 11
+          type: number
+        booleanField:
+          default: true
+          type: boolean
+      required:
+      - booleanField
+      - id
+      - numberField
+      - stringField
+      type: object

samples/server/petstore/spring-mvc-j8-async/.openapi-generator/FILES

@@ -14,7 +14,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/configuration/OpenAPIUiConfiguration.java
 src/main/java/org/openapitools/configuration/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/WebApplication.java
@@ -66,3 +65,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/spring-mvc-j8-localdatetime/.openapi-generator/FILES

@@ -14,7 +14,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/configuration/OpenAPIUiConfiguration.java
 src/main/java/org/openapitools/configuration/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/WebApplication.java
@@ -66,3 +65,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/spring-mvc-no-nullable/.openapi-generator/FILES

@@ -14,7 +14,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/configuration/OpenAPIUiConfiguration.java
 src/main/java/org/openapitools/configuration/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/WebApplication.java
@@ -66,3 +65,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/spring-mvc-spring-pageable/.openapi-generator/FILES

@@ -14,7 +14,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/configuration/OpenAPIUiConfiguration.java
 src/main/java/org/openapitools/configuration/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/WebApplication.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/spring-mvc/.openapi-generator/FILES

@@ -14,7 +14,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/configuration/OpenAPIUiConfiguration.java
 src/main/java/org/openapitools/configuration/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/WebApplication.java
@@ -66,3 +65,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES

@@ -18,7 +18,6 @@ src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/CustomInstantDeserializer.java
 src/main/java/org/openapitools/configuration/HomeController.java
 src/main/java/org/openapitools/configuration/JacksonConfiguration.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -66,3 +65,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-beanvalidation/.openapi-generator/FILES

@@ -16,7 +16,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-delegate-j8/.openapi-generator/FILES

@@ -22,7 +22,6 @@ src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/api/UserApiDelegate.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -70,3 +69,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-delegate/.openapi-generator/FILES

@@ -22,7 +22,6 @@ src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/api/UserApiDelegate.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -70,3 +69,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-implicitHeaders/.openapi-generator/FILES

@@ -16,7 +16,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES

@@ -24,7 +24,6 @@ src/main/java/org/openapitools/api/UserApiDelegate.java
 src/main/java/org/openapitools/configuration/CustomInstantDeserializer.java
 src/main/java/org/openapitools/configuration/HomeController.java
 src/main/java/org/openapitools/configuration/JacksonConfiguration.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -70,3 +69,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-spring-pageable-delegatePattern/.openapi-generator/FILES

@@ -22,7 +22,6 @@ src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/api/UserApiDelegate.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -68,3 +67,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES

@@ -18,7 +18,6 @@ src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/CustomInstantDeserializer.java
 src/main/java/org/openapitools/configuration/HomeController.java
 src/main/java/org/openapitools/configuration/JacksonConfiguration.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-spring-pageable/.openapi-generator/FILES

@@ -16,7 +16,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -62,3 +61,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-useoptional/.openapi-generator/FILES

@@ -16,7 +16,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot-virtualan/.openapi-generator/FILES

@@ -3,7 +3,6 @@ pom.xml
 src/main/java/org/openapitools/OpenAPI2SpringBoot.java
 src/main/java/org/openapitools/RFC3339DateFormat.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/virtualan/api/AnotherFakeApi.java
 src/main/java/org/openapitools/virtualan/api/AnotherFakeApiController.java
 src/main/java/org/openapitools/virtualan/api/ApiUtil.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/virtualan/model/TypeHolderExample.java
 src/main/java/org/openapitools/virtualan/model/User.java
 src/main/java/org/openapitools/virtualan/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml

samples/server/petstore/springboot/.openapi-generator/FILES

@@ -16,7 +16,6 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
-src/main/java/org/openapitools/configuration/OpenAPIDocumentationConfig.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -64,3 +63,4 @@ src/main/java/org/openapitools/model/TypeHolderExample.java
 src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
+src/main/resources/openapi.yaml