Rebased to current upstream/master. (OpenAPITools#4514)

Tests for python client, comprising support for additional_properties and arrays.
There are ugly workarounds for when there are discriminators, since the python client generator does not fully handle them.
Cool indentation of test files.

Author: michelealbano

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

@@ -695,6 +695,184 @@ public String toRegularExpression(String pattern) {
         return addRegularExpressionDelimiter(pattern);
     }
 
+    @Override
+    public String toExampleValue(Schema schema) {
+        return toExampleValueRecursive(schema, new ArrayList<String>(), 5);
+    }
+
+    private String toExampleValueRecursive(Schema schema, List<String> included_schemas, int indentation) {
+        String indentation_string = "";
+        for (int i=0 ; i< indentation ; i++) indentation_string += "    ";
+        String example = super.toExampleValue(schema);
+
+        // correct "true"s into "True"s, since super.toExampleValue uses "toString()" on Java booleans
+        if (ModelUtils.isBooleanSchema(schema) && null!=example) {
+            if ("false".equalsIgnoreCase(example)) example = "False";
+            else example = "True";
+        }
+
+        // correct "&#39;"s into "'"s after toString()
+        if (ModelUtils.isStringSchema(schema) && schema.getDefault() != null) {
+            example = (String) schema.getDefault();
+        }
+
+        if (StringUtils.isNotBlank(example) && !"null".equals(example)) {
+            if (ModelUtils.isStringSchema(schema)) {
+                example = "'" + example + "'";
+            }
+            return example;
+        }
+
+        if (schema.getEnum() != null && !schema.getEnum().isEmpty()) {
+        // Enum case:
+            example = schema.getEnum().get(0).toString();
+            if (ModelUtils.isStringSchema(schema)) {
+                example = "'" + escapeText(example) + "'";
+            }
+            if (null == example)
+                LOGGER.warn("Empty enum. Cannot built an example!");
+
+            return example;
+        } else if (null != schema.get$ref()) {
+        // $ref case:
+            Map<String, Schema> allDefinitions = ModelUtils.getSchemas(this.openAPI);
+            String ref = ModelUtils.getSimpleRef(schema.get$ref());
+            if (allDefinitions != null) {
+                Schema refSchema = allDefinitions.get(ref);
+                if (null == refSchema) {
+                    return "None";
+                } else {
+                    String refTitle = refSchema.getTitle();
+                    if (StringUtils.isBlank(refTitle) || "null".equals(refTitle)) {
+                        refSchema.setTitle(ref);
+                    }
+                    if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
+                        included_schemas.add(schema.getTitle());
+                    }
+                    return toExampleValueRecursive(refSchema, included_schemas, indentation);
+                }
+            } else {
+                LOGGER.warn("allDefinitions not defined in toExampleValue!\n");
+            }
+        }
+        if (ModelUtils.isDateSchema(schema)) {
+            example = "datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date()";
+            return example;
+        } else if (ModelUtils.isDateTimeSchema(schema)) {
+            example = "datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')";
+            return example;
+        } else if (ModelUtils.isBinarySchema(schema)) {
+            example = "bytes(b'blah')";
+            return example;
+        } else if (ModelUtils.isByteArraySchema(schema)) {
+            example = "YQ==";
+        } else if (ModelUtils.isStringSchema(schema)) {
+            // a BigDecimal:
+            if ("Number".equalsIgnoreCase(schema.getFormat())) {return "1";}
+            if (StringUtils.isNotBlank(schema.getPattern())) return "'a'"; // I cheat here, since it would be too complicated to generate a string from a regexp
+            int len = 0;
+            if (null != schema.getMinLength()) len = schema.getMinLength().intValue();
+            if (len < 1) len = 1;
+            example = "";
+            for (int i=0;i<len;i++) example += i;
+        } else if (ModelUtils.isIntegerSchema(schema)) {
+            if (schema.getMinimum() != null)
+                example = schema.getMinimum().toString();
+            else
+                example = "56";
+        } else if (ModelUtils.isNumberSchema(schema)) {
+            if (schema.getMinimum() != null)
+                example = schema.getMinimum().toString();
+            else
+                example = "1.337";
+        } else if (ModelUtils.isBooleanSchema(schema)) {
+            example = "True";
+        } else if (ModelUtils.isArraySchema(schema)) {
+            if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
+                included_schemas.add(schema.getTitle());
+            }
+            ArraySchema arrayschema = (ArraySchema) schema;
+            example = "[\n" + indentation_string + toExampleValueRecursive(arrayschema.getItems(), included_schemas, indentation+1) + "\n" + indentation_string + "]";
+        } else if (ModelUtils.isMapSchema(schema)) {
+            if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
+                included_schemas.add(schema.getTitle());
+            }
+            Object additionalObject = schema.getAdditionalProperties();
+            if (additionalObject instanceof Schema) {
+                Schema additional = (Schema) additionalObject;
+                String the_key = "'key'";
+                if (additional.getEnum() != null && !additional.getEnum().isEmpty()) {
+                    the_key = additional.getEnum().get(0).toString();
+                    if (ModelUtils.isStringSchema(additional)) {
+                        the_key = "'" + escapeText(the_key) + "'";
+                    }
+                }
+                example = "{\n" + indentation_string + the_key + " : " + toExampleValueRecursive(additional, included_schemas, indentation+1) + "\n" + indentation_string + "}";
+            } else {
+                example = "{ }";
+            }
+        } else if (ModelUtils.isObjectSchema(schema)) {
+            if (StringUtils.isBlank(schema.getTitle())) {
+                example = "None";
+                return example;
+            }
+
+            // I remove any property that is a discriminator, since it is not well supported by the python generator
+            String toExclude = null;
+            if (schema.getDiscriminator()!=null) {
+                toExclude = schema.getDiscriminator().getPropertyName();
+            }
+            
+            example = packageName + ".models." + underscore(schema.getTitle())+"."+schema.getTitle()+"(";
+
+            // if required only:
+            // List<String> reqs = schema.getRequired();
+
+            // if required and optionals
+            List<String> reqs = new ArrayList<String>();
+            for (Object toAdd : schema.getProperties().keySet())
+                reqs.add((String)toAdd);
+
+            Map<String, Schema> properties = schema.getProperties();
+            Set<String> propkeys = null;
+            if (properties != null) propkeys = properties.keySet();
+            if (toExclude != null && reqs.contains(toExclude)) {
+                reqs.remove(toExclude);
+            }
+            for (String toRemove : included_schemas) {
+                if (reqs.contains(toRemove)) {
+                    reqs.remove(toRemove);
+                }
+            }
+            if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
+                included_schemas.add(schema.getTitle());
+            }
+            if (null != schema.getRequired()) for (Object toAdd : schema.getRequired()) {
+                reqs.add((String)toAdd);
+            }
+            if (null!=propkeys) for (String propname : propkeys) {
+                Schema schema2 = properties.get(propname);
+                if (reqs.contains(propname)) {
+                    String refTitle = schema2.getTitle();
+                    if (StringUtils.isBlank(refTitle) || "null".equals(refTitle)) {
+                        schema2.setTitle(propname);
+                    }
+                    example += "\n" + indentation_string + underscore(propname) + " = "+
+                        toExampleValueRecursive(schema2, included_schemas, indentation+1)+", ";
+                }
+            }
+            example +=")";
+        } else {
+            LOGGER.warn("Type " + schema.getType() + " not handled properly in toExampleValue");
+        }
+
+        if (ModelUtils.isStringSchema(schema)) {
+            example = "'" + escapeText(example) + "'";
+        }
+
+        return example;
+    }
+
     @Override
     public void setParameterExampleValue(CodegenParameter p) {
         String example;

modules/openapi-generator/src/main/resources/python/model_test.mustache

@@ -5,14 +5,14 @@
 from __future__ import absolute_import
 
 import unittest
+import datetime
 
 {{#models}}
 {{#model}}
 import {{packageName}}
 from {{modelPackage}}.{{classFilename}} import {{classname}}  # noqa: E501
 from {{packageName}}.rest import ApiException
 
-
 class Test{{classname}}(unittest.TestCase):
     """{{classname}} unit test stubs"""
 
@@ -22,11 +22,31 @@ class Test{{classname}}(unittest.TestCase):
     def tearDown(self):
         pass
 
+    def make_instance(self, include_optional):
+        """Test {{classname}}
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # model = {{packageName}}.models.{{classFilename}}.{{classname}}()  # noqa: E501
+        if include_optional :
+            return {{classname}}(
+{{#vars}}
+                {{name}} = {{#example}}{{{.}}}{{/example}}{{^example}}None{{/example}}{{#hasMore}}, {{/hasMore}}
+{{/vars}}
+            )
+        else :
+            return {{classname}}(
+{{#vars}}
+{{#required}}
+                {{name}} = {{#example}}{{{.}}}{{/example}}{{^example}}None{{/example}},
+{{/required}}
+{{/vars}}
+        )
+
     def test{{classname}}(self):
         """Test {{classname}}"""
-        # FIXME: construct object with mandatory attributes with example values
-        # model = {{packageName}}.models.{{classFilename}}.{{classname}}()  # noqa: E501
-        pass
+        inst_req_only = self.make_instance(include_optional=False)
+        inst_req_and_optional = self.make_instance(include_optional=True)
 
 {{/model}}
 {{/models}}

samples/client/petstore/python/test/test_animal.py

@@ -5,20 +5,20 @@
 
     This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    The version of the OpenAPI document: 1.0.0
     Generated by: https://openapi-generator.tech
 """
 
 
 from __future__ import absolute_import
 
 import unittest
+import datetime
 
 import petstore_api
 from petstore_api.models.animal import Animal  # noqa: E501
 from petstore_api.rest import ApiException
 
-
 class TestAnimal(unittest.TestCase):
     """Animal unit test stubs"""
 
@@ -28,11 +28,26 @@ def setUp(self):
     def tearDown(self):
         pass
 
+    def make_instance(self, include_optional):
+        """Test Animal
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # model = petstore_api.models.animal.Animal()  # noqa: E501
+        if include_optional :
+            return Animal(
+                class_name = '0', 
+                color = 'red'
+            )
+        else :
+            return Animal(
+                class_name = '0',
+        )
+
     def testAnimal(self):
         """Test Animal"""
-        # FIXME: construct object with mandatory attributes with example values
-        # model = petstore_api.models.animal.Animal()  # noqa: E501
-        pass
+        inst_req_only = self.make_instance(include_optional=False)
+        inst_req_and_optional = self.make_instance(include_optional=True)
 
 
 if __name__ == '__main__':

samples/client/petstore/python/test/test_cat.py

@@ -5,20 +5,20 @@
 
     This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    The version of the OpenAPI document: 1.0.0
     Generated by: https://openapi-generator.tech
 """
 
 
 from __future__ import absolute_import
 
 import unittest
+import datetime
 
 import petstore_api
 from petstore_api.models.cat import Cat  # noqa: E501
 from petstore_api.rest import ApiException
 
-
 class TestCat(unittest.TestCase):
     """Cat unit test stubs"""
 
@@ -28,11 +28,24 @@ def setUp(self):
     def tearDown(self):
         pass
 
+    def make_instance(self, include_optional):
+        """Test Cat
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # model = petstore_api.models.cat.Cat()  # noqa: E501
+        if include_optional :
+            return Cat(
+                declawed = True
+            )
+        else :
+            return Cat(
+        )
+
     def testCat(self):
         """Test Cat"""
-        # FIXME: construct object with mandatory attributes with example values
-        # model = petstore_api.models.cat.Cat()  # noqa: E501
-        pass
+        inst_req_only = self.make_instance(include_optional=False)
+        inst_req_and_optional = self.make_instance(include_optional=True)
 
 
 if __name__ == '__main__':

samples/client/petstore/python/test/test_category.py

@@ -5,20 +5,20 @@
 
     This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    The version of the OpenAPI document: 1.0.0
     Generated by: https://openapi-generator.tech
 """
 
 
 from __future__ import absolute_import
 
 import unittest
+import datetime
 
 import petstore_api
 from petstore_api.models.category import Category  # noqa: E501
 from petstore_api.rest import ApiException
 
-
 class TestCategory(unittest.TestCase):
     """Category unit test stubs"""
 
@@ -28,11 +28,26 @@ def setUp(self):
     def tearDown(self):
         pass
 
+    def make_instance(self, include_optional):
+        """Test Category
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # model = petstore_api.models.category.Category()  # noqa: E501
+        if include_optional :
+            return Category(
+                id = 56, 
+                name = 'default-name'
+            )
+        else :
+            return Category(
+                name = 'default-name',
+        )
+
     def testCategory(self):
         """Test Category"""
-        # FIXME: construct object with mandatory attributes with example values
-        # model = petstore_api.models.category.Category()  # noqa: E501
-        pass
+        inst_req_only = self.make_instance(include_optional=False)
+        inst_req_and_optional = self.make_instance(include_optional=True)
 
 
 if __name__ == '__main__':