[Dart-dio] Add basic integration testing and fix compile errors (#8025)

* [dart-dio] Add basic integration test POM

This basically just fetches dependencies, runs the built_value generator and empty test cases. Even running empty test cases is more than is currently possible and at least finds compile errors.

There are compile errors atm which need to be fixed.

* [dart-dio] Fix missing BuiltSet import in models that use enums

* [dart-dio] Fix compile error when the return type is a Map

* the compile error was `serializerForType(Map<String, int>)` in `StoreApi` which needs to be  `serializerForType(Map)`
* use final instead of var in response handling

* [dart-dio] Generate docs after changes

* [dart-dio] Add integration test to CI execution list

Author: kuhnroyal

docs/generators/dart-dio.md

@@ -32,6 +32,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ---------- | ------- |
 |BuiltList|package:built_collection/built_collection.dart|
 |BuiltMap|package:built_collection/built_collection.dart|
+|BuiltSet|package:built_collection/built_collection.dart|
 |JsonObject|package:built_value/json_object.dart|
 |Uint8List|dart:typed_data|
 

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

@@ -617,7 +617,7 @@ public void postProcessFile(File file, String fileType) {
             return; // skip if DART_POST_PROCESS_FILE env variable is not defined
         }
 
-        // only procees the following type (or we can simply rely on the file extension to check if it's a Dart file)
+        // only process the following type (or we can simply rely on the file extension to check if it's a Dart file)
         Set<String> supportedFileType = Sets.newHashSet(
             "supporting-mustache",
             "model-test",

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

@@ -51,7 +51,7 @@ public class DartDioClientCodegen extends DartClientCodegen {
 
     private static final String IS_FORMAT_JSON = "jsonFormat";
     private static final String CLIENT_NAME = "clientName";
-    private static Set<String> modelToIgnore = new HashSet<>();
+    private static final Set<String> modelToIgnore = new HashSet<>();
 
     static {
         modelToIgnore.add("datetime");
@@ -71,10 +71,6 @@ public DartDioClientCodegen() {
         embeddedTemplateDir = "dart-dio";
         this.setTemplateDir(embeddedTemplateDir);
 
-        //no tests at this time
-        modelTestTemplateFiles.clear();
-        apiTestTemplateFiles.clear();
-
         cliOptions.add(new CliOption(NULLABLE_FIELDS, "Is the null fields should be in the JSON payload"));
         CliOption dateLibrary = new CliOption(DATE_LIBRARY, "Option. Date library to use").defaultValue(this.getDateLibrary());
         Map<String, String> dateOptions = new HashMap<>();
@@ -88,6 +84,7 @@ public DartDioClientCodegen() {
         typeMapping.put("AnyType", "Object");
 
         importMapping.put("BuiltList", "package:built_collection/built_collection.dart");
+        importMapping.put("BuiltSet", "package:built_collection/built_collection.dart");
         importMapping.put("BuiltMap", "package:built_collection/built_collection.dart");
         importMapping.put("JsonObject", "package:built_value/json_object.dart");
         importMapping.put("Uint8List", "dart:typed_data");
@@ -109,7 +106,6 @@ public void setNullableFields(boolean nullableFields) {
         this.nullableFields = nullableFields;
     }
 
-
     @Override
     public String getName() {
         return "dart-dio";
@@ -316,6 +312,11 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
         if (property.dataType.contains("JsonObject")) {
             model.imports.add("JsonObject");
         }
+
+        if (property.isEnum) {
+            // enums are generated with built_value and make use of BuiltSet
+            model.imports.add("BuiltSet");
+        }
     }
 
     @Override
@@ -378,5 +379,4 @@ public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> o
         return objs;
     }
 
-
 }

modules/openapi-generator/src/main/resources/dart-dio/api.mustache

@@ -95,18 +95,23 @@ class {{classname}} {
             ){{#returnType}}.then((response) {
 
         {{#isResponseFile}}
-            var data = response.data;
+            final data = response.data;
         {{/isResponseFile}}
         {{^isResponseFile}}
-            {{#isArray}}
-                final FullType type = const FullType(BuiltList, const [const FullType({{returnBaseType}})]);
-                BuiltList<{{returnBaseType}}> dataList = _serializers.deserialize(response.data is String ? jsonDecode(response.data) : response.data, specifiedType: type);
-                var data = dataList.toList();
-            {{/isArray}}
-            {{^isArray}}
-                var serializer = _serializers.serializerForType({{{returnType}}});
-                var data = _serializers.deserializeWith<{{{returnType}}}>(serializer, response.data is String ? jsonDecode(response.data) : response.data);
-            {{/isArray}}
+        {{#isArray}}
+            final FullType type = const FullType(BuiltList, const [const FullType({{returnBaseType}})]);
+            final BuiltList<{{returnBaseType}}> dataList = _serializers.deserialize(response.data is String ? jsonDecode(response.data) : response.data, specifiedType: type);
+            final data = dataList.toList();
+        {{/isArray}}
+        {{^isArray}}
+        {{#isMap}}
+            final serializer = _serializers.serializerForType(Map);
+        {{/isMap}}
+        {{^isMap}}
+            final serializer = _serializers.serializerForType({{{returnType}}});
+        {{/isMap}}
+            final data = _serializers.deserializeWith<{{{returnType}}}>(serializer, response.data is String ? jsonDecode(response.data) : response.data);
+        {{/isArray}}
         {{/isResponseFile}}
 
             return Response<{{{returnType}}}>(

modules/openapi-generator/src/main/resources/dart-dio/api_test.mustache

@@ -0,0 +1,29 @@
+import 'package:{{pubName}}/api.dart';
+import 'package:{{pubName}}/api/{{classFilename}}.dart';
+import 'package:test/test.dart';
+
+{{#operations}}
+
+/// tests for {{{classname}}}
+void main() {
+  final instance = {{{clientName}}}().get{{{classname}}}();
+
+  group({{{classname}}}, () {
+    {{#operation}}
+    {{#summary}}
+    // {{{.}}}
+    //
+    {{/summary}}
+    {{#notes}}
+    // {{{.}}}
+    //
+    {{/notes}}
+    //{{#returnType}}Future<{{{returnType}}}> {{/returnType}}{{^returnType}}Future {{/returnType}}{{{operationId}}}({{#allParams}}{{#required}}{{{dataType}}} {{{paramName}}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}}{{#hasOptionalParams}}{ {{#allParams}}{{^required}}{{{dataType}}} {{{paramName}}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}} }{{/hasOptionalParams}}) async
+    test('test {{{operationId}}}', () async {
+      // TODO
+    });
+
+    {{/operation}}
+  });
+}
+{{/operations}}

modules/openapi-generator/src/main/resources/dart-dio/model_test.mustache

@@ -0,0 +1,28 @@
+{{#models}}
+{{#model}}
+import 'package:{{pubName}}/model/{{classFilename}}.dart';
+import 'package:test/test.dart';
+
+// tests for {{{classname}}}
+void main() {
+  {{^isEnum}}
+  final instance = {{{classname}}}();
+  {{/isEnum}}
+
+  group({{{classname}}}, () {
+    {{#vars}}
+    {{#description}}
+    // {{{description}}}
+    {{/description}}
+    // {{{dataType}}} {{{name}}}{{#defaultValue}} (default value: {{{.}}}){{/defaultValue}}
+    test('to test the property `{{{name}}}`', () async {
+      // TODO
+    });
+
+    {{/vars}}
+
+  });
+
+}
+{{/model}}
+{{/models}}

modules/openapi-generator/src/main/resources/dart-dio/pubspec.mustache

@@ -13,4 +13,5 @@ dependencies:
 dev_dependencies:
     built_value_generator: ^7.1.0
     build_runner: ^1.7.1
+    test: ^1.3.0
 

pom.xml

@@ -1350,6 +1350,7 @@
                 <module>samples/server/petstore/go-api-server</module>
                 <module>samples/server/petstore/go-gin-api-server</module>
                 <module>samples/client/petstore/dart2/petstore</module>
+                <module>samples/client/petstore/dart-dio</module>
                 <module>samples/client/petstore/dart-jaguar/openapi</module>
                 <module>samples/client/petstore/dart-jaguar/flutter_petstore/openapi</module>
             </modules>

samples/client/petstore/dart-dio/.gitignore

@@ -27,6 +27,9 @@ doc/api/
 # (Library packages only! Remove pattern if developing an application package)
 pubspec.lock
 
+# Don't commit *.g.dart files which are genrated during integration tests
+lib/**/*.g.dart
+
 # Don’t commit files and directories created by other development environments.
 # For example, if your development environment creates any of the following files,
 # consider putting them in a global ignore file:

samples/client/petstore/dart-dio/.openapi-generator-ignore

@@ -21,3 +21,6 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+
+# Don't regenerate .gitignore as it contains customizations for generated dart files
+.gitignore