Kernel debugging; service tests

runtime/observatory/tests/service/service_test_common.dart

 // Copyright (c) 2016, 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 service_test_common;
 
 import 'dart:async';
 import 'package:observatory/models.dart' as M;
 import 'package:observatory/service_common.dart';
 import 'package:unittest/unittest.dart';
@@ skipping 262 matching lines @@
         sb.write(" $f [${await f.location.getLine()}]\n");
       }
       throw sb.toString();
     } else {
       print('Program is stopped at line: $line');
     }
   };
 }
 
 
-IsolateTest stoppedInFunction(String functionName, {bool contains: false}) {
+IsolateTest stoppedInFunction(String functionName,
+    {bool contains: false, bool includeOwner: false}) {
   return (Isolate isolate) async {
     print("Checking we are in function: $functionName");
 
     ServiceMap stack = await isolate.getStack();
     expect(stack.type, equals('Stack'));
 
     List<Frame> frames = stack['frames'];
     expect(frames.length, greaterThanOrEqualTo(1));
 
     Frame topFrame = stack['frames'][0];
     ServiceFunction function = await topFrame.function.load();
-    final bool matches =
-        contains ? function.name.contains(functionName) :
-                     function.name == functionName;
+    String foundFunctionName = function.name;
+    if (includeOwner) {
+      await (function.dartOwner as ServiceObject).load();
+      String ownerName = (function.dartOwner as ServiceObject).name;
+      foundFunctionName = "$ownerName.$foundFunctionName";
+    }
+    final bool matches = contains
+        ? foundFunctionName.contains(functionName)
+        : foundFunctionName == functionName;
     if (!matches) {
       StringBuffer sb = new StringBuffer();
       sb.write("Expected to be in function $functionName but "
-               "actually in function ${function.name}");
+          "actually in function ${function.name}");
       sb.write("\nFull stack trace:\n");
       for (Frame f in stack['frames']) {
         await f.function.load();
         await (f.function.dartOwner as ServiceObject).load();
         String name = f.function.name;
         String ownerName = (f.function.dartOwner as ServiceObject).name;
         sb.write(" $f [$name] [$ownerName]\n");
       }
       throw sb.toString();
     } else {
       print('Program is stopped in function: $functionName');
     }
   };
 }
 
-
 Future<Isolate> resumeIsolate(Isolate isolate) {
   Completer completer = new Completer();
   isolate.vm.getEventStream(VM.kDebugStream).then((stream) {
     var subscription;
     subscription = stream.listen((ServiceEvent event) {
       if (event.kind == ServiceEvent.kResume) {
         subscription.cancel();
         completer.complete();
       }
     });
@@ skipping 62 matching lines @@
 
 Future<Instance> rootLibraryFieldValue(Isolate isolate,
                                        String fieldName) async {
   Library rootLib = await isolate.rootLibrary.load();
   Field field = rootLib.variables.singleWhere((v) => v.name == fieldName);
   await field.load();
   Instance value = field.staticValue;
   await value.load();
   return value;
 }
+
+IsolateTest runStepThroughProgramRecordingStops(List<String> recordStops) {
+  return (Isolate isolate) async {
+    Completer completer = new Completer();
+
+    await subscribeToStream(isolate.vm, VM.kDebugStream,
+        (ServiceEvent event) async {
+      if (event.kind == ServiceEvent.kPauseBreakpoint) {
+        await isolate.reload();
+        // We are paused: Step further.
+        Frame frame = isolate.topFrame;
+        recordStops.add(await frame.location.toUserString());
+        if (event.atAsyncSuspension) {
+          isolate.stepOverAsyncSuspension();
+        } else {
+          isolate.stepOver();
+        }
+      } else if (event.kind == ServiceEvent.kPauseExit) {
+        // We are at the exit: The test is done.
+        await cancelStreamSubscription(VM.kDebugStream);
+        completer.complete();
+      }
+    });
+    isolate.resume();
+    return completer.future;
+  };
+}
+
+IsolateTest checkRecordedStops(
+    List<String> recordStops, List<String> expectedStops) {
+  return (Isolate isolate) async {
+    int end = recordStops.length < expectedStops.length
+        ? recordStops.length
+        : expectedStops.length;
+    for (int i = 0; i < end; ++i) {
+      expect(recordStops[i], expectedStops[i]);
+    }
+
+    expect(recordStops.length >= expectedStops.length, true,
+        reason: "Expects at least ${expectedStops.length} breaks.");
+  };
+}