// Copyright 2015 The Chromium 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 'dart:convert'; import 'package:args/command_runner.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/base/io.dart'; import 'package:flutter_tools/src/base/net.dart'; import 'package:flutter_tools/src/base/platform.dart'; import 'package:flutter_tools/src/cache.dart'; import 'package:flutter_tools/src/commands/create.dart'; import 'package:flutter_tools/src/dart/sdk.dart'; import 'package:flutter_tools/src/project.dart'; import 'package:flutter_tools/src/version.dart'; import 'package:mockito/mockito.dart'; import 'package:process/process.dart'; import '../src/common.dart'; import '../src/context.dart'; const String frameworkRevision = '12345678'; const String frameworkChannel = 'omega'; final Generator _kNoColorTerminalPlatform = () => FakePlatform.fromPlatform(const LocalPlatform())..stdoutSupportsAnsi = false; final Map noColorTerminalOverride = { Platform: _kNoColorTerminalPlatform, }; void main() { Directory tempDir; Directory projectDir; FlutterVersion mockFlutterVersion; LoggingProcessManager loggingProcessManager; setUpAll(() { Cache.disableLocking(); }); setUp(() { loggingProcessManager = LoggingProcessManager(); tempDir = fs.systemTempDirectory.createTempSync('flutter_tools_create_test.'); projectDir = tempDir.childDirectory('flutter_project'); mockFlutterVersion = MockFlutterVersion(); }); tearDown(() { tryToDelete(tempDir); }); // Verify that we create a default project ('app') that is // well-formed. testUsingContext('can create a default project', () async { await _createAndAnalyzeProject( projectDir, [], [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', 'flutter_project.iml', 'ios/Flutter/AppFrameworkInfo.plist', 'ios/Runner/AppDelegate.m', 'ios/Runner/GeneratedPluginRegistrant.h', 'lib/main.dart', ], ); return _runFlutterTest(projectDir); }, timeout: allowForRemotePubInvocation); testUsingContext('can create a default project if empty directory exists', () async { await projectDir.create(recursive: true); await _createAndAnalyzeProject( projectDir, [], [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', 'flutter_project.iml', 'ios/Flutter/AppFrameworkInfo.plist', 'ios/Runner/AppDelegate.m', 'ios/Runner/GeneratedPluginRegistrant.h', ], ); }, timeout: allowForRemotePubInvocation); testUsingContext('creates a module project correctly', () async { await _createAndAnalyzeProject(projectDir, [ '--template=module' ], [ '.android/app/', '.gitignore', '.ios/Flutter', '.metadata', 'lib/main.dart', 'pubspec.yaml', 'README.md', 'test/widget_test.dart', ], unexpectedPaths: [ 'android/', 'ios/', ]); return _runFlutterTest(projectDir); }, timeout: allowForRemotePubInvocation); testUsingContext('cannot create a project if non-empty non-project directory exists with .metadata', () async { await projectDir.absolute.childDirectory('blag').create(recursive: true); await projectDir.absolute.childFile('.metadata').writeAsString('project_type: blag\n'); expect( () async => await _createAndAnalyzeProject(projectDir, [], [], unexpectedPaths: [ 'android/', 'ios/', '.android/', '.ios/', ]), throwsToolExit(message: 'Sorry, unable to detect the type of project to recreate')); }, timeout: allowForRemotePubInvocation, overrides: noColorTerminalOverride); testUsingContext('Will create an app project if non-empty non-project directory exists without .metadata', () async { await projectDir.absolute.childDirectory('blag').create(recursive: true); await projectDir.absolute.childDirectory('.idea').create(recursive: true); await _createAndAnalyzeProject(projectDir, [], [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', 'flutter_project.iml', 'ios/Flutter/AppFrameworkInfo.plist', 'ios/Runner/AppDelegate.m', 'ios/Runner/GeneratedPluginRegistrant.h', ], unexpectedPaths: [ '.android/', '.ios/', ]); }, timeout: allowForRemotePubInvocation); testUsingContext('detects and recreates an app project correctly', () async { await projectDir.absolute.childDirectory('lib').create(recursive: true); await projectDir.absolute.childDirectory('ios').create(recursive: true); await _createAndAnalyzeProject(projectDir, [], [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', 'flutter_project.iml', 'ios/Flutter/AppFrameworkInfo.plist', 'ios/Runner/AppDelegate.m', 'ios/Runner/GeneratedPluginRegistrant.h', ], unexpectedPaths: [ '.android/', '.ios/', ]); }, timeout: allowForRemotePubInvocation); testUsingContext('detects and recreates a plugin project correctly', () async { await projectDir.create(recursive: true); await projectDir.absolute.childFile('.metadata').writeAsString('project_type: plugin\n'); return _createAndAnalyzeProject( projectDir, [], [ 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'example/ios/Runner/AppDelegate.h', 'example/ios/Runner/AppDelegate.m', 'example/ios/Runner/main.m', 'example/lib/main.dart', 'flutter_project.iml', 'ios/Classes/FlutterProjectPlugin.h', 'ios/Classes/FlutterProjectPlugin.m', 'lib/flutter_project.dart', ], ); }, timeout: allowForRemotePubInvocation); testUsingContext('detects and recreates a package project correctly', () async { await projectDir.create(recursive: true); await projectDir.absolute.childFile('.metadata').writeAsString('project_type: package\n'); return _createAndAnalyzeProject( projectDir, [], [ 'lib/flutter_project.dart', 'test/flutter_project_test.dart', ], unexpectedPaths: [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'example/ios/Runner/AppDelegate.h', 'example/ios/Runner/AppDelegate.m', 'example/ios/Runner/main.m', 'example/lib/main.dart', 'ios/Classes/FlutterProjectPlugin.h', 'ios/Classes/FlutterProjectPlugin.m', 'ios/Runner/AppDelegate.h', 'ios/Runner/AppDelegate.m', 'ios/Runner/main.m', 'lib/main.dart', 'test/widget_test.dart', ], ); }, timeout: allowForRemotePubInvocation); testUsingContext('kotlin/swift legacy app project', () async { return _createProject( projectDir, ['--no-pub', '--template=app', '--android-language=kotlin', '--ios-language=swift'], [ 'android/app/src/main/kotlin/com/example/flutterproject/MainActivity.kt', 'ios/Runner/AppDelegate.swift', 'ios/Runner/Runner-Bridging-Header.h', 'lib/main.dart', ], unexpectedPaths: [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'ios/Runner/AppDelegate.h', 'ios/Runner/AppDelegate.m', 'ios/Runner/main.m', ], ); }, timeout: allowForCreateFlutterProject); testUsingContext('can create a package project', () async { await _createAndAnalyzeProject( projectDir, ['--template=package'], [ 'lib/flutter_project.dart', 'test/flutter_project_test.dart', ], unexpectedPaths: [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'example/ios/Runner/AppDelegate.h', 'example/ios/Runner/AppDelegate.m', 'example/ios/Runner/main.m', 'example/lib/main.dart', 'ios/Classes/FlutterProjectPlugin.h', 'ios/Classes/FlutterProjectPlugin.m', 'ios/Runner/AppDelegate.h', 'ios/Runner/AppDelegate.m', 'ios/Runner/main.m', 'lib/main.dart', 'test/widget_test.dart', ], ); return _runFlutterTest(projectDir); }, timeout: allowForRemotePubInvocation); testUsingContext('can create a plugin project', () async { await _createAndAnalyzeProject( projectDir, ['--template=plugin'], [ 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'example/ios/Runner/AppDelegate.h', 'example/ios/Runner/AppDelegate.m', 'example/ios/Runner/main.m', 'example/lib/main.dart', 'flutter_project.iml', 'ios/Classes/FlutterProjectPlugin.h', 'ios/Classes/FlutterProjectPlugin.m', 'lib/flutter_project.dart', ], ); return _runFlutterTest(projectDir.childDirectory('example')); }, timeout: allowForRemotePubInvocation); testUsingContext('kotlin/swift plugin project', () async { return _createProject( projectDir, ['--no-pub', '--template=plugin', '-a', 'kotlin', '--ios-language', 'swift'], [ 'android/src/main/kotlin/com/example/flutterproject/FlutterProjectPlugin.kt', 'example/android/app/src/main/kotlin/com/example/flutterprojectexample/MainActivity.kt', 'example/ios/Runner/AppDelegate.swift', 'example/ios/Runner/Runner-Bridging-Header.h', 'example/lib/main.dart', 'ios/Classes/FlutterProjectPlugin.h', 'ios/Classes/FlutterProjectPlugin.m', 'ios/Classes/SwiftFlutterProjectPlugin.swift', 'lib/flutter_project.dart', ], unexpectedPaths: [ 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'example/ios/Runner/AppDelegate.h', 'example/ios/Runner/AppDelegate.m', 'example/ios/Runner/main.m', ], ); }, timeout: allowForCreateFlutterProject); testUsingContext('plugin project with custom org', () async { return _createProject( projectDir, ['--no-pub', '--template=plugin', '--org', 'com.bar.foo'], [ 'android/src/main/java/com/bar/foo/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/bar/foo/flutterprojectexample/MainActivity.java', ], unexpectedPaths: [ 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', ], ); }, timeout: allowForCreateFlutterProject); testUsingContext('plugin project with valid custom project name', () async { return _createProject( projectDir, ['--no-pub', '--template=plugin', '--project-name', 'xyz'], [ 'android/src/main/java/com/example/xyz/XyzPlugin.java', 'example/android/app/src/main/java/com/example/xyzexample/MainActivity.java', ], unexpectedPaths: [ 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', ], ); }, timeout: allowForCreateFlutterProject); testUsingContext('plugin project with invalid custom project name', () async { expect( () => _createProject(projectDir, ['--no-pub', '--template=plugin', '--project-name', 'xyz.xyz'], [], ), throwsToolExit(message: '"xyz.xyz" is not a valid Dart package name.'), ); }, timeout: allowForCreateFlutterProject); testUsingContext('legacy app project with-driver-test', () async { return _createAndAnalyzeProject( projectDir, ['--with-driver-test', '--template=app'], ['lib/main.dart'], ); }, timeout: allowForRemotePubInvocation); testUsingContext('module project with pub', () async { return _createProject(projectDir, [ '--template=module' ], [ '.android/build.gradle', '.android/Flutter/build.gradle', '.android/Flutter/src/main/AndroidManifest.xml', '.android/Flutter/src/main/java/io/flutter/facade/Flutter.java', '.android/Flutter/src/main/java/io/flutter/facade/FlutterFragment.java', '.android/Flutter/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', '.android/gradle.properties', '.android/gradle/wrapper/gradle-wrapper.jar', '.android/gradle/wrapper/gradle-wrapper.properties', '.android/gradlew', '.android/gradlew.bat', '.android/include_flutter.groovy', '.android/local.properties', '.android/settings.gradle', '.gitignore', '.metadata', '.packages', 'lib/main.dart', 'pubspec.lock', 'pubspec.yaml', 'README.md', 'test/widget_test.dart', ], unexpectedPaths: [ 'android/', 'ios/', ]); }, timeout: allowForRemotePubInvocation); testUsingContext('has correct content and formatting with module template', () async { Cache.flutterRoot = '../..'; when(mockFlutterVersion.frameworkRevision).thenReturn(frameworkRevision); when(mockFlutterVersion.channel).thenReturn(frameworkChannel); final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--template=module', '--no-pub', '--org', 'com.foo.bar', projectDir.path]); void expectExists(String relPath) { expect(fs.isFileSync('${projectDir.path}/$relPath'), true); } expectExists('lib/main.dart'); expectExists('test/widget_test.dart'); final String actualContents = await fs.file(projectDir.path + '/test/widget_test.dart').readAsString(); expect(actualContents.contains('flutter_test.dart'), true); for (FileSystemEntity file in projectDir.listSync(recursive: true)) { if (file is File && file.path.endsWith('.dart')) { final String original = file.readAsStringSync(); final Process process = await Process.start( sdkBinaryName('dartfmt'), [file.path], workingDirectory: projectDir.path, ); final String formatted = await process.stdout.transform(utf8.decoder).join(); expect(original, formatted, reason: file.path); } } await _runFlutterTest(projectDir, target: fs.path.join(projectDir.path, 'test', 'widget_test.dart')); // Generated Xcode settings final String xcodeConfigPath = fs.path.join('.ios', 'Flutter', 'Generated.xcconfig'); expectExists(xcodeConfigPath); final File xcodeConfigFile = fs.file(fs.path.join(projectDir.path, xcodeConfigPath)); final String xcodeConfig = xcodeConfigFile.readAsStringSync(); expect(xcodeConfig, contains('FLUTTER_ROOT=')); expect(xcodeConfig, contains('FLUTTER_APPLICATION_PATH=')); expect(xcodeConfig, contains('FLUTTER_TARGET=')); // App identification final String xcodeProjectPath = fs.path.join('.ios', 'Runner.xcodeproj', 'project.pbxproj'); expectExists(xcodeProjectPath); final File xcodeProjectFile = fs.file(fs.path.join(projectDir.path, xcodeProjectPath)); final String xcodeProject = xcodeProjectFile.readAsStringSync(); expect(xcodeProject, contains('PRODUCT_BUNDLE_IDENTIFIER = com.foo.bar.flutterProject')); final String versionPath = fs.path.join('.metadata'); expectExists(versionPath); final String version = fs.file(fs.path.join(projectDir.path, versionPath)).readAsStringSync(); expect(version, contains('version:')); expect(version, contains('revision: 12345678')); expect(version, contains('channel: omega')); // IntelliJ metadata final String intelliJSdkMetadataPath = fs.path.join('.idea', 'libraries', 'Dart_SDK.xml'); expectExists(intelliJSdkMetadataPath); final String sdkMetaContents = fs .file(fs.path.join( projectDir.path, intelliJSdkMetadataPath, )) .readAsStringSync(); expect(sdkMetaContents, contains('{ FlutterVersion: () => mockFlutterVersion, Platform: _kNoColorTerminalPlatform, }, timeout: allowForCreateFlutterProject); testUsingContext('has correct content and formatting with app template', () async { Cache.flutterRoot = '../..'; when(mockFlutterVersion.frameworkRevision).thenReturn(frameworkRevision); when(mockFlutterVersion.channel).thenReturn(frameworkChannel); final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--template=app', '--no-pub', '--org', 'com.foo.bar', projectDir.path]); void expectExists(String relPath) { expect(fs.isFileSync('${projectDir.path}/$relPath'), true); } expectExists('lib/main.dart'); expectExists('test/widget_test.dart'); for (FileSystemEntity file in projectDir.listSync(recursive: true)) { if (file is File && file.path.endsWith('.dart')) { final String original = file.readAsStringSync(); final Process process = await Process.start( sdkBinaryName('dartfmt'), [file.path], workingDirectory: projectDir.path, ); final String formatted = await process.stdout.transform(utf8.decoder).join(); expect(original, formatted, reason: file.path); } } await _runFlutterTest(projectDir, target: fs.path.join(projectDir.path, 'test', 'widget_test.dart')); // Generated Xcode settings final String xcodeConfigPath = fs.path.join('ios', 'Flutter', 'Generated.xcconfig'); expectExists(xcodeConfigPath); final File xcodeConfigFile = fs.file(fs.path.join(projectDir.path, xcodeConfigPath)); final String xcodeConfig = xcodeConfigFile.readAsStringSync(); expect(xcodeConfig, contains('FLUTTER_ROOT=')); expect(xcodeConfig, contains('FLUTTER_APPLICATION_PATH=')); // App identification final String xcodeProjectPath = fs.path.join('ios', 'Runner.xcodeproj', 'project.pbxproj'); expectExists(xcodeProjectPath); final File xcodeProjectFile = fs.file(fs.path.join(projectDir.path, xcodeProjectPath)); final String xcodeProject = xcodeProjectFile.readAsStringSync(); expect(xcodeProject, contains('PRODUCT_BUNDLE_IDENTIFIER = com.foo.bar.flutterProject')); final String versionPath = fs.path.join('.metadata'); expectExists(versionPath); final String version = fs.file(fs.path.join(projectDir.path, versionPath)).readAsStringSync(); expect(version, contains('version:')); expect(version, contains('revision: 12345678')); expect(version, contains('channel: omega')); // IntelliJ metadata final String intelliJSdkMetadataPath = fs.path.join('.idea', 'libraries', 'Dart_SDK.xml'); expectExists(intelliJSdkMetadataPath); final String sdkMetaContents = fs .file(fs.path.join( projectDir.path, intelliJSdkMetadataPath, )) .readAsStringSync(); expect(sdkMetaContents, contains('{ FlutterVersion: () => mockFlutterVersion, Platform: _kNoColorTerminalPlatform, }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen default template over existing project', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', projectDir.path]); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: app\n')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen default template over existing app project with no metadta and detect the type', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', '--template=app', projectDir.path]); // Remove the .metadata to simulate an older instantiation that didn't generate those. fs.file(fs.path.join(projectDir.path, '.metadata')).deleteSync(); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: app\n')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen app template over existing app project and detect the type', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', '--template=app', projectDir.path]); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: app\n')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen template over existing module project and detect the type', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', '--template=module', projectDir.path]); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: module\n')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen default template over existing plugin project and detect the type', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', '--template=plugin', projectDir.path]); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: plugin')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen default template over existing package project and detect the type', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--no-pub', '--template=package', projectDir.path]); await runner.run(['create', '--no-pub', projectDir.path]); final String metadata = fs.file(fs.path.join(projectDir.path, '.metadata')).readAsStringSync(); expect(metadata, contains('project_type: package')); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen module .android/ folder, reusing custom org', () async { await _createProject( projectDir, ['--template=module', '--org', 'com.bar.foo'], [], ); projectDir.childDirectory('.android').deleteSync(recursive: true); return _createProject( projectDir, [], [ '.android/app/src/main/java/com/bar/foo/flutterproject/host/MainActivity.java', ], ); }, timeout: allowForRemotePubInvocation); testUsingContext('can re-gen module .ios/ folder, reusing custom org', () async { await _createProject( projectDir, ['--template=module', '--org', 'com.bar.foo'], [], ); projectDir.childDirectory('.ios').deleteSync(recursive: true); await _createProject(projectDir, [], []); final FlutterProject project = await FlutterProject.fromDirectory(projectDir); expect( project.ios.productBundleIdentifier, 'com.bar.foo.flutterProject', ); }, timeout: allowForRemotePubInvocation); testUsingContext('can re-gen app android/ folder, reusing custom org', () async { await _createProject( projectDir, ['--no-pub', '--template=app', '--org', 'com.bar.foo'], [], ); projectDir.childDirectory('android').deleteSync(recursive: true); return _createProject( projectDir, ['--no-pub'], [ 'android/app/src/main/java/com/bar/foo/flutterproject/MainActivity.java', ], unexpectedPaths: [ 'android/app/src/main/java/com/example/flutterproject/MainActivity.java', ], ); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen app ios/ folder, reusing custom org', () async { await _createProject( projectDir, ['--no-pub', '--template=app', '--org', 'com.bar.foo'], [], ); projectDir.childDirectory('ios').deleteSync(recursive: true); await _createProject(projectDir, ['--no-pub'], []); final FlutterProject project = await FlutterProject.fromDirectory(projectDir); expect( project.ios.productBundleIdentifier, 'com.bar.foo.flutterProject', ); }, timeout: allowForCreateFlutterProject); testUsingContext('can re-gen plugin ios/ and example/ folders, reusing custom org', () async { await _createProject( projectDir, ['--no-pub', '--template=plugin', '--org', 'com.bar.foo'], [], ); projectDir.childDirectory('example').deleteSync(recursive: true); projectDir.childDirectory('ios').deleteSync(recursive: true); await _createProject( projectDir, ['--no-pub', '--template=plugin'], [ 'example/android/app/src/main/java/com/bar/foo/flutterprojectexample/MainActivity.java', 'ios/Classes/FlutterProjectPlugin.h', ], unexpectedPaths: [ 'example/android/app/src/main/java/com/example/flutterprojectexample/MainActivity.java', 'android/src/main/java/com/example/flutterproject/FlutterProjectPlugin.java', ], ); final FlutterProject project = await FlutterProject.fromDirectory(projectDir); expect( project.example.ios.productBundleIdentifier, 'com.bar.foo.flutterProjectExample', ); }, timeout: allowForCreateFlutterProject); testUsingContext('fails to re-gen without specified org when org is ambiguous', () async { await _createProject( projectDir, ['--no-pub', '--template=app', '--org', 'com.bar.foo'], [], ); fs.directory(fs.path.join(projectDir.path, 'ios')).deleteSync(recursive: true); await _createProject( projectDir, ['--no-pub', '--template=app', '--org', 'com.bar.baz'], [], ); expect( () => _createProject(projectDir, [], []), throwsToolExit(message: 'Ambiguous organization'), ); }, timeout: allowForCreateFlutterProject); // Verify that we help the user correct an option ordering issue testUsingContext('produces sensible error message', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); expect( runner.run(['create', projectDir.path, '--pub']), throwsToolExit(exitCode: 2, message: 'Try moving --pub'), ); }); testUsingContext('fails when file exists where output directory should be', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); final File existingFile = fs.file(fs.path.join(projectDir.path, 'bad')); if (!existingFile.existsSync()) { existingFile.createSync(recursive: true); } expect( runner.run(['create', existingFile.path]), throwsToolExit(message: 'existing file'), ); }); testUsingContext('fails overwrite when file exists where output directory should be', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); final File existingFile = fs.file(fs.path.join(projectDir.path, 'bad')); if (!existingFile.existsSync()) { existingFile.createSync(recursive: true); } expect( runner.run(['create', '--overwrite', existingFile.path]), throwsToolExit(message: 'existing file'), ); }); testUsingContext('overwrites existing directory when requested', () async { Cache.flutterRoot = '../..'; final Directory existingDirectory = fs.directory(fs.path.join(projectDir.path, 'bad')); if (!existingDirectory.existsSync()) { existingDirectory.createSync(recursive: true); } final File existingFile = fs.file(fs.path.join(existingDirectory.path, 'lib', 'main.dart')); existingFile.createSync(recursive: true); await _createProject( fs.directory(existingDirectory.path), ['--overwrite'], [ 'android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java', 'lib/main.dart', 'ios/Flutter/AppFrameworkInfo.plist', 'ios/Runner/AppDelegate.m', 'ios/Runner/GeneratedPluginRegistrant.h', ], ); }); testUsingContext('fails when invalid package name', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); expect( runner.run(['create', fs.path.join(projectDir.path, 'invalidName')]), throwsToolExit(message: '"invalidName" is not a valid Dart package name.'), ); }); testUsingContext( 'invokes pub offline when requested', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--pub', '--offline', projectDir.path]); expect(loggingProcessManager.commands.first, contains(matches(r'dart-sdk[\\/]bin[\\/]pub'))); expect(loggingProcessManager.commands.first, contains('--offline')); }, timeout: allowForCreateFlutterProject, overrides: { ProcessManager: () => loggingProcessManager, }, ); testUsingContext( 'invokes pub online when offline not requested', () async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); await runner.run(['create', '--pub', projectDir.path]); expect(loggingProcessManager.commands.first, contains(matches(r'dart-sdk[\\/]bin[\\/]pub'))); expect(loggingProcessManager.commands.first, isNot(contains('--offline'))); }, timeout: allowForCreateFlutterProject, overrides: { ProcessManager: () => loggingProcessManager, }, ); testUsingContext('can create a sample-based project', () async { await _createAndAnalyzeProject( projectDir, ['--no-pub', '--sample=foo.bar.Baz'], [ 'lib/main.dart', 'flutter_project.iml', 'android/app/src/main/AndroidManifest.xml', 'ios/Flutter/AppFrameworkInfo.plist', ], unexpectedPaths: ['test'], ); expect(projectDir.childDirectory('lib').childFile('main.dart').readAsStringSync(), contains('void main() {}')); }, timeout: allowForRemotePubInvocation, overrides: { HttpClientFactory: () => () => MockHttpClient(200, result: 'void main() {}'), }); } Future _createProject( Directory dir, List createArgs, List expectedPaths, { List unexpectedPaths = const [], }) async { Cache.flutterRoot = '../..'; final CreateCommand command = CreateCommand(); final CommandRunner runner = createTestCommandRunner(command); final List args = ['create']; args.addAll(createArgs); args.add(dir.path); await runner.run(args); bool pathExists(String path) { final String fullPath = fs.path.join(dir.path, path); return fs.typeSync(fullPath) != FileSystemEntityType.notFound; } final List failures = []; for (String path in expectedPaths) { if (!pathExists(path)) { failures.add('Path "$path" does not exist.'); } } for (String path in unexpectedPaths) { if (pathExists(path)) { failures.add('Path "$path" exists when it shouldn\'t.'); } } expect(failures, isEmpty, reason: failures.join('\n')); } Future _createAndAnalyzeProject( Directory dir, List createArgs, List expectedPaths, { List unexpectedPaths = const [], }) async { await _createProject(dir, createArgs, expectedPaths, unexpectedPaths: unexpectedPaths); await _analyzeProject(dir.path); } Future _analyzeProject(String workingDir) async { final String flutterToolsPath = fs.path.absolute(fs.path.join( 'bin', 'flutter_tools.dart', )); final List args = [] ..addAll(dartVmFlags) ..add(flutterToolsPath) ..add('analyze'); final ProcessResult exec = await Process.run( '$dartSdkPath/bin/dart', args, workingDirectory: workingDir, ); if (exec.exitCode != 0) { print(exec.stdout); print(exec.stderr); } expect(exec.exitCode, 0); } Future _runFlutterTest(Directory workingDir, {String target}) async { final String flutterToolsPath = fs.path.absolute(fs.path.join( 'bin', 'flutter_tools.dart', )); final List args = [] ..addAll(dartVmFlags) ..add(flutterToolsPath) ..add('test') ..add('--no-color'); if (target != null) { args.add(target); } final ProcessResult exec = await Process.run( '$dartSdkPath/bin/dart', args, workingDirectory: workingDir.path, ); if (exec.exitCode != 0) { print(exec.stdout); print(exec.stderr); } expect(exec.exitCode, 0); } class MockFlutterVersion extends Mock implements FlutterVersion {} /// A ProcessManager that invokes a real process manager, but keeps /// track of all commands sent to it. class LoggingProcessManager extends LocalProcessManager { List> commands = >[]; @override Future start( List command, { String workingDirectory, Map environment, bool includeParentEnvironment = true, bool runInShell = false, ProcessStartMode mode = ProcessStartMode.normal, }) { commands.add(command); return super.start( command, workingDirectory: workingDirectory, environment: environment, includeParentEnvironment: includeParentEnvironment, runInShell: runInShell, mode: mode, ); } } class MockHttpClient implements HttpClient { MockHttpClient(this.statusCode, {this.result}); final int statusCode; final String result; @override Future getUrl(Uri url) async { return MockHttpClientRequest(statusCode, result: result); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClient - $invocation'; } } class MockHttpClientRequest implements HttpClientRequest { MockHttpClientRequest(this.statusCode, {this.result}); final int statusCode; final String result; @override Future close() async { return MockHttpClientResponse(statusCode, result: result); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClientRequest - $invocation'; } } class MockHttpClientResponse extends Stream> implements HttpClientResponse { MockHttpClientResponse(this.statusCode, {this.result}); @override final int statusCode; final String result; @override String get reasonPhrase => ''; @override StreamSubscription> listen(void onData(List event), { Function onError, void onDone(), bool cancelOnError }) { return Stream>.fromIterable(>[result.codeUnits]) .listen(onData, onError: onError, onDone: onDone, cancelOnError: cancelOnError); } @override dynamic noSuchMethod(Invocation invocation) { throw 'io.HttpClientResponse - $invocation'; } }