Properly handle circular references among constants in the task model.

pkg/analyzer/test/src/task/dart_test.dart

 // Copyright (c) 2015, 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.src.task.dart_test;
 
 import 'package:analyzer/src/context/cache.dart';
 import 'package:analyzer/src/generated/ast.dart';
 import 'package:analyzer/src/generated/constant.dart';
 import 'package:analyzer/src/generated/element.dart';
@@ skipping 1294 matching lines @@
         expect(outputs[CONSTANT_VALUE], same(target));
         EvaluationResultImpl evaluationResult =
             (annotation.elementAnnotation as ElementAnnotationImpl).evaluationResult;
         return evaluationResult;
       }
     }
     fail('Annotation not found');
     return null;
   }
 
-  fail_circular_reference() {
-    // TODO(paulberry): get this to work.
-    EvaluationResultImpl evaluationResult = _computeTopLevelVariableConstValue(
-        'x', '''
-const x = y + 1;
-const y = x + 1;
-''');
-    expect(evaluationResult, isNotNull);
-    expect(evaluationResult.value, isNull);
-    expect(evaluationResult.errors, hasLength(1));
-    expect(evaluationResult.errors[0].errorCode,
-        CompileTimeErrorCode.RECURSIVE_COMPILE_TIME_CONSTANT);
+  fail_circular_reference_one_element() {
+    // See dartbug.com/23490.
+    _checkCircularities('x', [], 'const x = x;');
   }
 
   test_annotation_with_args() {
     Source source = newSource('/test.dart', '''
 const x = 1;
 @D(x) class C {}
 class D {
   const D(this.value);
   final value;
 }
@@ skipping 27 matching lines @@
     CompilationUnit unit = outputs[RESOLVED_UNIT1];
     // Compute the constant value of the annotation on C.
     EvaluationResultImpl evaluationResult =
         computeClassAnnotation(source, unit, 'C');
     // And check that it has the expected value.
     expect(evaluationResult, isNotNull);
     expect(evaluationResult.value, isNotNull);
     expect(evaluationResult.value.intValue, 1);
   }
 
+  test_circular_reference() {
+    _checkCircularities('x', ['y'], '''
+const x = y + 1;
+const y = x + 1;
+''');
+  }
+
+  test_circular_reference_strongly_connected_component() {
+    // When there is a circularity, all elements in the strongly connected
+    // component should be marked as having an error.
+    _checkCircularities('a', ['b', 'c', 'd'], '''
+const a = b;
+const b = c + d;
+const c = a;
+const d = a;
+''');
+  }
+
   test_dependency() {
     EvaluationResultImpl evaluationResult = _computeTopLevelVariableConstValue(
         'x', '''
 const x = y + 1;
 const y = 1;
 ''');
     expect(evaluationResult, isNotNull);
     expect(evaluationResult.value, isNotNull);
     expect(evaluationResult.value.intValue, 2);
   }
@@ skipping 15 matching lines @@
   test_simple_constant() {
     EvaluationResultImpl evaluationResult = _computeTopLevelVariableConstValue(
         'x', '''
 const x = 1;
 ''');
     expect(evaluationResult, isNotNull);
     expect(evaluationResult.value, isNotNull);
     expect(evaluationResult.value.intValue, 1);
   }
 
+  void _checkCircularities(
+      String variableName, List<String> otherVariables, String content) {
+    // Evaluating the first constant should produce an error.
+    CompilationUnit unit = _resolveUnit(content);
+    _expectCircularityError(_evaluateConstant(unit, variableName));
+    // And all the other constants involved in the strongly connected component
+    // should be set to the same error state.
+    for (String otherVariableName in otherVariables) {
+      PropertyInducingElement otherVariableElement =
+          _findVariable(unit, otherVariableName);
+      _expectCircularityError(
+          (otherVariableElement as TopLevelVariableElementImpl).evaluationResult);
+    }
+  }
+
   EvaluationResultImpl _computeTopLevelVariableConstValue(
       String variableName, String content) {
-    Source source = newSource('/test.dart', content);
-    // First compute the resolved unit for the source.
-    LibrarySpecificUnit librarySpecificUnit =
-        new LibrarySpecificUnit(source, source);
-    _computeResult(librarySpecificUnit, RESOLVED_UNIT1);
-    CompilationUnit unit = outputs[RESOLVED_UNIT1];
+    return _evaluateConstant(_resolveUnit(content), variableName);
+  }
+
+  EvaluationResultImpl _evaluateConstant(
+      CompilationUnit unit, String variableName) {
     // Find the element for the given constant.
-    List<PropertyAccessorElement> accessors = unit.element.accessors;
-    Element variableElement = accessors
-        .firstWhere((PropertyAccessorElement accessor) {
-      return accessor.isGetter && accessor.name == variableName;
-    }).variable;
+    PropertyInducingElement variableElement = _findVariable(unit, variableName);
     // Now compute the value of the constant.
     _computeResult(variableElement, CONSTANT_VALUE);
     expect(outputs[CONSTANT_VALUE], same(variableElement));
     EvaluationResultImpl evaluationResult =
         (variableElement as TopLevelVariableElementImpl).evaluationResult;
     return evaluationResult;
   }
+
+  void _expectCircularityError(EvaluationResultImpl evaluationResult) {
+    expect(evaluationResult, isNotNull);
+    expect(evaluationResult.value, isNull);
+    expect(evaluationResult.errors, hasLength(1));
+    expect(evaluationResult.errors[0].errorCode,
+        CompileTimeErrorCode.RECURSIVE_COMPILE_TIME_CONSTANT);
+  }
+
+  PropertyInducingElement _findVariable(
+      CompilationUnit unit, String variableName) {
+    // Find the element for the given constant.
+    List<PropertyAccessorElement> accessors = unit.element.accessors;
+    Element variableElement = accessors
+        .firstWhere((PropertyAccessorElement accessor) {
+      return accessor.isGetter && accessor.name == variableName;
+    }).variable;

[scheglov, 2015/05/19 19:25:41]

You could use unit.element.topLevelVariables directly.

[Paul Berry, 2015/05/19 19:36:11]

Done.

+    return variableElement;
+  }
+
+  CompilationUnit _resolveUnit(String content) {
+    Source source = newSource('/test.dart', content);
+    // First compute the resolved unit for the source.
+    LibrarySpecificUnit librarySpecificUnit =
+        new LibrarySpecificUnit(source, source);
+    _computeResult(librarySpecificUnit, RESOLVED_UNIT1);
+    CompilationUnit unit = outputs[RESOLVED_UNIT1];
+    return unit;
+  }
 }
 
 @reflectiveTest
 class ContainingLibrariesTaskTest extends _AbstractDartTaskTest {
   test_buildInputs() {
     Map<String, TaskInput> inputs =
         ContainingLibrariesTask.buildInputs(emptySource);
     expect(inputs, isNotNull);
     expect(inputs, isEmpty);
   }
@@ skipping 973 matching lines @@
   /**
    * Fill [errorListener] with [result] errors in the current [task].
    */
   void _fillErrorListener(ResultDescriptor<List<AnalysisError>> result) {
     List<AnalysisError> errors = task.outputs[result];
     expect(errors, isNotNull, reason: result.name);
     errorListener = new GatheringErrorListener();
     errorListener.addAll(errors);
   }
 }