Fix some tests that fail with Swift Package Manager enabled (flutter#152267)

loic-sharma · TytaniumDev · commit 9b7160881ab7 · 2024-08-07T12:19:14.000-07:00
flutter#152049 was reverted as it broke several post-submit tests. This relands the test fixes in flutter#152049 without enabling Swift Package Manager on the master channel. This change is split into two commits: 1. flutter@dd1762a - The changes in flutter#152049 1. flutter@00fdcfb - Undoes the changes that enabled Swift Package Manager on the master channel Part of flutter#151567
diff --git a/dev/devicelab/bin/tasks/build_ios_framework_module_test.dart b/dev/devicelab/bin/tasks/build_ios_framework_module_test.dart
@@ -151,7 +151,7 @@ Future<void> _testBuildIosFramework(Directory projectDir, { bool isModule = fals
 
   section('Check debug build has no Dart AOT');
 
-  final String aotSymbols = await _dylibSymbols(debugAppFrameworkPath);
+  final String aotSymbols = await dumpSymbolTable(debugAppFrameworkPath);
 
   if (aotSymbols.contains('architecture') ||
       aotSymbols.contains('_kDartVmSnapshot')) {
@@ -172,7 +172,7 @@ Future<void> _testBuildIosFramework(Directory projectDir, { bool isModule = fals
 
     await _checkDylib(appFrameworkPath);
 
-    final String aotSymbols = await _dylibSymbols(appFrameworkPath);
+    final String aotSymbols = await dumpSymbolTable(appFrameworkPath);
 
     if (!aotSymbols.contains('_kDartVmSnapshot')) {
       throw TaskResult.failure('$mode App.framework missing Dart AOT');
@@ -562,7 +562,7 @@ Future<void> _testBuildMacOSFramework(Directory projectDir) async {
 
   section('Check debug build has no Dart AOT');
 
-  final String aotSymbols = await _dylibSymbols(debugAppFrameworkPath);
+  final String aotSymbols = await dumpSymbolTable(debugAppFrameworkPath);
 
   if (aotSymbols.contains('architecture') ||
       aotSymbols.contains('_kDartVmSnapshot')) {
@@ -583,7 +583,7 @@ Future<void> _testBuildMacOSFramework(Directory projectDir) async {
 
     await _checkDylib(appFrameworkPath);
 
-    final String aotSymbols = await _dylibSymbols(appFrameworkPath);
+    final String aotSymbols = await dumpSymbolTable(appFrameworkPath);
 
     if (!aotSymbols.contains('_kDartVmSnapshot')) {
       throw TaskResult.failure('$mode App.framework missing Dart AOT');
@@ -939,15 +939,6 @@ Future<void> _checkStatic(String pathToLibrary) async {
   }
 }
 
-Future<String> _dylibSymbols(String pathToDylib) {
-  return eval('nm', <String>[
-    '-g',
-    pathToDylib,
-    '-arch',
-    'arm64',
-  ]);
-}
-
 Future<bool> _linksOnFlutter(String pathToBinary) async {
   final String loadCommands = await eval('otool', <String>[
     '-l',
diff --git a/dev/devicelab/bin/tasks/module_test_ios.dart b/dev/devicelab/bin/tasks/module_test_ios.dart
@@ -703,13 +703,7 @@ Future<bool> _isAppAotBuild(Directory app) async {
     'App',
   );
 
-  final String symbolTable = await eval(
-    'nm',
-    <String> [
-      '-gU',
-      binary,
-    ],
-  );
+  final String symbolTable = await dumpSymbolTable(binary);
 
   return symbolTable.contains('kDartIsolateSnapshotInstructions');
 }
diff --git a/dev/devicelab/bin/tasks/plugin_dependencies_test.dart b/dev/devicelab/bin/tasks/plugin_dependencies_test.dart
@@ -6,6 +6,7 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:flutter_devicelab/framework/framework.dart';
+import 'package:flutter_devicelab/framework/ios.dart';
 import 'package:flutter_devicelab/framework/task_result.dart';
 import 'package:flutter_devicelab/framework/utils.dart';
 import 'package:path/path.dart' as path;
@@ -209,6 +210,7 @@ public class DummyPluginAClass {
       final String flutterPluginsDependenciesFileContent = flutterPluginsDependenciesFile.readAsStringSync();
 
       final Map<String, dynamic> jsonContent = json.decode(flutterPluginsDependenciesFileContent) as Map<String, dynamic>;
+      final bool swiftPackageManagerEnabled = jsonContent['swift_package_manager_enabled'] as bool? ?? false;
 
       // Verify the dependencyGraph object is valid. The rest of the contents of this file are not relevant to the
       // dependency graph and are tested by unit tests.
@@ -302,28 +304,35 @@ public class DummyPluginAClass {
           return TaskResult.failure('Failed to build plugin A example iOS app');
         }
 
-        checkDirectoryExists(path.join(
-          appBundle.path,
-          'Frameworks',
-          'plugin_a.framework',
-        ));
-        checkDirectoryExists(path.join(
-          appBundle.path,
-          'Frameworks',
-          'plugin_b.framework',
-        ));
-        checkDirectoryExists(path.join(
-          appBundle.path,
-          'Frameworks',
-          'plugin_c.framework',
-        ));
-
-        // Plugin D is Android only and should not be embedded.
-        checkDirectoryNotExists(path.join(
-          appBundle.path,
-          'Frameworks',
-          'plugin_d.framework',
-        ));
+        if (swiftPackageManagerEnabled) {
+          // Check plugins are built statically if using SwiftPM.
+          final String executable = path.join(appBundle.path, 'Runner');
+          final String symbols = await dumpSymbolTable(executable);
+
+          final bool foundA = symbols.contains('plugin_a');
+          final bool foundB = symbols.contains('plugin_b');
+          final bool foundC = symbols.contains('plugin_c');
+          final bool foundD = symbols.contains('plugin_d');
+
+          if (!foundA || !foundB || !foundC) {
+            return TaskResult.failure(
+              'Failed to find plugins_a, plugin_b, or plugin_c symbols in the app'
+            );
+          }
+
+          if (foundD) {
+            return TaskResult.failure(
+              'Found Android plugin_d symbols in iOS app'
+            );
+          }
+        } else {
+          // Check plugins are built dynamically if using CocoaPods.
+          checkDirectoryExists(path.join(appBundle.path, 'Frameworks', 'plugin_a.framework'));
+          checkDirectoryExists(path.join(appBundle.path, 'Frameworks', 'plugin_b.framework'));
+          checkDirectoryExists(path.join(appBundle.path, 'Frameworks', 'plugin_c.framework'));
+
+          checkDirectoryNotExists(path.join(appBundle.path, 'Frameworks', 'plugin_d.framework'));
+        }
       }
 
       return TaskResult.success(null);
diff --git a/dev/devicelab/lib/framework/ios.dart b/dev/devicelab/lib/framework/ios.dart
@@ -308,3 +308,17 @@ File? _createDisabledSandboxEntitlementFile(
 
   return disabledSandboxEntitlementFile;
 }
+
+/// Returns global (external) symbol table entries, delimited by new lines.
+Future<String> dumpSymbolTable(String filePath) {
+  return eval(
+    'nm',
+    <String>[
+      '--extern-only',
+      '--just-symbol-name',
+      filePath,
+      '-arch',
+      'arm64',
+    ],
+  );
+}
diff --git a/dev/devicelab/lib/tasks/plugin_tests.dart b/dev/devicelab/lib/tasks/plugin_tests.dart
@@ -77,6 +77,11 @@ class PluginTest {
       final _FlutterProject app = await _FlutterProject.create(tempDir, options, buildTarget,
           name: 'plugintestapp', template: 'app', environment: appCreateEnvironment);
       try {
+        if (cocoapodsTransitiveFlutterDependency) {
+          section('Disable Swift Package Manager');
+          await app.disableSwiftPackageManager();
+        }
+
         section('Add plugins');
         await app.addPlugin('plugintest',
             pluginPath: path.join('..', 'plugintest'));
@@ -147,6 +152,20 @@ class _FlutterProject {
     return _FlutterProject(Directory(path.join(rootPath)), 'example');
   }
 
+  Future<void> disableSwiftPackageManager() async {
+    final File pubspec = pubspecFile;
+    String content = await pubspec.readAsString();
+    content = content.replaceFirst(
+      '# The following section is specific to Flutter packages.\n'
+      'flutter:\n',
+      '# The following section is specific to Flutter packages.\n'
+      'flutter:\n'
+      '\n'
+      '  disable-swift-package-manager: true\n'
+    );
+    await pubspec.writeAsString(content, flush: true);
+  }
+
   Future<void> addPlugin(String plugin, {String? pluginPath}) async {
     final File pubspec = pubspecFile;
     String content = await pubspec.readAsString();
@@ -244,9 +263,14 @@ class $dartPluginClass {
     await podspec.writeAsString(podspecContent, flush: true);
 
     // Make PlugintestPlugin.swift compile on iOS and macOS with target conditionals.
+    // If SwiftPM is disabled, the file will be in `darwin/Classes/`.
+    // Otherwise, the file will be in `darwin/<plugin>/Sources/<plugin>/`.
     final String pluginClass = '${name[0].toUpperCase()}${name.substring(1)}Plugin';
     print('pluginClass: $pluginClass');
-    final File pluginRegister = File(path.join(darwinDir.path, 'Classes', '$pluginClass.swift'));
+    File pluginRegister = File(path.join(darwinDir.path, 'Classes', '$pluginClass.swift'));
+    if (!pluginRegister.existsSync()) {
+      pluginRegister = File(path.join(darwinDir.path, name, 'Sources', name, '$pluginClass.swift'));
+    }
     final String pluginRegisterContent = '''
 #if os(macOS)
 import FlutterMacOS
@@ -494,42 +518,55 @@ s.dependency 'AppAuth', '1.6.0'
         }
 
         if (validateNativeBuildProject) {
-          final File podsProject = File(path.join(rootPath, target, 'Pods', 'Pods.xcodeproj', 'project.pbxproj'));
-          if (!podsProject.existsSync()) {
-            throw TaskResult.failure('Xcode Pods project file missing at ${podsProject.path}');
-          }
-
-          final String podsProjectContent = podsProject.readAsStringSync();
-          if (target == 'ios') {
-            // Plugins with versions lower than the app version should not have IPHONEOS_DEPLOYMENT_TARGET set.
-            // The plugintest plugin target should not have IPHONEOS_DEPLOYMENT_TARGET set since it has been lowered
-            // in _reduceDarwinPluginMinimumVersion to 10, which is below the target version of 11.
-            if (podsProjectContent.contains('IPHONEOS_DEPLOYMENT_TARGET = 10')) {
-              throw TaskResult.failure('Plugin build setting IPHONEOS_DEPLOYMENT_TARGET not removed');
-            }
-            // Transitive dependency AppAuth targeting too-low 8.0 was not fixed.
-            if (podsProjectContent.contains('IPHONEOS_DEPLOYMENT_TARGET = 8')) {
-              throw TaskResult.failure('Transitive dependency build setting IPHONEOS_DEPLOYMENT_TARGET=8 not removed');
+          final File generatedSwiftManifest = File(path.join(
+            rootPath,
+            target,
+            'Flutter',
+            'ephemeral',
+            'Packages',
+            'FlutterGeneratedPluginSwiftPackage',
+            'Package.swift'
+          ));
+          final bool swiftPackageManagerEnabled = generatedSwiftManifest.existsSync();
+
+          if (!swiftPackageManagerEnabled) {
+            final File podsProject = File(path.join(rootPath, target, 'Pods', 'Pods.xcodeproj', 'project.pbxproj'));
+            if (!podsProject.existsSync()) {
+              throw TaskResult.failure('Xcode Pods project file missing at ${podsProject.path}');
             }
-            if (!podsProjectContent.contains(r'"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "$(inherited) i386";')) {
-              throw TaskResult.failure(r'EXCLUDED_ARCHS is not "$(inherited) i386"');
-            }
-          } else if (target == 'macos') {
-            // Same for macOS deployment target, but 10.8.
-            // The plugintest target should not have MACOSX_DEPLOYMENT_TARGET set.
-            if (podsProjectContent.contains('MACOSX_DEPLOYMENT_TARGET = 10.8')) {
-              throw TaskResult.failure('Plugin build setting MACOSX_DEPLOYMENT_TARGET not removed');
-            }
-            // Transitive dependency AppAuth targeting too-low 10.9 was not fixed.
-            if (podsProjectContent.contains('MACOSX_DEPLOYMENT_TARGET = 10.9')) {
-              throw TaskResult.failure('Transitive dependency build setting MACOSX_DEPLOYMENT_TARGET=10.9 not removed');
+
+            final String podsProjectContent = podsProject.readAsStringSync();
+            if (target == 'ios') {
+              // Plugins with versions lower than the app version should not have IPHONEOS_DEPLOYMENT_TARGET set.
+              // The plugintest plugin target should not have IPHONEOS_DEPLOYMENT_TARGET set since it has been lowered
+              // in _reduceDarwinPluginMinimumVersion to 10, which is below the target version of 11.
+              if (podsProjectContent.contains('IPHONEOS_DEPLOYMENT_TARGET = 10')) {
+                throw TaskResult.failure('Plugin build setting IPHONEOS_DEPLOYMENT_TARGET not removed');
+              }
+              // Transitive dependency AppAuth targeting too-low 8.0 was not fixed.
+              if (podsProjectContent.contains('IPHONEOS_DEPLOYMENT_TARGET = 8')) {
+                throw TaskResult.failure('Transitive dependency build setting IPHONEOS_DEPLOYMENT_TARGET=8 not removed');
+              }
+              if (!podsProjectContent.contains(r'"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "$(inherited) i386";')) {
+                throw TaskResult.failure(r'EXCLUDED_ARCHS is not "$(inherited) i386"');
+              }
+            } else if (target == 'macos') {
+              // Same for macOS deployment target, but 10.8.
+              // The plugintest target should not have MACOSX_DEPLOYMENT_TARGET set.
+              if (podsProjectContent.contains('MACOSX_DEPLOYMENT_TARGET = 10.8')) {
+                throw TaskResult.failure('Plugin build setting MACOSX_DEPLOYMENT_TARGET not removed');
+              }
+              // Transitive dependency AppAuth targeting too-low 10.9 was not fixed.
+              if (podsProjectContent.contains('MACOSX_DEPLOYMENT_TARGET = 10.9')) {
+                throw TaskResult.failure('Transitive dependency build setting MACOSX_DEPLOYMENT_TARGET=10.9 not removed');
+              }
             }
-          }
 
-          if (localEngine != null) {
-            final RegExp localEngineSearchPath = RegExp('FRAMEWORK_SEARCH_PATHS\\s*=[^;]*${localEngine.path}');
-            if (!localEngineSearchPath.hasMatch(podsProjectContent)) {
-              throw TaskResult.failure('FRAMEWORK_SEARCH_PATHS does not contain the --local-engine path');
+            if (localEngine != null) {
+              final RegExp localEngineSearchPath = RegExp('FRAMEWORK_SEARCH_PATHS\\s*=[^;]*${localEngine.path}');
+              if (!localEngineSearchPath.hasMatch(podsProjectContent)) {
+                throw TaskResult.failure('FRAMEWORK_SEARCH_PATHS does not contain the --local-engine path');
+              }
             }
           }
         }
diff --git a/packages/flutter_tools/test/commands.shard/permeable/create_test.dart b/packages/flutter_tools/test/commands.shard/permeable/create_test.dart
@@ -693,7 +693,7 @@ void main() {
     ),
   });
 
-  testUsingContext('kotlin/swift plugin project', () async {
+  testUsingContext('kotlin/swift plugin project without Swift Package Manager', () async {
     return _createProject(
       projectDir,
       <String>['--no-pub', '--template=plugin', '-a', 'kotlin', '--ios-language', 'swift', '--platforms', 'ios,android'],
@@ -718,6 +718,9 @@ void main() {
         'ios/Classes/FlutterProjectPlugin.m',
       ],
     );
+  }, overrides: <Type, Generator>{
+    // Test flags disable Swift Package Manager.
+    FeatureFlags: () => TestFeatureFlags(),
   });
 
   testUsingContext('swift plugin project with Swift Package Manager', () async {
@@ -1944,7 +1947,7 @@ void main() {
     );
   });
 
-  testUsingContext('can re-gen plugin ios/ and example/ folders, reusing custom org', () async {
+  testUsingContext('can re-gen plugin ios/ and example/ folders, reusing custom org, without Swift Package Manager', () async {
     await _createProject(
       projectDir,
       <String>[
@@ -1969,13 +1972,56 @@ void main() {
       unexpectedPaths: <String>[
         'example/android/app/src/main/java/com/example/flutter_project_example/MainActivity.java',
         'android/src/main/java/com/example/flutter_project/FlutterProjectPlugin.java',
+        'ios/flutter_project/Sources/flutter_project/include/flutter_project/FlutterProjectPlugin.h',
       ],
     );
     final FlutterProject project = FlutterProject.fromDirectory(projectDir);
     expect(
       await project.example.ios.productBundleIdentifier(BuildInfo.debug),
       'com.bar.foo.flutterProjectExample',
     );
+  }, overrides: <Type, Generator>{
+    // Test flags disable Swift Package Manager.
+    FeatureFlags: () => TestFeatureFlags(),
+  });
+
+  testUsingContext('can re-gen plugin ios/ and example/ folders, reusing custom org, with Swift Package Manager', () async {
+    await _createProject(
+      projectDir,
+      <String>[
+        '--no-pub',
+        '--template=plugin',
+        '--org', 'com.bar.foo',
+        '-i', 'objc',
+        '-a', 'java',
+        '--platforms', 'ios,android',
+      ],
+      <String>[],
+    );
+    projectDir.childDirectory('example').deleteSync(recursive: true);
+    projectDir.childDirectory('ios').deleteSync(recursive: true);
+    await _createProject(
+      projectDir,
+      <String>['--no-pub', '--template=plugin', '-i', 'objc', '-a', 'java', '--platforms', 'ios,android'],
+      <String>[
+        'example/android/app/src/main/java/com/bar/foo/flutter_project_example/MainActivity.java',
+        'ios/flutter_project/Sources/flutter_project/include/flutter_project/FlutterProjectPlugin.h',
+      ],
+      unexpectedPaths: <String>[
+        'example/android/app/src/main/java/com/example/flutter_project_example/MainActivity.java',
+        'android/src/main/java/com/example/flutter_project/FlutterProjectPlugin.java',
+        'ios/Classes/FlutterProjectPlugin.h',
+      ],
+    );
+    final FlutterProject project = FlutterProject.fromDirectory(projectDir);
+    expect(
+      await project.example.ios.productBundleIdentifier(BuildInfo.debug),
+      'com.bar.foo.flutterProjectExample',
+    );
+  }, overrides: <Type, Generator>{
+    FeatureFlags: () => TestFeatureFlags(
+      isSwiftPackageManagerEnabled: true,
+    ),
   });
 
   testUsingContext('fails to re-gen without specified org when org is ambiguous', () async {
diff --git a/packages/flutter_tools/test/host_cross_arch.shard/ios_content_validation_test.dart b/packages/flutter_tools/test/host_cross_arch.shard/ios_content_validation_test.dart
