mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
The main purpose of this PR is to add the Flutter framework as a Swift Package dependency. As such, Xcode will now handle the copying, thinning, and codesigning of the framework and therefore the Flutter Xcode Run Scripts shouldn't. This will allow plugins to declare a dependency on the Flutter framework package and eliminate the need for the Pre-Action "prepare" script. This PR does not technically make the Flutter framework a local package override, that will be added in a follow up PR: https://github.com/flutter/flutter/pull/179512 This change includes: * Generation of the FlutterFramework swift package (this will generate a Package.swift and symlink to the Flutter framework in the artifact cache) <img width="400" height="271" alt="Screenshot 2025-12-04 at 4 54 43 PM" src="https://github.com/user-attachments/assets/6cfde6da-3698-4b76-b3b1-725f91fbf58d" /> * Adding the FlutterFramework as a dependency to the FlutterGeneratedPluginSwiftPackage (which the the Swift package the Xcode project has a dependency on) <img width="400" height="195" alt="Screenshot 2025-12-04 at 4 55 13 PM" src="https://github.com/user-attachments/assets/30fa402a-6a11-4df0-b2cd-a4a82197e50a" /> ### Change to Flutter Run Scripts Flutter currently has 3 Xcode Run Scripts: * prepare (happens in a scheme pre-action) * [PREVIOUS] Via `flutter assemble` - copies the Flutter framework from engine build cache to `BUILT_PRODUCTS_DIR` * [NEW] Same as previous except skips codesigning. This is still included to accommodate plugins that don't have a dependency declared on the Flutter framework. * build (happens in first Run Script in the Xcode build phases that happens before compiling) * [PREVIOUS] Via `flutter assemble` - copies, thins, and codesigns Flutter framework into `BUILT_PRODUCTS_DIR` * [NEW] Is skipped, Xcode now does this * embed_and_thin (happens in second Run Script in the Xcode build phases after compiling, linking, and embedding) * [PREVIOUS] Copies Flutter framework from `BUILT_PRODUCTS_DIR` to `TARGET_BUILD_DIR` * [NEW] * Validates Flutter framework in `BUILT_PRODUCTS_DIR` & `TARGET_BUILD_DIR` (which would have been put there by Xcode via SwiftPM) matches the Flutter framework in the engine cache. * If it matches, do not copy. Xcode now does this. * If it doesn't: * Call `flutter assemble` to copy the correct Flutter framework into `BUILT_PRODUCTS_DIR` * Then copy from `BUILT_PRODUCTS_DIR` to `TARGET_BUILD_DIR`. Fixes https://github.com/flutter/flutter/issues/166489. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
664 lines
26 KiB
Dart
664 lines
26 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 'package:file/memory.dart';
|
|
import 'package:file_testing/file_testing.dart';
|
|
import 'package:flutter_tools/src/artifacts.dart';
|
|
import 'package:flutter_tools/src/base/file_system.dart';
|
|
import 'package:flutter_tools/src/base/logger.dart';
|
|
import 'package:flutter_tools/src/base/version.dart';
|
|
import 'package:flutter_tools/src/build_info.dart';
|
|
import 'package:flutter_tools/src/build_system/build_system.dart';
|
|
import 'package:flutter_tools/src/cache.dart';
|
|
import 'package:flutter_tools/src/features.dart';
|
|
import 'package:flutter_tools/src/flutter_manifest.dart';
|
|
import 'package:flutter_tools/src/ios/xcodeproj.dart';
|
|
import 'package:flutter_tools/src/project.dart';
|
|
import 'package:test/fake.dart';
|
|
|
|
import '../src/common.dart';
|
|
import '../src/context.dart';
|
|
import '../src/fakes.dart';
|
|
|
|
void main() {
|
|
group('IosProject', () {
|
|
testWithoutContext('managedDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.managedDirectory.path, 'app_name/ios/Flutter');
|
|
});
|
|
|
|
testWithoutContext('module managedDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs, isModule: true));
|
|
expect(project.managedDirectory.path, 'app_name/.ios/Flutter');
|
|
});
|
|
|
|
testWithoutContext('ephemeralDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.ephemeralDirectory.path, 'app_name/ios/Flutter/ephemeral');
|
|
});
|
|
|
|
testWithoutContext('module ephemeralDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs, isModule: true));
|
|
expect(project.ephemeralDirectory.path, 'app_name/.ios/Flutter/ephemeral');
|
|
});
|
|
|
|
testWithoutContext('flutterSwiftPackagesDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.flutterSwiftPackagesDirectory.path, 'app_name/ios/Flutter/ephemeral/Packages');
|
|
});
|
|
|
|
testWithoutContext('relativeSwiftPackagesDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.relativeSwiftPackagesDirectory.path,
|
|
'app_name/ios/Flutter/ephemeral/Packages/.packages',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('flutterFrameworkSwiftPackageDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.flutterFrameworkSwiftPackageDirectory.path,
|
|
'app_name/ios/Flutter/ephemeral/Packages/.packages/FlutterFramework',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('flutterPluginSwiftPackageDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.flutterPluginSwiftPackageDirectory.path,
|
|
'app_name/ios/Flutter/ephemeral/Packages/FlutterGeneratedPluginSwiftPackage',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('module flutterPluginSwiftPackageDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs, isModule: true));
|
|
expect(
|
|
project.flutterPluginSwiftPackageDirectory.path,
|
|
'app_name/.ios/Flutter/ephemeral/Packages/FlutterGeneratedPluginSwiftPackage',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('xcodeConfigFor', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.xcodeConfigFor('Debug').path, 'app_name/ios/Flutter/Debug.xcconfig');
|
|
});
|
|
|
|
testWithoutContext('lldbInitFile', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.lldbInitFile.path, 'app_name/ios/Flutter/ephemeral/flutter_lldbinit');
|
|
});
|
|
|
|
testWithoutContext('lldbHelperPythonFile', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.lldbHelperPythonFile.path,
|
|
'app_name/ios/Flutter/ephemeral/flutter_lldb_helper.py',
|
|
);
|
|
});
|
|
|
|
group('projectInfo', () {
|
|
testUsingContext(
|
|
'is null if XcodeProjectInterpreter is null',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.projectInfo(), isNull);
|
|
},
|
|
overrides: <Type, Generator>{XcodeProjectInterpreter: () => null},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is null if XcodeProjectInterpreter is not installed',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.projectInfo(), isNull);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(isInstalled: false),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is null if xcodeproj does not exist',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(await project.projectInfo(), isNull);
|
|
},
|
|
overrides: <Type, Generator>{XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter()},
|
|
);
|
|
|
|
testUsingContext(
|
|
'returns XcodeProjectInfo',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.projectInfo(), isNotNull);
|
|
},
|
|
overrides: <Type, Generator>{XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter()},
|
|
);
|
|
});
|
|
|
|
testUsingContext(
|
|
'schemeForBuildInfo succeeds',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
const BuildInfo buildInfo = BuildInfo.debug;
|
|
expect(await project.schemeForBuildInfo(buildInfo), 'Runner');
|
|
},
|
|
overrides: <Type, Generator>{XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter()},
|
|
);
|
|
|
|
testUsingContext(
|
|
'schemeForBuildInfo returns null if unable to find project',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
const BuildInfo buildInfo = BuildInfo.debug;
|
|
expect(await project.schemeForBuildInfo(buildInfo), isNull);
|
|
},
|
|
overrides: <Type, Generator>{XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter()},
|
|
);
|
|
|
|
testUsingContext(
|
|
'schemeForBuildInfo succeeds with flavor',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
const buildInfo = BuildInfo(
|
|
BuildMode.debug,
|
|
'my_flavor',
|
|
treeShakeIcons: true,
|
|
packageConfigPath: '',
|
|
);
|
|
expect(await project.schemeForBuildInfo(buildInfo), 'my_flavor');
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () =>
|
|
FakeXcodeProjectInterpreter(schemes: ['Runner', 'my_flavor']),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'schemeForBuildInfo throws error if flavor is not found',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
project.xcodeProject.createSync(recursive: true);
|
|
const buildInfo = BuildInfo(
|
|
BuildMode.debug,
|
|
'invalid_flavor',
|
|
treeShakeIcons: true,
|
|
packageConfigPath: '',
|
|
);
|
|
await expectLater(project.schemeForBuildInfo(buildInfo), throwsToolExit());
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () =>
|
|
FakeXcodeProjectInterpreter(schemes: ['Runner', 'my_flavor']),
|
|
},
|
|
);
|
|
|
|
group('usesSwiftPackageManager', () {
|
|
testUsingContext(
|
|
'is true when iOS project exists',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isTrue);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
"is false when iOS project doesn't exist",
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when Xcode is less than 15',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(14, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when Swift Package Manager feature is not enabled',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when project is a module',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest(isModule: true);
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
});
|
|
|
|
group('parseFlavorFromConfiguration', () {
|
|
testWithoutContext('from FLAVOR when CONFIGURATION is null', () async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
final env = Environment.test(
|
|
fs.currentDirectory,
|
|
fileSystem: fs,
|
|
logger: BufferLogger.test(),
|
|
artifacts: Artifacts.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
defines: <String, String>{kFlavor: 'strawberry'},
|
|
);
|
|
expect(await project.parseFlavorFromConfiguration(env), 'strawberry');
|
|
});
|
|
|
|
testWithoutContext('from FLAVOR when CONFIGURATION is does not contain delimiter', () async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
final env = Environment.test(
|
|
fs.currentDirectory,
|
|
fileSystem: fs,
|
|
logger: BufferLogger.test(),
|
|
artifacts: Artifacts.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
defines: <String, String>{kFlavor: 'strawberry', kXcodeConfiguration: 'Debug'},
|
|
);
|
|
expect(await project.parseFlavorFromConfiguration(env), 'strawberry');
|
|
});
|
|
|
|
testUsingContext(
|
|
'from CONFIGURATION when has flavor following a hyphen that matches a scheme',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
final env = Environment.test(
|
|
fs.currentDirectory,
|
|
fileSystem: fs,
|
|
logger: BufferLogger.test(),
|
|
artifacts: Artifacts.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
defines: <String, String>{kFlavor: 'strawberry', kXcodeConfiguration: 'Debug-vanilla'},
|
|
);
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.parseFlavorFromConfiguration(env), 'vanilla');
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () =>
|
|
FakeXcodeProjectInterpreter(schemes: <String>['Runner', 'vanilla']),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'from CONFIGURATION when has flavor following a space that matches a scheme',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
final env = Environment.test(
|
|
fs.currentDirectory,
|
|
fileSystem: fs,
|
|
logger: BufferLogger.test(),
|
|
artifacts: Artifacts.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
defines: <String, String>{kFlavor: 'strawberry', kXcodeConfiguration: 'Debug vanilla'},
|
|
);
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.parseFlavorFromConfiguration(env), 'vanilla');
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () =>
|
|
FakeXcodeProjectInterpreter(schemes: <String>['Runner', 'vanilla']),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'from FLAVOR when CONFIGURATION does not match a scheme',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = IosProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
final env = Environment.test(
|
|
fs.currentDirectory,
|
|
fileSystem: fs,
|
|
logger: BufferLogger.test(),
|
|
artifacts: Artifacts.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
defines: <String, String>{kFlavor: 'strawberry', kXcodeConfiguration: 'Debug-random'},
|
|
);
|
|
project.xcodeProject.createSync(recursive: true);
|
|
expect(await project.parseFlavorFromConfiguration(env), 'strawberry');
|
|
},
|
|
overrides: <Type, Generator>{
|
|
XcodeProjectInterpreter: () =>
|
|
FakeXcodeProjectInterpreter(schemes: <String>['Runner', 'vanilla']),
|
|
},
|
|
);
|
|
});
|
|
|
|
group('ensureReadyForPlatformSpecificTooling', () {
|
|
group('lldb files are generated', () {
|
|
testUsingContext(
|
|
'when they are missing',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final flutterProject = FlutterProject(projectDirectory, manifest, manifest);
|
|
final project = IosProject.fromFlutter(flutterProject);
|
|
expect(project.lldbInitFile, isNot(exists));
|
|
expect(project.lldbHelperPythonFile, isNot(exists));
|
|
|
|
await project.ensureReadyForPlatformSpecificTooling();
|
|
|
|
expect(project.lldbInitFile, exists);
|
|
expect(project.lldbHelperPythonFile, exists);
|
|
},
|
|
overrides: <Type, Generator>{Cache: () => FakeCache(olderThanToolsStamp: true)},
|
|
);
|
|
|
|
testUsingContext(
|
|
'when they are older than tool',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('ios').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final flutterProject = FlutterProject(projectDirectory, manifest, manifest);
|
|
final project = IosProject.fromFlutter(flutterProject);
|
|
project.lldbInitFile.createSync(recursive: true);
|
|
project.lldbInitFile.writeAsStringSync('old');
|
|
project.lldbHelperPythonFile.createSync(recursive: true);
|
|
project.lldbHelperPythonFile.writeAsStringSync('old');
|
|
|
|
await project.ensureReadyForPlatformSpecificTooling();
|
|
|
|
expect(
|
|
project.lldbInitFile.readAsStringSync(),
|
|
contains('Generated file, do not edit.'),
|
|
);
|
|
expect(
|
|
project.lldbHelperPythonFile.readAsStringSync(),
|
|
contains('Generated file, do not edit.'),
|
|
);
|
|
},
|
|
overrides: <Type, Generator>{Cache: () => FakeCache(olderThanToolsStamp: true)},
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
group('MacOSProject', () {
|
|
testWithoutContext('managedDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.managedDirectory.path, 'app_name/macos/Flutter');
|
|
});
|
|
|
|
testWithoutContext('module managedDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.managedDirectory.path, 'app_name/macos/Flutter');
|
|
});
|
|
|
|
testWithoutContext('ephemeralDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.ephemeralDirectory.path, 'app_name/macos/Flutter/ephemeral');
|
|
});
|
|
|
|
testWithoutContext('flutterSwiftPackagesDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.flutterSwiftPackagesDirectory.path,
|
|
'app_name/macos/Flutter/ephemeral/Packages',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('relativeSwiftPackagesDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.relativeSwiftPackagesDirectory.path,
|
|
'app_name/macos/Flutter/ephemeral/Packages/.packages',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('flutterPluginSwiftPackageDirectory', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(
|
|
project.flutterPluginSwiftPackageDirectory.path,
|
|
'app_name/macos/Flutter/ephemeral/Packages/FlutterGeneratedPluginSwiftPackage',
|
|
);
|
|
});
|
|
|
|
testWithoutContext('xcodeConfigFor', () {
|
|
final fs = MemoryFileSystem.test();
|
|
final project = MacOSProject.fromFlutter(FakeFlutterProject(fileSystem: fs));
|
|
expect(project.xcodeConfigFor('Debug').path, 'app_name/macos/Flutter/Flutter-Debug.xcconfig');
|
|
});
|
|
|
|
group('usesSwiftPackageManager', () {
|
|
testUsingContext(
|
|
'is true when macOS project exists',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('macos').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.macos.usesSwiftPackageManager, isTrue);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
"is false when macOS project doesn't exist",
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.ios.usesSwiftPackageManager, isFalse);
|
|
expect(project.macos.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when Xcode is less than 15',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('macos').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.macos.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(14, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when Swift Package Manager feature is not enabled',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('macos').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest();
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.macos.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
|
|
testUsingContext(
|
|
'is false when project is a module',
|
|
() async {
|
|
final fs = MemoryFileSystem.test();
|
|
final Directory projectDirectory = fs.directory('path');
|
|
projectDirectory.childDirectory('macos').createSync(recursive: true);
|
|
final FlutterManifest manifest = FakeFlutterManifest(isModule: true);
|
|
final project = FlutterProject(projectDirectory, manifest, manifest);
|
|
expect(project.macos.usesSwiftPackageManager, isFalse);
|
|
},
|
|
overrides: <Type, Generator>{
|
|
FeatureFlags: () => TestFeatureFlags(isSwiftPackageManagerEnabled: true),
|
|
XcodeProjectInterpreter: () => FakeXcodeProjectInterpreter(version: Version(15, 0, 0)),
|
|
},
|
|
);
|
|
});
|
|
});
|
|
}
|
|
|
|
class FakeFlutterProject extends Fake implements FlutterProject {
|
|
FakeFlutterProject({required this.fileSystem, this.isModule = false});
|
|
|
|
MemoryFileSystem fileSystem;
|
|
|
|
@override
|
|
late final Directory directory = fileSystem.directory('app_name');
|
|
|
|
@override
|
|
bool isModule = false;
|
|
|
|
@override
|
|
FlutterManifest get manifest => FakeFlutterManifest();
|
|
}
|
|
|
|
class FakeXcodeProjectInterpreter extends Fake implements XcodeProjectInterpreter {
|
|
FakeXcodeProjectInterpreter({
|
|
this.isInstalled = true,
|
|
this.version,
|
|
this.schemes = const <String>['Runner'],
|
|
});
|
|
|
|
@override
|
|
final bool isInstalled;
|
|
|
|
@override
|
|
final Version? version;
|
|
|
|
List<String> schemes;
|
|
|
|
@override
|
|
Future<XcodeProjectInfo?> getInfo(String projectPath, {String? projectFilename}) async {
|
|
return XcodeProjectInfo(<String>[], <String>[], schemes, BufferLogger.test());
|
|
}
|
|
}
|
|
|
|
class FakeFlutterManifest extends Fake implements FlutterManifest {
|
|
FakeFlutterManifest({this.isModule = false});
|
|
|
|
@override
|
|
bool isModule;
|
|
|
|
@override
|
|
String? buildName;
|
|
|
|
@override
|
|
String? buildNumber;
|
|
|
|
@override
|
|
String? get iosBundleIdentifier => null;
|
|
|
|
@override
|
|
String get appName => '';
|
|
|
|
@override
|
|
PluginPlatformConfig? get ios => null;
|
|
|
|
@override
|
|
PluginPlatformConfig? get macos => null;
|
|
}
|
|
|
|
class FakeCache extends Fake implements Cache {
|
|
FakeCache({this.olderThanToolsStamp = false});
|
|
|
|
bool olderThanToolsStamp;
|
|
Map<String, bool> filesOlderThanToolsStamp = <String, bool>{};
|
|
|
|
@override
|
|
bool isOlderThanToolsStamp(FileSystemEntity entity) {
|
|
if (filesOlderThanToolsStamp.containsKey(entity.basename)) {
|
|
return filesOlderThanToolsStamp[entity.basename]!;
|
|
}
|
|
return olderThanToolsStamp;
|
|
}
|
|
}
|