pkg/vm_service/test/causal_async_stack_contents_test.dart

// Copyright (c) 2017, 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.
//
// VMOptions=--verbose_debug

import 'package:test/test.dart';
import 'package:vm_service/vm_service.dart';

import 'causal_async_stack_contents_lib.dart' as testee_lib;
import 'common/service_test_common.dart';
import 'common/test_helper.dart';

void main([args = const <String>[]]) =>
    IsolateTestHarness('causal_async_stack_contents_lib.dart', args)
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_2')
        .stepOver()
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_B')
        .addCustomTest((VmService service, IsolateRef isolateRef) async {
          final Stack stack = await service.getStack(isolateRef.id!);
          // No causal frames because we are in a completely synchronous stack.
          expect(stack.asyncCausalFrames, isNull);
        })
        .resumeIsolate()
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_1')
        .stepOver()
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_A')
        .addCustomTest((VmService service, IsolateRef isolateRef) async {
          final Stack stack = await service.getStack(isolateRef.id!);
          // Has causal frames (we are inside an async function)
          expect(stack.asyncCausalFrames, isNotNull);
          expect(
            stack.asyncCausalFrames![0].function!.name,
            contains('helper'),
          );
          // "helper" is not await'ed.
        })
        .resumeIsolate()
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_0')
        .stepOver()
        .hasStoppedAtBreakpoint()
        .stoppedAtLine('LINE_C')
        .addCustomTest((VmService service, IsolateRef isolateRef) async {
          final Stack stack = await service.getStack(isolateRef.id!);
          // Has causal frames (we are inside a function called by an async function)
          expect(stack.asyncCausalFrames, isNotNull);
          final asyncStack = stack.asyncCausalFrames!;
          expect(asyncStack[0].function!.name, contains('foobar'));
          expect(asyncStack[1].function!.name, contains('helper'));
          // "helper" is not await'ed.
        })
        .run(testeeMain: testee_lib.main, extraArgs: extraDebuggingArgs);