various fixes

Author: wing328

bin/configs/java-okhttp-gson.yaml

@@ -10,7 +10,7 @@ parameterNameMappings:
   _type: underscoreType
   type_: typeWithUnderscore
 additionalProperties:
-  defaultToEmptyContainer: "array?|map?"
+  defaultToEmptyContainer: "array?|array|map?"
   artifactId: petstore-okhttp-gson
   hideGenerationTimestamp: true
   useOneOfDiscriminatorLookup: true

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

@@ -401,6 +401,7 @@ public void processOpts() {
 
         if (additionalProperties.containsKey(DEFAULT_TO_EMPTY_CONTAINER) && additionalProperties.get(DEFAULT_TO_EMPTY_CONTAINER) instanceof String) {
             parseDefaultToEmptyContainer((String) additionalProperties.get(DEFAULT_TO_EMPTY_CONTAINER));
+            defaultToEmptyContainer = true;
         }
     }
 
@@ -4328,11 +4329,18 @@ void parseDefaultToEmptyContainer(String input) {
                 } else {
                     LOGGER.error("Skipped invalid container type `{}` in the rule `{}`.", containerType, input);
                 }
+            } else { // required
+                containerType = rule;
+                if ("array".equalsIgnoreCase(containerType)) {
+                    arrayDefaultToEmpty = true;
+                } else if ("map".equalsIgnoreCase(containerType)) {
+                    mapDefaultToEmpty = true;
+                } else {
+                    LOGGER.error("Skipped invalid container type `{}` in the rule `{}`.", containerType, input);
+                }
             }
 
-            defaultToEmptyContainer = true;
         }
-
     }
 
     /**

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

@@ -1240,7 +1240,7 @@ public String toArrayDefaultValue(CodegenProperty cp, Schema schema) {
                 if (schema.getDefault() instanceof ArrayNode) { // array of default values
                     ArrayNode _default = (ArrayNode) schema.getDefault();
                     if (_default.isEmpty()) { // e.g. default: []
-                        return getDefaultCollectionType(schema);
+                        return getDefaultCollectionType(schema, "");
                     }
 
                     List<String> final_values = _values;
@@ -1253,6 +1253,11 @@ public String toArrayDefaultValue(CodegenProperty cp, Schema schema) {
                     _default.forEach((element) -> {
                         final_values.add(String.valueOf(element));
                     });
+
+                    if (_default != null && _default.isEmpty() && defaultToEmptyContainer) {
+                        // e.g. [] with the option defaultToEmptyContainer enabled
+                        return getDefaultCollectionType(schema, "");
+                    }
                 } else { // single value
                     _values = java.util.Collections.singletonList(String.valueOf(schema.getDefault()));
                 }
@@ -1431,12 +1436,31 @@ private String getDefaultCollectionType(Schema schema) {
 
     private String getDefaultCollectionType(Schema schema, String defaultValues) {
         String arrayFormat = "new %s<>(Arrays.asList(%s))";
+
+        if (defaultToEmptyContainer) {
+            // respect the default value in the spec
+            if (defaultValues == null) { // default value not provided
+                return null;
+            } else if (defaultValues.isEmpty()) { // e.g. [] to indicates empty container
+                arrayFormat = "new %s<>()";
+                return getDefaultCollectionType(arrayFormat, defaultValues, ModelUtils.isSet(schema));
+            } else { // default value not empty
+                return getDefaultCollectionType(arrayFormat, defaultValues, ModelUtils.isSet(schema));
+            }
+        }
+
         if (defaultValues == null || defaultValues.isEmpty()) {
+            // default to empty container even though default value is null
+            // to respect default values provided in the spec, set the option `defaultToEmptyContainer` properly
             defaultValues = "";
             arrayFormat = "new %s<>()";
         }
 
-        if (ModelUtils.isSet(schema)) {
+        return getDefaultCollectionType(arrayFormat, defaultValues, ModelUtils.isSet(schema));
+    }
+
+    private String getDefaultCollectionType(String arrayFormat, String defaultValues, boolean isSet) {
+        if (isSet) {
             return String.format(Locale.ROOT, arrayFormat,
                     instantiationTypes().getOrDefault("set", "LinkedHashSet"), defaultValues);
         }

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

@@ -5501,4 +5501,35 @@ public void testEnumFieldShouldBeFinal_issue21018() throws IOException {
         JavaFileAssert.assertThat(files.get("SomeObject.java"))
                 .fileContains("private final String value");
     }
+
+    @Test
+    public void testCollectionTypesWithDefaults_issue_collection() throws IOException {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+
+        OpenAPI openAPI = new OpenAPIParser()
+                .readLocation("src/test/resources/3_0/java/issue_collection.yaml", null, new ParseOptions()).getOpenAPI();
+        SpringCodegen codegen = new SpringCodegen();
+        codegen.setLibrary(SPRING_CLOUD_LIBRARY);
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(CodegenConstants.MODEL_PACKAGE, "xyz.model");
+        codegen.additionalProperties().put(CodegenConstants.API_NAME_SUFFIX, "Controller");
+        codegen.additionalProperties().put(CodegenConstants.API_PACKAGE, "xyz.controller");
+        codegen.additionalProperties().put(CodegenConstants.MODEL_NAME_SUFFIX, "Dto");
+        codegen.additionalProperties().put("defaultToEmptyContainer", "array");
+
+        ClientOptInput input = new ClientOptInput()
+                .openAPI(openAPI)
+                .config(codegen);
+
+        DefaultGenerator generator = new DefaultGenerator();
+        Map<String, File> files = generator.opts(input).generate().stream()
+                .collect(Collectors.toMap(File::getName, Function.identity()));
+
+        JavaFileAssert.assertThat(files.get("PetDto.java"))
+                .fileContains("private List<@Valid TagDto> tags;")
+                .fileContains("private List<@Valid TagDto> tagsRequiredList = new ArrayList<>();")
+                .fileContains("private List<String> stringList;")
+                .fileContains("private List<String> stringRequiredList = new ArrayList<>();");
+    }
 }

modules/openapi-generator/src/test/resources/3_0/java/issue_collection.yaml

@@ -0,0 +1,75 @@
+openapi: 3.0.0
+servers:
+  - url: 'http://petstore.swagger.io/v2'
+info:
+  description: >-
+    This is a sample server Petstore server. For this sample, you can use the api key
+    `special-key` to test the authorization filters.
+  version: 1.0.0
+  title: OpenAPI Petstore
+  license:
+    name: Apache-2.0
+    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
+paths:
+  '/pet/{petId}':
+    get:
+      tags:
+        - pet
+      summary: Find pet by ID
+      description: Returns a single pet
+      operationId: getPetById
+      parameters:
+        - name: petId
+          in: path
+          description: ID of pet to return
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        '400':
+          description: Invalid ID supplied
+        '404':
+          description: Pet not found
+components:
+  schemas:
+    Tag:
+      title: Pet Tag
+      description: A tag for a pet
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+    Pet:
+      title: a Pet
+      description: A pet for sale in the pet store
+      type: object
+      required:
+        - tagsRequiredList
+        - stringRequiredList
+      properties:
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/Tag'
+        tagsRequiredList:
+          type: array
+          items:
+            $ref: '#/components/schemas/Tag'
+        stringList:
+          type: array
+          items:
+            type: string
+        stringRequiredList:
+          type: array
+          items:
+            type: string

samples/client/petstore/java/okhttp-gson/api/openapi.yaml

@@ -1757,6 +1757,7 @@ components:
           example: doggie
           type: string
         photoUrls:
+          default: []
           items:
             type: string
           type: array
@@ -2639,13 +2640,15 @@ components:
           example: doggie
           type: string
         photoUrls:
+          default: []
           items:
             type: string
           type: array
           xml:
             name: photoUrl
             wrapped: true
         tags:
+          default: []
           items:
             $ref: '#/components/schemas/Tag'
           type: array
@@ -2773,6 +2776,7 @@ components:
           example: doggie
           type: string
         photoUrls:
+          default: []
           items:
             type: string
           type: array
@@ -2841,6 +2845,7 @@ components:
           example: doggie
           type: string
         photoUrls:
+          default: []
           items:
             type: string
           type: array
@@ -3132,6 +3137,7 @@ components:
     AllOfModelArrayAnyOf_allOf_linkListColumn1:
       properties:
         value:
+          default: []
           items:
             $ref: '#/components/schemas/AllOfModelArrayAnyOf_allOf_linkListColumn1_value'
           type: array

samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/AllOfModelArrayAnyOfAllOfLinkListColumn1.java

@@ -56,7 +56,7 @@ public class AllOfModelArrayAnyOfAllOfLinkListColumn1 {
   public static final String SERIALIZED_NAME_VALUE = "value";
   @SerializedName(SERIALIZED_NAME_VALUE)
   @javax.annotation.Nonnull
-  private List<AllOfModelArrayAnyOfAllOfLinkListColumn1Value> value;
+  private List<AllOfModelArrayAnyOfAllOfLinkListColumn1Value> value = new ArrayList<>();
 
   public AllOfModelArrayAnyOfAllOfLinkListColumn1() {
   }

samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/NewPet.java

@@ -88,7 +88,7 @@ public class NewPet {
   public static final String SERIALIZED_NAME_PHOTO_URLS = "photoUrls";
   @SerializedName(SERIALIZED_NAME_PHOTO_URLS)
   @javax.annotation.Nonnull
-  private List<String> photoUrls;
+  private List<String> photoUrls = new ArrayList<>();
 
   public static final String SERIALIZED_NAME_TAGS = "tags";
   @SerializedName(SERIALIZED_NAME_TAGS)

samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/Pet.java

@@ -72,7 +72,7 @@ public class Pet {
   public static final String SERIALIZED_NAME_PHOTO_URLS = "photoUrls";
   @SerializedName(SERIALIZED_NAME_PHOTO_URLS)
   @javax.annotation.Nonnull
-  private List<String> photoUrls;
+  private List<String> photoUrls = new ArrayList<>();
 
   public static final String SERIALIZED_NAME_TAGS = "tags";
   @SerializedName(SERIALIZED_NAME_TAGS)

samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/PetComposition.java

@@ -72,7 +72,7 @@ public class PetComposition {
   public static final String SERIALIZED_NAME_PHOTO_URLS = "photoUrls";
   @SerializedName(SERIALIZED_NAME_PHOTO_URLS)
   @javax.annotation.Nonnull
-  private List<String> photoUrls;
+  private List<String> photoUrls = new ArrayList<>();
 
   public static final String SERIALIZED_NAME_TAGS = "tags";
   @SerializedName(SERIALIZED_NAME_TAGS)