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

5 6 7
import 'package:meta/meta.dart';
import 'package:process/process.dart';

8
import '../base/common.dart';
9
import '../base/context.dart';
10
import '../base/file_system.dart';
11
import '../base/io.dart';
12 13
import '../base/logger.dart';
import '../base/os.dart';
14
import '../base/platform.dart';
15
import '../base/user_messages.dart';
16
import '../base/utils.dart';
17
import '../base/version.dart';
18
import '../convert.dart';
19
import '../doctor.dart';
20
import '../features.dart';
21
import '../globals.dart' as globals;
22
import 'android_sdk.dart';
23
import 'android_studio.dart';
24

25
const int kAndroidSdkMinVersion = 29;
26
final Version kAndroidJavaMinVersion = Version(1, 8, 0);
27 28
final Version kAndroidSdkBuildToolsMinVersion = Version(28, 0, 3);

29 30 31
AndroidWorkflow get androidWorkflow => context.get<AndroidWorkflow>();
AndroidValidator get androidValidator => context.get<AndroidValidator>();
AndroidLicenseValidator get androidLicenseValidator => context.get<AndroidLicenseValidator>();
32

33 34 35 36 37 38 39
enum LicensesAccepted {
  none,
  some,
  all,
  unknown,
}

40 41 42
final RegExp licenseCounts = RegExp(r'(\d+) of (\d+) SDK package licenses? not accepted.');
final RegExp licenseNotAccepted = RegExp(r'licenses? not accepted', caseSensitive: false);
final RegExp licenseAccepted = RegExp(r'All SDK package licenses accepted.');
43

44
class AndroidWorkflow implements Workflow {
45 46
  AndroidWorkflow({
    @required AndroidSdk androidSdk,
47 48 49
    @required FeatureFlags featureFlags,
  }) : _androidSdk = androidSdk,
       _featureFlags = featureFlags;
50 51

  final AndroidSdk _androidSdk;
52
  final FeatureFlags _featureFlags;
53

54
  @override
55
  bool get appliesToHostPlatform => _featureFlags.isAndroidEnabled;
56

57
  @override
58 59
  bool get canListDevices => _androidSdk != null
    && _androidSdk.adbPath != null;
60

61
  @override
62 63 64
  bool get canLaunchDevices => _androidSdk != null
    && _androidSdk.adbPath != null
    && _androidSdk.validateSdkWellFormed().isEmpty;
65

66
  @override
67 68 69
  bool get canListEmulators => _androidSdk != null
    && _androidSdk.adbPath != null
    && _androidSdk.emulatorPath != null;
70 71
}

72 73 74 75 76 77 78
/// A validator that checks if the Android SDK and Java SDK are available and
/// installed correctly.
///
/// Android development requires the Android SDK, and at least one Java SDK. While
/// newer Java compilers can be used to compile the Java application code, the SDK
/// tools themselves required JDK 1.8. This older JDK is normally bundled with
/// Android Studio.
79
class AndroidValidator extends DoctorValidator {
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  AndroidValidator({
    @required AndroidSdk androidSdk,
    @required AndroidStudio androidStudio,
    @required FileSystem fileSystem,
    @required Logger logger,
    @required Platform platform,
    @required ProcessManager processManager,
    @required UserMessages userMessages,
  }) : _androidSdk = androidSdk,
       _androidStudio = androidStudio,
       _fileSystem = fileSystem,
       _logger = logger,
       _operatingSystemUtils = OperatingSystemUtils(
         fileSystem: fileSystem,
         logger: logger,
         platform: platform,
         processManager: processManager,
       ),
       _platform = platform,
       _processManager = processManager,
       _userMessages = userMessages,
       super('Android toolchain - develop for Android devices');

  final AndroidSdk _androidSdk;
  final AndroidStudio _androidStudio;
  final FileSystem _fileSystem;
  final Logger _logger;
  final OperatingSystemUtils _operatingSystemUtils;
  final Platform _platform;
  final ProcessManager _processManager;
  final UserMessages _userMessages;
111

112 113 114 115
  @override
  String get slowWarning => '${_task ?? 'This'} is taking a long time...';
  String _task;

116 117 118 119 120 121 122 123 124 125 126
  /// Finds the semantic version anywhere in a text.
  static final RegExp _javaVersionPattern = RegExp(r'(\d+)(\.(\d+)(\.(\d+))?)?');

  /// `java -version` response is not only a number, but also includes other
  /// information eg. `openjdk version "1.7.0_212"`.
  /// This method extracts only the semantic version from from that response.
  static String _extractJavaVersion(String text) {
    final Match match = _javaVersionPattern.firstMatch(text ?? '');
    return text?.substring(match.start, match.end);
  }

127
  /// Returns false if we cannot determine the Java version or if the version
128
  /// is older that the minimum allowed version of 1.8.
129
  Future<bool> _checkJavaVersion(String javaBinary, List<ValidationMessage> messages) async {
130
    _task = 'Checking Java status';
131
    try {
132 133
      if (!_processManager.canRun(javaBinary)) {
        messages.add(ValidationMessage.error(_userMessages.androidCantRunJavaBinary(javaBinary)));
134
        return false;
135
      }
136
      String javaVersionText;
137
      try {
138 139
        _logger.printTrace('java -version');
        final ProcessResult result = await _processManager.run(<String>[javaBinary, '-version']);
140
        if (result.exitCode == 0) {
141
          final List<String> versionLines = (result.stderr as String).split('\n');
142
          javaVersionText = versionLines.length >= 2 ? versionLines[1] : versionLines[0];
143
        }
144
      } on Exception catch (error) {
145
        _logger.printTrace(error.toString());
146
      }
147
      if (javaVersionText == null || javaVersionText.isEmpty) {
148
        // Could not determine the java version.
149
        messages.add(ValidationMessage.error(_userMessages.androidUnknownJavaVersion));
150 151
        return false;
      }
152 153
      final Version javaVersion = Version.parse(_extractJavaVersion(javaVersionText));
      if (javaVersion < kAndroidJavaMinVersion) {
154
        messages.add(ValidationMessage.error(_userMessages.androidJavaMinimumVersion(javaVersionText)));
155 156
        return false;
      }
157
      messages.add(ValidationMessage(_userMessages.androidJavaVersion(javaVersionText)));
158 159 160
      return true;
    } finally {
      _task = null;
161 162 163
    }
  }

164
  @override
165
  Future<ValidationResult> validate() async {
166
    final List<ValidationMessage> messages = <ValidationMessage>[];
167

168
    if (_androidSdk == null) {
169
      // No Android SDK found.
170 171 172
      if (_platform.environment.containsKey(kAndroidHome)) {
        final String androidHomeDir = _platform.environment[kAndroidHome];
        messages.add(ValidationMessage.error(_userMessages.androidBadSdkDir(kAndroidHome, androidHomeDir)));
173
      } else {
174 175
        // Instruct user to set [kAndroidSdkRoot] and not deprecated [kAndroidHome]
        // See https://github.com/flutter/flutter/issues/39301
176
        messages.add(ValidationMessage.error(_userMessages.androidMissingSdkInstructions(_platform)));
177
      }
178
      return ValidationResult(ValidationType.missing, messages);
179
    }
180

181 182
    if (_androidSdk.licensesAvailable && !_androidSdk.platformToolsAvailable) {
      messages.add(ValidationMessage.hint(_userMessages.androidSdkLicenseOnly(kAndroidHome)));
183 184 185
      return ValidationResult(ValidationType.partial, messages);
    }

186
    messages.add(ValidationMessage(_userMessages.androidSdkLocation(_androidSdk.directory)));
187

188
    String sdkVersionText;
189
    if (_androidSdk.latestVersion != null) {
190
      if (_androidSdk.latestVersion.sdkLevel < kAndroidSdkMinVersion || _androidSdk.latestVersion.buildToolsVersion < kAndroidSdkBuildToolsMinVersion) {
191
        messages.add(ValidationMessage.error(
192 193 194 195 196 197
          _userMessages.androidSdkBuildToolsOutdated(
            _androidSdk.sdkManagerPath,
            kAndroidSdkMinVersion,
            kAndroidSdkBuildToolsMinVersion.toString(),
            _platform,
          )),
198 199 200
        );
        return ValidationResult(ValidationType.missing, messages);
      }
201
      sdkVersionText = _userMessages.androidStatusInfo(_androidSdk.latestVersion.buildToolsVersionName);
202

203 204 205
      messages.add(ValidationMessage(_userMessages.androidSdkPlatformToolsVersion(
        _androidSdk.latestVersion.platformName,
        _androidSdk.latestVersion.buildToolsVersionName)));
206
    } else {
207
      messages.add(ValidationMessage.error(_userMessages.androidMissingSdkInstructions(_platform)));
208
    }
209

210 211
    if (_platform.environment.containsKey(kAndroidHome)) {
      final String androidHomeDir = _platform.environment[kAndroidHome];
212
      messages.add(ValidationMessage('$kAndroidHome = $androidHomeDir'));
213
    }
214 215
    if (_platform.environment.containsKey(kAndroidSdkRoot)) {
      final String androidSdkRoot = _platform.environment[kAndroidSdkRoot];
216 217
      messages.add(ValidationMessage('$kAndroidSdkRoot = $androidSdkRoot'));
    }
218

219
    final List<String> validationResult = _androidSdk.validateSdkWellFormed();
220

221 222
    if (validationResult.isNotEmpty) {
      // Android SDK is not functional.
223
      messages.addAll(validationResult.map<ValidationMessage>((String message) {
224
        return ValidationMessage.error(message);
225
      }));
226
      messages.add(ValidationMessage(_userMessages.androidSdkInstallHelp(_platform)));
227
      return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
228 229 230
    }

    // Now check for the JDK.
231 232 233 234 235 236
    final String javaBinary = AndroidSdk.findJavaBinary(
      androidStudio: _androidStudio,
      fileSystem: _fileSystem,
      operatingSystemUtils: _operatingSystemUtils,
      platform: _platform,
    );
237
    if (javaBinary == null) {
238
      messages.add(ValidationMessage.error(_userMessages.androidMissingJdk));
239
      return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
240
    }
241
    messages.add(ValidationMessage(_userMessages.androidJdkLocation(javaBinary)));
242 243

    // Check JDK version.
244
    if (! await _checkJavaVersion(javaBinary, messages)) {
245
      return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
246 247
    }

248 249 250 251 252
    // Success.
    return ValidationResult(ValidationType.installed, messages, statusInfo: sdkVersionText);
  }
}

253 254
/// A subvalidator that checks if the licenses within the detected Android
/// SDK have been accepted.
255
class AndroidLicenseValidator extends DoctorValidator {
256
  AndroidLicenseValidator() : super('Android license subvalidator',);
257

258 259 260
  @override
  String get slowWarning => 'Checking Android licenses is taking an unexpectedly long time...';

261 262 263 264 265
  @override
  Future<ValidationResult> validate() async {
    final List<ValidationMessage> messages = <ValidationMessage>[];

    // Match pre-existing early termination behavior
266 267
    if (globals.androidSdk == null || globals.androidSdk.latestVersion == null ||
        globals.androidSdk.validateSdkWellFormed().isNotEmpty ||
268 269 270 271
        ! await _checkJavaVersionNoOutput()) {
      return ValidationResult(ValidationType.missing, messages);
    }

272
    final String sdkVersionText = userMessages.androidStatusInfo(globals.androidSdk.latestVersion.buildToolsVersionName);
273

274 275 276
    // Check for licenses.
    switch (await licensesAccepted) {
      case LicensesAccepted.all:
277
        messages.add(ValidationMessage(userMessages.androidLicensesAll));
278 279
        break;
      case LicensesAccepted.some:
280
        messages.add(ValidationMessage.hint(userMessages.androidLicensesSome));
281
        return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
282
      case LicensesAccepted.none:
283
        messages.add(ValidationMessage.error(userMessages.androidLicensesNone));
284
        return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
285
      case LicensesAccepted.unknown:
286
        messages.add(ValidationMessage.error(userMessages.androidLicensesUnknown(globals.platform)));
287
        return ValidationResult(ValidationType.partial, messages, statusInfo: sdkVersionText);
288
    }
289
    return ValidationResult(ValidationType.installed, messages, statusInfo: sdkVersionText);
290
  }
291

292
  Future<bool> _checkJavaVersionNoOutput() async {
293 294 295 296 297 298
    final String javaBinary = AndroidSdk.findJavaBinary(
      androidStudio: globals.androidStudio,
      fileSystem: globals.fs,
      operatingSystemUtils: globals.os,
      platform: globals.platform,
    );
299 300 301
    if (javaBinary == null) {
      return false;
    }
302
    if (!globals.processManager.canRun(javaBinary)) {
303 304 305 306
      return false;
    }
    String javaVersion;
    try {
307
      final ProcessResult result = await globals.processManager.run(<String>[javaBinary, '-version']);
308
      if (result.exitCode == 0) {
309
        final List<String> versionLines = (result.stderr as String).split('\n');
310 311
        javaVersion = versionLines.length >= 2 ? versionLines[1] : versionLines[0];
      }
312
    } on Exception catch (error) {
313
      globals.printTrace(error.toString());
314 315 316 317 318 319 320 321
    }
    if (javaVersion == null) {
      // Could not determine the java version.
      return false;
    }
    return true;
  }

322
  Future<LicensesAccepted> get licensesAccepted async {
323
    LicensesAccepted status;
324

325 326
    void _handleLine(String line) {
      if (licenseCounts.hasMatch(line)) {
327 328 329 330 331 332 333
        final Match match = licenseCounts.firstMatch(line);
        if (match.group(1) != match.group(2)) {
          status = LicensesAccepted.some;
        } else {
          status = LicensesAccepted.none;
        }
      } else if (licenseNotAccepted.hasMatch(line)) {
334 335 336
        // The licenseNotAccepted pattern is trying to match the same line as
        // licenseCounts, but is more general. In case the format changes, a
        // more general match may keep doctor mostly working.
337
        status = LicensesAccepted.none;
338 339
      } else if (licenseAccepted.hasMatch(line)) {
        status ??= LicensesAccepted.all;
340 341 342
      }
    }

343 344 345
    if (!_canRunSdkManager()) {
      return LicensesAccepted.unknown;
    }
346

347
    try {
348
      final Process process = await globals.processUtils.start(
349 350
        <String>[globals.androidSdk.sdkManagerPath, '--licenses'],
        environment: globals.androidSdk.sdkManagerEnv,
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
      );
      process.stdin.write('n\n');
      // We expect logcat streams to occasionally contain invalid utf-8,
      // see: https://github.com/flutter/flutter/pull/8864.
      final Future<void> output = process.stdout
        .transform<String>(const Utf8Decoder(reportErrors: false))
        .transform<String>(const LineSplitter())
        .listen(_handleLine)
        .asFuture<void>(null);
      final Future<void> errors = process.stderr
        .transform<String>(const Utf8Decoder(reportErrors: false))
        .transform<String>(const LineSplitter())
        .listen(_handleLine)
        .asFuture<void>(null);
      await Future.wait<void>(<Future<void>>[output, errors]);
      return status ?? LicensesAccepted.unknown;
    } on ProcessException catch (e) {
368
      globals.printTrace('Failed to run Android sdk manager: $e');
369 370
      return LicensesAccepted.unknown;
    }
371 372
  }

373 374
  /// Run the Android SDK manager tool in order to accept SDK licenses.
  static Future<bool> runLicenseManager() async {
375
    if (globals.androidSdk == null) {
376
      globals.printStatus(userMessages.androidSdkShort);
377 378 379
      return false;
    }

380
    if (!_canRunSdkManager()) {
381
      throwToolExit(userMessages.androidMissingSdkManager(globals.androidSdk.sdkManagerPath, globals.platform));
382
    }
383

384
    try {
385
      final Process process = await globals.processUtils.start(
386 387
        <String>[globals.androidSdk.sdkManagerPath, '--licenses'],
        environment: globals.androidSdk.sdkManagerEnv,
388 389 390 391
      );

      // The real stdin will never finish streaming. Pipe until the child process
      // finishes.
392 393 394 395 396 397 398 399 400
      unawaited(process.stdin.addStream(globals.stdio.stdin)
        // If the process exits unexpectedly with an error, that will be
        // handled by the caller.
        .catchError((dynamic err, StackTrace stack) {
          globals.printTrace('Echoing stdin to the licenses subprocess failed:');
          globals.printTrace('$err\n$stack');
        }
      ));

401 402
      // Wait for stdout and stderr to be fully processed, because process.exitCode
      // may complete first.
403 404 405 406 407
      try {
        await waitGroup<void>(<Future<void>>[
          globals.stdio.addStdoutStream(process.stdout),
          globals.stdio.addStderrStream(process.stderr),
        ]);
408
      } on Exception catch (err, stack) {
409 410 411
        globals.printTrace('Echoing stdout or stderr from the license subprocess failed:');
        globals.printTrace('$err\n$stack');
      }
412 413 414 415 416

      final int exitCode = await process.exitCode;
      return exitCode == 0;
    } on ProcessException catch (e) {
      throwToolExit(userMessages.androidCannotRunSdkManager(
417
        globals.androidSdk.sdkManagerPath,
418
        e.toString(),
419
        globals.platform,
420
      ));
421 422
      return false;
    }
423
  }
424

425
  static bool _canRunSdkManager() {
426 427
    assert(globals.androidSdk != null);
    final String sdkManagerPath = globals.androidSdk.sdkManagerPath;
428
    return globals.processManager.canRun(sdkManagerPath);
429
  }
430
}