| // 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:async'; |
| |
| import 'package:file/file.dart'; |
| import 'package:flutter_tools/src/artifacts.dart'; |
| import 'package:flutter_tools/src/base/file_system.dart'; |
| import 'package:flutter_tools/src/base/io.dart' show ProcessException, ProcessResult; |
| import 'package:flutter_tools/src/cache.dart'; |
| import 'package:flutter_tools/src/ios/mac.dart'; |
| import 'package:flutter_tools/src/ios/xcodeproj.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:platform/platform.dart'; |
| import 'package:process/process.dart'; |
| |
| import '../../src/common.dart'; |
| import '../../src/context.dart'; |
| |
| final Generator _kNoColorTerminalPlatform = () => FakePlatform.fromPlatform(const LocalPlatform())..stdoutSupportsAnsi = false; |
| final Map<Type, Generator> noColorTerminalOverride = <Type, Generator>{ |
| Platform: _kNoColorTerminalPlatform, |
| }; |
| |
| class MockArtifacts extends Mock implements Artifacts {} |
| class MockCache extends Mock implements Cache {} |
| class MockProcessManager extends Mock implements ProcessManager {} |
| class MockFile extends Mock implements File {} |
| class MockXcodeProjectInterpreter extends Mock implements XcodeProjectInterpreter {} |
| class MockIosProject extends Mock implements IosProject {} |
| |
| void main() { |
| group('IMobileDevice', () { |
| final FakePlatform osx = FakePlatform.fromPlatform(const LocalPlatform()) |
| ..operatingSystem = 'macos'; |
| MockProcessManager mockProcessManager; |
| final String libimobiledevicePath = globals.fs.path.join('bin', 'cache', 'artifacts', 'libimobiledevice'); |
| final String ideviceIdPath = globals.fs.path.join(libimobiledevicePath, 'idevice_id'); |
| final String ideviceInfoPath = globals.fs.path.join(libimobiledevicePath, 'ideviceinfo'); |
| final String idevicescreenshotPath = globals.fs.path.join(libimobiledevicePath, 'idevicescreenshot'); |
| MockArtifacts mockArtifacts; |
| MockCache mockCache; |
| |
| setUp(() { |
| mockProcessManager = MockProcessManager(); |
| mockCache = MockCache(); |
| mockArtifacts = MockArtifacts(); |
| when(mockArtifacts.getArtifactPath(Artifact.ideviceId, platform: anyNamed('platform'))).thenReturn(ideviceIdPath); |
| when(mockCache.dyLdLibEntry).thenReturn( |
| MapEntry<String, String>('DYLD_LIBRARY_PATH', libimobiledevicePath) |
| ); |
| }); |
| |
| testUsingContext('isWorking returns false if libimobiledevice is not installed', () async { |
| when(mockProcessManager.runSync( |
| <String>[ideviceIdPath, '-h'], environment: anyNamed('environment'), |
| )).thenReturn(ProcessResult(123, 1, '', '')); |
| expect(await iMobileDevice.isWorking, false); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getAvailableDeviceIDs throws ToolExit when libimobiledevice is not installed', () async { |
| when(mockProcessManager.run( |
| <String>[ideviceIdPath, '-l'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenThrow(ProcessException(ideviceIdPath, <String>['-l'])); |
| expect(() async => await iMobileDevice.getAvailableDeviceIDs(), throwsToolExit()); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getAvailableDeviceIDs throws ToolExit when idevice_id returns non-zero', () async { |
| when(mockProcessManager.run( |
| <String>[ideviceIdPath, '-l'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(1, 1, '', 'Sad today'))); |
| expect(() async => await iMobileDevice.getAvailableDeviceIDs(), throwsToolExit()); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getAvailableDeviceIDs returns idevice_id output when installed', () async { |
| when(mockProcessManager.run( |
| <String>[ideviceIdPath, '-l'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(1, 0, 'foo', ''))); |
| expect(await iMobileDevice.getAvailableDeviceIDs(), 'foo'); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getInfoForDevice throws IOSDeviceNotFoundError when ideviceinfo returns specific error code and message', () async { |
| when(mockArtifacts.getArtifactPath(Artifact.ideviceinfo, platform: anyNamed('platform'))).thenReturn(ideviceInfoPath); |
| when(mockProcessManager.run( |
| <String>[ideviceInfoPath, '-u', 'foo', '-k', 'bar'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(1, 255, 'No device found with udid foo, is it plugged in?', ''))); |
| expect(() async => await iMobileDevice.getInfoForDevice('foo', 'bar'), throwsA(isA<IOSDeviceNotFoundError>())); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getInfoForDevice throws IOSDeviceNotFoundError when user has not yet trusted the host', () async { |
| when(mockArtifacts.getArtifactPath(Artifact.ideviceinfo, platform: anyNamed('platform'))).thenReturn(ideviceInfoPath); |
| when(mockProcessManager.run( |
| <String>[ideviceInfoPath, '-u', 'foo', '-k', 'bar'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) { |
| final ProcessResult result = ProcessResult( |
| 1, |
| 255, |
| '', |
| 'ERROR: Could not connect to lockdownd, error code -${LockdownReturnCode.pairingDialogResponsePending.code}', |
| ); |
| return Future<ProcessResult>.value(result); |
| }); |
| expect(() async => await iMobileDevice.getInfoForDevice('foo', 'bar'), throwsA(isA<IOSDeviceNotTrustedError>())); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getInfoForDevice throws ToolExit lockdownd fails for unknown reason', () async { |
| when(mockArtifacts.getArtifactPath(Artifact.ideviceinfo, platform: anyNamed('platform'))).thenReturn(ideviceInfoPath); |
| when(mockProcessManager.run( |
| <String>[ideviceInfoPath, '-u', 'foo', '-k', 'bar'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) { |
| final ProcessResult result = ProcessResult( |
| 1, |
| 255, |
| '', |
| 'ERROR: Could not connect to lockdownd, error code -12345', |
| ); |
| return Future<ProcessResult>.value(result); |
| }); |
| expect(() async => await iMobileDevice.getInfoForDevice('foo', 'bar'), throwsToolExit()); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| testUsingContext('getInfoForDevice throws IOSDeviceNotFoundError when host trust is revoked', () async { |
| when(mockArtifacts.getArtifactPath(Artifact.ideviceinfo, platform: anyNamed('platform'))).thenReturn(ideviceInfoPath); |
| when(mockProcessManager.run( |
| <String>[ideviceInfoPath, '-u', 'foo', '-k', 'bar'], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| )).thenAnswer((_) { |
| final ProcessResult result = ProcessResult( |
| 1, |
| 255, |
| '', |
| 'ERROR: Could not connect to lockdownd, error code -${LockdownReturnCode.invalidHostId.code}', |
| ); |
| return Future<ProcessResult>.value(result); |
| }); |
| expect(() async => await iMobileDevice.getInfoForDevice('foo', 'bar'), throwsA(isA<IOSDeviceNotTrustedError>())); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| |
| group('screenshot', () { |
| final String outputPath = globals.fs.path.join('some', 'test', 'path', 'image.png'); |
| MockProcessManager mockProcessManager; |
| MockFile mockOutputFile; |
| |
| setUp(() { |
| mockProcessManager = MockProcessManager(); |
| mockOutputFile = MockFile(); |
| when(mockArtifacts.getArtifactPath(Artifact.idevicescreenshot, platform: anyNamed('platform'))).thenReturn(idevicescreenshotPath); |
| }); |
| |
| testUsingContext('error if idevicescreenshot is not installed', () async { |
| when(mockOutputFile.path).thenReturn(outputPath); |
| |
| // Let `idevicescreenshot` fail with exit code 1. |
| when(mockProcessManager.run(<String>[idevicescreenshotPath, outputPath], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| workingDirectory: null, |
| )).thenAnswer((_) => Future<ProcessResult>.value(ProcessResult(4, 1, '', ''))); |
| |
| expect(() async => await iMobileDevice.takeScreenshot(mockOutputFile), throwsA(anything)); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Platform: () => osx, |
| Cache: () => mockCache, |
| }); |
| |
| testUsingContext('idevicescreenshot captures and returns screenshot', () async { |
| when(mockOutputFile.path).thenReturn(outputPath); |
| when(mockProcessManager.run(any, environment: anyNamed('environment'), workingDirectory: null)).thenAnswer( |
| (Invocation invocation) => Future<ProcessResult>.value(ProcessResult(4, 0, '', ''))); |
| |
| await iMobileDevice.takeScreenshot(mockOutputFile); |
| verify(mockProcessManager.run(<String>[idevicescreenshotPath, outputPath], |
| environment: <String, String>{'DYLD_LIBRARY_PATH': libimobiledevicePath}, |
| workingDirectory: null, |
| )); |
| }, overrides: <Type, Generator>{ |
| ProcessManager: () => mockProcessManager, |
| Cache: () => mockCache, |
| Artifacts: () => mockArtifacts, |
| }); |
| }); |
| }); |
| |
| group('Diagnose Xcode build failure', () { |
| Map<String, String> buildSettings; |
| MockUsage mockUsage; |
| |
| setUp(() { |
| buildSettings = <String, String>{ |
| 'PRODUCT_BUNDLE_IDENTIFIER': 'test.app', |
| }; |
| mockUsage = MockUsage(); |
| }); |
| |
| testUsingContext('Sends analytics when bitcode fails', () async { |
| const List<String> buildCommands = <String>['xcrun', 'cc', 'blah']; |
| final XcodeBuildResult buildResult = XcodeBuildResult( |
| success: false, |
| stdout: 'BITCODE_ENABLED = YES', |
| xcodeBuildExecution: XcodeBuildExecution( |
| buildCommands: buildCommands, |
| appDirectory: '/blah/blah', |
| buildForPhysicalDevice: true, |
| buildSettings: buildSettings, |
| ), |
| ); |
| |
| await diagnoseXcodeBuildFailure(buildResult); |
| verify(mockUsage.sendEvent('build', |
| any, |
| label: 'xcode-bitcode-failure', |
| parameters: <String, String>{ |
| cdKey(CustomDimensions.buildEventCommand): buildCommands.toString(), |
| cdKey(CustomDimensions.buildEventSettings): buildSettings.toString(), |
| })).called(1); |
| }, overrides: <Type, Generator>{ |
| Usage: () => mockUsage, |
| }); |
| |
| testUsingContext('No provisioning profile shows message', () async { |
| final XcodeBuildResult buildResult = XcodeBuildResult( |
| success: false, |
| stdout: ''' |
| Launching lib/main.dart on iPhone in debug mode... |
| Signing iOS app for device deployment using developer identity: "iPhone Developer: test@flutter.io (1122334455)" |
| Running Xcode build... 1.3s |
| Failed to build iOS app |
| Error output from Xcode build: |
| ↳ |
| ** BUILD FAILED ** |
| |
| |
| The following build commands failed: |
| Check dependencies |
| (1 failure) |
| Xcode's output: |
| ↳ |
| Build settings from command line: |
| ARCHS = arm64 |
| BUILD_DIR = /Users/blah/blah |
| DEVELOPMENT_TEAM = AABBCCDDEE |
| ONLY_ACTIVE_ARCH = YES |
| SDKROOT = iphoneos10.3 |
| |
| === CLEAN TARGET Runner OF PROJECT Runner WITH CONFIGURATION Release === |
| |
| Check dependencies |
| [BCEROR]No profiles for 'com.example.test' were found: Xcode couldn't find a provisioning profile matching 'com.example.test'. |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| |
| Create product structure |
| /bin/mkdir -p /Users/blah/Runner.app |
| |
| Clean.Remove clean /Users/blah/Runner.app.dSYM |
| builtin-rm -rf /Users/blah/Runner.app.dSYM |
| |
| Clean.Remove clean /Users/blah/Runner.app |
| builtin-rm -rf /Users/blah/Runner.app |
| |
| Clean.Remove clean /Users/blah/Runner-dfvicjniknvzghgwsthwtgcjhtsk/Build/Intermediates/Runner.build/Release-iphoneos/Runner.build |
| builtin-rm -rf /Users/blah/Runner-dfvicjniknvzghgwsthwtgcjhtsk/Build/Intermediates/Runner.build/Release-iphoneos/Runner.build |
| |
| ** CLEAN SUCCEEDED ** |
| |
| === BUILD TARGET Runner OF PROJECT Runner WITH CONFIGURATION Release === |
| |
| Check dependencies |
| No profiles for 'com.example.test' were found: Xcode couldn't find a provisioning profile matching 'com.example.test'. |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| |
| Could not build the precompiled application for the device. |
| |
| Error launching application on iPhone.''', |
| xcodeBuildExecution: XcodeBuildExecution( |
| buildCommands: <String>['xcrun', 'xcodebuild', 'blah'], |
| appDirectory: '/blah/blah', |
| buildForPhysicalDevice: true, |
| buildSettings: buildSettings, |
| ), |
| ); |
| |
| await diagnoseXcodeBuildFailure(buildResult); |
| expect( |
| testLogger.errorText, |
| contains('No Provisioning Profile was found for your project\'s Bundle Identifier or your \ndevice.'), |
| ); |
| }, overrides: noColorTerminalOverride); |
| |
| testUsingContext('No development team shows message', () async { |
| final XcodeBuildResult buildResult = XcodeBuildResult( |
| success: false, |
| stdout: ''' |
| Running "flutter pub get" in flutter_gallery... 0.6s |
| Launching lib/main.dart on x in release mode... |
| Running pod install... 1.2s |
| Running Xcode build... 1.4s |
| Failed to build iOS app |
| Error output from Xcode build: |
| ↳ |
| ** BUILD FAILED ** |
| |
| |
| The following build commands failed: |
| Check dependencies |
| (1 failure) |
| Xcode's output: |
| ↳ |
| blah |
| |
| === CLEAN TARGET url_launcher OF PROJECT Pods WITH CONFIGURATION Release === |
| |
| Check dependencies |
| |
| blah |
| |
| === CLEAN TARGET Pods-Runner OF PROJECT Pods WITH CONFIGURATION Release === |
| |
| Check dependencies |
| |
| blah |
| |
| === CLEAN TARGET Runner OF PROJECT Runner WITH CONFIGURATION Release === |
| |
| Check dependencies |
| [BCEROR]Signing for "Runner" requires a development team. Select a development team in the project editor. |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| [BCEROR]Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| |
| blah |
| |
| ** CLEAN SUCCEEDED ** |
| |
| === BUILD TARGET url_launcher OF PROJECT Pods WITH CONFIGURATION Release === |
| |
| Check dependencies |
| |
| blah |
| |
| === BUILD TARGET Pods-Runner OF PROJECT Pods WITH CONFIGURATION Release === |
| |
| Check dependencies |
| |
| blah |
| |
| === BUILD TARGET Runner OF PROJECT Runner WITH CONFIGURATION Release === |
| |
| Check dependencies |
| Signing for "Runner" requires a development team. Select a development team in the project editor. |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| Code signing is required for product type 'Application' in SDK 'iOS 10.3' |
| |
| Could not build the precompiled application for the device.''', |
| xcodeBuildExecution: XcodeBuildExecution( |
| buildCommands: <String>['xcrun', 'xcodebuild', 'blah'], |
| appDirectory: '/blah/blah', |
| buildForPhysicalDevice: true, |
| buildSettings: buildSettings, |
| ), |
| ); |
| |
| await diagnoseXcodeBuildFailure(buildResult); |
| expect( |
| testLogger.errorText, |
| contains('Building a deployable iOS app requires a selected Development Team with a \nProvisioning Profile.'), |
| ); |
| }, overrides: noColorTerminalOverride); |
| }); |
| |
| group('Upgrades project.pbxproj for old asset usage', () { |
| const List<String> flutterAssetPbxProjLines = <String>[ |
| '/* flutter_assets */', |
| '/* App.framework', |
| 'another line', |
| ]; |
| |
| const List<String> appFlxPbxProjLines = <String>[ |
| '/* app.flx', |
| '/* App.framework', |
| 'another line', |
| ]; |
| |
| const List<String> cleanPbxProjLines = <String>[ |
| '/* App.framework', |
| 'another line', |
| ]; |
| |
| testUsingContext('upgradePbxProjWithFlutterAssets', () async { |
| final MockIosProject project = MockIosProject(); |
| final MockFile pbxprojFile = MockFile(); |
| |
| when(project.xcodeProjectInfoFile).thenReturn(pbxprojFile); |
| when(project.hostAppBundleName).thenReturn('UnitTestRunner.app'); |
| when(pbxprojFile.readAsLinesSync()) |
| .thenAnswer((_) => flutterAssetPbxProjLines); |
| when(pbxprojFile.existsSync()) |
| .thenAnswer((_) => true); |
| |
| bool result = upgradePbxProjWithFlutterAssets(project); |
| expect(result, true); |
| expect( |
| testLogger.statusText, |
| contains('Removing obsolete reference to flutter_assets'), |
| ); |
| testLogger.clear(); |
| |
| when(pbxprojFile.readAsLinesSync()) |
| .thenAnswer((_) => appFlxPbxProjLines); |
| result = upgradePbxProjWithFlutterAssets(project); |
| expect(result, true); |
| expect( |
| testLogger.statusText, |
| contains('Removing obsolete reference to app.flx'), |
| ); |
| testLogger.clear(); |
| |
| when(pbxprojFile.readAsLinesSync()) |
| .thenAnswer((_) => cleanPbxProjLines); |
| result = upgradePbxProjWithFlutterAssets(project); |
| expect(result, true); |
| expect( |
| testLogger.statusText, |
| isEmpty, |
| ); |
| }); |
| }); |
| } |
| |
| class MockUsage extends Mock implements Usage {} |
