pkg/dds/test/dap/integration/debug_exceptions_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 'package:test/test.dart';

import 'test_client.dart';
import 'test_scripts.dart';
import 'test_support.dart';

main() {
  group('debug mode', () {
    late DapTestSession dap;
    setUp(() async {
      // Temporarily enable verbose logging to debug some flakes on the bots
      // https://dart-ci.appspot.com/log/pkg-linux-release/unittest-asserts-release-linux-x64/33507/pkg/dds/test/dap/integration/debug_exceptions_test
      //
      // 00:04 debug mode parses line/column information from stack traces
      //
      //   Expected: '/b/s/w/iteji7yqhs/dart-sdk-dap-testBGWEDP/appTDIQAM/test_file.dart'
      //     Actual: <null>
      //      Which: not an <Instance of 'String'>
      dap = await DapTestSession.setUp(forceVerboseLogging: true);
    });
    tearDown(() => dap.tearDown());

    test('does not pause on exceptions if mode not set', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(simpleThrowingProgram);

      // Run the app and expect it to complete (it should not pause).
      final outputEvents = await client.collectOutput(file: testFile);

      // Expect error info printed to stderr.
      final output = outputEvents
          .where((e) => e.category == 'stderr')
          .map((e) => e.output)
          .join();
      expectLinesStartWith(output, [
        'Unhandled exception:',
        'Exception: error text',
      ]);
    });

    test('pauses on uncaught exceptions when mode=Unhandled', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(simpleThrowingProgram);

      // Run and expect to pause on an exception.
      await client.pauseOnException(
        testFile,
        exceptionPauseMode: 'Unhandled',
        expectText: '_Exception (Exception: error text)',
      );
    });

    test('includes the stack trace in exception text', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(asyncExceptionProgram);

      // Run and expect to pause on an exception.
      final stoppedEvent = await client.pauseOnException(
        testFile,
        exceptionPauseMode: 'Unhandled',
        // No stack trace yet, see comment below.
        expectText: 'UnimplementedError (UnimplementedError: NYI)',
      );

      // When we pause on an exception as it's thrown, we don't have a
      // stackTrace yet (though it is always the same as the current stack).
      // The stack trace is populated later after we've stepped (or been caught
      // further up). Issue a continue and wait for it to break at the next
      // level up before expecting the stack trace.
      client.continue_(stoppedEvent.threadId!);
      final nextStop = await client.expectStop('exception');
      // Now we expect the stack trace where the exception really occurred
      // (which is not where we currently are), so it should include the
      // throwNYI function.
      expect(
          nextStop.text?.split('\n'),
          containsAllInOrder([
            'UnimplementedError (UnimplementedError: NYI)',
            matches(r'^#0\s* inner'),
            matches(r'^#1\s* outer'),
            matches(r'^#2\s* main'),
          ]));
    });

    test('does not pauses on caught exceptions when mode=Unhandled', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(simpleCaughtErrorProgram);

      // Run the app and expect it to complete (it should not pause).
      final outputEvents = await client.collectOutput(file: testFile);

      // Expect error info sent to stdout via `print()`.
      final output = outputEvents
          .where((e) => e.category == 'stdout')
          .map((e) => e.output)
          .join();
      expectLines(output, ['Caught!']);
    });

    test('pauses on caught exceptions when mode=All', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(simpleCaughtErrorProgram);

      // Run and expect to pause on an exception.
      await client.pauseOnException(
        testFile,
        exceptionPauseMode: 'All',
      );
    });

    test('parses line/column information from stack traces', () async {
      final client = dap.client;
      final testFile = dap.createTestFile(simpleThrowingProgram);
      final exceptionLine = lineWith(testFile, 'throw');
      final outputEvents = await client.collectOutput(file: testFile);

      // Find the output event for the top of the printed stack trace.
      // It should look something like:
      // #0      main (file:///var/folders/[...]/app3JZLvu/test_file.dart:2:5)
      final mainStackFrameEvent = outputEvents
          .firstWhere((event) => event.output.startsWith('#0      main'));

      // Expect that there is metadata attached that matches the file/location we
      // expect.
      expect(
        mainStackFrameEvent.source?.path,
        uppercaseDriveLetter(testFile.path),
      );
      expect(mainStackFrameEvent.line, exceptionLine);
      expect(mainStackFrameEvent.column, 5);
    });
    // These tests can be slow due to starting up the external server process.
  }, timeout: Timeout.none);
}