attach_test.dart 51.4 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';

7
import 'package:file/memory.dart';
8
import 'package:flutter_tools/src/android/android_device.dart';
9
import 'package:flutter_tools/src/application_package.dart';
10
import 'package:flutter_tools/src/artifacts.dart';
11
import 'package:flutter_tools/src/base/common.dart';
12
import 'package:flutter_tools/src/base/dds.dart';
13
import 'package:flutter_tools/src/base/file_system.dart';
14
import 'package:flutter_tools/src/base/io.dart';
15
import 'package:flutter_tools/src/base/logger.dart';
16 17
import 'package:flutter_tools/src/base/platform.dart';
import 'package:flutter_tools/src/base/signals.dart';
18
import 'package:flutter_tools/src/base/terminal.dart';
19
import 'package:flutter_tools/src/build_info.dart';
20 21 22
import 'package:flutter_tools/src/cache.dart';
import 'package:flutter_tools/src/commands/attach.dart';
import 'package:flutter_tools/src/device.dart';
23
import 'package:flutter_tools/src/device_port_forwarder.dart';
24
import 'package:flutter_tools/src/ios/application_package.dart';
25
import 'package:flutter_tools/src/ios/devices.dart';
26
import 'package:flutter_tools/src/macos/macos_ipad_device.dart';
27
import 'package:flutter_tools/src/mdns_discovery.dart';
28
import 'package:flutter_tools/src/project.dart';
29
import 'package:flutter_tools/src/reporting/reporting.dart';
30
import 'package:flutter_tools/src/resident_runner.dart';
31
import 'package:flutter_tools/src/run_hot.dart';
32
import 'package:flutter_tools/src/vmservice.dart';
33
import 'package:multicast_dns/multicast_dns.dart';
34
import 'package:test/fake.dart';
35
import 'package:vm_service/vm_service.dart' as vm_service;
36

37 38
import '../../src/common.dart';
import '../../src/context.dart';
39
import '../../src/fake_devices.dart';
40
import '../../src/test_flutter_command_runner.dart';
41

42 43 44 45 46 47 48 49 50 51
class FakeStdio extends Fake implements Stdio {
  @override
  bool stdinHasTerminal = false;
}

class FakeProcessInfo extends Fake implements ProcessInfo {
  @override
  int maxRss = 0;
}

52
void main() {
53 54 55 56
  tearDown(() {
    MacOSDesignedForIPadDevices.allowDiscovery = false;
  });

57
  group('attach', () {
58 59
    late StreamLogger logger;
    late FileSystem testFileSystem;
60
    late TestDeviceManager testDeviceManager;
61 62 63 64 65 66
    late Artifacts artifacts;
    late Stdio stdio;
    late Terminal terminal;
    late Signals signals;
    late Platform platform;
    late ProcessInfo processInfo;
67

68
    setUp(() {
69
      Cache.disableLocking();
70
      logger = StreamLogger();
71 72
      platform = FakePlatform();
      testFileSystem = MemoryFileSystem.test();
73
      testFileSystem.directory('lib').createSync();
74
      testFileSystem.file(testFileSystem.path.join('lib', 'main.dart')).createSync();
75 76 77 78 79
      artifacts = Artifacts.test();
      stdio = FakeStdio();
      terminal = FakeTerminal();
      signals = Signals.test();
      processInfo = FakeProcessInfo();
80
      testDeviceManager = TestDeviceManager(logger: BufferLogger.test());
81 82
    });

83
    group('with one device and no specified target file', () {
84 85
      const int devicePort = 499;
      const int hostPort = 42;
86
      final int future = DateTime.now().add(const Duration(days: 1)).millisecondsSinceEpoch;
87

88 89 90 91
      late FakeDeviceLogReader fakeLogReader;
      late RecordingPortForwarder portForwarder;
      late FakeDartDevelopmentService fakeDds;
      late FakeAndroidDevice device;
92 93

      setUp(() {
94
        fakeLogReader = FakeDeviceLogReader();
95
        portForwarder = RecordingPortForwarder(hostPort);
96
        fakeDds = FakeDartDevelopmentService();
97 98 99
        device = FakeAndroidDevice(id: '1')
          ..portForwarder = portForwarder
          ..dds = fakeDds;
100 101
      });

102
      tearDown(() {
103
        fakeLogReader.dispose();
104
      });
105

106
      testUsingContext('succeeds with iOS device with protocol discovery', () async {
107 108 109
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
110
          majorSdkVersion: 12,
111 112 113 114 115 116
          onGetLogReader: () {
            fakeLogReader.addLine('Foo');
            fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
            return fakeLogReader;
          },
        );
117
        testDeviceManager.devices = <Device>[device];
118 119
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
120 121
          if (message == '[verbose] VM Service URL on device: http://127.0.0.1:$devicePort') {
            // The "VM Service URL on device" message is output by the ProtocolDiscovery when it found the VM Service.
122 123 124
            completer.complete();
          }
        });
125 126 127 128 129 130 131 132
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
133
        hotRunner.isWaitingForVmService = false;
134 135 136 137 138
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
139 140 141 142 143 144 145 146 147
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach']);
148 149 150 151 152 153 154 155 156 157 158
        await completer.future;

        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);

        await fakeLogReader.dispose();
        await loggerSubscription.cancel();
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
159
        DeviceManager: () => testDeviceManager,
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
        MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
          mdnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
          preliminaryMDnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
          logger: logger,
          flutterUsage: TestUsage(),
        ),
      });

      testUsingContext('succeeds with iOS device with mDNS', () async {
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
          majorSdkVersion: 16,
          onGetLogReader: () {
            fakeLogReader.addLine('Foo');
            fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
            return fakeLogReader;
          },
        );
        testDeviceManager.devices = <Device>[device];
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
188
        hotRunner.isWaitingForVmService = false;
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach']);
        await fakeLogReader.dispose();

        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);
        expect(hotRunnerFactory.devices, hasLength(1));
        final FlutterDevice flutterDevice = hotRunnerFactory.devices.first;
209 210
        final Uri? vmServiceUri = await flutterDevice.vmServiceUris?.first;
        expect(vmServiceUri.toString(), 'http://127.0.0.1:$hostPort/xyz/');
211 212 213 214 215 216
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
        DeviceManager: () => testDeviceManager,
        MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
217
          mdnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
          preliminaryMDnsClient: FakeMDnsClient(
            <PtrResourceRecord>[
              PtrResourceRecord('foo', future, domainName: 'bar'),
            ],
            <String, List<SrvResourceRecord>>{
              'bar': <SrvResourceRecord>[
                SrvResourceRecord('bar', future, port: devicePort, weight: 1, priority: 1, target: 'appId'),
              ],
            },
            txtResponse: <String, List<TxtResourceRecord>>{
              'bar': <TxtResourceRecord>[
                TxtResourceRecord('bar', future, text: 'authCode=xyz\n'),
              ],
            },
          ),
          logger: logger,
          flutterUsage: TestUsage(),
        ),
      });

238
      testUsingContext('succeeds with iOS device with mDNS wireless device', () async {
239 240 241 242
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
          majorSdkVersion: 16,
243
          connectionInterface: DeviceConnectionInterface.wireless,
244 245 246 247 248 249 250 251 252 253
        );
        testDeviceManager.devices = <Device>[device];
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
254
        hotRunner.isWaitingForVmService = false;
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach']);
        await fakeLogReader.dispose();

        expect(portForwarder.devicePort, null);
        expect(portForwarder.hostPort, hostPort);
        expect(hotRunnerFactory.devices, hasLength(1));

        final FlutterDevice flutterDevice = hotRunnerFactory.devices.first;
276 277
        final Uri? vmServiceUri = await flutterDevice.vmServiceUris?.first;
        expect(vmServiceUri.toString(), 'http://111.111.111.111:123/xyz/');
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
        DeviceManager: () => testDeviceManager,
        MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
          mdnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
          preliminaryMDnsClient: FakeMDnsClient(
            <PtrResourceRecord>[
              PtrResourceRecord('foo', future, domainName: 'srv-foo'),
            ],
            <String, List<SrvResourceRecord>>{
              'srv-foo': <SrvResourceRecord>[
                SrvResourceRecord('srv-foo', future, port: 123, weight: 1, priority: 1, target: 'target-foo'),
              ],
            },
            ipResponse: <String, List<IPAddressResourceRecord>>{
              'target-foo': <IPAddressResourceRecord>[
                IPAddressResourceRecord('target-foo', 0, address: InternetAddress.tryParse('111.111.111.111')!),
              ],
            },
            txtResponse: <String, List<TxtResourceRecord>>{
              'srv-foo': <TxtResourceRecord>[
                TxtResourceRecord('srv-foo', future, text: 'authCode=xyz\n'),
              ],
            },
          ),
          logger: logger,
          flutterUsage: TestUsage(),
        ),
      });

310
      testUsingContext('succeeds with iOS device with mDNS wireless device with debug-port', () async {
311 312 313 314
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
          majorSdkVersion: 16,
315
          connectionInterface: DeviceConnectionInterface.wireless,
316 317 318 319 320 321 322 323 324 325
        );
        testDeviceManager.devices = <Device>[device];
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
326
        hotRunner.isWaitingForVmService = false;
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach', '--debug-port', '123']);
        await fakeLogReader.dispose();

        expect(portForwarder.devicePort, null);
        expect(portForwarder.hostPort, hostPort);
        expect(hotRunnerFactory.devices, hasLength(1));

        final FlutterDevice flutterDevice = hotRunnerFactory.devices.first;
348 349
        final Uri? vmServiceUri = await flutterDevice.vmServiceUris?.first;
        expect(vmServiceUri.toString(), 'http://111.111.111.111:123/xyz/');
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
        DeviceManager: () => testDeviceManager,
        MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
          mdnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
          preliminaryMDnsClient: FakeMDnsClient(
            <PtrResourceRecord>[
              PtrResourceRecord('bar', future, domainName: 'srv-bar'),
              PtrResourceRecord('foo', future, domainName: 'srv-foo'),
            ],
            <String, List<SrvResourceRecord>>{
              'srv-bar': <SrvResourceRecord>[
                SrvResourceRecord('srv-bar', future, port: 321, weight: 1, priority: 1, target: 'target-bar'),
              ],
              'srv-foo': <SrvResourceRecord>[
                SrvResourceRecord('srv-foo', future, port: 123, weight: 1, priority: 1, target: 'target-foo'),
              ],
            },
            ipResponse: <String, List<IPAddressResourceRecord>>{
              'target-foo': <IPAddressResourceRecord>[
                IPAddressResourceRecord('target-foo', 0, address: InternetAddress.tryParse('111.111.111.111')!),
              ],
            },
            txtResponse: <String, List<TxtResourceRecord>>{
              'srv-foo': <TxtResourceRecord>[
                TxtResourceRecord('srv-foo', future, text: 'authCode=xyz\n'),
              ],
            },
          ),
          logger: logger,
          flutterUsage: TestUsage(),
        ),
      });

386
      testUsingContext('succeeds with iOS device with mDNS wireless device with debug-url', () async {
387 388 389 390
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
          majorSdkVersion: 16,
391
          connectionInterface: DeviceConnectionInterface.wireless,
392 393 394 395 396 397 398 399 400 401
        );
        testDeviceManager.devices = <Device>[device];
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
402
        hotRunner.isWaitingForVmService = false;
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach', '--debug-url', 'https://0.0.0.0:123']);
        await fakeLogReader.dispose();

        expect(portForwarder.devicePort, null);
        expect(portForwarder.hostPort, hostPort);
        expect(hotRunnerFactory.devices, hasLength(1));

        final FlutterDevice flutterDevice = hotRunnerFactory.devices.first;
424 425
        final Uri? vmServiceUri = await flutterDevice.vmServiceUris?.first;
        expect(vmServiceUri.toString(), 'http://111.111.111.111:123/xyz/');
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
        DeviceManager: () => testDeviceManager,
        MDnsVmServiceDiscovery: () => MDnsVmServiceDiscovery(
          mdnsClient: FakeMDnsClient(<PtrResourceRecord>[], <String, List<SrvResourceRecord>>{}),
          preliminaryMDnsClient: FakeMDnsClient(
            <PtrResourceRecord>[
              PtrResourceRecord('bar', future, domainName: 'srv-bar'),
              PtrResourceRecord('foo', future, domainName: 'srv-foo'),
            ],
            <String, List<SrvResourceRecord>>{
              'srv-bar': <SrvResourceRecord>[
                SrvResourceRecord('srv-bar', future, port: 321, weight: 1, priority: 1, target: 'target-bar'),
              ],
              'srv-foo': <SrvResourceRecord>[
                SrvResourceRecord('srv-foo', future, port: 123, weight: 1, priority: 1, target: 'target-foo'),
              ],
            },
            ipResponse: <String, List<IPAddressResourceRecord>>{
              'target-foo': <IPAddressResourceRecord>[
                IPAddressResourceRecord('target-foo', 0, address: InternetAddress.tryParse('111.111.111.111')!),
              ],
            },
            txtResponse: <String, List<TxtResourceRecord>>{
              'srv-foo': <TxtResourceRecord>[
                TxtResourceRecord('srv-foo', future, text: 'authCode=xyz\n'),
              ],
            },
          ),
457 458 459 460 461
          logger: logger,
          flutterUsage: TestUsage(),
        ),
      });

462
      testUsingContext('finds VM Service port and forwards', () async {
463 464
        device.onGetLogReader = () {
          fakeLogReader.addLine('Foo');
465
          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
466 467
          return fakeLogReader;
        };
468
        testDeviceManager.devices = <Device>[device];
469 470
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
471 472
          if (message == '[verbose] VM Service URL on device: http://127.0.0.1:$devicePort') {
            // The "VM Service URL on device" message is output by the ProtocolDiscovery when it found the VM Service.
473 474 475
            completer.complete();
          }
        });
476 477 478 479 480 481 482 483 484 485
        final Future<void> task = createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach']);
486
        await completer.future;
487 488 489 490

        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);

491
        await fakeLogReader.dispose();
492 493
        await expectLoggerInterruptEndsTask(task, logger);
        await loggerSubscription.cancel();
494 495
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
496
        ProcessManager: () => FakeProcessManager.any(),
497
        Logger: () => logger,
498
        DeviceManager: () => testDeviceManager,
499 500
      });

501
      testUsingContext('Fails with tool exit on bad VmService uri', () async {
502 503
        device.onGetLogReader = () {
          fakeLogReader.addLine('Foo');
504
          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
505 506 507
          fakeLogReader.dispose();
          return fakeLogReader;
        };
508
        testDeviceManager.devices = <Device>[device];
509 510 511 512 513 514 515 516 517 518
        expect(() => createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach']), throwsToolExit());
519 520
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
521
        ProcessManager: () => FakeProcessManager.any(),
522
        Logger: () => logger,
523
        DeviceManager: () => testDeviceManager,
524 525
      });

526
      testUsingContext('accepts filesystem parameters', () async {
527 528
        device.onGetLogReader = () {
          fakeLogReader.addLine('Foo');
529
          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
530 531
          return fakeLogReader;
        };
532
        testDeviceManager.devices = <Device>[device];
533 534 535 536 537 538

        const String filesystemScheme = 'foo';
        const String filesystemRoot = '/build-output/';
        const String projectRoot = '/build-output/project-root';
        const String outputDill = '/tmp/output.dill';

539 540
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
541 542
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
543 544 545 546
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
547
        hotRunner.isWaitingForVmService = false;
548 549 550

        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;
551

552
        final AttachCommand command = AttachCommand(
553
          hotRunnerFactory: hotRunnerFactory,
554 555 556 557 558 559 560 561
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
562 563 564 565 566 567 568 569 570 571 572
        );
        await createTestCommandRunner(command).run(<String>[
          'attach',
          '--filesystem-scheme',
          filesystemScheme,
          '--filesystem-root',
          filesystemRoot,
          '--project-root',
          projectRoot,
          '--output-dill',
          outputDill,
573
          '-v', // enables verbose logging
574 575
        ]);

576
        // Validate the attach call built a fake runner with the right
577
        // project root and output dill.
578 579 580
        expect(hotRunnerFactory.projectRootPath, projectRoot);
        expect(hotRunnerFactory.dillOutputPath, outputDill);
        expect(hotRunnerFactory.devices, hasLength(1));
581 582 583

        // Validate that the attach call built a flutter device with the right
        // output dill, filesystem scheme, and filesystem root.
584
        final FlutterDevice flutterDevice = hotRunnerFactory.devices.first;
585

586 587
        expect(flutterDevice.buildInfo.fileSystemScheme, filesystemScheme);
        expect(flutterDevice.buildInfo.fileSystemRoots, const <String>[filesystemRoot]);
588 589
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
590
        ProcessManager: () => FakeProcessManager.any(),
591
        DeviceManager: () => testDeviceManager,
592
      });
593

594
      testUsingContext('exits when ipv6 is specified and debug-port is not on non-iOS device', () async {
595
        testDeviceManager.devices = <Device>[device];
596

597 598 599 600 601 602 603 604 605 606
        final AttachCommand command = AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        );
607 608 609
        await expectLater(
          createTestCommandRunner(command).run(<String>['attach', '--ipv6']),
          throwsToolExit(
610
            message: 'When the --debug-port or --debug-url is unknown, this command determines '
611 612 613 614 615
                     'the value of --ipv6 on its own.',
          ),
        );
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
616
        ProcessManager: () => FakeProcessManager.any(),
617
        DeviceManager: () => testDeviceManager,
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
      });

      testUsingContext('succeeds when ipv6 is specified and debug-port is not on iOS device', () async {
        final FakeIOSDevice device = FakeIOSDevice(
          logReader: fakeLogReader,
          portForwarder: portForwarder,
          majorSdkVersion: 12,
          onGetLogReader: () {
            fakeLogReader.addLine('Foo');
            fakeLogReader.addLine('The Dart VM service is listening on http://[::1]:$devicePort');
            return fakeLogReader;
          },
        );
        testDeviceManager.devices = <Device>[device];
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
          if (message == '[verbose] VM Service URL on device: http://[::1]:$devicePort') {
            // The "VM Service URL on device" message is output by the ProtocolDiscovery when it found the VM Service.
            completer.complete();
          }
        });
        final FakeHotRunner hotRunner = FakeHotRunner();
        hotRunner.onAttach = (
          Completer<DebugConnectionInfo>? connectionInfoCompleter,
          Completer<void>? appStartedCompleter,
          bool allowExistingDdsInstance,
          bool enableDevTools,
        ) async => 0;
        hotRunner.exited = false;
        hotRunner.isWaitingForVmService = false;
        final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
          ..hotRunner = hotRunner;

        await createTestCommandRunner(AttachCommand(
          hotRunnerFactory: hotRunnerFactory,
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(<String>['attach', '--ipv6']);
        await completer.future;

        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);

        await fakeLogReader.dispose();
        await loggerSubscription.cancel();
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
        ProcessManager: () => FakeProcessManager.any(),
        Logger: () => logger,
        DeviceManager: () => testDeviceManager,
      });
675

676
      testUsingContext('exits when vm-service-port is specified and debug-port is not', () async {
677 678
        device.onGetLogReader = () {
          fakeLogReader.addLine('Foo');
679
          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
680 681
          return fakeLogReader;
        };
682
        testDeviceManager.devices = <Device>[device];
683

684 685 686 687 688 689 690 691 692 693
        final AttachCommand command = AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        );
694
        await expectLater(
695
          createTestCommandRunner(command).run(<String>['attach', '--vm-service-port', '100']),
696
          throwsToolExit(
697
            message: 'When the --debug-port or --debug-url is unknown, this command does not use '
698
                     'the value of --vm-service-port.',
699 700 701 702
          ),
        );
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
703
        ProcessManager: () => FakeProcessManager.any(),
704
        DeviceManager: () => testDeviceManager,
705
      },);
706
    });
707

708
    group('forwarding to given port', () {
709 710
      const int devicePort = 499;
      const int hostPort = 42;
711 712
      late RecordingPortForwarder portForwarder;
      late FakeAndroidDevice device;
713

714
      setUp(() {
715
        final FakeDartDevelopmentService fakeDds = FakeDartDevelopmentService();
716 717 718 719
        portForwarder = RecordingPortForwarder(hostPort);
        device = FakeAndroidDevice(id: '1')
          ..portForwarder = portForwarder
          ..dds = fakeDds;
720
      });
721

722
      testUsingContext('succeeds in ipv4 mode', () async {
723
        testDeviceManager.devices = <Device>[device];
724

725 726 727 728 729 730 731 732
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
          if (message == '[verbose] Connecting to service protocol: http://127.0.0.1:42/') {
            // Wait until resident_runner.dart tries to connect.
            // There's nothing to connect _to_, so that's as far as we care to go.
            completer.complete();
          }
        });
733 734 735 736 737 738 739 740 741 742
        final Future<void> task = createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        ))
743 744
          .run(<String>['attach', '--debug-port', '$devicePort']);
        await completer.future;
745 746
        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);
747 748 749

        await expectLoggerInterruptEndsTask(task, logger);
        await loggerSubscription.cancel();
750 751
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
752
        ProcessManager: () => FakeProcessManager.any(),
753
        Logger: () => logger,
754
        DeviceManager: () => testDeviceManager,
755 756 757
      });

      testUsingContext('succeeds in ipv6 mode', () async {
758
        testDeviceManager.devices = <Device>[device];
759

760 761 762 763 764 765 766 767
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
          if (message == '[verbose] Connecting to service protocol: http://[::1]:42/') {
            // Wait until resident_runner.dart tries to connect.
            // There's nothing to connect _to_, so that's as far as we care to go.
            completer.complete();
          }
        });
768 769 770 771 772 773 774 775 776 777
        final Future<void> task = createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        ))
778 779
          .run(<String>['attach', '--debug-port', '$devicePort', '--ipv6']);
        await completer.future;
780 781 782

        expect(portForwarder.devicePort, devicePort);
        expect(portForwarder.hostPort, hostPort);
783 784 785

        await expectLoggerInterruptEndsTask(task, logger);
        await loggerSubscription.cancel();
786 787
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
788
        ProcessManager: () => FakeProcessManager.any(),
789
        Logger: () => logger,
790
        DeviceManager: () => testDeviceManager,
791 792
      });

793
      testUsingContext('skips in ipv4 mode with a provided VM Service port', () async {
794
        testDeviceManager.devices = <Device>[device];
795

796 797 798 799 800 801 802 803
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
          if (message == '[verbose] Connecting to service protocol: http://127.0.0.1:42/') {
            // Wait until resident_runner.dart tries to connect.
            // There's nothing to connect _to_, so that's as far as we care to go.
            completer.complete();
          }
        });
804 805 806 807 808 809 810 811 812 813
        final Future<void> task = createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(
814 815 816 817
          <String>[
            'attach',
            '--debug-port',
            '$devicePort',
818
            '--vm-service-port',
819
            '$hostPort',
820 821 822
            // Ensure DDS doesn't use hostPort by binding to a random port.
            '--dds-port',
            '0',
823
          ],
824
        );
825
        await completer.future;
826 827
        expect(portForwarder.devicePort, null);
        expect(portForwarder.hostPort, 42);
828 829 830

        await expectLoggerInterruptEndsTask(task, logger);
        await loggerSubscription.cancel();
831 832
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
833
        ProcessManager: () => FakeProcessManager.any(),
834
        Logger: () => logger,
835
        DeviceManager: () => testDeviceManager,
836 837
      });

838
      testUsingContext('skips in ipv6 mode with a provided VM Service port', () async {
839
        testDeviceManager.devices = <Device>[device];
840

841 842 843 844 845 846 847 848
        final Completer<void> completer = Completer<void>();
        final StreamSubscription<String> loggerSubscription = logger.stream.listen((String message) {
          if (message == '[verbose] Connecting to service protocol: http://[::1]:42/') {
            // Wait until resident_runner.dart tries to connect.
            // There's nothing to connect _to_, so that's as far as we care to go.
            completer.complete();
          }
        });
849 850 851 852 853 854 855 856 857 858
        final Future<void> task = createTestCommandRunner(AttachCommand(
          artifacts: artifacts,
          stdio: stdio,
          logger: logger,
          terminal: terminal,
          signals: signals,
          platform: platform,
          processInfo: processInfo,
          fileSystem: testFileSystem,
        )).run(
859 860 861 862
          <String>[
            'attach',
            '--debug-port',
            '$devicePort',
863
            '--vm-service-port',
864 865
            '$hostPort',
            '--ipv6',
866 867 868
            // Ensure DDS doesn't use hostPort by binding to a random port.
            '--dds-port',
            '0',
869
          ],
870
        );
871
        await completer.future;
872 873
        expect(portForwarder.devicePort, null);
        expect(portForwarder.hostPort, 42);
874 875 876

        await expectLoggerInterruptEndsTask(task, logger);
        await loggerSubscription.cancel();
877 878
      }, overrides: <Type, Generator>{
        FileSystem: () => testFileSystem,
879
        ProcessManager: () => FakeProcessManager.any(),
880
        Logger: () => logger,
881
        DeviceManager: () => testDeviceManager,
882 883
      });
    });
884 885

    testUsingContext('exits when no device connected', () async {
886 887 888 889 890 891 892 893 894 895
      final AttachCommand command = AttachCommand(
        artifacts: artifacts,
        stdio: stdio,
        logger: logger,
        terminal: terminal,
        signals: signals,
        platform: platform,
        processInfo: processInfo,
        fileSystem: testFileSystem,
      );
896 897
      await expectLater(
        createTestCommandRunner(command).run(<String>['attach']),
Dan Field's avatar
Dan Field committed
898
        throwsToolExit(),
899
      );
900
      expect(testLogger.statusText, containsIgnoringWhitespace('No supported devices connected'));
901 902
    }, overrides: <Type, Generator>{
      FileSystem: () => testFileSystem,
903
      ProcessManager: () => FakeProcessManager.any(),
904
      DeviceManager: () => testDeviceManager,
905
    });
906

907
    testUsingContext('fails when targeted device is not Android with --device-user', () async {
908
      final FakeIOSDevice device = FakeIOSDevice();
909
      testDeviceManager.devices = <Device>[device];
910 911 912 913 914 915 916 917 918 919
      expect(createTestCommandRunner(AttachCommand(
        artifacts: artifacts,
        stdio: stdio,
        logger: logger,
        terminal: terminal,
        signals: signals,
        platform: platform,
        processInfo: processInfo,
        fileSystem: testFileSystem,
      )).run(<String>[
920 921 922 923 924 925 926
        'attach',
        '--device-user',
        '10',
      ]), throwsToolExit(message: '--device-user is only supported for Android'));
    }, overrides: <Type, Generator>{
      FileSystem: () => testFileSystem,
      ProcessManager: () => FakeProcessManager.any(),
927
      DeviceManager: () => testDeviceManager,
928 929
    });

930
    testUsingContext('exits when multiple devices connected', () async {
931 932 933 934 935 936 937 938 939 940
      final AttachCommand command = AttachCommand(
        artifacts: artifacts,
        stdio: stdio,
        logger: logger,
        terminal: terminal,
        signals: signals,
        platform: platform,
        processInfo: processInfo,
        fileSystem: testFileSystem,
      );
941 942 943 944
      testDeviceManager.devices = <Device>[
        FakeAndroidDevice(id: 'xx1'),
        FakeAndroidDevice(id: 'yy2'),
      ];
945 946
      await expectLater(
        createTestCommandRunner(command).run(<String>['attach']),
Dan Field's avatar
Dan Field committed
947
        throwsToolExit(),
948
      );
949
      expect(testLogger.statusText, containsIgnoringWhitespace('More than one device'));
950 951
      expect(testLogger.statusText, contains('xx1'));
      expect(testLogger.statusText, contains('yy2'));
952
      expect(MacOSDesignedForIPadDevices.allowDiscovery, isTrue);
953 954
    }, overrides: <Type, Generator>{
      FileSystem: () => testFileSystem,
955
      ProcessManager: () => FakeProcessManager.any(),
956 957
      DeviceManager: () => testDeviceManager,
      AnsiTerminal: () => FakeTerminal(stdinHasTerminal: false),
958
    });
959 960

    testUsingContext('Catches service disappeared error', () async {
961 962 963 964 965 966 967
      final FakeAndroidDevice device = FakeAndroidDevice(id: '1')
        ..portForwarder = const NoOpDevicePortForwarder()
        ..onGetLogReader = () => NoOpDeviceLogReader('test');
      final FakeHotRunner hotRunner = FakeHotRunner();
      final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
        ..hotRunner = hotRunner;
      hotRunner.onAttach = (
968 969
        Completer<DebugConnectionInfo>? connectionInfoCompleter,
        Completer<void>? appStartedCompleter,
970 971 972
        bool allowExistingDdsInstance,
        bool enableDevTools,
      ) async {
973 974
        await null;
        throw vm_service.RPCError('flutter._listViews', RPCErrorCodes.kServiceDisappeared, '');
975
      };
976

977
      testDeviceManager.devices = <Device>[device];
978 979
      testFileSystem.file('lib/main.dart').createSync();

980 981 982 983 984 985 986 987 988 989 990
      final AttachCommand command = AttachCommand(
        hotRunnerFactory: hotRunnerFactory,
        artifacts: artifacts,
        stdio: stdio,
        logger: logger,
        terminal: terminal,
        signals: signals,
        platform: platform,
        processInfo: processInfo,
        fileSystem: testFileSystem,
      );
991 992 993 994 995 996
      await expectLater(createTestCommandRunner(command).run(<String>[
        'attach',
      ]), throwsToolExit(message: 'Lost connection to device.'));
    }, overrides: <Type, Generator>{
      FileSystem: () => testFileSystem,
      ProcessManager: () => FakeProcessManager.any(),
997
      DeviceManager: () => testDeviceManager,
998 999 1000
    });

    testUsingContext('Does not catch generic RPC error', () async {
1001 1002 1003 1004 1005 1006 1007 1008
      final FakeAndroidDevice device = FakeAndroidDevice(id: '1')
        ..portForwarder = const NoOpDevicePortForwarder()
        ..onGetLogReader = () => NoOpDeviceLogReader('test');
      final FakeHotRunner hotRunner = FakeHotRunner();
      final FakeHotRunnerFactory hotRunnerFactory = FakeHotRunnerFactory()
        ..hotRunner = hotRunner;

      hotRunner.onAttach = (
1009 1010
        Completer<DebugConnectionInfo>? connectionInfoCompleter,
        Completer<void>? appStartedCompleter,
1011 1012 1013
        bool allowExistingDdsInstance,
        bool enableDevTools,
      ) async {
1014 1015
        await null;
        throw vm_service.RPCError('flutter._listViews', RPCErrorCodes.kInvalidParams, '');
1016 1017
      };

1018
      testDeviceManager.devices = <Device>[device];
1019 1020
      testFileSystem.file('lib/main.dart').createSync();

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
      final AttachCommand command = AttachCommand(
        hotRunnerFactory: hotRunnerFactory,
        artifacts: artifacts,
        stdio: stdio,
        logger: logger,
        terminal: terminal,
        signals: signals,
        platform: platform,
        processInfo: processInfo,
        fileSystem: testFileSystem,
      );
1032 1033 1034 1035 1036 1037
      await expectLater(createTestCommandRunner(command).run(<String>[
        'attach',
      ]), throwsA(isA<vm_service.RPCError>()));
    }, overrides: <Type, Generator>{
      FileSystem: () => testFileSystem,
      ProcessManager: () => FakeProcessManager.any(),
1038
      DeviceManager: () => testDeviceManager,
1039
    });
1040 1041 1042
  });
}

1043
class FakeHotRunner extends Fake implements HotRunner {
1044
  late Future<int> Function(Completer<DebugConnectionInfo>?, Completer<void>?, bool, bool) onAttach;
1045 1046 1047 1048 1049

  @override
  bool exited = false;

  @override
1050
  bool isWaitingForVmService = true;
1051 1052 1053

  @override
  Future<int> attach({
1054 1055
    Completer<DebugConnectionInfo>? connectionInfoCompleter,
    Completer<void>? appStartedCompleter,
1056 1057
    bool allowExistingDdsInstance = false,
    bool enableDevTools = false,
1058
    bool needsFullRestart = true,
1059 1060 1061 1062 1063 1064
  }) {
    return onAttach(connectionInfoCompleter, appStartedCompleter, allowExistingDdsInstance, enableDevTools);
  }
}

class FakeHotRunnerFactory extends Fake implements HotRunnerFactory {
1065 1066 1067 1068
  late HotRunner hotRunner;
  String? dillOutputPath;
  String? projectRootPath;
  late List<FlutterDevice> devices;
1069 1070 1071 1072

  @override
  HotRunner build(
    List<FlutterDevice> devices, {
1073 1074
    required String target,
    required DebuggingOptions debuggingOptions,
1075
    bool benchmarkMode = false,
1076
    File? applicationBinary,
1077
    bool hostIsIde = false,
1078 1079 1080
    String? projectRootPath,
    String? packagesFilePath,
    String? dillOutputPath,
1081 1082
    bool stayResident = true,
    bool ipv6 = false,
1083
    FlutterProject? flutterProject,
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
  }) {
    this.devices = devices;
    this.dillOutputPath = dillOutputPath;
    this.projectRootPath = projectRootPath;
    return hotRunner;
  }
}

class RecordingPortForwarder implements DevicePortForwarder {
  RecordingPortForwarder([this.hostPort]);

1095 1096
  int? devicePort;
  int? hostPort;
1097 1098 1099 1100 1101

  @override
  Future<void> dispose() async { }

  @override
1102
  Future<int> forward(int devicePort, {int? hostPort}) async {
1103 1104
    this.devicePort = devicePort;
    this.hostPort ??= hostPort;
1105
    return this.hostPort!;
1106 1107 1108 1109 1110 1111 1112 1113
  }

  @override
  List<ForwardedPort> get forwardedPorts => <ForwardedPort>[];

  @override
  Future<void> unforward(ForwardedPort forwardedPort) async { }
}
1114 1115 1116 1117 1118 1119 1120 1121

class StreamLogger extends Logger {
  @override
  bool get isVerbose => true;

  @override
  void printError(
    String message, {
1122 1123 1124 1125 1126 1127
    StackTrace? stackTrace,
    bool? emphasis,
    TerminalColor? color,
    int? indent,
    int? hangingIndent,
    bool? wrap,
1128
  }) {
1129 1130 1131 1132 1133 1134 1135
    hadErrorOutput = true;
    _log('[stderr] $message');
  }

  @override
  void printWarning(
    String message, {
1136 1137 1138 1139 1140
    bool? emphasis,
    TerminalColor? color,
    int? indent,
    int? hangingIndent,
    bool? wrap,
1141 1142
  }) {
    hadWarningOutput = true;
1143 1144 1145 1146 1147 1148
    _log('[stderr] $message');
  }

  @override
  void printStatus(
    String message, {
1149 1150 1151 1152 1153 1154
    bool? emphasis,
    TerminalColor? color,
    bool? newline,
    int? indent,
    int? hangingIndent,
    bool? wrap,
1155 1156 1157 1158
  }) {
    _log('[stdout] $message');
  }

1159 1160 1161
  @override
  void printBox(
    String message, {
1162
    String? title,
1163 1164 1165 1166 1167 1168 1169 1170
  }) {
    if (title == null) {
      _log('[stdout] $message');
    } else {
      _log('[stdout] $title: $message');
    }
  }

1171 1172 1173 1174 1175 1176 1177 1178
  @override
  void printTrace(String message) {
    _log('[verbose] $message');
  }

  @override
  Status startProgress(
    String message, {
1179 1180
    Duration? timeout,
    String? progressId,
1181
    bool multilineOutput = false,
1182
    bool includeTiming = true,
1183 1184 1185
    int progressIndicatorPadding = kDefaultStatusPadding,
  }) {
    _log('[progress] $message');
1186 1187 1188
    return SilentStatus(
      stopwatch: Stopwatch(),
    )..start();
1189 1190
  }

1191
  @override
1192
  Status startSpinner({
1193 1194 1195
    VoidCallback? onFinish,
    Duration? timeout,
    SlowWarningCallback? slowWarningCallback,
1196
    TerminalColor? warningColor,
1197
  }) {
1198 1199 1200 1201 1202 1203
    return SilentStatus(
      stopwatch: Stopwatch(),
      onFinish: onFinish,
    )..start();
  }

1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
  bool _interrupt = false;

  void interrupt() {
    _interrupt = true;
  }

  final StreamController<String> _controller = StreamController<String>.broadcast();

  void _log(String message) {
    _controller.add(message);
    if (_interrupt) {
      _interrupt = false;
      throw const LoggerInterrupted();
    }
  }

  Stream<String> get stream => _controller.stream;
1221 1222

  @override
1223
  void sendEvent(String name, [Map<String, dynamic>? args]) { }
1224 1225 1226 1227 1228 1229

  @override
  bool get supportsColor => throw UnimplementedError();

  @override
  bool get hasTerminal => false;
1230 1231

  @override
1232
  void clear() => _log('[stdout] ${terminal.clearScreen()}\n');
1233 1234 1235

  @override
  Terminal get terminal => Terminal.test();
1236 1237 1238 1239 1240 1241 1242 1243
}

class LoggerInterrupted implements Exception {
  const LoggerInterrupted();
}

Future<void> expectLoggerInterruptEndsTask(Future<void> task, StreamLogger logger) async {
  logger.interrupt(); // an exception during the task should cause it to fail...
1244 1245 1246 1247
  await expectLater(
    () => task,
    throwsA(isA<ToolExit>().having((ToolExit error) => error.exitCode, 'exitCode', 2)),
  );
1248
}
1249

1250 1251 1252 1253 1254 1255 1256
class FakeDartDevelopmentService extends Fake implements DartDevelopmentService {
  @override
  Future<void> get done => noopCompleter.future;
  final Completer<void> noopCompleter = Completer<void>();

  @override
  Future<void> startDartDevelopmentService(
1257
    Uri vmServiceUri, {
1258 1259 1260 1261
    required Logger logger,
    int? hostPort,
    bool? ipv6,
    bool? disableServiceAuthCodes,
1262
    bool cacheStartupProfile = false,
1263 1264 1265 1266 1267
  }) async {}

  @override
  Uri get uri => Uri.parse('http://localhost:8181');
}
1268

1269 1270 1271
// Unfortunately Device, despite not being immutable, has an `operator ==`.
// Until we fix that, we have to also ignore related lints here.
// ignore: avoid_implementing_value_types
1272
class FakeAndroidDevice extends Fake implements AndroidDevice {
1273
  FakeAndroidDevice({required this.id});
1274 1275

  @override
1276
  late DartDevelopmentService dds;
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292

  @override
  final String id;

  @override
  String get name => 'd$id';

  @override
  Future<bool> get isLocalEmulator async => false;

  @override
  Future<String> get sdkNameAndVersion async => 'Android 46';

  @override
  Future<String> get targetPlatformDisplayName async => 'android';

1293 1294 1295
  @override
  Future<TargetPlatform> get targetPlatform async => TargetPlatform.android_arm;

1296 1297 1298 1299
  @override
  DeviceConnectionInterface get connectionInterface =>
      DeviceConnectionInterface.attached;

1300 1301 1302
  @override
  bool isSupported() => true;

1303 1304 1305
  @override
  bool get isConnected => true;

1306 1307 1308 1309 1310 1311 1312 1313
  @override
  bool get supportsHotRestart => true;

  @override
  bool get supportsFlutterExit => false;

  @override
  bool isSupportedForProject(FlutterProject flutterProject) => true;
1314 1315

  @override
1316
  DevicePortForwarder? portForwarder;
1317

1318
  DeviceLogReader Function()? onGetLogReader;
1319 1320 1321

  @override
  FutureOr<DeviceLogReader> getLogReader({
1322
    ApplicationPackage? app,
1323 1324
    bool includePastLogs = false,
  }) {
1325 1326 1327 1328 1329 1330
    if (onGetLogReader == null) {
      throw UnimplementedError(
        'Called getLogReader but no onGetLogReader callback was supplied in the constructor to FakeAndroidDevice.',
      );
    }
    return onGetLogReader!();
1331 1332 1333
  }

  @override
1334
  OverrideArtifacts? get artifactOverrides => null;
1335 1336 1337 1338 1339 1340

  @override
  final PlatformType platformType = PlatformType.android;

  @override
  Category get category => Category.mobile;
1341 1342 1343

  @override
  bool get ephemeral => true;
1344
}
1345

1346 1347 1348
// Unfortunately Device, despite not being immutable, has an `operator ==`.
// Until we fix that, we have to also ignore related lints here.
// ignore: avoid_implementing_value_types
1349
class FakeIOSDevice extends Fake implements IOSDevice {
1350 1351 1352 1353
  FakeIOSDevice({
    DevicePortForwarder? portForwarder,
    DeviceLogReader? logReader,
    this.onGetLogReader,
1354
    this.connectionInterface = DeviceConnectionInterface.attached,
1355
    this.majorSdkVersion = 0,
1356 1357 1358
  }) : _portForwarder = portForwarder, _logReader = logReader;

  final DevicePortForwarder? _portForwarder;
1359 1360 1361 1362
  @override
  int majorSdkVersion;

  @override
1363 1364 1365 1366 1367
  final DeviceConnectionInterface connectionInterface;

  @override
  bool get isWirelesslyConnected =>
      connectionInterface == DeviceConnectionInterface.wireless;
1368 1369

  @override
1370
  DevicePortForwarder get portForwarder => _portForwarder!;
1371 1372

  @override
1373
  DartDevelopmentService get dds => throw UnimplementedError('getter dds not implemented');
1374

1375 1376 1377 1378
  final DeviceLogReader? _logReader;
  DeviceLogReader get logReader => _logReader!;

  final DeviceLogReader Function()? onGetLogReader;
1379 1380 1381

  @override
  DeviceLogReader getLogReader({
1382
    IOSApp? app,
1383
    bool includePastLogs = false,
1384 1385 1386 1387 1388 1389 1390 1391
  }) {
    if (onGetLogReader == null) {
      throw UnimplementedError(
        'Called getLogReader but no onGetLogReader callback was supplied in the constructor to FakeIOSDevice',
      );
    }
    return onGetLogReader!();
  }
1392 1393

  @override
1394
  OverrideArtifacts? get artifactOverrides => null;
1395 1396 1397 1398 1399 1400 1401 1402 1403

  @override
  final String name = 'name';

  @override
  Future<TargetPlatform> get targetPlatform async => TargetPlatform.ios;

  @override
  final PlatformType platformType = PlatformType.ios;
1404 1405 1406 1407 1408 1409

  @override
  bool isSupported() => true;

  @override
  bool isSupportedForProject(FlutterProject project) => true;
1410 1411 1412

  @override
  bool get isConnected => true;
1413 1414 1415

  @override
  bool get ephemeral => true;
1416
}
1417 1418 1419 1420

class FakeMDnsClient extends Fake implements MDnsClient {
  FakeMDnsClient(this.ptrRecords, this.srvResponse, {
    this.txtResponse = const <String, List<TxtResourceRecord>>{},
1421
    this.ipResponse = const <String, List<IPAddressResourceRecord>>{},
1422 1423 1424 1425 1426 1427
    this.osErrorOnStart = false,
  });

  final List<PtrResourceRecord> ptrRecords;
  final Map<String, List<SrvResourceRecord>> srvResponse;
  final Map<String, List<TxtResourceRecord>> txtResponse;
1428
  final Map<String, List<IPAddressResourceRecord>> ipResponse;
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
  final bool osErrorOnStart;

  @override
  Future<void> start({
    InternetAddress? listenAddress,
    NetworkInterfacesFactory? interfacesFactory,
    int mDnsPort = 5353,
    InternetAddress? mDnsAddress,
  }) async {
    if (osErrorOnStart) {
      throw const OSError('Operation not supported on socket', 102);
    }
  }

  @override
  Stream<T> lookup<T extends ResourceRecord>(
    ResourceRecordQuery query, {
    Duration timeout = const Duration(seconds: 5),
  }) {
1448
    if (T == PtrResourceRecord && query.fullyQualifiedName == MDnsVmServiceDiscovery.dartVmServiceName) {
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
      return Stream<PtrResourceRecord>.fromIterable(ptrRecords) as Stream<T>;
    }
    if (T == SrvResourceRecord) {
      final String key = query.fullyQualifiedName;
      return Stream<SrvResourceRecord>.fromIterable(srvResponse[key] ?? <SrvResourceRecord>[]) as Stream<T>;
    }
    if (T == TxtResourceRecord) {
      final String key = query.fullyQualifiedName;
      return Stream<TxtResourceRecord>.fromIterable(txtResponse[key] ?? <TxtResourceRecord>[]) as Stream<T>;
    }
1459 1460 1461 1462
    if (T == IPAddressResourceRecord) {
      final String key = query.fullyQualifiedName;
      return Stream<IPAddressResourceRecord>.fromIterable(ipResponse[key] ?? <IPAddressResourceRecord>[]) as Stream<T>;
    }
1463 1464 1465 1466 1467 1468
    throw UnsupportedError('Unsupported query type $T');
  }

  @override
  void stop() {}
}
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488

class TestDeviceManager extends DeviceManager {
  TestDeviceManager({required this.logger}) : super(logger: logger);
  List<Device> devices = <Device>[];

  final BufferLogger logger;

  @override
  List<DeviceDiscovery> get deviceDiscoverers {
    final FakePollingDeviceDiscovery discoverer = FakePollingDeviceDiscovery();
    devices.forEach(discoverer.addDevice);
    return <DeviceDiscovery>[discoverer];
  }
}

class FakeTerminal extends Fake implements AnsiTerminal {
  FakeTerminal({this.stdinHasTerminal = true});

  @override
  final bool stdinHasTerminal;
1489 1490 1491

  @override
  bool usesTerminalUi = false;
1492
}