mirror of
https://github.com/flutter/flutter
synced 2024-10-13 11:42:54 +00:00
e23c4796a3
This will allow experimenting with the remove to string transformer before we're ready to turn it on by default. This doesn't work for web yet since we use dart2js instead of the frontend_server for producing kernel
530 lines
19 KiB
Dart
530 lines
19 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'dart:io';
|
|
|
|
import 'package:args/command_runner.dart';
|
|
import 'package:flutter_tools/src/android/android_builder.dart';
|
|
import 'package:flutter_tools/src/android/android_sdk.dart';
|
|
import 'package:flutter_tools/src/base/context.dart';
|
|
import 'package:flutter_tools/src/base/file_system.dart';
|
|
|
|
import 'package:flutter_tools/src/cache.dart';
|
|
import 'package:flutter_tools/src/commands/build_apk.dart';
|
|
import 'package:flutter_tools/src/project.dart';
|
|
import 'package:flutter_tools/src/reporting/reporting.dart';
|
|
import 'package:flutter_tools/src/globals.dart' as globals;
|
|
import 'package:mockito/mockito.dart';
|
|
import 'package:process/process.dart';
|
|
|
|
import '../../src/android_common.dart';
|
|
import '../../src/common.dart';
|
|
import '../../src/context.dart';
|
|
import '../../src/mocks.dart';
|
|
|
|
void main() {
|
|
Cache.disableLocking();
|
|
|
|
group('Usage', () {
|
|
Directory tempDir;
|
|
Usage mockUsage;
|
|
|
|
setUp(() {
|
|
mockUsage = MockUsage();
|
|
tempDir = globals.fs.systemTempDirectory.createTempSync('flutter_tools_packages_test.');
|
|
});
|
|
|
|
tearDown(() {
|
|
tryToDelete(tempDir);
|
|
});
|
|
|
|
testUsingContext('indicate the default target platforms', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
final BuildApkCommand command = await runBuildApkCommand(projectPath);
|
|
|
|
expect(await command.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkTargetPlatform, 'android-arm,android-arm64,android-x64'));
|
|
|
|
}, overrides: <Type, Generator>{
|
|
AndroidBuilder: () => FakeAndroidBuilder(),
|
|
});
|
|
|
|
testUsingContext('split per abi', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
final BuildApkCommand commandWithFlag = await runBuildApkCommand(projectPath,
|
|
arguments: <String>['--split-per-abi']);
|
|
expect(await commandWithFlag.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkSplitPerAbi, 'true'));
|
|
|
|
final BuildApkCommand commandWithoutFlag = await runBuildApkCommand(projectPath);
|
|
expect(await commandWithoutFlag.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkSplitPerAbi, 'false'));
|
|
|
|
}, overrides: <Type, Generator>{
|
|
AndroidBuilder: () => FakeAndroidBuilder(),
|
|
});
|
|
|
|
testUsingContext('build type', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
final BuildApkCommand commandDefault = await runBuildApkCommand(projectPath);
|
|
expect(await commandDefault.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkBuildMode, 'release'));
|
|
|
|
final BuildApkCommand commandInRelease = await runBuildApkCommand(projectPath,
|
|
arguments: <String>['--release']);
|
|
expect(await commandInRelease.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkBuildMode, 'release'));
|
|
|
|
final BuildApkCommand commandInDebug = await runBuildApkCommand(projectPath,
|
|
arguments: <String>['--debug']);
|
|
expect(await commandInDebug.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkBuildMode, 'debug'));
|
|
|
|
final BuildApkCommand commandInProfile = await runBuildApkCommand(projectPath,
|
|
arguments: <String>['--profile']);
|
|
expect(await commandInProfile.usageValues,
|
|
containsPair(CustomDimensions.commandBuildApkBuildMode, 'profile'));
|
|
|
|
}, overrides: <Type, Generator>{
|
|
AndroidBuilder: () => FakeAndroidBuilder(),
|
|
});
|
|
|
|
testUsingContext('logs success', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
await runBuildApkCommand(projectPath);
|
|
|
|
verify(mockUsage.sendEvent(
|
|
'tool-command-result',
|
|
'apk',
|
|
label: 'success',
|
|
value: anyNamed('value'),
|
|
parameters: anyNamed('parameters'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidBuilder: () => FakeAndroidBuilder(),
|
|
Usage: () => mockUsage,
|
|
});
|
|
});
|
|
|
|
group('Gradle', () {
|
|
Directory tempDir;
|
|
ProcessManager mockProcessManager;
|
|
String gradlew;
|
|
AndroidSdk mockAndroidSdk;
|
|
Usage mockUsage;
|
|
|
|
setUp(() {
|
|
mockUsage = MockUsage();
|
|
when(mockUsage.isFirstRun).thenReturn(true);
|
|
|
|
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');
|
|
|
|
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);
|
|
|
|
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, '', ''));
|
|
});
|
|
|
|
mockAndroidSdk = MockAndroidSdk();
|
|
when(mockAndroidSdk.directory).thenReturn('irrelevant');
|
|
});
|
|
|
|
tearDown(() {
|
|
tryToDelete(tempDir);
|
|
});
|
|
|
|
group('AndroidSdk', () {
|
|
testUsingContext('validateSdkWellFormed() not called, sdk reinitialized', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
await expectLater(
|
|
runBuildApkCommand(
|
|
projectPath,
|
|
arguments: <String>['--no-pub'],
|
|
),
|
|
throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'),
|
|
);
|
|
|
|
verifyNever(mockAndroidSdk.validateSdkWellFormed());
|
|
verify(mockAndroidSdk.reinitialize()).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
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 runBuildApkCommand(
|
|
projectPath,
|
|
arguments: <String>['--no-pub'],
|
|
);
|
|
}, throwsToolExit(
|
|
message: 'No Android SDK found. Try setting the ANDROID_HOME environment variable',
|
|
));
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => null,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
});
|
|
});
|
|
|
|
testUsingContext('shrinking is enabled by default on release mode', () async {
|
|
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',
|
|
'-Ptarget-platform=android-arm,android-arm64,android-x64',
|
|
'-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-Pshrink=true',
|
|
'assembleRelease',
|
|
],
|
|
workingDirectory: anyNamed('workingDirectory'),
|
|
environment: anyNamed('environment'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
});
|
|
|
|
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',
|
|
'-Ptarget-platform=android-arm,android-arm64,android-x64',
|
|
'-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-Pshrink=true',
|
|
'-Psplit-debug-info=${tempDir.path}',
|
|
'assembleRelease',
|
|
],
|
|
workingDirectory: anyNamed('workingDirectory'),
|
|
environment: anyNamed('environment'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
});
|
|
|
|
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')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-Pextra-front-end-options=foo,bar',
|
|
'-Pshrink=true',
|
|
'assembleRelease',
|
|
],
|
|
workingDirectory: anyNamed('workingDirectory'),
|
|
environment: anyNamed('environment'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
});
|
|
|
|
testUsingContext('shrinking is disabled when --no-shrink is passed', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
await expectLater(() async {
|
|
await runBuildApkCommand(
|
|
projectPath,
|
|
arguments: <String>['--no-shrink'],
|
|
);
|
|
}, 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')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'assembleRelease',
|
|
],
|
|
workingDirectory: anyNamed('workingDirectory'),
|
|
environment: anyNamed('environment'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
});
|
|
|
|
testUsingContext('guides the user when the shrinker fails', () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
|
|
when(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')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-Pshrink=true',
|
|
'assembleRelease',
|
|
],
|
|
workingDirectory: anyNamed('workingDirectory'),
|
|
environment: anyNamed('environment'),
|
|
)).thenAnswer((_) {
|
|
const String r8StdoutWarning =
|
|
"Execution failed for task ':app:transformClassesAndResourcesWithR8ForStageInternal'.\n"
|
|
'> com.android.tools.r8.CompilationFailedException: Compilation failed to complete';
|
|
return Future<Process>.value(
|
|
createMockProcess(
|
|
exitCode: 1,
|
|
stdout: r8StdoutWarning,
|
|
),
|
|
);
|
|
});
|
|
|
|
await expectLater(() async {
|
|
await runBuildApkCommand(
|
|
projectPath,
|
|
);
|
|
}, throwsToolExit(message: 'Gradle task assembleRelease failed with exit code 1'));
|
|
|
|
expect(testLogger.statusText,
|
|
contains('The shrinker may have failed to optimize the Java bytecode.'));
|
|
expect(testLogger.statusText,
|
|
contains('To disable the shrinker, pass the `--no-shrink` flag to this command.'));
|
|
expect(testLogger.statusText,
|
|
contains('To learn more, see: https://developer.android.com/studio/build/shrink-code'));
|
|
|
|
verify(mockUsage.sendEvent(
|
|
'build',
|
|
'apk',
|
|
label: 'gradle-r8-failure',
|
|
parameters: anyNamed('parameters'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
Usage: () => mockUsage,
|
|
});
|
|
|
|
testUsingContext("reports when the app isn't using AndroidX", () async {
|
|
final String projectPath = await createProject(tempDir,
|
|
arguments: <String>['--no-pub', '--template=app']);
|
|
// Simulate a non-androidx project.
|
|
tempDir
|
|
.childDirectory('flutter_project')
|
|
.childDirectory('android')
|
|
.childFile('gradle.properties')
|
|
.writeAsStringSync('android.useAndroidX=false');
|
|
|
|
when(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')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-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 APK in the file system.
|
|
await expectLater(() async {
|
|
await runBuildApkCommand(
|
|
projectPath,
|
|
);
|
|
}, throwsToolExit());
|
|
|
|
expect(testLogger.statusText, contains("Your app isn't using AndroidX"));
|
|
expect(testLogger.statusText, contains(
|
|
'To avoid potential build failures, you can quickly migrate your app by '
|
|
'following the steps on https://goo.gl/CP92wY'
|
|
)
|
|
);
|
|
verify(mockUsage.sendEvent(
|
|
'build',
|
|
'apk',
|
|
label: 'app-not-using-android-x',
|
|
parameters: anyNamed('parameters'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
Usage: () => mockUsage,
|
|
});
|
|
|
|
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',
|
|
'-Ptarget-platform=android-arm,android-arm64,android-x64',
|
|
'-Ptarget=${globals.fs.path.join(tempDir.path, 'flutter_project', 'lib', 'main.dart')}',
|
|
'-Ptrack-widget-creation=true',
|
|
'-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 APK in the file system.
|
|
await expectLater(() async {
|
|
await runBuildApkCommand(
|
|
projectPath,
|
|
);
|
|
}, throwsToolExit());
|
|
|
|
expect(testLogger.statusText.contains("[!] Your app isn't using AndroidX"), isFalse);
|
|
expect(
|
|
testLogger.statusText.contains(
|
|
'To avoid potential build failures, you can quickly migrate your app by '
|
|
'following the steps on https://goo.gl/CP92wY'
|
|
),
|
|
isFalse,
|
|
);
|
|
verify(mockUsage.sendEvent(
|
|
'build',
|
|
'apk',
|
|
label: 'app-using-android-x',
|
|
parameters: anyNamed('parameters'),
|
|
)).called(1);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
AndroidSdk: () => mockAndroidSdk,
|
|
FlutterProjectFactory: () => FakeFlutterProjectFactory(tempDir),
|
|
ProcessManager: () => mockProcessManager,
|
|
Usage: () => mockUsage,
|
|
});
|
|
});
|
|
}
|
|
|
|
Future<BuildApkCommand> runBuildApkCommand(
|
|
String target, {
|
|
List<String> arguments,
|
|
}) async {
|
|
final BuildApkCommand command = BuildApkCommand();
|
|
final CommandRunner<void> runner = createTestCommandRunner(command);
|
|
await runner.run(<String>[
|
|
'apk',
|
|
...?arguments,
|
|
'--no-pub',
|
|
globals.fs.path.join(target, 'lib', 'main.dart'),
|
|
]);
|
|
return command;
|
|
}
|
|
|
|
class MockAndroidSdk extends Mock implements AndroidSdk {}
|
|
class MockProcessManager extends Mock implements ProcessManager {}
|
|
class MockProcess extends Mock implements Process {}
|
|
class MockUsage extends Mock implements Usage {}
|