Roll forward "Use package:stack_trace in unittest."

This reverts r24669 and rolls forward r24652, r24659, and r24661.

BUG=11649
[email protected], [email protected]

Review URL: https://codereview.chromium.org//18892003

git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@25131 260f80e4-7a28-3924-810f-c04153c831b5

Author: nex3

pkg/unittest/lib/compact_vm_config.dart

@@ -15,6 +15,7 @@ import 'dart:io';
 import 'dart:isolate';
 
 import 'unittest.dart';
+import 'src/utils.dart';
 import 'vm_config.dart';
 
 const String _GREEN = '\u001b[32m';
@@ -57,11 +58,11 @@ class CompactVMConfiguration extends VMConfiguration {
       _progressLine(_start, _pass, _fail, test.description);
       print('');
       if (test.message != '') {
-        print(_indent(test.message));
+        print(indent(test.message));
       }
 
-      if (test.stackTrace != null && test.stackTrace != '') {
-        print(_indent(test.stackTrace));
+      if (test.stackTrace != null) {
+        print(indent(test.stackTrace.toString()));
       }
     }
   }
@@ -75,10 +76,6 @@ class CompactVMConfiguration extends VMConfiguration {
     });
   }
 
-  String _indent(String str) {
-    return str.split("\n").map((line) => "  $line").join("\n");
-  }
-
   void onSummary(int passed, int failed, int errors, List<TestCase> results,
       String uncaughtError) {
     var success = false;

pkg/unittest/lib/html_config.dart

@@ -80,7 +80,9 @@ String _toHtml(TestCase test_) {
       </tr>''';
 
   if (test_.stackTrace != null) {
-    html = '$html<tr><td></td><td colspan="2"><pre>${_htmlEscape(test_.stackTrace)}</pre></td></tr>';
+    html = '$html<tr><td></td><td colspan="2"><pre>' +
+        _htmlEscape(test_.stackTrace.toString()) +
+        '</pre></td></tr>';
   }
 
   return html;

pkg/unittest/lib/html_enhanced_config.dart

@@ -270,7 +270,8 @@ class HtmlEnhancedConfiguration extends Configuration {
         '${test_.description}. ${_htmlEscape(test_.message)}');
 
     if (test_.stackTrace != null) {
-      addRowElement('', '', '<pre>${_htmlEscape(test_.stackTrace)}</pre>');
+      addRowElement('', '',
+          '<pre>${_htmlEscape(test_.stackTrace.toString())}</pre>');
     }
   }
 

pkg/unittest/lib/interactive_html_config.dart

@@ -20,6 +20,9 @@ library unittest_interactive_html_config;
 import 'dart:html';
 import 'dart:async';
 import 'dart:math';
+
+import 'package:stack_trace/stack_trace.dart';
+
 import 'unittest.dart';
 
 /** The messages exchanged between parent and child. */
@@ -152,17 +155,25 @@ class ChildInteractiveHtmlConfiguration extends HtmlConfiguration {
   }
 
   /**
-   * Get the elapsed time for the test, anbd post the test result
-   * back to the parent window. If the test failed due to an exception
-   * the stack is posted back too (before the test result).
+   * Get the elapsed time for the test, and post the test result back to the
+   * parent window. If the test failed due to an exception the stack is posted
+   * back too (before the test result).
    */
   void onTestResult(TestCase testCase) {
     super.onTestResult(testCase);
     DateTime end = new DateTime.now();
     int elapsed = end.difference(_testStarts[testCase.id]).inMilliseconds;
     if (testCase.stackTrace != null) {
+      var message = json.stringify(testCase.stackTrace.frames.map((frame) {
+        return <String>{
+          "uri": frame.uri.toString(),
+          "line": frame.line,
+          "column": frame.column,
+          "member": frame.member
+        };
+      }).toList());
       _parentWindow.postMessage(
-          _Message.text(_Message.STACK, elapsed, testCase.stackTrace), '*');
+          _Message.text(_Message.STACK, elapsed, message), '*');
     }
     _parentWindow.postMessage(
         _Message.text(testCase.result, elapsed, testCase.message), '*');
@@ -185,7 +196,7 @@ class ParentInteractiveHtmlConfiguration extends HtmlConfiguration {
 
 
   /** The stack that was posted back from the child, if any. */
-  String _stack;
+  Trace _stack;
 
   int _testTime;
   /**
@@ -233,7 +244,13 @@ class ParentInteractiveHtmlConfiguration extends HtmlConfiguration {
     if (msg.messageType == _Message.LOG) {
       logMessage(e.data);
     } else if (msg.messageType == _Message.STACK) {
-      _stack = msg.body;
+      _stack = new Trace(json.parse(msg.body).map((frame) {
+        return new Frame(
+            Uri.parse(frame['uri']),
+            frame['line'],
+            frame['column'],
+            frame['member']);
+      }));
     } else {
       _testTime = msg.elapsed;
       logMessage(_Message.text(_Message.LOG, _testTime, 'Complete'));

pkg/unittest/lib/src/config.dart

@@ -55,8 +55,8 @@ class Configuration {
 
   // If stopTestOnExpectFailure is false, we need to capture failures, which
   // we do with this List.
-  List _testLogBuffer = new List();
-  
+  final _testLogBuffer = <Pair<String, Trace>>[];
+
   /**
    * The constructor sets up a failure handler for [expect] that redirects
    * [expect] failures to [onExpectFailure].
@@ -99,24 +99,25 @@ class Configuration {
     if (!stopTestOnExpectFailure && _testLogBuffer.length > 0) {
       // Write the message/stack pairs up to the last pairs.
       var reason = new StringBuffer();
-      for (var i = 0; i < _testLogBuffer.length - 2; i += 2) {
-        reason.write(_testLogBuffer[i]);
+      for (var reasonAndTrace in
+             _testLogBuffer.take(_testLogBuffer.length - 1)) {
+        reason.write(reasonAndTrace.first);
         reason.write('\n');
-        reason.write(_formatStack(_testLogBuffer[i+1]));
+        reason.write(reasonAndTrace.last);
         reason.write('\n');
       }
+      var lastReasonAndTrace = _testLogBuffer.last;
       // Write the last message.
-      reason.write(_testLogBuffer[_testLogBuffer.length - 2]);
+      reason.write(lastReasonAndTrace.first);
       if (testCase.result == PASS) {
         testCase._result = FAIL;
         testCase._message = reason.toString();
         // Use the last stack as the overall failure stack.    
-        testCase._stackTrace = 
-            _formatStack(_testLogBuffer[_testLogBuffer.length - 1]);
+        testCase._stackTrace = lastReasonAndTrace.last;
       } else {
         // Add the last stack to the message; we have a further stack
         // caused by some other failure.
-        reason.write(_formatStack(_testLogBuffer[_testLogBuffer.length - 1]));
+        reason.write(lastReasonAndTrace.last);
         reason.write('\n');
         // Add the existing reason to the end of the expect log to 
         // create the final message.
@@ -150,11 +151,11 @@ class Configuration {
     if (stopTestOnExpectFailure) {
       throw new TestFailure(reason);
     } else {
-      _testLogBuffer.add(reason);
       try {
         throw '';
       } catch (_, stack) {
-        _testLogBuffer.add(stack);
+        _testLogBuffer.add(
+            new Pair<String, Trace>(reason, new Trace.from(stack)));
       }
     }
   }
@@ -170,12 +171,12 @@ class Configuration {
     result.write("\n");
 
     if (testCase.message != '') {
-      result.write(_indent(testCase.message));
+      result.write(indent(testCase.message));
       result.write("\n");
     }
 
-    if (testCase.stackTrace != null && testCase.stackTrace != '') {
-      result.write(_indent(testCase.stackTrace));
+    if (testCase.stackTrace != null) {
+      result.write(indent(testCase.stackTrace.toString()));
       result.write("\n");
     }
     return result.toString();
@@ -228,17 +229,10 @@ class Configuration {
     }
   }
 
-  String _indent(String str) {
-    // TODO(nweiz): Use this simpler code once issue 2980 is fixed.
-    // return str.replaceAll(new RegExp("^", multiLine: true), "  ");
-
-    return str.split("\n").map((line) => "  $line").join("\n");
-  }
-
   /** Handle errors that happen outside the tests. */
   // TODO(vsm): figure out how to expose the stack trace here
   // Currently e.message works in dartium, but not in dartc.
-  void handleExternalError(e, String message, [String stack = '']) =>
+  void handleExternalError(e, String message, [stack]) =>
       _reportTestError('$message\nCaught $e', stack);
 
   _postMessage(String message) {

pkg/unittest/lib/src/test_case.dart

@@ -41,9 +41,9 @@ class TestCase {
    */
   String get result => _result;
 
-  String _stackTrace;
+  Trace _stackTrace;
   /** Stack trace associated with this test, or [null] if it succeeded. */
-  String get stackTrace => _stackTrace;
+  Trace get stackTrace => _stackTrace;
 
   /** The group (or groups) under which this test is running. */
   final String currentGroup;
@@ -69,7 +69,6 @@ class TestCase {
 
   Function _errorHandler(String stage) => (e) {
     var stack = getAttachedStackTrace(e);
-    stack = (stack == null) ? '' : '$stack';
     if (result == null || result == PASS) {
       if (e is TestFailure) {
         fail("$e", stack);
@@ -122,9 +121,9 @@ class TestCase {
 
   // Set the results, notify the config, and return true if this
   // is the first time the result is being set.
-  void _setResult(String testResult, String messageText, String stack) {
+  void _setResult(String testResult, String messageText, stack) {
     _message = messageText;
-    _stackTrace = _formatStack(stack);
+    _stackTrace = _getTrace(stack);
     if (result == null) {
       _result = testResult;
       _config.onTestResult(this);
@@ -134,9 +133,7 @@ class TestCase {
     }
   }
 
-  void _complete(String testResult,
-                [String messageText = '',
-                 String stack = '']) {
+  void _complete(String testResult, [String messageText = '', stack]) {
     if (runningTime == null) {
       // The startTime can be `null` if an error happened during setup. In this
       // case we simply report a running time of 0.
@@ -158,8 +155,7 @@ class TestCase {
     _complete(PASS);
   }
 
-  void fail(String messageText, [String stack = '']) {
-    assert(stack != null);
+  void fail(String messageText, [stack]) {
     if (result != null) {
       String newMessage = (result == PASS)
           ? 'Test failed after initially passing: $messageText'
@@ -171,8 +167,7 @@ class TestCase {
     }
   }
 
-  void error(String messageText, [String stack = '']) {
-    assert(stack != null);
+  void error(String messageText, [stack]) {
     _complete(ERROR, messageText, stack);
   }
 

pkg/unittest/lib/src/utils.dart

@@ -46,3 +46,24 @@ String _escapeChar(String ch) {
     return ch;
 }
 
+/** Indent each line in [str] by two spaces. */
+String indent(String str) =>
+  str.replaceAll(new RegExp("^", multiLine: true), "  ");
+
+/** A pair of values. */
+class Pair<E, F> {
+  E first;
+  F last;
+
+  Pair(this.first, this.last);
+
+  String toString() => '($first, $last)';
+
+  bool operator==(other) {
+    if (other is! Pair) return false;
+    return other.first == first && other.last == last;
+  }
+
+  int get hashCode => first.hashCode ^ last.hashCode;
+}
+