build_appbundle_test.dart 16.6 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
import 'dart:io';

7 8
import 'package:args/command_runner.dart';
import 'package:flutter_tools/src/android/android_builder.dart';
9
import 'package:flutter_tools/src/android/android_sdk.dart';
10
import 'package:flutter_tools/src/base/context.dart';
11 12 13
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/cache.dart';
import 'package:flutter_tools/src/commands/build_appbundle.dart';
14
import 'package:flutter_tools/src/globals.dart' as globals;
15
import 'package:flutter_tools/src/project.dart';
16
import 'package:flutter_tools/src/reporting/reporting.dart';
17 18
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
19

20
import '../../src/android_common.dart';
21 22
import '../../src/common.dart';
import '../../src/context.dart';
23
import '../../src/mocks.dart';
24 25 26 27

void main() {
  Cache.disableLocking();

28
  group('Usage', () {
29
    Directory tempDir;
30
    Usage mockUsage;
31 32

    setUp(() {
33
      tempDir = globals.fs.systemTempDirectory.createTempSync('flutter_tools_packages_test.');
34
      mockUsage = MockUsage();
35 36 37 38 39 40 41 42 43
    });

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

    testUsingContext('indicate the default target platforms', () async {
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);
44
      final BuildAppBundleCommand command = await runBuildAppBundleCommand(projectPath);
45 46

      expect(await command.usageValues,
47
          containsPair(CustomDimensions.commandBuildAppBundleTargetPlatform, 'android-arm,android-arm64,android-x64'));
48 49 50

    }, overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
51
    });
52 53 54 55 56

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

57
      final BuildAppBundleCommand commandDefault = await runBuildAppBundleCommand(projectPath);
58 59 60
      expect(await commandDefault.usageValues,
          containsPair(CustomDimensions.commandBuildAppBundleBuildMode, 'release'));

61
      final BuildAppBundleCommand commandInRelease = await runBuildAppBundleCommand(projectPath,
62 63 64 65
          arguments: <String>['--release']);
      expect(await commandInRelease.usageValues,
          containsPair(CustomDimensions.commandBuildAppBundleBuildMode, 'release'));

66
      final BuildAppBundleCommand commandInDebug = await runBuildAppBundleCommand(projectPath,
67 68 69 70
          arguments: <String>['--debug']);
      expect(await commandInDebug.usageValues,
          containsPair(CustomDimensions.commandBuildAppBundleBuildMode, 'debug'));

71
      final BuildAppBundleCommand commandInProfile = await runBuildAppBundleCommand(projectPath,
72 73 74 75 76 77
          arguments: <String>['--profile']);
      expect(await commandInProfile.usageValues,
          containsPair(CustomDimensions.commandBuildAppBundleBuildMode, 'profile'));

    }, overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
78
    });
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

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

      await runBuildAppBundleCommand(projectPath);

      verify(mockUsage.sendEvent(
        'tool-command-result',
        'appbundle',
        label: 'success',
        value: anyNamed('value'),
        parameters: anyNamed('parameters'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidBuilder: () => FakeAndroidBuilder(),
      Usage: () => mockUsage,
    });
98
  });
99

Emmanuel Garcia's avatar
Emmanuel Garcia committed
100
  group('Gradle', () {
101 102 103 104 105 106 107 108 109 110
    Directory tempDir;
    ProcessManager mockProcessManager;
    MockAndroidSdk mockAndroidSdk;
    String gradlew;
    Usage mockUsage;

    setUp(() {
      mockUsage = MockUsage();
      when(mockUsage.isFirstRun).thenReturn(true);

111 112 113
      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');
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

      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);

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
      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, '', ''));
      });

157
      mockAndroidSdk = MockAndroidSdk();
158 159
      when(mockAndroidSdk.licensesAvailable).thenReturn(true);
      when(mockAndroidSdk.platformToolsAvailable).thenReturn(true);
160 161 162 163 164 165 166 167
      when(mockAndroidSdk.validateSdkWellFormed()).thenReturn(const <String>[]);
      when(mockAndroidSdk.directory).thenReturn('irrelevant');
    });

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

168 169
    group('AndroidSdk', () {
      testUsingContext('validateSdkWellFormed() not called, sdk reinitialized', () async {
170 171
        final String projectPath = await createProject(tempDir,
            arguments: <String>['--no-pub', '--template=app']);
172 173

        await expectLater(
174 175 176 177
          runBuildAppBundleCommand(
            projectPath,
            arguments: <String>['--no-pub'],
          ),
178
          throwsToolExit(message: 'Gradle task bundleRelease failed with exit code 1'),
179 180 181 182 183 184 185
        );

        verifyNever(mockAndroidSdk.validateSdkWellFormed());
        verify(mockAndroidSdk.reinitialize()).called(1);
      },
      overrides: <Type, Generator>{
        AndroidSdk: () => mockAndroidSdk,
186 187 188 189 190 191 192 193 194 195 196 197 198 199
        FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
        ProcessManager: () => mockProcessManager,
      });

      testUsingContext('throws throwsToolExit if AndroidSdk is null', () async {
        final String projectPath = await createProject(tempDir,
            arguments: <String>['--no-pub', '--template=app']);

        await expectLater(() async {
          await runBuildAppBundleCommand(
            projectPath,
            arguments: <String>['--no-pub'],
          );
        }, throwsToolExit(
200
          message: 'No Android SDK found. Try setting the ANDROID_HOME environment variable',
201 202 203 204 205
        ));
      },
      overrides: <Type, Generator>{
        AndroidSdk: () => null,
        FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
206 207 208 209
        ProcessManager: () => mockProcessManager,
      });
    });

Emmanuel Garcia's avatar
Emmanuel Garcia committed
210
    testUsingContext('shrinking is enabled by default on release mode', () async {
211 212 213 214 215 216 217 218 219 220 221 222 223
      final String projectPath = await createProject(
          tempDir,
          arguments: <String>['--no-pub', '--template=app'],
        );

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

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
224
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
225
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
226
          '-Ptrack-widget-creation=false',
Emmanuel Garcia's avatar
Emmanuel Garcia committed
227
          '-Pshrink=true',
228 229 230 231 232 233 234 235 236 237
          'bundleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
238
    });
239

Emmanuel Garcia's avatar
Emmanuel Garcia committed
240
    testUsingContext('shrinking is disabled when --no-shrink is passed', () async {
241 242 243 244 245 246 247 248
      final String projectPath = await createProject(
          tempDir,
          arguments: <String>['--no-pub', '--template=app'],
        );

      await expectLater(() async {
        await runBuildAppBundleCommand(
          projectPath,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
249
          arguments: <String>['--no-shrink'],
250 251 252 253 254 255 256
        );
      }, throwsToolExit(message: 'Gradle task bundleRelease failed with exit code 1'));

      verify(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
257
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
258
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
259 260 261 262 263 264 265 266 267 268 269
          '-Ptrack-widget-creation=false',
          'bundleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
270
    });
271

Emmanuel Garcia's avatar
Emmanuel Garcia committed
272
    testUsingContext('guides the user when the shrinker fails', () async {
273 274 275 276 277 278 279
      final String projectPath = await createProject(tempDir,
          arguments: <String>['--no-pub', '--template=app']);

      when(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
280
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
281
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
282
          '-Ptrack-widget-creation=false',
Emmanuel Garcia's avatar
Emmanuel Garcia committed
283
          '-Pshrink=true',
284 285 286 287 288
          'bundleRelease',
        ],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) {
Emmanuel Garcia's avatar
Emmanuel Garcia committed
289
        const String r8StdoutWarning =
290
            "Execution failed for task ':app:transformClassesAndResourcesWithR8ForStageInternal'.\n"
Emmanuel Garcia's avatar
Emmanuel Garcia committed
291
            '> com.android.tools.r8.CompilationFailedException: Compilation failed to complete';
292 293 294
        return Future<Process>.value(
          createMockProcess(
            exitCode: 1,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
295
            stdout: r8StdoutWarning,
296
          ),
297 298 299 300 301 302 303 304 305 306
        );
      });

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

      expect(testLogger.statusText,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
307
          contains('The shrinker may have failed to optimize the Java bytecode.'));
308
      expect(testLogger.statusText,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
309
          contains('To disable the shrinker, pass the `--no-shrink` flag to this command.'));
310
      expect(testLogger.statusText,
Emmanuel Garcia's avatar
Emmanuel Garcia committed
311
          contains('To learn more, see: https://developer.android.com/studio/build/shrink-code'));
312 313

      verify(mockUsage.sendEvent(
314 315
        'build',
        'appbundle',
316
        label: 'gradle-r8-failure',
317 318 319 320 321 322 323 324
        parameters: anyNamed('parameters'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
      Usage: () => mockUsage,
325
    });
326

327
    testUsingContext("reports when the app isn't using AndroidX", () async {
328
      final String projectPath = await createProject(tempDir,
329 330 331 332 333 334 335
          arguments: <String>['--no-pub', '--template=app']);
      // Simulate a non-androidx project.
      tempDir
        .childDirectory('flutter_project')
        .childDirectory('android')
        .childFile('gradle.properties')
        .writeAsStringSync('android.useAndroidX=false');
336 337 338 339 340

      when(mockProcessManager.start(
        <String>[
          gradlew,
          '-q',
341
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
342
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
          '-Ptrack-widget-creation=false',
          '-Pshrink=true',
          '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 AAB in the file system.
      await expectLater(() async {
        await runBuildAppBundleCommand(
          projectPath,
        );
      }, throwsToolExit());

kwkr's avatar
kwkr committed
364 365
      expect(testLogger.statusText, containsIgnoringWhitespace("Your app isn't using AndroidX"));
      expect(testLogger.statusText, containsIgnoringWhitespace(
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
        'To avoid potential build failures, you can quickly migrate your app by '
        'following the steps on https://goo.gl/CP92wY'
        )
      );
      verify(mockUsage.sendEvent(
        'build',
        'appbundle',
        label: 'app-not-using-android-x',
        parameters: anyNamed('parameters'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
      Usage: () => mockUsage,
382
    });
383 384 385 386 387 388 389 390 391

    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',
392
          '-Ptarget-platform=android-arm,android-arm64,android-x64',
393
          '-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
          '-Ptrack-widget-creation=false',
          '-Pshrink=true',
          '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 AAB in the file system.
      await expectLater(() async {
        await runBuildAppBundleCommand(
          projectPath,
        );
      }, throwsToolExit());

kwkr's avatar
kwkr committed
415 416
      expect(testLogger.statusText,
        not(containsIgnoringWhitespace("Your app isn't using AndroidX")));
417
      expect(
kwkr's avatar
kwkr committed
418
        testLogger.statusText, not(containsIgnoringWhitespace(
419
          'To avoid potential build failures, you can quickly migrate your app by '
kwkr's avatar
kwkr committed
420
          'following the steps on https://goo.gl/CP92wY'))
421 422 423 424 425 426 427 428 429 430 431 432 433
      );
      verify(mockUsage.sendEvent(
        'build',
        'appbundle',
        label: 'app-using-android-x',
        parameters: anyNamed('parameters'),
      )).called(1);
    },
    overrides: <Type, Generator>{
      AndroidSdk: () => mockAndroidSdk,
      FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
      ProcessManager: () => mockProcessManager,
      Usage: () => mockUsage,
434
    });
435
  });
436
}
437 438

Future<BuildAppBundleCommand> runBuildAppBundleCommand(
439 440 441
  String target, {
  List<String> arguments,
}) async {
442 443 444 445 446
  final BuildAppBundleCommand command = BuildAppBundleCommand();
  final CommandRunner<void> runner = createTestCommandRunner(command);
  await runner.run(<String>[
    'appbundle',
    ...?arguments,
447
    '--no-pub',
448
    globals.fs.path.join(target, 'lib', 'main.dart'),
449 450 451 452
  ]);
  return command;
}

kwkr's avatar
kwkr committed
453 454 455 456
Matcher not(Matcher target){
  return isNot(target);
}

457 458 459 460
class MockAndroidSdk extends Mock implements AndroidSdk {}
class MockProcessManager extends Mock implements ProcessManager {}
class MockProcess extends Mock implements Process {}
class MockUsage extends Mock implements Usage {}