sdk/pkg/dds/test/dap/dart_cli_test.dart

// Copyright (c) 2021, 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:async';
import 'dart:io';

import 'package:dds/dap.dart';
import 'package:test/test.dart';

import 'mocks.dart';

main() {
  group('dart cli adapter', () {
    late MockDartCliDebugAdapter adapter;

    setUp(() {
      adapter = MockDartCliDebugAdapter();
    });

    tearDown(() {
      adapter.terminateRequest(MockRequest(), TerminateArguments(), () {});
    });

    test('includes vmAdditionalArgs', () async {
      final responseCompleter = Completer<void>();
      final request = MockRequest();
      final args = DartLaunchRequestArguments(
        program: 'foo.dart',
        vmAdditionalArgs: ['vm_arg'],
        noDebug: true,
      );

      await adapter.configurationDoneRequest(request, null, () {});
      await adapter.launchRequest(request, args, responseCompleter.complete);
      await responseCompleter.future;

      expect(adapter.executable, equals(Platform.resolvedExecutable));
      expect(adapter.processArgs, containsAllInOrder(['vm_arg', 'foo.dart']));
    });

    test('includes toolArgs', () async {
      final responseCompleter = Completer<void>();
      final request = MockRequest();
      final args = DartLaunchRequestArguments(
        program: 'foo.dart',
        toolArgs: ['tool_arg'],
        noDebug: true,
      );

      await adapter.configurationDoneRequest(request, null, () {});
      await adapter.launchRequest(request, args, responseCompleter.complete);
      await responseCompleter.future;

      expect(adapter.executable, equals(Platform.resolvedExecutable));
      expect(adapter.processArgs, containsAllInOrder(['tool_arg', 'foo.dart']));
    });

    test('includes env', () async {
      final responseCompleter = Completer<void>();
      final request = MockRequest();
      final args = DartLaunchRequestArguments(
        program: 'foo.dart',
        env: {
          'ENV1': 'VAL1',
          'ENV2': 'VAL2',
        },
        noDebug: true,
      );

      await adapter.configurationDoneRequest(request, null, () {});
      await adapter.launchRequest(request, args, responseCompleter.complete);
      await responseCompleter.future;

      expect(adapter.executable, equals(Platform.resolvedExecutable));
      expect(adapter.env!['ENV1'], 'VAL1');
      expect(adapter.env!['ENV2'], 'VAL2');
    });

    group('--timeline-streams', () {
      test('included by default in debug mode', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.executable, equals(Platform.resolvedExecutable));
        expect(adapter.processArgs, contains(contains('--timeline_streams')));
      });

      test('not included by default in noDebug mode', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
          noDebug: true,
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.executable, equals(Platform.resolvedExecutable));
        expect(adapter.processArgs,
            isNot(contains(contains('--timeline_streams'))));
      });

      for (final flagName in ['timeline_streams', 'timeline-streams']) {
        test('can be overridden as --$flagName=', () async {
          final responseCompleter = Completer<void>();
          final request = MockRequest();
          final args = DartLaunchRequestArguments(
              program: 'foo.dart', toolArgs: ['--$flagName=custom']);

          await adapter.configurationDoneRequest(request, null, () {});
          await adapter.launchRequest(
              request, args, responseCompleter.complete);
          await responseCompleter.future;

          expect(adapter.executable, equals(Platform.resolvedExecutable));
          expect(adapter.processArgs, contains(contains('--$flagName=custom')));
          // Default is not also included.
          expect(adapter.processArgs.where((arg) => arg.contains('streams')),
              hasLength(1));
        });

        test('can be overridden as --$flagName --value', () async {
          final responseCompleter = Completer<void>();
          final request = MockRequest();
          final args = DartLaunchRequestArguments(
              program: 'foo.dart', toolArgs: ['--$flagName', 'custom']);

          await adapter.configurationDoneRequest(request, null, () {});
          await adapter.launchRequest(
              request, args, responseCompleter.complete);
          await responseCompleter.future;

          expect(adapter.executable, equals(Platform.resolvedExecutable));
          expect(adapter.processArgs,
              containsAllInOrder(['--$flagName', 'custom']));
          // Default is not also included.
          expect(adapter.processArgs.where((arg) => arg.contains('streams')),
              hasLength(1));
        });
      }
    });

    group('uses `dart run`', () {
      test('by default', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
          noDebug: true,
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.processArgs, contains('run'));
      });

      test('if explicitly specified in toolArgs', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
          toolArgs: ['run'],
          noDebug: true,
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.processArgs.where((arg) => arg == 'run'), hasLength(1));
      });
    });

    group('includes customTool', () {
      test('with no args replaced', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
          customTool: '/custom/dart',
          noDebug: true,
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.executable, equals('/custom/dart'));
        // a standard built-in arg should be present.
        expect(adapter.processArgs, contains('--no-serve-devtools'));
      });

      test('with all args replaced', () async {
        final responseCompleter = Completer<void>();
        final request = MockRequest();
        final args = DartLaunchRequestArguments(
          program: 'foo.dart',
          customTool: '/custom/dart',
          customToolReplacesArgs: 9999, // replaces all built-in args
          noDebug: true,
          toolArgs: ['tool_args'], // should still be in args
        );

        await adapter.configurationDoneRequest(request, null, () {});
        await adapter.launchRequest(request, args, responseCompleter.complete);
        await responseCompleter.future;

        expect(adapter.executable, equals('/custom/dart'));
        // normal built-in args are replaced by customToolReplacesArgs, but
        // user-provided toolArgs are not.
        // The argument here should match the one verified in the test above to
        // ensure it's real.
        expect(adapter.processArgs, isNot(contains('--no-serve-devtools')));
        expect(adapter.processArgs, contains('tool_args'));
      });
    });
  });
}