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

import 'dart:async';
6
import 'dart:convert';
7 8 9 10
import 'dart:io';
import 'dart:math' as math;

import 'package:path/path.dart' as path;
11
import 'package:retry/retry.dart';
12 13 14

import 'utils.dart';

15 16
const String DeviceIdEnvName = 'FLUTTER_DEVICELAB_DEVICEID';

17 18 19 20 21 22
class DeviceException implements Exception {
  const DeviceException(this.message);

  final String message;

  @override
23
  String toString() => '$DeviceException: $message';
24
}
25 26 27 28 29 30 31 32 33 34 35

/// Gets the artifact path relative to the current directory.
String getArtifactPath() {
  return path.normalize(
      path.join(
        path.current,
        '../../bin/cache/artifacts',
      )
    );
}

36
/// Return the item is in idList if find a match, otherwise return null
37 38
String? _findMatchId(List<String> idList, String idPattern) {
  String? candidate;
39
  idPattern = idPattern.toLowerCase();
40
  for (final String id in idList) {
41 42 43 44 45 46 47 48 49 50
    if (id.toLowerCase() == idPattern) {
      return id;
    }
    if (id.toLowerCase().startsWith(idPattern)) {
      candidate ??= id;
    }
  }
  return candidate;
}

51
/// The root of the API for controlling devices.
52
DeviceDiscovery get devices => DeviceDiscovery();
53 54

/// Device operating system the test is configured to test.
55 56 57 58 59 60 61
enum DeviceOperatingSystem {
  android,
  androidArm,
  androidArm64,
  fake,
  fuchsia,
  ios,
62
  linux,
63 64 65
  macos,
  windows,
}
66 67 68 69 70 71 72

/// Device OS to test on.
DeviceOperatingSystem deviceOperatingSystem = DeviceOperatingSystem.android;

/// Discovers available devices and chooses one to work with.
abstract class DeviceDiscovery {
  factory DeviceDiscovery() {
73
    switch (deviceOperatingSystem) {
74
      case DeviceOperatingSystem.android:
75
        return AndroidDeviceDiscovery();
76
      case DeviceOperatingSystem.androidArm:
77
        return AndroidDeviceDiscovery(cpu: AndroidCPU.arm);
78
      case DeviceOperatingSystem.androidArm64:
79
        return AndroidDeviceDiscovery(cpu: AndroidCPU.arm64);
80
      case DeviceOperatingSystem.ios:
81
        return IosDeviceDiscovery();
82 83
      case DeviceOperatingSystem.fuchsia:
        return FuchsiaDeviceDiscovery();
84 85
      case DeviceOperatingSystem.linux:
        return LinuxDeviceDiscovery();
86 87
      case DeviceOperatingSystem.macos:
        return MacosDeviceDiscovery();
88 89
      case DeviceOperatingSystem.windows:
        return WindowsDeviceDiscovery();
90
      case DeviceOperatingSystem.fake:
91
        print('Looking for fake devices! You should not see this in release builds.');
92
        return FakeDeviceDiscovery();
93 94
    }
  }
95

96 97 98 99 100
  /// Selects a device to work with, load-balancing between devices if more than
  /// one are available.
  ///
  /// Calling this method does not guarantee that the same device will be
  /// returned. For such behavior see [workingDevice].
101
  Future<void> chooseWorkingDevice();
102

103
  /// Selects a device to work with by device ID.
104 105
  Future<void> chooseWorkingDeviceById(String deviceId);

106 107 108 109
  /// A device to work with.
  ///
  /// Returns the same device when called repeatedly (unlike
  /// [chooseWorkingDevice]). This is useful when you need to perform multiple
110
  /// operations on one.
111
  Future<Device> get workingDevice;
112

113 114
  /// Lists all available devices' IDs.
  Future<List<String>> discoverDevices();
115

116 117
  /// Checks the health of the available devices.
  Future<Map<String, HealthCheckResult>> checkDevices();
118

119
  /// Prepares the system to run tasks.
120
  Future<void> performPreflightTasks();
121 122
}

123 124
/// A proxy for one specific device.
abstract class Device {
125 126 127
  // Const constructor so subclasses may be const.
  const Device();

128 129
  /// A unique device identifier.
  String get deviceId;
130

131 132
  /// Whether the device is awake.
  Future<bool> isAwake();
133

134 135
  /// Whether the device is asleep.
  Future<bool> isAsleep();
136

137
  /// Wake up the device if it is not awake.
138
  Future<void> wakeUp();
139

140
  /// Send the device to sleep mode.
141
  Future<void> sendToSleep();
142

143 144 145
  /// Emulates pressing the home button.
  Future<void> home();

146
  /// Emulates pressing the power button, toggling the device's on/off state.
147
  Future<void> togglePower();
148

149 150 151
  /// Unlocks the device.
  ///
  /// Assumes the device doesn't have a secure unlock pattern.
152
  Future<void> unlock();
153

154 155 156
  /// Attempt to reboot the phone, if possible.
  Future<void> reboot();

157
  /// Emulate a tap on the touch screen.
158
  Future<void> tap(int x, int y);
159

160 161 162
  /// Read memory statistics for a process.
  Future<Map<String, dynamic>> getMemoryStats(String packageName);

163 164 165 166 167 168
  /// Stream the system log from the device.
  ///
  /// Flutter applications' `print` statements end up in this log
  /// with some prefix.
  Stream<String> get logcat;

169 170 171 172 173 174 175 176
  /// Clears the device logs.
  ///
  /// This is important because benchmarks tests rely on the logs produced by
  /// the flutter run command.
  ///
  /// On Android, those logs may contain logs from previous test.
  Future<void> clearLogs();

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
  /// Whether this device supports calls to [startLoggingToSink]
  /// and [stopLoggingToSink].
  bool get canStreamLogs => false;

  /// Starts logging to an [IOSink].
  ///
  /// If `clear` is set to true, the log will be cleared before starting. This
  /// is not supported on all platforms.
  Future<void> startLoggingToSink(IOSink sink, {bool clear = true}) {
    throw UnimplementedError();
  }

  /// Stops logging that was started by [startLoggingToSink].
  Future<void> stopLoggingToSink() {
    throw UnimplementedError();
  }

194
  /// Stop a process.
195
  Future<void> stop(String packageName);
196

197 198 199 200 201 202 203 204 205 206 207 208 209 210
  /// Wait for the device to become ready.
  Future<void> awaitDevice();

  Future<void> uninstallApp() async {
    await flutter('install', options: <String>[
      '--uninstall-only',
      '-d',
      deviceId]);

    await Future<void>.delayed(const Duration(seconds: 2));

    await awaitDevice();
  }

211 212 213 214
  @override
  String toString() {
    return 'device: $deviceId';
  }
215
}
216

217
enum AndroidCPU {
218
  arm,
219 220 221
  arm64,
}

222
class AndroidDeviceDiscovery implements DeviceDiscovery {
223
  factory AndroidDeviceDiscovery({AndroidCPU? cpu}) {
224
    return _instance ??= AndroidDeviceDiscovery._(cpu);
225 226
  }

227 228
  AndroidDeviceDiscovery._(this.cpu);

229
  final AndroidCPU? cpu;
230

231 232 233
  // Parses information about a device. Example:
  //
  // 015d172c98400a03       device usb:340787200X product:nakasi model:Nexus_7 device:grouper
234
  static final RegExp _kDeviceRegex = RegExp(r'^(\S+)\s+(\S+)(.*)');
235

236
  static AndroidDeviceDiscovery? _instance;
237

238
  AndroidDevice? _workingDevice;
239 240 241 242

  @override
  Future<AndroidDevice> get workingDevice async {
    if (_workingDevice == null) {
243
      if (Platform.environment.containsKey(DeviceIdEnvName)) {
244
        final String deviceId = Platform.environment[DeviceIdEnvName]!;
245
        await chooseWorkingDeviceById(deviceId);
246
        return _workingDevice!;
247
      }
248
      await chooseWorkingDevice();
249
    }
250

251
    return _workingDevice!;
252 253
  }

254 255
  Future<bool> _matchesCPURequirement(AndroidDevice device) async {
    switch (cpu) {
256 257
      case null:
        return true;
258
      case AndroidCPU.arm64:
259
        return device.isArm64();
260
      case AndroidCPU.arm:
261
        return device.isArm();
262 263 264
    }
  }

265 266 267
  /// Picks a random Android device out of connected devices and sets it as
  /// [workingDevice].
  @override
268
  Future<void> chooseWorkingDevice() async {
269 270
    final List<AndroidDevice> allDevices = (await discoverDevices())
      .map<AndroidDevice>((String id) => AndroidDevice(deviceId: id))
271 272
      .toList();

273
    if (allDevices.isEmpty) {
274
      throw const DeviceException('No Android devices detected');
275
    }
276

277 278 279 280 281 282 283 284 285 286 287 288 289
    if (cpu != null) {
      for (final AndroidDevice device in allDevices) {
        if (await _matchesCPURequirement(device)) {
          _workingDevice = device;
          break;
        }
      }

    } else {
      // TODO(yjbanov): filter out and warn about those with low battery level
      _workingDevice = allDevices[math.Random().nextInt(allDevices.length)];
    }

290
    if (_workingDevice == null) {
291
      throw const DeviceException('Cannot find a suitable Android device');
292
    }
293

294
    print('Device chosen: $_workingDevice');
295 296
  }

297 298
  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async {
299
    final String? matchedId = _findMatchId(await discoverDevices(), deviceId);
300 301
    if (matchedId != null) {
      _workingDevice = AndroidDevice(deviceId: matchedId);
302
      if (cpu != null) {
303
        if (!await _matchesCPURequirement(_workingDevice!)) {
304 305 306
          throw DeviceException('The selected device $matchedId does not match the cpu requirement');
        }
      }
307 308 309 310 311 312 313 314 315
      print('Choose device by ID: $matchedId');
      return;
    }
    throw DeviceException(
      'Device with ID $deviceId is not found for operating system: '
      '$deviceOperatingSystem'
      );
  }

316 317
  @override
  Future<List<String>> discoverDevices() async {
318
    final List<String> output = (await eval(adbPath, <String>['devices', '-l']))
319
        .trim().split('\n');
320
    final List<String> results = <String>[];
321
    for (final String line in output) {
322
      // Skip lines like: * daemon started successfully *
323
      if (line.startsWith('* daemon ')) {
324
        continue;
325
      }
326

327
      if (line.startsWith('List of devices')) {
328
        continue;
329
      }
330 331

      if (_kDeviceRegex.hasMatch(line)) {
332
        final Match match = _kDeviceRegex.firstMatch(line)!;
333

334 335
        final String deviceID = match[1]!;
        final String deviceState = match[2]!;
336 337 338 339 340

        if (!const <String>['unauthorized', 'offline'].contains(deviceState)) {
          results.add(deviceID);
        }
      } else {
341
        throw FormatException('Failed to parse device from adb output: "$line"');
342 343 344 345 346 347
      }
    }

    return results;
  }

348 349
  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
350
    final Map<String, HealthCheckResult> results = <String, HealthCheckResult>{};
351
    for (final String deviceId in await discoverDevices()) {
352
      try {
353
        final AndroidDevice device = AndroidDevice(deviceId: deviceId);
354 355 356
        // Just a smoke test that we can read wakefulness state
        // TODO(yjbanov): check battery level
        await device._getWakefulness();
357
        results['android-device-$deviceId'] = HealthCheckResult.success();
358
      } on Exception catch (e, s) {
359
        results['android-device-$deviceId'] = HealthCheckResult.error(e, s);
360 361 362 363 364 365
      }
    }
    return results;
  }

  @override
366
  Future<void> performPreflightTasks() async {
367 368 369 370 371 372
    // Kills the `adb` server causing it to start a new instance upon next
    // command.
    //
    // Restarting `adb` helps with keeping device connections alive. When `adb`
    // runs non-stop for too long it loses connections to devices. There may be
    // a better method, but so far that's the best one I've found.
373
    await exec(adbPath, <String>['kill-server']);
374 375 376
  }
}

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
class LinuxDeviceDiscovery implements DeviceDiscovery {
  factory LinuxDeviceDiscovery() {
    return _instance ??= LinuxDeviceDiscovery._();
  }

  LinuxDeviceDiscovery._();

  static LinuxDeviceDiscovery? _instance;

  static const LinuxDevice _device = LinuxDevice();

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
    return <String, HealthCheckResult>{};
  }

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

  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async { }

  @override
  Future<List<String>> discoverDevices() async {
    return <String>['linux'];
  }

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

  @override
  Future<Device> get workingDevice  async => _device;
}

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
class MacosDeviceDiscovery implements DeviceDiscovery {
  factory MacosDeviceDiscovery() {
    return _instance ??= MacosDeviceDiscovery._();
  }

  MacosDeviceDiscovery._();

  static MacosDeviceDiscovery? _instance;

  static const MacosDevice _device = MacosDevice();

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
    return <String, HealthCheckResult>{};
  }

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

  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async { }

  @override
  Future<List<String>> discoverDevices() async {
    return <String>['macos'];
  }

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

  @override
  Future<Device> get workingDevice  async => _device;
}

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
class WindowsDeviceDiscovery implements DeviceDiscovery {
  factory WindowsDeviceDiscovery() {
    return _instance ??= WindowsDeviceDiscovery._();
  }

  WindowsDeviceDiscovery._();

  static WindowsDeviceDiscovery? _instance;

  static const WindowsDevice _device = WindowsDevice();

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
    return <String, HealthCheckResult>{};
  }

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

  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async { }

  @override
  Future<List<String>> discoverDevices() async {
    return <String>['windows'];
  }

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

  @override
  Future<Device> get workingDevice  async => _device;
}

479 480 481 482 483 484 485
class FuchsiaDeviceDiscovery implements DeviceDiscovery {
  factory FuchsiaDeviceDiscovery() {
    return _instance ??= FuchsiaDeviceDiscovery._();
  }

  FuchsiaDeviceDiscovery._();

486
  static FuchsiaDeviceDiscovery? _instance;
487

488
  FuchsiaDevice? _workingDevice;
489

490
  String get _ffx {
491 492 493
    final String ffx = path.join(getArtifactPath(), 'fuchsia', 'tools','x64', 'ffx');
    if (!File(ffx).existsSync()) {
      throw FileSystemException("Couldn't find ffx at location $ffx");
494
    }
495
    return ffx;
496
  }
497 498 499 500

  @override
  Future<FuchsiaDevice> get workingDevice async {
    if (_workingDevice == null) {
501
      if (Platform.environment.containsKey(DeviceIdEnvName)) {
502
        final String deviceId = Platform.environment[DeviceIdEnvName]!;
503
        await chooseWorkingDeviceById(deviceId);
504
        return _workingDevice!;
505
      }
506 507
      await chooseWorkingDevice();
    }
508
    return _workingDevice!;
509 510 511 512 513 514 515 516 517 518
  }

  /// Picks the first connected Fuchsia device.
  @override
  Future<void> chooseWorkingDevice() async {
    final List<FuchsiaDevice> allDevices = (await discoverDevices())
      .map<FuchsiaDevice>((String id) => FuchsiaDevice(deviceId: id))
      .toList();

    if (allDevices.isEmpty) {
519
      throw const DeviceException('No Fuchsia devices detected');
520 521
    }
    _workingDevice = allDevices.first;
522
    print('Device chosen: $_workingDevice');
523 524
  }

525 526
  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async {
527 528
    final String? matchedId = _findMatchId(await discoverDevices(), deviceId);
    if (matchedId != null) {
529 530 531 532 533 534 535 536 537 538
      _workingDevice = FuchsiaDevice(deviceId: matchedId);
      print('Choose device by ID: $matchedId');
      return;
    }
    throw DeviceException(
      'Device with ID $deviceId is not found for operating system: '
      '$deviceOperatingSystem'
      );
  }

539 540
  @override
  Future<List<String>> discoverDevices() async {
541
    final List<String> output = (await eval(_ffx, <String>['target', 'list', '-f', 's']))
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
      .trim()
      .split('\n');

    final List<String> devices = <String>[];
    for (final String line in output) {
      final List<String> parts = line.split(' ');
      assert(parts.length == 2);
      devices.add(parts.last); // The device id.
    }
    return devices;
  }

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
    final Map<String, HealthCheckResult> results = <String, HealthCheckResult>{};
    for (final String deviceId in await discoverDevices()) {
      try {
        final int resolveResult = await exec(
560
          _ffx,
561
          <String>[
562 563
            'target',
            'list',
564
            '-f',
565
            'a',
566
            deviceId,
567
          ]
568
        );
569
        if (resolveResult == 0) {
570 571 572 573
          results['fuchsia-device-$deviceId'] = HealthCheckResult.success();
        } else {
          results['fuchsia-device-$deviceId'] = HealthCheckResult.failure('Cannot resolve device $deviceId');
        }
574
      } on Exception catch (error, stacktrace) {
575 576 577 578 579 580 581 582 583 584
        results['fuchsia-device-$deviceId'] = HealthCheckResult.error(error, stacktrace);
      }
    }
    return results;
  }

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

585
class AndroidDevice extends Device {
586
  AndroidDevice({required this.deviceId}) {
587 588
    _updateDeviceInfo();
  }
589 590 591

  @override
  final String deviceId;
592
  String deviceInfo = '';
593
  int apiLevel = 0;
594

595
  /// Whether the device is awake.
596
  @override
597 598 599 600 601
  Future<bool> isAwake() async {
    return await _getWakefulness() == 'Awake';
  }

  /// Whether the device is asleep.
602
  @override
603 604 605 606 607
  Future<bool> isAsleep() async {
    return await _getWakefulness() == 'Asleep';
  }

  /// Wake up the device if it is not awake using [togglePower].
608
  @override
609
  Future<void> wakeUp() async {
610
    if (!(await isAwake())) {
611
      await togglePower();
612
    }
613 614 615
  }

  /// Send the device to sleep mode if it is not asleep using [togglePower].
616
  @override
617
  Future<void> sendToSleep() async {
618
    if (!(await isAsleep())) {
619
      await togglePower();
620
    }
621 622
  }

623 624 625 626 627 628
  /// Sends `KEYCODE_HOME` (3), which causes the device to go to the home screen.
  @override
  Future<void> home() async {
    await shellExec('input', const <String>['keyevent', '3']);
  }

629 630
  /// Sends `KEYCODE_POWER` (26), which causes the device to toggle its mode
  /// between awake and asleep.
631
  @override
632
  Future<void> togglePower() async {
633 634 635 636 637 638
    await shellExec('input', const <String>['keyevent', '26']);
  }

  /// Unlocks the device by sending `KEYCODE_MENU` (82).
  ///
  /// This only works when the device doesn't have a secure unlock pattern.
639
  @override
640
  Future<void> unlock() async {
641 642 643 644
    await wakeUp();
    await shellExec('input', const <String>['keyevent', '82']);
  }

645
  @override
646
  Future<void> tap(int x, int y) async {
647 648 649
    await shellExec('input', <String>['tap', '$x', '$y']);
  }

650 651 652 653
  /// Retrieves device's wakefulness state.
  ///
  /// See: https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/os/PowerManagerInternal.java
  Future<String> _getWakefulness() async {
654
    final String powerInfo = await shellEval('dumpsys', <String>['power']);
655 656 657 658
    // A motoG4 phone returns `mWakefulness=Awake`.
    // A Samsung phone returns `getWakefullnessLocked()=Awake`.
    final RegExp wakefulnessRegexp = RegExp(r'.*(mWakefulness=|getWakefulnessLocked\(\)=).*');
    final String wakefulness = grep(wakefulnessRegexp, from: powerInfo).single.split('=')[1].trim();
659 660 661
    return wakefulness;
  }

662 663 664 665 666
  Future<bool> isArm64() async {
    final String cpuInfo = await shellEval('getprop', const <String>['ro.product.cpu.abi']);
    return cpuInfo.contains('arm64');
  }

667 668 669 670 671
  Future<bool> isArm() async {
    final String cpuInfo = await shellEval('getprop', const <String>['ro.product.cpu.abi']);
    return cpuInfo.contains('armeabi');
  }

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
  Future<void> _updateDeviceInfo() async {
    String info;
    try {
      info = await shellEval(
        'getprop',
        <String>[
          'ro.bootimage.build.fingerprint', ';',
          'getprop', 'ro.build.version.release', ';',
          'getprop', 'ro.build.version.sdk',
        ],
        silent: true,
      );
    } on IOException {
      info = '';
    }
    final List<String> list = info.split('\n');
    if (list.length == 3) {
689 690
      apiLevel = int.parse(list[2]);
      deviceInfo = 'fingerprint: ${list[0]} os: ${list[1]}  api-level: $apiLevel';
691
    } else {
692
      apiLevel = 0;
693 694 695 696
      deviceInfo = '';
    }
  }

697
  /// Executes [command] on `adb shell`.
698
  Future<void> shellExec(String command, List<String> arguments, { Map<String, String>? environment, bool silent = false }) async {
699
    await adb(<String>['shell', command, ...arguments], environment: environment, silent: silent);
700 701 702
  }

  /// Executes [command] on `adb shell` and returns its standard output as a [String].
703
  Future<String> shellEval(String command, List<String> arguments, { Map<String, String>? environment, bool silent = false }) {
704
    return adb(<String>['shell', command, ...arguments], environment: environment, silent: silent);
705 706 707
  }

  /// Runs `adb` with the given [arguments], selecting this device.
708 709
  Future<String> adb(
      List<String> arguments, {
710
      Map<String, String>? environment,
711 712 713 714 715 716 717 718 719
      bool silent = false,
    }) {
    return eval(
      adbPath,
      <String>['-s', deviceId, ...arguments],
      environment: environment,
      printStdout: !silent,
      printStderr: !silent,
    );
720
  }
721 722 723

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
724
    final String meminfo = await shellEval('dumpsys', <String>['meminfo', packageName]);
725
    final Match? match = RegExp(r'TOTAL\s+(\d+)').firstMatch(meminfo);
726
    assert(match != null, 'could not parse dumpsys meminfo output');
727
    return <String, dynamic>{
728
      'total_kb': int.parse(match!.group(1)!),
729 730 731
    };
  }

732 733 734
  @override
  bool get canStreamLogs => true;

735 736
  bool _abortedLogging = false;
  Process? _loggingProcess;
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752

  @override
  Future<void> startLoggingToSink(IOSink sink, {bool clear = true}) async {
    if (clear) {
      await adb(<String>['logcat', '--clear'], silent: true);
    }
    _loggingProcess = await startProcess(
      adbPath,
      // Make logcat less chatty by filtering down to just ActivityManager
      // (to let us know when app starts), flutter (needed by tests to see
      // log output), and fatal messages (hopefully catches tombstones).
      // For local testing, this can just be:
      //   <String>['-s', deviceId, 'logcat']
      // to view the whole log, or just run logcat alongside this.
      <String>['-s', deviceId, 'logcat', 'ActivityManager:I', 'flutter:V', '*:F'],
    );
753
    _loggingProcess!.stdout
754 755 756 757
      .transform<String>(const Utf8Decoder(allowMalformed: true))
      .listen((String line) {
        sink.write(line);
      });
758
    _loggingProcess!.stderr
759 760 761 762
      .transform<String>(const Utf8Decoder(allowMalformed: true))
      .listen((String line) {
        sink.write(line);
      });
763
    unawaited(_loggingProcess!.exitCode.then<void>((int exitCode) {
764 765 766 767 768 769 770 771
      if (!_abortedLogging) {
        sink.writeln('adb logcat failed with exit code $exitCode.\n');
      }
    }));
  }

  @override
  Future<void> stopLoggingToSink() async {
772 773
    if (_loggingProcess != null) {
      _abortedLogging = true;
774 775
      _loggingProcess!.kill();
      await _loggingProcess!.exitCode;
776
    }
777 778
  }

779 780 781 782 783
  @override
  Future<void> clearLogs() {
    return adb(<String>['logcat', '-c']);
  }

784 785
  @override
  Stream<String> get logcat {
786 787 788 789
    final Completer<void> stdoutDone = Completer<void>();
    final Completer<void> stderrDone = Completer<void>();
    final Completer<void> processDone = Completer<void>();
    final Completer<void> abort = Completer<void>();
790
    bool aborted = false;
791
    late final StreamController<String> stream;
792
    stream = StreamController<String>(
793
      onListen: () async {
794
        await clearLogs();
795 796 797 798 799 800 801 802 803 804
        final Process process = await startProcess(
          adbPath,
          // Make logcat less chatty by filtering down to just ActivityManager
          // (to let us know when app starts), flutter (needed by tests to see
          // log output), and fatal messages (hopefully catches tombstones).
          // For local testing, this can just be:
          //   <String>['-s', deviceId, 'logcat']
          // to view the whole log, or just run logcat alongside this.
          <String>['-s', deviceId, 'logcat', 'ActivityManager:I', 'flutter:V', '*:F'],
        );
805
        process.stdout
806 807
          .transform<String>(utf8.decoder)
          .transform<String>(const LineSplitter())
808 809
          .listen((String line) {
            print('adb logcat: $line');
810 811 812
            if (!stream.isClosed) {
              stream.sink.add(line);
            }
813 814
          }, onDone: () { stdoutDone.complete(); });
        process.stderr
815 816
          .transform<String>(utf8.decoder)
          .transform<String>(const LineSplitter())
817 818 819
          .listen((String line) {
            print('adb logcat stderr: $line');
          }, onDone: () { stderrDone.complete(); });
820
        unawaited(process.exitCode.then<void>((int exitCode) {
821 822
          print('adb logcat process terminated with exit code $exitCode');
          if (!aborted) {
823
            stream.addError(BuildFailedError('adb logcat failed with exit code $exitCode.\n'));
824 825
            processDone.complete();
          }
826
        }));
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
        await Future.any<dynamic>(<Future<dynamic>>[
          Future.wait<void>(<Future<void>>[
            stdoutDone.future,
            stderrDone.future,
            processDone.future,
          ]),
          abort.future,
        ]);
        aborted = true;
        print('terminating adb logcat');
        process.kill();
        print('closing logcat stream');
        await stream.close();
      },
      onCancel: () {
        if (!aborted) {
          print('adb logcat aborted');
          aborted = true;
          abort.complete();
        }
      },
    );
    return stream.stream;
  }

852
  @override
853
  Future<void> stop(String packageName) async {
854 855
    return shellExec('am', <String>['force-stop', packageName]);
  }
856 857 858 859 860

  @override
  String toString() {
    return '$deviceId $deviceInfo';
  }
861 862 863 864 865

  @override
  Future<void> reboot() {
    return adb(<String>['reboot']);
  }
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882

  @override
  Future<void> awaitDevice() async {
    print('Waiting for device.');
    final String waitOut = await adb(<String>['wait-for-device']);
    print(waitOut);
    const RetryOptions retryOptions = RetryOptions(delayFactor: Duration(seconds: 1), maxAttempts: 10, maxDelay: Duration(minutes: 1));
    await retryOptions.retry(() async {
      final String adbShellOut = await adb(<String>['shell', 'getprop sys.boot_completed']);
      if (adbShellOut != '1') {
        print('Device not ready.');
        print(adbShellOut);
        throw const DeviceException('Phone not ready.');
      }
    }, retryIf: (Exception e) => e is DeviceException);
    print('Done waiting for device.');
  }
883 884 885 886
}

class IosDeviceDiscovery implements DeviceDiscovery {
  factory IosDeviceDiscovery() {
887
    return _instance ??= IosDeviceDiscovery._();
888 889 890 891
  }

  IosDeviceDiscovery._();

892
  static IosDeviceDiscovery? _instance;
893

894
  IosDevice? _workingDevice;
895 896 897 898

  @override
  Future<IosDevice> get workingDevice async {
    if (_workingDevice == null) {
899
      if (Platform.environment.containsKey(DeviceIdEnvName)) {
900
        final String deviceId = Platform.environment[DeviceIdEnvName]!;
901
        await chooseWorkingDeviceById(deviceId);
902
        return _workingDevice!;
903
      }
904 905 906
      await chooseWorkingDevice();
    }

907
    return _workingDevice!;
908 909 910 911 912
  }

  /// Picks a random iOS device out of connected devices and sets it as
  /// [workingDevice].
  @override
913
  Future<void> chooseWorkingDevice() async {
914
    final List<IosDevice> allDevices = (await discoverDevices())
915
      .map<IosDevice>((String id) => IosDevice(deviceId: id))
916 917
      .toList();

918
    if (allDevices.isEmpty) {
919
      throw const DeviceException('No iOS devices detected');
920
    }
921 922

    // TODO(yjbanov): filter out and warn about those with low battery level
923
    _workingDevice = allDevices[math.Random().nextInt(allDevices.length)];
924
    print('Device chosen: $_workingDevice');
925 926
  }

927 928
  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async {
929
    final String? matchedId = _findMatchId(await discoverDevices(), deviceId);
930 931 932 933 934 935 936 937 938 939 940
    if (matchedId != null) {
      _workingDevice = IosDevice(deviceId: matchedId);
      print('Choose device by ID: $matchedId');
      return;
    }
    throw DeviceException(
      'Device with ID $deviceId is not found for operating system: '
      '$deviceOperatingSystem'
      );
  }

941 942
  @override
  Future<List<String>> discoverDevices() async {
943 944
    final List<dynamic> results = json.decode(await eval(
      path.join(flutterDirectory.path, 'bin', 'flutter'),
945
      <String>['devices', '--machine', '--suppress-analytics', '--device-timeout', '5'],
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
    )) as List<dynamic>;

    // [
    //   {
    //     "name": "Flutter's iPhone",
    //     "id": "00008020-00017DA80CC1002E",
    //     "isSupported": true,
    //     "targetPlatform": "ios",
    //     "emulator": false,
    //     "sdk": "iOS 13.2",
    //     "capabilities": {
    //       "hotReload": true,
    //       "hotRestart": true,
    //       "screenshot": true,
    //       "fastStart": false,
    //       "flutterExit": true,
    //       "hardwareRendering": false,
    //       "startPaused": false
    //     }
    //   }
    // ]

    final List<String> deviceIds = <String>[];

    for (final dynamic result in results) {
      final Map<String, dynamic> device = result as Map<String, dynamic>;
      if (device['targetPlatform'] == 'ios' &&
          device['id'] != null &&
          device['emulator'] != true &&
          device['isSupported'] == true) {
        deviceIds.add(device['id'] as String);
      }
    }

    if (deviceIds.isEmpty) {
981
      throw const DeviceException('No connected physical iOS devices found.');
982 983
    }
    return deviceIds;
984
  }
985 986 987

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
988
    final Map<String, HealthCheckResult> results = <String, HealthCheckResult>{};
989
    for (final String deviceId in await discoverDevices()) {
990
      // TODO(ianh): do a more meaningful connectivity check than just recording the ID
991
      results['ios-device-$deviceId'] = HealthCheckResult.success();
992 993 994 995 996
    }
    return results;
  }

  @override
997
  Future<void> performPreflightTasks() async {
998 999 1000 1001 1002
    // Currently we do not have preflight tasks for iOS.
  }
}

/// iOS device.
1003
class IosDevice extends Device {
1004
  IosDevice({ required this.deviceId });
1005 1006 1007 1008

  @override
  final String deviceId;

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  String get idevicesyslogPath {
    return path.join(flutterDirectory.path, 'bin', 'cache', 'artifacts', 'libimobiledevice', 'idevicesyslog');
  }

  String get dyldLibraryPath {
    final List<String> dylibsPaths = <String>[
      path.join(flutterDirectory.path, 'bin', 'cache', 'artifacts', 'libimobiledevice'),
      path.join(flutterDirectory.path, 'bin', 'cache', 'artifacts', 'openssl'),
      path.join(flutterDirectory.path, 'bin', 'cache', 'artifacts', 'usbmuxd'),
      path.join(flutterDirectory.path, 'bin', 'cache', 'artifacts', 'libplist'),
    ];
    return dylibsPaths.join(':');
  }

  @override
  bool get canStreamLogs => true;

1026 1027
  bool _abortedLogging = false;
  Process? _loggingProcess;
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038

  @override
  Future<void> startLoggingToSink(IOSink sink, {bool clear = true}) async {
    // Clear is not supported.
    _loggingProcess = await startProcess(
      idevicesyslogPath,
      <String>['-u', deviceId, '--quiet'],
      environment: <String, String>{
        'DYLD_LIBRARY_PATH': dyldLibraryPath,
      },
    );
1039
    _loggingProcess!.stdout
1040 1041 1042 1043
      .transform<String>(const Utf8Decoder(allowMalformed: true))
      .listen((String line) {
        sink.write(line);
      });
1044
    _loggingProcess!.stderr
1045 1046 1047 1048
      .transform<String>(const Utf8Decoder(allowMalformed: true))
      .listen((String line) {
        sink.write(line);
      });
1049
    unawaited(_loggingProcess!.exitCode.then<void>((int exitCode) {
1050 1051 1052 1053 1054 1055 1056 1057
      if (!_abortedLogging) {
        sink.writeln('idevicesyslog failed with exit code $exitCode.\n');
      }
    }));
  }

  @override
  Future<void> stopLoggingToSink() async {
1058 1059
    if (_loggingProcess != null) {
      _abortedLogging = true;
1060 1061
      _loggingProcess!.kill();
      await _loggingProcess!.exitCode;
1062
    }
1063 1064
  }

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
  // The methods below are stubs for now. They will need to be expanded.
  // We currently do not have a way to lock/unlock iOS devices. So we assume the
  // devices are already unlocked. For now we'll just keep them at minimum
  // screen brightness so they don't drain battery too fast.

  @override
  Future<bool> isAwake() async => true;

  @override
  Future<bool> isAsleep() async => false;

  @override
1077
  Future<void> wakeUp() async {}
1078 1079

  @override
1080
  Future<void> sendToSleep() async {}
1081

1082 1083 1084
  @override
  Future<void> home() async {}

1085
  @override
1086
  Future<void> togglePower() async {}
1087 1088

  @override
1089
  Future<void> unlock() async {}
1090

1091
  @override
1092
  Future<void> tap(int x, int y) async {
1093
    throw UnimplementedError();
1094 1095
  }

1096 1097
  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
1098
    throw UnimplementedError();
1099 1100
  }

1101 1102
  @override
  Stream<String> get logcat {
1103
    throw UnimplementedError();
1104 1105
  }

1106 1107 1108
  @override
  Future<void> clearLogs() async {}

1109
  @override
1110
  Future<void> stop(String packageName) async {}
1111 1112 1113

  @override
  Future<void> reboot() {
1114
    return Process.run('idevicediagnostics', <String>['restart', '-u', deviceId]);
1115
  }
1116 1117 1118

  @override
  Future<void> awaitDevice() async {}
1119 1120
}

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
class LinuxDevice extends Device {
  const LinuxDevice();

  @override
  String get deviceId => 'linux';

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
    return <String, dynamic>{};
  }

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

  @override
  Future<bool> isAsleep() async {
    return false;
  }

  @override
  Future<bool> isAwake() async {
    return true;
  }

  @override
  Stream<String> get logcat => const Stream<String>.empty();

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

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

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

  @override
  Future<void> stop(String packageName) async { }

  @override
  Future<void> tap(int x, int y) async { }

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

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

  @override
  Future<void> wakeUp() async { }
1171 1172 1173

  @override
  Future<void> awaitDevice() async {}
1174 1175
}

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
class MacosDevice extends Device {
  const MacosDevice();

  @override
  String get deviceId => 'macos';

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
    return <String, dynamic>{};
  }

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

  @override
  Future<bool> isAsleep() async {
    return false;
  }

  @override
  Future<bool> isAwake() async {
    return true;
  }

  @override
  Stream<String> get logcat => const Stream<String>.empty();

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

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

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

  @override
  Future<void> stop(String packageName) async { }

  @override
  Future<void> tap(int x, int y) async { }

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

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

  @override
  Future<void> wakeUp() async { }
1226 1227 1228

  @override
  Future<void> awaitDevice() async {}
1229 1230
}

1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
class WindowsDevice extends Device {
  const WindowsDevice();

  @override
  String get deviceId => 'windows';

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
    return <String, dynamic>{};
  }

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

  @override
  Future<bool> isAsleep() async {
    return false;
  }

  @override
  Future<bool> isAwake() async {
    return true;
  }

  @override
  Stream<String> get logcat => const Stream<String>.empty();

1258 1259 1260
  @override
  Future<void> clearLogs() async {}

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
  @override
  Future<void> reboot() async { }

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

  @override
  Future<void> stop(String packageName) async { }

  @override
  Future<void> tap(int x, int y) async { }

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

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

  @override
  Future<void> wakeUp() async { }
1281 1282 1283

  @override
  Future<void> awaitDevice() async {}
1284 1285
}

1286
/// Fuchsia device.
1287
class FuchsiaDevice extends Device {
1288
  const FuchsiaDevice({ required this.deviceId });
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305

  @override
  final String deviceId;

  // TODO(egarciad): Implement these for Fuchsia.
  @override
  Future<bool> isAwake() async => true;

  @override
  Future<bool> isAsleep() async => false;

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

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

1306 1307 1308
  @override
  Future<void> home() async {}

1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
  @override
  Future<void> togglePower() async {}

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

  @override
  Future<void> tap(int x, int y) async {}

  @override
  Future<void> stop(String packageName) async {}

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
1323
    throw UnimplementedError();
1324 1325 1326 1327
  }

  @override
  Stream<String> get logcat {
1328
    throw UnimplementedError();
1329
  }
1330

1331 1332 1333
  @override
  Future<void> clearLogs() async {}

1334 1335 1336 1337
  @override
  Future<void> reboot() async {
    // Unsupported.
  }
1338 1339 1340

  @override
  Future<void> awaitDevice() async {}
1341 1342
}

1343 1344
/// Path to the `adb` executable.
String get adbPath {
1345
  final String? androidHome = Platform.environment['ANDROID_HOME'] ?? Platform.environment['ANDROID_SDK_ROOT'];
1346

1347 1348
  if (androidHome == null) {
    throw const DeviceException(
1349
      'The ANDROID_HOME environment variable is '
1350
      'missing. The variable must point to the Android '
1351 1352 1353
      'SDK directory containing platform-tools.'
    );
  }
1354

1355
  final String adbPath = path.join(androidHome, 'platform-tools/adb');
1356

1357
  if (!canRun(adbPath)) {
1358
    throw DeviceException('adb not found at: $adbPath');
1359
  }
1360

1361
  return path.absolute(adbPath);
1362
}
1363 1364

class FakeDevice extends Device {
1365
  const FakeDevice({ required this.deviceId });
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381

  @override
  final String deviceId;

  @override
  Future<bool> isAwake() async => true;

  @override
  Future<bool> isAsleep() async => false;

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

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

1382 1383 1384
  @override
  Future<void> home() async {}

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
  @override
  Future<void> togglePower() async {}

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

  @override
  Future<void> tap(int x, int y) async {
    throw UnimplementedError();
  }

  @override
  Future<Map<String, dynamic>> getMemoryStats(String packageName) async {
    throw UnimplementedError();
  }

  @override
  Stream<String> get logcat {
    throw UnimplementedError();
  }

1406 1407 1408
  @override
  Future<void> clearLogs() async {}

1409 1410
  @override
  Future<void> stop(String packageName) async {}
1411 1412 1413 1414 1415

  @override
  Future<void> reboot() async {
    // Unsupported.
  }
1416 1417 1418

  @override
  Future<void> awaitDevice() async {}
1419 1420 1421 1422 1423 1424 1425 1426 1427
}

class FakeDeviceDiscovery implements DeviceDiscovery {
  factory FakeDeviceDiscovery() {
    return _instance ??= FakeDeviceDiscovery._();
  }

  FakeDeviceDiscovery._();

1428
  static FakeDeviceDiscovery? _instance;
1429

1430
  FakeDevice? _workingDevice;
1431 1432 1433 1434 1435

  @override
  Future<FakeDevice> get workingDevice async {
    if (_workingDevice == null) {
      if (Platform.environment.containsKey(DeviceIdEnvName)) {
1436
        final String deviceId = Platform.environment[DeviceIdEnvName]!;
1437
        await chooseWorkingDeviceById(deviceId);
1438
        return _workingDevice!;
1439 1440 1441 1442
      }
      await chooseWorkingDevice();
    }

1443
    return _workingDevice!;
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
  }

  /// The Fake is only available for by ID device discovery.
  @override
  Future<void> chooseWorkingDevice() async {
    throw const DeviceException('No fake devices detected');
  }

  @override
  Future<void> chooseWorkingDeviceById(String deviceId) async {
1454
    final String? matchedId = _findMatchId(await discoverDevices(), deviceId);
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
    if (matchedId != null) {
      _workingDevice = FakeDevice(deviceId: matchedId);
      print('Choose device by ID: $matchedId');
      return;
    }
    throw DeviceException(
      'Device with ID $deviceId is not found for operating system: '
      '$deviceOperatingSystem'
      );
  }

  @override
  Future<List<String>> discoverDevices() async {
    return <String>['FAKE_SUCCESS', 'THIS_IS_A_FAKE'];
  }

  @override
  Future<Map<String, HealthCheckResult>> checkDevices() async {
    final Map<String, HealthCheckResult> results = <String, HealthCheckResult>{};
    for (final String deviceId in await discoverDevices()) {
      results['fake-device-$deviceId'] = HealthCheckResult.success();
    }
    return results;
  }

  @override
1481
  Future<void> performPreflightTasks() async { }
1482
}