build_apk_test.dart 19 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
// @dart = 2.8

7
import 'dart:io' hide Directory;
8

9 10
import 'package:args/command_runner.dart';
import 'package:flutter_tools/src/android/android_builder.dart';
11
import 'package:flutter_tools/src/android/android_sdk.dart';
12
import 'package:flutter_tools/src/base/file_system.dart';
13

14 15
import 'package:flutter_tools/src/cache.dart';
import 'package:flutter_tools/src/commands/build_apk.dart';
16
import 'package:flutter_tools/src/project.dart';
17
import 'package:flutter_tools/src/reporting/reporting.dart';
18
import 'package:flutter_tools/src/globals_null_migrated.dart' as globals;
19
import 'package:mockito/mockito.dart';
20
import 'package:process/process.dart';
21

22
import '../../src/android_common.dart';
23 24
import '../../src/common.dart';
import '../../src/context.dart';
25
import '../../src/mocks.dart' hide MockAndroidSdk;
26
import '../../src/test_flutter_command_runner.dart';
27 28 29 30

void main() {
  Cache.disableLocking();

31
  group('Usage', () {
32
    Directory tempDir;
33
    TestUsage testUsage;
34 35

    setUp(() {
36
      testUsage = TestUsage();
37
      tempDir = globals.fs.systemTempDirectory.createTempSync('flutter_tools_packages_test.');
38 39 40 41 42 43 44 45 46
    });

    tearDown(() {
      tryToDelete(tempDir);
    });

    testUsingContext('indicate the default target platforms', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);
47
      final BuildApkCommand command = await runBuildApkCommand(projectPath);
48 49

      expect(await command.usageValues,
50
          containsPair(CustomDimensions.commandBuildApkTargetPlatform, 'android-arm,android-arm64,android-x64'));
51 52 53

    }, overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
54
    });
55 56 57 58 59

    testUsingContext('split per abi', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

60
      final BuildApkCommand commandWithFlag = await runBuildApkCommand(projectPath,
61 62 63 64
          arguments: <String>['--split-per-abi']);
      expect(await commandWithFlag.usageValues,
          containsPair(CustomDimensions.commandBuildApkSplitPerAbi, 'true'));

65
      final BuildApkCommand commandWithoutFlag = await runBuildApkCommand(projectPath);
66 67 68 69 70
      expect(await commandWithoutFlag.usageValues,
          containsPair(CustomDimensions.commandBuildApkSplitPerAbi, 'false'));

    }, overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
71
    });
72 73 74 75 76

    testUsingContext('build type', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

77
      final BuildApkCommand commandDefault = await runBuildApkCommand(projectPath);
78 79 80
      expect(await commandDefault.usageValues,
          containsPair(CustomDimensions.commandBuildApkBuildMode, 'release'));

81
      final BuildApkCommand commandInRelease = await runBuildApkCommand(projectPath,
82 83 84 85
          arguments: <String>['--release']);
      expect(await commandInRelease.usageValues,
          containsPair(CustomDimensions.commandBuildApkBuildMode, 'release'));

86
      final BuildApkCommand commandInDebug = await runBuildApkCommand(projectPath,
87 88 89 90
          arguments: <String>['--debug']);
      expect(await commandInDebug.usageValues,
          containsPair(CustomDimensions.commandBuildApkBuildMode, 'debug'));

91
      final BuildApkCommand commandInProfile = await runBuildApkCommand(projectPath,
92 93 94 95 96 97
          arguments: <String>['--profile']);
      expect(await commandInProfile.usageValues,
          containsPair(CustomDimensions.commandBuildApkBuildMode, 'profile'));

    }, overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
98
    });
99 100 101 102 103 104 105

    testUsingContext('logs success', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      await runBuildApkCommand(projectPath);

106 107 108 109 110 111 112
      expect(testUsage.events, contains(
        const TestUsageEvent(
          'tool-command-result',
          'apk',
          label: 'success',
        ),
      ));
113 114 115
    },
    overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
116
      Usage: () => testUsage,
117
    });
118
  });
119 120 121 122 123 124

  group('Gradle', () {
    Directory tempDir;
    ProcessManager mockProcessManager;
    String gradlew;
    AndroidSdk mockAndroidSdk;
125
    TestUsage testUsage;
126 127

    setUp(() {
128
      testUsage = TestUsage();
129

130 131 132
      tempDir = globals.fs.systemTempDirectory.createTempSync('flutter_tools_packages_test.');
      gradlew = globals.fs.path.join(tempDir.path, 'flutter_project', 'android',
          globals.platform.isWindows ? 'gradlew.bat' : 'gradlew');
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

      mockProcessManager = MockProcessManager();
      when(mockProcessManager.run(<String>[gradlew, '-v'],
          environment: anyNamed('environment')))
        .thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(0, 0, '', '')));

      when(mockProcessManager.run(<String>[gradlew, 'app:properties'],
          workingDirectory: anyNamed('workingDirectory'),
          environment: anyNamed('environment')))
        .thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(0, 0, 'buildDir: irrelevant', '')));

      when(mockProcessManager.run(<String>[gradlew, 'app:tasks', '--all', '--console=auto'],
          workingDirectory: anyNamed('workingDirectory'),
          environment: anyNamed('environment')))
        .thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(0, 0, 'assembleRelease', '')));
      // Fallback with error.
      final Process process = createMockProcess(exitCode: 1);
      when(mockProcessManager.start(any,
          workingDirectory: anyNamed('workingDirectory'),
          environment: anyNamed('environment')))
        .thenAnswer((_) => Future<Process>.value(process));
      when(mockProcessManager.canRun(any)).thenReturn(false);

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
      when(mockProcessManager.runSync(
        argThat(contains(contains('gen_snapshot'))),
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenReturn(ProcessResult(0, 255, '', ''));

      when(mockProcessManager.runSync(
        <String>['/usr/bin/xcode-select', '--print-path'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenReturn(ProcessResult(0, 0, '', ''));

      when(mockProcessManager.run(
        <String>['which', 'pod'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) {
        return Future<ProcessResult>.value(ProcessResult(0, 0, '', ''));
      });

176
      mockAndroidSdk = FakeAndroidSdk(globals.fs.directory('irrelevant'));
177 178 179 180 181 182
    });

    tearDown(() {
      tryToDelete(tempDir);
    });

183
    group('AndroidSdk', () {
184 185 186 187 188 189 190 191 192 193
      testUsingContext('throws throwsToolExit if AndroidSdk is null', () async {
        final String projectPath = await createProject(tempDir,
            arguments: <String>['--no-pub', '--template=app']);

        await expectLater(() async {
          await runBuildApkCommand(
            projectPath,
            arguments: <String>['--no-pub'],
          );
        }, throwsToolExit(
194
          message: 'No Android SDK found. Try setting the ANDROID_SDK_ROOT environment variable',
195 196 197 198 199
        ));
      },
      overrides: <Type, Generator>{
        AndroidSdk: () => null,
        FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
200
        ProcessManager: () => mockProcessManager,
201 202 203
      });
    });

Emmanuel Garcia's avatar
Emmanuel Garcia committed
204
    testUsingContext('shrinking is enabled by default on release mode', () async {
205 206 207 208 209 210 211 212 213 214 215
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      await expectLater(() async {
        await runBuildApkCommand(projectPath);
      }, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
216
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
217
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
218
          '-Pdart-obfuscation=false',
219
          '-Ptrack-widget-creation=true',
220
          '-Ptree-shake-icons=true',
221 222 223 224 225 226 227 228 229 230
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
231
    });
232

233 234 235 236 237 238 239 240 241 242 243 244
    testUsingContext('--split-debug-info is enabled when an output directory is provided', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      await expectLater(() async {
        await runBuildApkCommand(projectPath, arguments: <String>['--split-debug-info=${tempDir.path}']);
      }, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
245
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
246
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
247
          '-Pdart-obfuscation=false',
248
          '-Psplit-debug-info=${tempDir.path}',
249
          '-Ptrack-widget-creation=true',
250
          '-Ptree-shake-icons=true',
251 252 253 254 255 256 257 258 259 260 261 262
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
    });

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    testUsingContext('--extra-front-end-options are provided to gradle project', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      await expectLater(() async {
        await runBuildApkCommand(projectPath, arguments: <String>[
          '--extra-front-end-options=foo',
          '--extra-front-end-options=bar',
        ]);
      }, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
280
          '-Pdart-obfuscation=false',
281
          '-Pextra-front-end-options=foo,bar',
282
          '-Ptrack-widget-creation=true',
283
          '-Ptree-shake-icons=true',
284 285 286 287 288 289 290 291 292 293 294 295
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
    });

Emmanuel Garcia's avatar
Emmanuel Garcia committed
296
    testUsingContext('shrinking is disabled when --no-shrink is passed', () async {
297 298 299 300 301 302
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      await expectLater(() async {
        await runBuildApkCommand(
          projectPath,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
303
          arguments: <String>['--no-shrink'],
304 305 306 307 308 309 310
        );
      }, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
311
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
312
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
313
          '-Pdart-obfuscation=false',
314
          '-Ptrack-widget-creation=true',
315
          '-Ptree-shake-icons=true',
316 317 318 319 320 321 322 323 324 325
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
326
    });
327

Emmanuel Garcia's avatar
Emmanuel Garcia committed
328
    testUsingContext('guides the user when the shrinker fails', () async {
329 330 331 332 333 334 335
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      when(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
336
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
337
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
338
          '-Pdart-obfuscation=false',
339
          '-Ptrack-widget-creation=true',
340
          '-Ptree-shake-icons=true',
341 342 343 344 345
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) {
Emmanuel Garcia's avatar
Emmanuel Garcia committed
346
        const String r8StdoutWarning =
347
            "Execution failed for task ':app:transformClassesAndResourcesWithR8ForStageInternal'.\n"
Emmanuel Garcia's avatar
Emmanuel Garcia committed
348
            '> com.android.tools.r8.CompilationFailedException: Compilation failed to complete';
349 350 351
        return Future<Process>.value(
          createMockProcess(
            exitCode: 1,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
352
            stdout: r8StdoutWarning,
353
          ),
354 355 356 357 358 359 360 361 362
        );
      });

      await expectLater(() async {
        await runBuildApkCommand(
          projectPath,
        );
      }, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));

363 364 365 366 367 368 369 370 371 372 373 374
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace('The shrinker may have failed to optimize the Java bytecode.'),
      );
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace('To disable the shrinker, pass the `--no-shrink` flag to this command.'),
      );
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace('To learn more, see: https://developer.android.com/studio/build/shrink-code'),
      );
375

376 377 378 379 380 381 382 383
      expect(testUsage.events, contains(
        const TestUsageEvent(
          'build',
          'apk',
          label: 'gradle-r8-failure',
          parameters: <String, String>{},
        ),
      ));
384 385 386 387 388
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
389
      Usage: () => testUsage,
390
    });
391

392
    testUsingContext("reports when the app isn't using AndroidX", () async {
393
      final String projectPath = await createProject(tempDir,
394 395 396 397 398 399 400
          arguments: <String>['--no-pub', '--template=app']);
      // Simulate a non-androidx project.
      tempDir
        .childDirectory('flutter_project')
        .childDirectory('android')
        .childFile('gradle.properties')
        .writeAsStringSync('android.useAndroidX=false');
401 402 403 404 405

      when(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
406
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
407
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
408
          '-Pdart-obfuscation=false',
409
          '-Ptrack-widget-creation=true',
410
          '-Ptree-shake-icons=true',
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) {
        return Future<Process>.value(
          createMockProcess(
            exitCode: 0,
            stdout: '',
          ),
        );
      });
      // The command throws a [ToolExit] because it expects an APK in the file system.
      await expectLater(() async {
        await runBuildApkCommand(
          projectPath,
        );
      }, throwsToolExit());

430 431 432 433 434 435 436
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace("Your app isn't using AndroidX"),
      );
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace(
437 438
        'To avoid potential build failures, you can quickly migrate your app by '
        'following the steps on https://goo.gl/CP92wY'
439
        ),
440
      );
441 442 443 444 445 446 447 448 449

      expect(testUsage.events, contains(
        const TestUsageEvent(
          'build',
          'apk',
          label: 'app-not-using-android-x',
          parameters: <String, String>{},
        ),
      ));
450 451 452 453 454
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
455
      Usage: () => testUsage,
456
    });
457 458 459 460 461 462 463 464 465

    testUsingContext('reports when the app is using AndroidX', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      when(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
466
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
467
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
468
          '-Pdart-obfuscation=false',
469
          '-Ptrack-widget-creation=true',
470
          '-Ptree-shake-icons=true',
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
          'assembleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) {
        return Future<Process>.value(
          createMockProcess(
            exitCode: 0,
            stdout: '',
          ),
        );
      });
      // The command throws a [ToolExit] because it expects an APK in the file system.
      await expectLater(() async {
        await runBuildApkCommand(
          projectPath,
        );
      }, throwsToolExit());

490
      expect(testLogger.statusText.contains("[!] Your app isn't using AndroidX"), isFalse);
491
      expect(
492
        testLogger.statusText.contains(
493 494 495 496 497
          'To avoid potential build failures, you can quickly migrate your app by '
          'following the steps on https://goo.gl/CP92wY'
        ),
        isFalse,
      );
498 499 500 501 502 503 504 505 506

      expect(testUsage.events, contains(
        const TestUsageEvent(
          'build',
          'apk',
          label: 'app-using-android-x',
          parameters: <String, String>{},
        ),
      ));
507 508 509 510 511
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
512
      Usage: () => testUsage,
513
    });
514 515 516 517
  });
}

Future<BuildApkCommand> runBuildApkCommand(
518 519 520
  String target, {
  List<String> arguments,
}) async {
521 522 523 524 525
  final BuildApkCommand command = BuildApkCommand();
  final CommandRunner<void> runner = createTestCommandRunner(command);
  await runner.run(<String>[
    'apk',
    ...?arguments,
526
    '--no-pub',
527
    globals.fs.path.join(target, 'lib', 'main.dart'),
528 529
  ]);
  return command;
530
}
531

532 533 534 535 536 537 538
class FakeAndroidSdk extends Fake implements AndroidSdk {
  FakeAndroidSdk(this.directory);

  @override
  final Directory directory;
}

539
class MockProcessManager extends Mock implements ProcessManager {}