Change integration test send...() methods to use structured objects.

pkg/analysis_server/tool/spec/codegen_inttest_methods.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /**
  * Code generation for the file "integration_test_methods.dart".
  */
 library codegenInttestMethods;
 
 import 'dart:convert';
 
 import 'api.dart';
+import 'codegen_dart.dart';
 import 'codegen_tools.dart';
 import 'from_html.dart';
 import 'to_html.dart';
 
 /**
  * Visitor that generates the code for integration_test_methods.dart
  */
-class CodegenInttestMethodsVisitor extends HierarchicalApiVisitor with
-    CodeGenerator {
+class CodegenInttestMethodsVisitor extends DartCodegenVisitor with CodeGenerator
+    {
   /**
    * Visitor used to produce doc comments.
    */
   final ToHtmlVisitor toHtmlVisitor;
 
   /**
    * Code snippets concatenated to initialize all of the class fields.
    */
   List<String> fieldInitializationCode = <String>[];
 
@@ skipping 11 matching lines @@
   visitApi() {
     outputHeader();
     writeln();
     writeln('/**');
     writeln(' * Convenience methods for running integration tests');
     writeln(' */');
     writeln('library test.integration.methods;');
     writeln();
     writeln("import 'dart:async';");
     writeln();
+    writeln("import 'package:analysis_server/src/protocol.dart';");
     writeln("import 'package:unittest/unittest.dart';");
     writeln();
     writeln("import 'integration_tests.dart';");
     writeln("import 'protocol_matchers.dart';");
     writeln();
     writeln();
     writeln('/**');
     writeln(' * Convenience methods for running integration tests');
     writeln(' */');
     writeln('abstract class IntegrationTestMixin {');
@@ skipping 29 matching lines @@
         });
         writeln('}');
       });
       writeln('}');
     });
     writeln('}');
   }
 
   @override
   visitNotification(Notification notification) {
-    String streamName = camelJoin(['on', notification.domainName,
-        notification.event]);
+    String streamName =
+        camelJoin(['on', notification.domainName, notification.event]);
     writeln();
     docComment(toHtmlVisitor.collectHtml(() {
       toHtmlVisitor.translateHtml(notification.html);
       toHtmlVisitor.describePayload(notification.params, 'Parameters');
     }));
     writeln('Stream $streamName;');
     writeln();
     docComment(toHtmlVisitor.collectHtml(() {
       toHtmlVisitor.write('Stream controller for [$streamName].');
     }));
     writeln('StreamController _$streamName;');
     fieldInitializationCode.add(collectCode(() {
       writeln('_$streamName = new StreamController(sync: true);');
       writeln('$streamName = _$streamName.stream.asBroadcastStream();');
     }));
     notificationSwitchContents.add(collectCode(() {
       writeln('case ${JSON.encode(notification.longEvent)}:');
       indent(() {
-        String paramsValidator = camelJoin(['is', notification.domainName,
-            notification.event, 'params']);
+        String paramsValidator =
+            camelJoin(['is', notification.domainName, notification.event, 'params']);
         writeln('expect(params, $paramsValidator);');
         writeln('_$streamName.add(params);');
         writeln('break;');
       });
     }));
   }
 
   @override
   visitRequest(Request request) {
     String methodName = camelJoin(['send', request.domainName, request.method]);
     List<String> args = <String>[];
     List<String> optionalArgs = <String>[];
     if (request.params != null) {
       for (TypeObjectField field in request.params.fields) {
         if (field.optional) {
           optionalArgs.add(formatArgument(field));
         } else {
           args.add(formatArgument(field));
         }
       }
     }
-    optionalArgs.add('bool checkTypes: true');
-    args.add('{${optionalArgs.join(', ')}}');
+    if (optionalArgs.isNotEmpty) {
+      args.add('{${optionalArgs.join(', ')}}');
+    }
     writeln();
     docComment(toHtmlVisitor.collectHtml(() {
       toHtmlVisitor.translateHtml(request.html);
       toHtmlVisitor.describePayload(request.params, 'Parameters');
       toHtmlVisitor.describePayload(request.result, 'Returns');
     }));
     writeln('Future $methodName(${args.join(', ')}) {');
     indent(() {
-      String paramsValidator = camelJoin(['is', request.domainName,
-          request.method, 'params']);
-      String resultValidator = camelJoin(['is', request.domainName,
-          request.method, 'result']);
+      String requestClass =
+          camelJoin([request.domainName, request.method, 'params'], doCapitalize: true);
+      String resultValidator =
+          camelJoin(['is', request.domainName, request.method, 'result']);
       String paramsVar = 'null';
       if (request.params != null) {
         paramsVar = 'params';
-        writeln('Map<String, dynamic> params = {};');
+        List<String> args = <String>[];
+        List<String> optionalArgs = <String>[];
         for (TypeObjectField field in request.params.fields) {
           if (field.optional) {
-            writeln('if (${field.name} != null) {');
-            indent(() {
-              populateField(field);
-            });
-            writeln('}');
+            optionalArgs.add('${field.name}: ${field.name}');
           } else {
-            populateField(field);
+            args.add(field.name);
           }
         }
-        writeln('if (checkTypes) {');
-        indent(() {
-          writeln('expect(params, $paramsValidator);');
-        });
-        writeln('}');
+        args.addAll(optionalArgs);
+        writeln('var params = new $requestClass(${args.join(', ')}).toJson();');
       }
       writeln(
           'return server.send(${JSON.encode(request.longMethod)}, $paramsVar)');
       indent(() {
         writeln('  .then((result) {');
-        writeln('if (checkTypes) {');
-        indent(() {
-          writeln('expect(result, $resultValidator);');
-        });
-        writeln('}');
+        writeln('expect(result, $resultValidator);');
         writeln('return result;');
       });
       writeln('});');
     });
     writeln('}');
   }
 
   /**
    * Generate a function argument for the given parameter field.
    */
   String formatArgument(TypeObjectField field) =>
-      '${jsonType(field.type)} ${field.name}';
-
-  /**
-   * Generate code that populates the given parameter field based on the
-   * function argument from [formatArgument].
-   */
-  void populateField(TypeObjectField field) {
-    writeln('params[${JSON.encode(field.name)}] = ${field.name};');
-  }
+      '${dartType(field.type)} ${field.name}';
 
   /**
    * Figure out the appropriate Dart type for data having the given API
    * protocol [type].
    */
   String jsonType(TypeDecl type) {
     type = resolveTypeReferenceChain(type);
     if (type is TypeEnum) {
       return 'String';
     } else if (type is TypeList) {
@@ skipping 15 matching lines @@
           throw new Exception(type.typeName);
       }
     } else if (type is TypeUnion) {
       return 'Object';
     } else {
       throw new Exception('Unexpected kind of TypeDecl');
     }
   }
 }
 
-final GeneratedFile target = new GeneratedFile(
-    '../../test/integration/integration_test_methods.dart', () {
-  CodegenInttestMethodsVisitor visitor = new CodegenInttestMethodsVisitor(
-      readApi());
+final GeneratedFile target =
+    new GeneratedFile('../../test/integration/integration_test_methods.dart', () {
+  CodegenInttestMethodsVisitor visitor =
+      new CodegenInttestMethodsVisitor(readApi());
   return visitor.collectCode(visitor.visitApi);
 });
 
 /**
  * Translate spec_input.html into protocol_matchers.dart.
  */
 main() {
   target.generate();
 }