pkg/vm_service/test/eval_test_common.dart

// Copyright (c) 2024, 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 'package:test/test.dart';
import 'package:vm_service/vm_service.dart';
import 'common/service_test_common.dart';

IsolateTestHarness createHarness(String scriptName, List<String> args) {
  return IsolateTestHarness('eval_lib.dart', args)
      .hasStoppedAtBreakpoint()
      // Evaluate against library, class, and instance.
      .addCustomTest((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(2));
        expect(stack.frames![0].function!.name, 'method');
        expect((stack.frames![0].function!.owner as ClassRef).name, 'MyClass');

        final LibraryRef lib =
            isolate.libraries!.firstWhere((l) => l.uri!.contains('eval_lib'));
        final ClassRef cls = stack.frames![0].function!.owner;
        final InstanceRef instance = stack.frames![0].vars![0].value;

        dynamic result =
            await service.evaluate(isolateId, lib.id!, 'globalVar + 5');
        print(result);
        expect(result.valueAsString, '105');

        await expectError(
          () =>
              service.evaluate(isolateId, lib.id!, 'globalVar + staticVar + 5'),
        );

        result = await service.evaluate(
          isolateId,
          cls.id!,
          'globalVar + staticVar + 5',
        );
        print(result);
        expect(result.valueAsString, '1105');

        await expectError(
            () => service.evaluate(isolateId, cls.id!, 'this + 5'));

        result = await service.evaluate(isolateId, instance.id!, 'this + 5');
        print(result);
        expect(result.valueAsString, '10005');

        result = await service.evaluate(isolateId, instance.id!, 'this + frog');
        print(result);
        expect(result, isA<ErrorRef>());
        expect(
          result.message,
          contains("Class 'int' has no instance getter 'frog'"),
        );
      })
      .resumeIsolate()
      .hasStoppedAtBreakpoint()
      .addCustomTest((VmService service, IsolateRef isolate) async {
        final isolateId = isolate.id!;
        final stack = await service.getStack(isolateId);

        // Make sure we are in the right place.
        expect(stack.frames!.length, greaterThanOrEqualTo(2));
        expect(stack.frames![0].function!.name, 'foo');
        expect((stack.frames![0].function!.owner as ClassRef).name, '_MyClass');

        final ClassRef cls = stack.frames![0].function!.owner;

        final InstanceRef result =
            await service.evaluate(isolateId, cls.id!, '1+1') as InstanceRef;
        print(result);
        expect(result.valueAsString, '2');
      });
}

Future<void> expectError(Future<Response> Function() func) async {
  try {
    await func();
    fail('Failed to throw');
  } on RPCError catch (e) {
    expect(e.code, 113); // Compile time error.
  }
}