pkg/vm_service/test/coverage_async_test.dart

// Copyright (c) 2022, 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.

import 'dart:developer';

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

import 'common/service_test_common.dart';
import 'common/test_helper.dart';

Future<int> asyncFunction() async {
  await Future.delayed(const Duration(milliseconds: 1));
  return 123;
}

Stream<int> asyncGenerator() async* {
  await Future.delayed(const Duration(milliseconds: 1));
  yield 456;
}

Iterable<int> syncGenerator() sync* {
  yield 789;
}

Future<void> wrapperFunction() async {
  print(await asyncFunction());
  await for (final value in asyncGenerator()) {
    print(value);
  }
  for (final value in syncGenerator()) {
    print(value);
  }
}

Future<void> testFunction() async {
  debugger();
  await wrapperFunction();
  debugger();
}

bool allRangesCompiled(coverage) {
  for (int i = 0; i < coverage['ranges'].length; i++) {
    if (!coverage['ranges'][i]['compiled']) {
      return false;
    }
  }
  return true;
}

IsolateTest coverageTest(Map<String, dynamic> expectedRange) {
  return (VmService service, IsolateRef isolateRef) async {
    final isolateId = isolateRef.id!;
    final isolate = await service.getIsolate(isolateId);
    final stack = await service.getStack(isolateId);

    // Make sure we are in the right place.
    expect(stack.frames!.length, greaterThanOrEqualTo(1));
    expect(stack.frames![0].function!.name, 'testFunction');

    final root =
        await service.getObject(isolateId, isolate.rootLib!.id!) as Library;
    FuncRef funcRef =
        root.functions!.singleWhere((f) => f.name == 'wrapperFunction');
    Func func = await service.getObject(isolateId, funcRef.id!) as Func;
    final location = func.location!;

    final report = await service.getSourceReport(
      isolateId,
      [SourceReportKind.kCoverage],
      scriptId: location.script!.id,
      tokenPos: location.tokenPos,
      endTokenPos: location.endTokenPos,
      forceCompile: true,
      reportLines: true,
    );
    expect(report.ranges!.length, 1);
    expect(report.ranges![0].toJson(), expectedRange);
    expect(report.scripts!.length, 1);
    expect(
      report.scripts![0].uri,
      endsWith('coverage_async_test.dart'),
    );
  };
}

var tests = <IsolateTest>[
  hasStoppedAtBreakpoint,
  coverageTest(
    {
      'scriptIndex': 0,
      'startPos': 674,
      'endPos': 878,
      'compiled': true,
      'coverage': {
        'hits': [],
        'misses': [27, 28, 28, 29, 29, 29, 30, 32, 32, 33]
      }
    },
  ),
  resumeIsolate,
  hasStoppedAtBreakpoint,
  coverageTest(
    {
      'scriptIndex': 0,
      'startPos': 674,
      'endPos': 878,
      'compiled': true,
      'coverage': {
        'hits': [27, 28, 28, 29, 29, 29, 30, 32, 32, 33],
        'misses': []
      }
    },
  ),
];

main([args = const <String>[]]) => runIsolateTests(
      args,
      tests,
      'coverage_async_test.dart',
      testeeConcurrent: testFunction,
    );