fix import mapping for return types (#14525) (#15719)

* importContainerType = true

* add unit test

* disable MyImportTest

* build all samples, add import exceptions

* simplify code

* delete myImportTest

* generate docs

* extend comment

* remove inline comment

Author: martin-mfg

docs/generators/groovy.md

@@ -123,6 +123,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <li>File</li>
 <li>Float</li>
 <li>Integer</li>
+<li>List</li>
 <li>Long</li>
 <li>Map</li>
 <li>Object</li>

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

@@ -659,6 +659,23 @@ public Map<String, ModelsMap> updateAllModels(Map<String, ModelsMap> objs) {
         return objs;
     }
 
+    /**
+     * Removes importToRemove from the imports of objs, if present.
+     * This is useful to remove imports that are already present in operations-related template files, to avoid importing the same thing twice.
+     *
+     * @param objs imports will be removed from this objs' imports collection
+     * @param importToRemove the import statement to be removed
+     */
+    protected void removeImport(OperationsMap objs, String importToRemove) {
+        List<Map<String, String>> imports = objs.getImports();
+        for (Iterator<Map<String, String>> itr = imports.iterator(); itr.hasNext(); ) {
+            String itrImport = itr.next().get("import");
+            if (itrImport.equals(importToRemove)) {
+                itr.remove();
+            }
+        }
+    }
+
     /**
      * Removes imports from the model that points to itself
      * Marks a self referencing property, if detected
@@ -5196,7 +5213,7 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
             codegenParameter.dataType = codegenProperty.dataType;
         }
         if (!addSchemaImportsFromV3SpecLocations) {
-            if (ModelUtils.isSet(parameterSchema)) {
+            if (ModelUtils.isArraySchema(parameterSchema)) {
                 imports.add(codegenProperty.baseType);
             }
         }
@@ -7403,7 +7420,7 @@ protected LinkedHashMap<String, CodegenMediaType> getContent(Content content, Se
                 if (addSchemaImportsFromV3SpecLocations) {
                     addImports(imports, schemaProp.getImports(importContainerType, importBaseType, generatorMetadata.getFeatureSet()));
                 } else {
-                    addImports(imports, schemaProp.getImports(false, importBaseType, generatorMetadata.getFeatureSet()));
+                    addImports(imports, schemaProp.getImports(true, importBaseType, generatorMetadata.getFeatureSet()));
                 }
             }
         }

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

@@ -24,8 +24,11 @@
 import org.openapitools.codegen.meta.features.DocumentationFeature;
 import org.openapitools.codegen.meta.features.GlobalFeature;
 import org.openapitools.codegen.meta.features.SecurityFeature;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 
 import java.io.File;
+import java.util.List;
 
 import static org.openapitools.codegen.utils.StringUtils.*;
 
@@ -221,4 +224,11 @@ public String toApiFilename(String name) {
     public void setOptionalProjectFileFlag(boolean flag) {
         this.optionalProjectFileFlag = flag;
     }
+
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "#include <QList>");
+        return objs;
+    }
 }

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

@@ -23,6 +23,8 @@
 import org.openapitools.codegen.meta.features.*;
 import org.openapitools.codegen.meta.GeneratorMetadata;
 import org.openapitools.codegen.meta.Stability;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 import org.openapitools.codegen.utils.ModelUtils;
 
 import java.io.File;
@@ -340,5 +342,11 @@ public String toDefaultValue(Schema p) {
         return "null";
     }
 
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "#include <list>");
+        return objs;
+    }
 
 }

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

@@ -68,6 +68,7 @@ public GroovyClientCodegen() {
         languageSpecificPrimitives.add("ArrayList");
         languageSpecificPrimitives.add("File");
         languageSpecificPrimitives.add("Map");
+        languageSpecificPrimitives.add("List");
 
         // this must not be OS-specific
         sourceFolder = projectFolder + "/groovy";

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

@@ -19,18 +19,19 @@
 
 import io.swagger.v3.oas.models.media.ComposedSchema;
 import io.swagger.v3.oas.models.media.Schema;
-import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.features.CXFServerFeatures;
 import org.openapitools.codegen.languages.features.GzipTestFeatures;
 import org.openapitools.codegen.languages.features.LoggingTestFeatures;
 import org.openapitools.codegen.languages.features.UseGenericResponseFeatures;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 import org.openapitools.codegen.utils.ModelUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
-import java.util.Set;
+import java.util.List;
 
 public class JavaCXFServerCodegen extends AbstractJavaJAXRSServerCodegen
         implements CXFServerFeatures, GzipTestFeatures, LoggingTestFeatures, UseGenericResponseFeatures {
@@ -263,6 +264,13 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
         }
     }
 
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "java.util.List");
+        return objs;
+    }
+
     @Override
     public String getHelp() {
         return "Generates a Java JAXRS Server application based on Apache CXF framework.";

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

@@ -19,8 +19,11 @@
 
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 
 import java.io.File;
+import java.util.List;
 
 /**
  * Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an
@@ -98,6 +101,13 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
         model.imports.add("JsonProperty");
     }
 
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "java.util.List");
+        return objs;
+    }
+
     @Override
     public String getHelp() {
         return "Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an "

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

@@ -21,9 +21,12 @@
 import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.meta.features.DocumentationFeature;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 import org.openapitools.codegen.meta.features.SecurityFeature;
 
 import java.io.File;
+import java.util.List;
 import java.util.Map;
 
 import static org.openapitools.codegen.languages.features.GzipFeatures.USE_GZIP_FEATURE;
@@ -314,4 +317,11 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
         }
     }
 
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "java.util.List");
+        return objs;
+    }
+
 }

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

@@ -23,6 +23,7 @@
 import org.openapitools.codegen.meta.features.DocumentationFeature;
 import org.openapitools.codegen.model.ModelMap;
 import org.openapitools.codegen.model.ModelsMap;
+import org.openapitools.codegen.model.OperationsMap;
 
 import java.util.*;
 
@@ -154,4 +155,11 @@ public ModelsMap postProcessModelsEnum(ModelsMap objs) {
         return objs;
     }
 
+    @Override
+    public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
+        objs = super.postProcessOperationsWithModels(objs, allModels);
+        removeImport(objs, "java.util.List");
+        return objs;
+    }
+
 }

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

@@ -32,7 +32,6 @@
 import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import java.util.stream.Collectors;
 
 import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
 import static org.openapitools.codegen.utils.StringUtils.camelize;
@@ -371,6 +370,8 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             }
         }
 
+        removeImport(objs, "java.util.List");
+
         return objs;
     }