Add test that app builds if migrated to SwiftPM but SwiftPM is turned off #153800

loic-sharma · 2024-08-20T23:00:52Z

When a Flutter app is migrated to add Swift Package Manager integration, the Xcode project is modified to depend on a local Swift package that's generated by the Flutter tool. This generated package is how plugins are added to the Xcode project if the SwiftPM feature is enabled.

If an app has been migrated to SwiftPM but Flutter's SwiftPM feature is disabled, the tool must continue to generate a Swift package to ensure the app continues to build. Otherwise, the Xcode project would depend on a local package that does not exist.

This adds a high-level integration test that ensures this behavior works as expected, which mirrors this finer-grained unit test:

flutter/packages/flutter_tools/test/general.shard/macos/darwin_dependency_management_test.dart

Lines 340 to 382 in 47c1df9

    
           group('when not using Swift Package Manager', () { 
        
             testWithoutContext('but project already migrated', () async { 
        
               final MemoryFileSystem fs = MemoryFileSystem(); 
        
               final BufferLogger testLogger = BufferLogger.test(); 
        
               final File cocoapodPluginPodspec = fs.file('/path/to/cocoapod_plugin_1/darwin/cocoapod_plugin_1.podspec') 
        
                   ..createSync(recursive: true); 
        
               final List<Plugin> plugins = <Plugin>[ 
        
                 FakePlugin( 
        
                   name: 'cocoapod_plugin_1', 
        
                   platforms: <String, PluginPlatform>{platform.name: FakePluginPlatform()}, 
        
                   pluginPodspecPath: cocoapodPluginPodspec.path, 
        
                 ), 
        
               ]; 
        
               final FakeSwiftPackageManager swiftPackageManager = FakeSwiftPackageManager( 
        
                 expectedPlugins: plugins, 
        
               ); 
        
               final FakeCocoaPods cocoaPods = FakeCocoaPods(); 
        
               final FakeFlutterProject project = FakeFlutterProject( 
        
                 usesSwiftPackageManager: true, 
        
                 fileSystem: fs, 
        
               ); 
        
               final XcodeBasedProject xcodeProject = platform == SupportedPlatform.ios ? project.ios : project.macos; 
        
               xcodeProject.xcodeProjectInfoFile.createSync(recursive: true); 
        
               xcodeProject.xcodeProjectInfoFile.writeAsStringSync( 
        
                 'FlutterGeneratedPluginSwiftPackage', 
        
               ); 
        
               final DarwinDependencyManagement dependencyManagement = DarwinDependencyManagement( 
        
                 project: project, 
        
                 plugins: plugins, 
        
                 cocoapods: cocoaPods, 
        
                 swiftPackageManager: swiftPackageManager, 
        
                 fileSystem: fs, 
        
                 logger: testLogger, 
        
               ); 
        
               await dependencyManagement.setUp( 
        
                 platform: platform, 
        
               ); 
        
               expect(swiftPackageManager.generated, isTrue); 
        
               expect(testLogger.warningText, isEmpty); 
        
               expect(testLogger.statusText, isEmpty); 
        
               expect(cocoaPods.podfileSetup, isTrue); 
        
             });

Part of #153448

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…s turned off (flutter/flutter#153800)

… off (flutter#153800) When a Flutter app is migrated to add Swift Package Manager integration, the Xcode project is modified to depend on a local Swift package that's generated by the Flutter tool. This generated package is how plugins are added to the Xcode project if the SwiftPM feature is enabled. If an app has been migrated to SwiftPM but Flutter's SwiftPM feature is disabled, the [tool must continue to generate a Swift package](https://github.com/flutter/flutter/blob/47c1df9640f8812bed40dc1174dc4acd0eb7fd86/packages/flutter_tools/lib/src/macos/darwin_dependency_management.dart#L69-L78) to ensure the app continues to build. Otherwise, the Xcode project would depend on a local package that does not exist. This adds a high-level integration test that ensures this behavior works as expected, which mirrors this finer-grained unit test: https://github.com/flutter/flutter/blob/47c1df9640f8812bed40dc1174dc4acd0eb7fd86/packages/flutter_tools/test/general.shard/macos/darwin_dependency_management_test.dart#L340-L382 Part of flutter#153448

…s turned off (flutter/flutter#153800)

loic-sharma added 2 commits August 19, 2024 14:53

WIP

d69f094

Fix

cfe2bb3

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Aug 20, 2024

loic-sharma mentioned this pull request Aug 20, 2024

[tool] Always generate the Package.swift file #153448

Closed

2 tasks

Add cocoapods check

628778c

loic-sharma requested a review from jmagman August 21, 2024 17:46

loic-sharma marked this pull request as ready for review August 21, 2024 17:46

jmagman approved these changes Aug 21, 2024

View reviewed changes

loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 21, 2024

auto-submit bot merged commit 88d9f61 into flutter:master Aug 21, 2024

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to 59e6c8d52f11 (20 revisions) flutter/packages#7477

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

1c2dd92

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to 544ce7cd34b7 (21 revisions) flutter/packages#7478

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

7614c27

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to a9e94d9045cd (22 revisions) flutter/packages#7479

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

49f87e9

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to 4a6fbef83f9b (23 revisions) flutter/packages#7481

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

0a500ef

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to ef098c2aa47d (24 revisions) flutter/packages#7482

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

e315015

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 22, 2024

Roll Flutter from b8f89f70bf4e to 1b234858f2e8 (25 revisions) flutter/packages#7483

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 22, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

44bba0c

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 23, 2024

Roll Flutter from b8f89f70bf4e to 43495d6f2d7f (39 revisions) flutter/packages#7485

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 23, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

0ce22c9

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 23, 2024

Roll Flutter from b8f89f70bf4e to 1cdff3616eec (40 revisions) flutter/packages#7486

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 23, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

30aab1f

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 23, 2024

Roll Flutter from b8f89f70bf4e to b2de4dfc2bd2 (41 revisions) flutter/packages#7488

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 23, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

0553670

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll mentioned this pull request Aug 23, 2024

Roll Flutter from b8f89f70bf4e to d7b092e42d8d (42 revisions) flutter/packages#7489

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 23, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

8acfb56

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

6537147

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

05f0fb3

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

508f0ff

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

d3d5593

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

5de71b0

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

92daa23

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

079ea49

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 31, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

a5b367f

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 31, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

14011a3

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 1, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

6bd99c0

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

02fd5b4

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

2a5b4f2

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

2a3ac95

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

05e20e0

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

c46a133

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 3, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

93b7bda

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

0f4cc4d

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

f51b9ab

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

0bfa832

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

2709d07

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

96c45d9

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 4, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

166be5f

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 5, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

b4a0ebb

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 5, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

c0e6a7d

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 5, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

c126451

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 5, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

22759b0

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 5, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

6770faf

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 11, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

2259943

…s turned off (flutter/flutter#153800)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 12, 2024

88d9f61 Add test that app builds if migrated to SwiftPM but SwiftPM i…

cb910da

…s turned off (flutter/flutter#153800)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add test that app builds if migrated to SwiftPM but SwiftPM is turned off #153800

Add test that app builds if migrated to SwiftPM but SwiftPM is turned off #153800

Uh oh!

loic-sharma commented Aug 20, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	group('when not using Swift Package Manager', () {
	testWithoutContext('but project already migrated', () async {
	final MemoryFileSystem fs = MemoryFileSystem();
	final BufferLogger testLogger = BufferLogger.test();
	final File cocoapodPluginPodspec = fs.file('/path/to/cocoapod_plugin_1/darwin/cocoapod_plugin_1.podspec')
	..createSync(recursive: true);
	final List<Plugin> plugins = <Plugin>[
	FakePlugin(
	name: 'cocoapod_plugin_1',
	platforms: <String, PluginPlatform>{platform.name: FakePluginPlatform()},
	pluginPodspecPath: cocoapodPluginPodspec.path,
	),
	];
	final FakeSwiftPackageManager swiftPackageManager = FakeSwiftPackageManager(
	expectedPlugins: plugins,
	);
	final FakeCocoaPods cocoaPods = FakeCocoaPods();
	final FakeFlutterProject project = FakeFlutterProject(
	usesSwiftPackageManager: true,
	fileSystem: fs,
	);
	final XcodeBasedProject xcodeProject = platform == SupportedPlatform.ios ? project.ios : project.macos;
	xcodeProject.xcodeProjectInfoFile.createSync(recursive: true);
	xcodeProject.xcodeProjectInfoFile.writeAsStringSync(
	'FlutterGeneratedPluginSwiftPackage',
	);

	final DarwinDependencyManagement dependencyManagement = DarwinDependencyManagement(
	project: project,
	plugins: plugins,
	cocoapods: cocoaPods,
	swiftPackageManager: swiftPackageManager,
	fileSystem: fs,
	logger: testLogger,
	);
	await dependencyManagement.setUp(
	platform: platform,
	);
	expect(swiftPackageManager.generated, isTrue);
	expect(testLogger.warningText, isEmpty);
	expect(testLogger.statusText, isEmpty);
	expect(cocoaPods.podfileSetup, isTrue);
	});

Add test that app builds if migrated to SwiftPM but SwiftPM is turned off #153800

Add test that app builds if migrated to SwiftPM but SwiftPM is turned off #153800

Uh oh!

Conversation

loic-sharma commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

loic-sharma commented Aug 20, 2024 •

edited

Loading