Merge pull request #729 from shourien/codegen-issue-728

728 Fix parameter bean validation issues for micronaut code generator

Author: HugoMario

src/main/resources/handlebars/JavaMicronaut/beanValidationHeaderParams.mustache

@@ -0,0 +1 @@
+{{#required}}@NotNull {{/required}}{{^required}}@Nullable {{/required}}{{>beanValidationCore}}

src/main/resources/handlebars/JavaMicronaut/beanValidationQueryParams.mustache

@@ -1 +1 @@
-{{#required}}@NotNull {{/required}}{{>beanValidationCore}}
+{{#required}}@NotNull {{/required}}{{^required}}@Nullable {{/required}}{{>beanValidationCore}}

src/main/resources/handlebars/JavaMicronaut/headerParams.mustache

@@ -1 +1 @@
-{{#isHeaderParam}}@Parameter(description = "{{{description}}}" {{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) @Header(value = "{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isHeaderParam}}
+{{#isHeaderParam}}{{#useBeanValidation}}{{>beanValidationHeaderParams}}{{/useBeanValidation}}@Parameter(description = "{{{description}}}" {{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{#useBeanValidation}}@Valid {{/useBeanValidation}}@Header(value = "{{baseName}}") {{>optionalDataType}} {{paramName}}{{/isHeaderParam}}

src/main/resources/handlebars/JavaMicronaut/queryParams.mustache

@@ -1 +1 @@
-{{#isQueryParam}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}@Parameter(description = "{{{description}}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{#useBeanValidation}}@Valid {{#required}}@NotNull {{/required}}{{/useBeanValidation}}@QueryValue(value = "{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>optionalDataType}} {{paramName}}{{/isQueryParam}}
+{{#isQueryParam}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}@Parameter(description = "{{{description}}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{#useBeanValidation}}@Valid {{/useBeanValidation}}@QueryValue(value = "{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>optionalDataType}} {{paramName}}{{/isQueryParam}}

src/test/java/io/swagger/codegen/v3/generators/java/MicronautGeneratorCodegenTest.java

@@ -26,7 +26,7 @@ public void generateCode() throws IOException {
 
         final CodegenConfigurator configurator = new CodegenConfigurator()
                 .setLang("micronaut")
-                .setInputSpecURL("src/test/resources/3_0_0/parameterOrder.yaml")
+                .setInputSpecURL("src/test/resources/3_0_0/parameterValidation.yaml")
                 .setOutputDir(output.getAbsolutePath());
 
         final ClientOptInput clientOptInput = configurator.toClientOptInput();
@@ -57,11 +57,12 @@ public void testApiInterface() throws IOException {
         Assert.assertTrue(content.contains(expectedContent));
     }
 
-    @Test(description = "verify that parameters are listed as follows: header, query, path, cookie, body")
+    @Test(description = "verify that parameters are listed as follows: header, path, query, cookie, body")
     public void testApiParameters() throws IOException {
-        final String expectedContent = "default Single<HttpResponse<LocalizedText>> updateTest(@Parameter(description = \"Localized Text object containing updated data.\" ) @Valid @Body LocalizedText body" + System.lineSeparator()
-                                 + ",@Parameter(description = \"description\") @PathVariable(\"id\") Long id" + System.lineSeparator()
-                                 + ")";
+        final String expectedContent = "default Single<HttpResponse<LocalizedText>> updateTest(@Parameter(description = \"Localized Text object.\" ) @Valid @Body LocalizedText body" + System.lineSeparator()
+                                 + ",@NotNull @Pattern(regexp=\"[0-9]+\") @Parameter(description = \"header description\" ) @Valid @Header(value = \"x-header\") String xHeader" + System.lineSeparator()
+                                 + ",@Parameter(description = \"path description\") @PathVariable(\"id\") Long id" + System.lineSeparator()
+                                 + ",@Nullable @Parameter(description = \"query description\") @Valid @QueryValue(value = \"name\") String name";
         final File controllerFile = new File(output, "/src/main/java/io/swagger/api/AdminApi.java");
         final String content = FileUtils.readFileToString(controllerFile);
         Assert.assertTrue(content.contains(expectedContent));

src/test/resources/3_0_0/parameterValidation.yaml

@@ -0,0 +1,140 @@
+openapi: 3.0.3
+info:
+  title: Title
+  version: "2.0.0"
+  description: test
+  contact:
+    name: test contact
+    url: 'http://www.contact.com'
+security:
+  - OAuth2: []
+paths:
+  '/admin/texts/{id}':
+    parameters:
+      - name: x-header
+        in: header
+        description: header description
+        required: true
+        schema:
+          type: string
+          pattern: "[0-9]+"
+      - name: name
+        in: query
+        description: query description
+        schema:
+          type: string
+      - name: id
+        in: path
+        description: path description
+        required: true
+        schema:
+          type: integer
+          format: int64
+    put:
+      summary: Update
+      description: description
+      operationId: updateTest
+      responses:
+        200:
+          description: Successfully updated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LocalizedText'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/LocalizedText'
+        description: Localized Text object.
+        required: true
+        x-ecc-validate:
+          validated: [Update]
+servers:
+  - url: 'http://localhost:8082/v1'
+  - url: 'https://localhost:8082/v1'
+components:
+  schemas:
+    BaseAudit:
+      type: object
+      description: Base audit fields
+      properties:
+        created:
+          type: string
+          format: date-time
+          description: Indicates time of creation.
+        modified:
+          type: string
+          format: date-time
+          description: Indicates time of last modification.
+        createdBy:
+          type: string
+          description: Identification of creator.
+        modifiedBy:
+          type: string
+          description: Identification of modifier.
+    BaseRecordVersion:
+      type: object
+      description: BaseRecordVersion
+      properties:
+        recordVersion:
+          type: integer
+          x-ecc-validate:
+            check-null: [Create]
+            check-not-null: [Update]
+            check-required: [Patch, BulkPatch]
+          description: 'Timestamp from last update, not to be updated directly'
+          format: int64
+    LocalizedText:
+      type: object
+      required:
+        - module
+        - locale
+        - key
+        - defaultValue
+      allOf:
+        - $ref: '#/components/schemas/BaseRecordVersion'
+        - $ref: '#/components/schemas/BaseAudit'
+        - properties:
+            id:
+              type: integer
+              format: int64
+              x-ecc-validate:
+                check-null: [Create, Update]
+                check-not-valid: [Patch]
+              description: ID of the Localized text
+              example: 1
+            module:
+              type: string
+              x-ecc-validate:
+                check-not-empty: [Create, Update]
+                check-not-valid: [Patch]
+              description: Module name to be used for key value to be loaded
+              example: COMMONS
+            locale:
+              type: string
+              x-ecc-validate:
+                check-not-empty: [Create, Update]
+                check-not-valid: [Patch]
+              description: Localization to be retrieved
+              example: en
+            key:
+              type: string
+              x-ecc-validate:
+                check-not-empty: [Create, Update]
+                check-not-valid: [Patch]
+              description: Localized text key value normally used for retrieval
+              example: LocalizedTextToBeRetrieved
+            defaultValue:
+              type: string
+              x-ecc-validate:
+                check-not-empty: [Create, Update]
+                check-valid: [Patch]
+              description: Default Text to be used
+              example: Default Localized Text
+            customValue:
+              type: string
+              x-ecc-validate:
+                check-valid: [Create, Update, Patch]
+              description: Alternative Text to be used
+              example: Alternative Localized Text