add element to completion suggestions

pkg/analysis_server/test/services/completion/completion_test_util.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.
 
 library test.services.completion.util;
 
 import 'dart:async';
 
-import 'package:analysis_server/src/protocol.dart';
+import 'package:analysis_server/src/protocol.dart' as protocol show Element, ElementKind;
+import 'package:analysis_server/src/protocol.dart' hide Element;
 import 'package:analysis_server/src/services/completion/dart_completion_manager.dart';
 import 'package:analysis_server/src/services/index/index.dart';
 import 'package:analysis_server/src/services/index/local_memory_index.dart';
 import 'package:analysis_server/src/services/search/search_engine_internal.dart';
 import 'package:analyzer/src/generated/ast.dart';
 import 'package:analyzer/src/generated/element.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:unittest/unittest.dart';
 
@@ skipping 57 matching lines @@
     }
     expect(cs.kind, equals(kind));
     expect(cs.relevance, equals(relevance));
     expect(cs.selectionOffset, equals(completion.length));
     expect(cs.selectionLength, equals(0));
     expect(cs.isDeprecated, equals(isDeprecated));
     expect(cs.isPotential, equals(isPotential));
     return cs;
   }
 
-  void assertSuggestClass(String className, [CompletionRelevance relevance =
-      CompletionRelevance.DEFAULT]) {
-    assertSuggest(CompletionSuggestionKind.CLASS, className, relevance);
+  CompletionSuggestion assertSuggestClass(String name,
+      [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
+    CompletionSuggestion cs =
+        assertSuggest(CompletionSuggestionKind.CLASS, name, relevance);
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.CLASS));
+    expect(element.name, equals(name));
+    expect(element.returnType, isNull);
+    return cs;
   }
 
-  void assertSuggestField(String completion, String declaringType, String type,
+  CompletionSuggestion assertSuggestFunction(String name, String returnType,
+      bool isDeprecated, [CompletionRelevance relevance =
+      CompletionRelevance.DEFAULT]) {
+    CompletionSuggestion cs = assertSuggest(
+        CompletionSuggestionKind.FUNCTION,
+        name,
+        relevance,
+        isDeprecated);
+    expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.FUNCTION));
+    expect(element.name, equals(name));
+    expect(element.isDeprecated, equals(isDeprecated));
+    expect(
+        element.returnType,
+        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
+  }
+
+  CompletionSuggestion assertSuggestGetter(String name, String returnType,
       [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
     CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.FIELD, completion, relevance);
-    expect(cs.declaringType, equals(declaringType));
-    expect(cs.returnType, equals(type));
+        assertSuggest(CompletionSuggestionKind.GETTER, name, relevance);
+    expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.GETTER));
+    expect(element.name, equals(name));
+    expect(
+        element.returnType,
+        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
   }
 
-  void assertSuggestFunction(String completion, String returnType,
+  CompletionSuggestion assertSuggestLibraryPrefix(String prefix,
       [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
     CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.FUNCTION, completion, relevance);
-    expect(cs.returnType, equals(returnType));
+        assertSuggest(CompletionSuggestionKind.LIBRARY_PREFIX, prefix, relevance);
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.LIBRARY));
+    expect(element.name, equals(prefix));
+    expect(element.returnType, isNull);
+    return cs;
   }
 
-  void assertSuggestGetter(String className, String returnType,
-      [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
-    CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.GETTER, className, relevance);
-    expect(cs.returnType, equals(returnType));
-  }
-
-  void assertSuggestLibraryPrefix(String completion,
-      [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
-    assertSuggest(
-        CompletionSuggestionKind.LIBRARY_PREFIX,
-        completion,
-        relevance);
-  }
-
-  void assertSuggestLocalVariable(String completion, String returnType,
-      [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
-    CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.LOCAL_VARIABLE, completion, relevance);
-    expect(cs.returnType, equals(returnType));
-  }
-
-  void assertSuggestMethod(String className, String declaringType,
+  CompletionSuggestion assertSuggestLocalVariable(String name,
       String returnType, [CompletionRelevance relevance =
       CompletionRelevance.DEFAULT]) {
     CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.METHOD, className, relevance);
-    expect(cs.declaringType, equals(declaringType));
+        assertSuggest(CompletionSuggestionKind.LOCAL_VARIABLE, name, relevance);
     expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.LOCAL_VARIABLE));
+    expect(element.name, equals(name));
+    expect(
+        element.returnType,
+        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
   }
 
-  void assertSuggestMethodName(String completion, String declaringType,
+  CompletionSuggestion assertSuggestMethod(String name, String declaringType,
       String returnType, [CompletionRelevance relevance =
       CompletionRelevance.DEFAULT]) {
     CompletionSuggestion cs =
-        assertSuggest(CompletionSuggestionKind.METHOD_NAME, completion, relevance);
+        assertSuggest(CompletionSuggestionKind.METHOD, name, relevance);
     expect(cs.declaringType, equals(declaringType));
     expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.METHOD));
+    expect(element.name, equals(name));
+    expect(
+        element.returnType,
+        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
   }
 
-  void assertSuggestParameter(String completion, String returnType,
+  CompletionSuggestion assertSuggestParameter(String name, String returnType,
       [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
-    assertSuggest(CompletionSuggestionKind.PARAMETER, completion, relevance);
+    CompletionSuggestion cs =
+        assertSuggest(CompletionSuggestionKind.PARAMETER, name, relevance);
+    expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.PARAMETER));
+    expect(element.name, equals(name));
+    expect(
+        element.returnType,
+        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
   }
 
-  void assertSuggestSetter(String className, [CompletionRelevance relevance =
-      CompletionRelevance.DEFAULT]) {
-    assertSuggest(CompletionSuggestionKind.SETTER, className, relevance);
+  CompletionSuggestion assertSuggestSetter(String name,
+      [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
+    CompletionSuggestion cs =
+        assertSuggest(CompletionSuggestionKind.SETTER, name, relevance);
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.SETTER));
+    expect(element.name, equals(name));
+    expect(element.returnType, isNull);
+    return cs;
   }
 
-  void assertSuggestTopLevelVar(String completion, String returnType,
+  CompletionSuggestion assertSuggestTopLevelVar(String name, String returnType,
       [CompletionRelevance relevance = CompletionRelevance.DEFAULT]) {
-    CompletionSuggestion cs = assertSuggest(
-        CompletionSuggestionKind.TOP_LEVEL_VARIABLE,
-        completion,
-        relevance);
+    CompletionSuggestion cs =
+        assertSuggest(CompletionSuggestionKind.TOP_LEVEL_VARIABLE, name, relevance);
     expect(cs.returnType, equals(returnType));
+    protocol.Element element = cs.element;
+    expect(element, isNotNull);
+    expect(element.kind, equals(protocol.ElementKind.TOP_LEVEL_VARIABLE));
+    expect(element.name, equals(name));
+    //TODO (danrubel) return type level variable 'type' but not as 'returnType'
+//    expect(
+//        element.returnType,
+//        equals(returnType != null ? returnType : 'dynamic'));
+    return cs;
   }
 
   bool computeFast() {
     _computeFastCalled = true;
     CompilationUnit unit = context.parseCompilationUnit(testSource);
     request.unit = unit;
     request.node = new NodeLocator.con1(completionOffset).searchWithin(unit);
     return computer.computeFast(request);
   }
 
@@ skipping 47 matching lines @@
     return computer.computeFull(request);
   }
 
   @override
   void setUp() {
     super.setUp();
     index = createLocalMemoryIndex();
     searchEngine = new SearchEngineImpl(index);
   }
 }